Difference between revisions of "Command/definecombinedlist"
(Create reference page) |
(cleanup) |
||
Line 1: | Line 1: | ||
− | |||
− | |||
{{Reference | {{Reference | ||
|name=definecombinedlist | |name=definecombinedlist | ||
Line 27: | Line 25: | ||
== Description == | == Description == | ||
− | The command | + | The command [[cmd:placecontent|\placecontent]] is available after definition with [[cmd:definecombinedlist|\definecombinedlist]]. |
− | + | ||
− | + | This command and [[cmd:definelist|\definelist]] allows you to define your own lists necessary for structuring your documents. | |
− | This command and [[cmd:definelist]] allows you to define your own lists necessary for structuring your documents. | ||
The use of this command and its related commands is illustrated for the table of contents. | The use of this command and its related commands is illustrated for the table of contents. | ||
− | + | ||
− | + | <texcode> | |
− | + | \definelist[chapter] | |
− | + | \setuplist | |
− | + | [chapter] | |
− | + | [before=\blank, | |
− | + | after=\blank, | |
− | + | style=bold] | |
− | + | \definelist[section] | |
− | + | \setuplist | |
− | + | [section] | |
+ | [alternative=d] | ||
</texcode> | </texcode> | ||
− | Now there are two lists of chapters and sections and these will be combined in a table of contents with the command | + | Now there are two lists of chapters and sections and these will be combined in a table of contents with the command [[cmd:definecombinedlist|\definecombinedlist]]. |
<texcode> | <texcode> | ||
− | + | \definecombinedlist | |
− | + | [contents] | |
− | + | [chapter,section] | |
− | + | [level=subsection] | |
</texcode> | </texcode> | ||
− | Now two commands are available: | + | Now two commands are available: [[cmd:placecontent|\placecontent]] and [[cmd:completecontent|\completecontent]]. With the second command the title of the table of contents will be added to the table of contents itself. |
The layout of lists can be varied with the parameter alternative: | The layout of lists can be varied with the parameter alternative: | ||
Line 65: | Line 63: | ||
* f = reserved for interactive purposes | * f = reserved for interactive purposes | ||
− | Lists are set up with: | + | Lists are set up with: [[cmd:setuplist|\setuplist]] and [[cmd:setupcombinedlist|\setupcombinedlist]]. |
− | |||
− | |||
If you want to change the layout of the generated table of contents you’ll have to remember that it is a list. | If you want to change the layout of the generated table of contents you’ll have to remember that it is a list. | ||
<texcode> | <texcode> | ||
− | + | \setupcombinedlist | |
− | + | [content] | |
− | + | [alternative=c, | |
− | + | aligntitle=no, | |
− | + | width=2.5cm] | |
</texcode> | </texcode> | ||
This will result in a somewhat different layout than the default one. | This will result in a somewhat different layout than the default one. | ||
− | Lists are called up and placed with | + | Lists are called up and placed with [[cmd:placelist|\placelist]]. |
− | |||
− | |||
So if you want a table of content you type: | So if you want a table of content you type: | ||
<texcode> | <texcode> | ||
− | + | \placecontent[level=section] | |
− | + | \completecontent[level=section] | |
</texcode> | </texcode> | ||
Line 94: | Line 88: | ||
A long list or a long table of contents will use up more than one page. To be able to force page breaking you can type: | A long list or a long table of contents will use up more than one page. To be able to force page breaking you can type: | ||
− | + | <texcode>\completecontent[2.2,8.5,12.3.3]</texcode> | |
A page break will occur after section 2.2 and 8.5 and sub section 12.3.3. | A page break will occur after section 2.2 and 8.5 and sub section 12.3.3. | ||
− | In some cases you want to be able to write your own text in an automatically generated list. This is done with | + | In some cases you want to be able to write your own text in an automatically generated list. This is done with [[cmd:writetolist|\writetolist]] and [[cmd:writebetweenlist|\writebetweenlist]] |
− | |||
− | |||
For example if you want to make a remark in your table of contents after a section titled Hotels in Hasselt you can type: | For example if you want to make a remark in your table of contents after a section titled Hotels in Hasselt you can type: | ||
<texcode> | <texcode> | ||
− | + | \section{Hotels in Hasselt} | |
− | + | \writebetweenlist[section]{\blank} | |
</texcode> | </texcode> | ||
Revision as of 16:30, 14 April 2010
\definecombinedlist
Syntax
\definecombinedlist[...][...,...,...][...,...=...,...] | |
[...] | name |
[...,...,...] | list |
[...,...=...,...] | see \setupcombinedlist |
Description
The command \placecontent is available after definition with \definecombinedlist.
This command and \definelist allows you to define your own lists necessary for structuring your documents.
The use of this command and its related commands is illustrated for the table of contents.
\definelist[chapter] \setuplist [chapter] [before=\blank, after=\blank, style=bold] \definelist[section] \setuplist [section] [alternative=d]
Now there are two lists of chapters and sections and these will be combined in a table of contents with the command \definecombinedlist.
\definecombinedlist [contents] [chapter,section] [level=subsection]
Now two commands are available: \placecontent and \completecontent. With the second command the title of the table of contents will be added to the table of contents itself.
The layout of lists can be varied with the parameter alternative:
- a = number – title – page number
- b = number – title – spaces – page number
- c = number – title – dots – page number
- d = number – title – page number (continuing)
- e = reserved for interactive purposes
- f = reserved for interactive purposes
Lists are set up with: \setuplist and \setupcombinedlist.
If you want to change the layout of the generated table of contents you’ll have to remember that it is a list.
\setupcombinedlist [content] [alternative=c, aligntitle=no, width=2.5cm]
This will result in a somewhat different layout than the default one.
Lists are called up and placed with \placelist.
So if you want a table of content you type:
\placecontent[level=section] \completecontent[level=section]
only the sections will be displayed. You might need this option when you have a well structured document that has sub sub sub sub sub sections and you don’t want those in the table of contents.
A long list or a long table of contents will use up more than one page. To be able to force page breaking you can type:
\completecontent[2.2,8.5,12.3.3]
A page break will occur after section 2.2 and 8.5 and sub section 12.3.3. In some cases you want to be able to write your own text in an automatically generated list. This is done with \writetolist and \writebetweenlist
For example if you want to make a remark in your table of contents after a section titled Hotels in Hasselt you can type:
\section{Hotels in Hasselt} \writebetweenlist[section]{\blank}