File: structure.page

package info (click to toggle)
enter-tex 3.48.0-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 7,460 kB
  • sloc: ansic: 10,657; xml: 3,025; makefile: 8; sh: 7
file content (59 lines) | stat: -rw-r--r-- 1,626 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
<page xmlns="http://projectmallard.org/1.0/"
      xmlns:its="http://www.w3.org/2005/11/its"
      type="topic"
      id="structure">

<info>
  <link type="guide" xref="index" />
</info>

<title>Document's Structure</title>

<synopsis>
  <p>The list of chapters, sections, sub-sections and other things like tables,
  figures, … of a document, to easily navigate in it.</p>
</synopsis>

<section id="display">
  <title>Display the structure</title>

  <p>
    The structure can be displayed in the side panel. If the side panel is hidden,
    go to
    <guiseq>
      <gui style="menu">View</gui>
      <gui style="menu">Side panel</gui>
    </guiseq>.
  </p>

  <p>
    The structure's content is not automatically updated. That's why there is a refresh
    button. If text is inserted in the document, the position of an item (e.g. a section)
    remains correct, as far as the item is still there, and is not modified.
  </p>
</section>

<section id="actions">
  <title>Actions</title>

  <p>
    Some actions such as "cut", "copy" or "comment" can be performed on a
    structure's item. Either by a right click, or via the
    <gui style="menu">Structure</gui> menu.
  </p>
</section>

<section its:locNote="Do not translate the words TODO and FIXME. They are special comments
that can be inserted in LaTeX documents." id="todos-and-fixmes">
  <title>TODOs and FIXMEs</title>

  <p>
    It can be useful to add TODOs and FIXMEs comments in the document. They will be
    displayed in the structure. Example:
  </p>

  <code mime="text/x-tex">
%TODO a remaining task
%FIXME something is broken</code>
</section>
</page>