Difference between revisions of "Command/setupregister"
< Command
Jump to navigation
Jump to search
m (Text replace - "[[Category:Commands|" to "== ConTeXt-Forum == {{Forum|{{SUBPAGENAME}}}} [[Category:Commands|") |
m (→Description: emphasize double meaning of "distance") |
||
(22 intermediate revisions by 9 users not shown) | |||
Line 50: | Line 50: | ||
</tr> | </tr> | ||
<tr valign="top" class="third"> | <tr valign="top" class="third"> | ||
+ | <td class="cmd">[[Command/keyword:check|check]]</td> | ||
+ | <td>[[Command/value:yes|yes]] [[Command/value:no|no]] </td> | ||
+ | </tr> <tr valign="top" class="third"> | ||
<td class="cmd">[[Command/keyword:sectionnumber|sectionnumber]]</td> | <td class="cmd">[[Command/keyword:sectionnumber|sectionnumber]]</td> | ||
<td>[[Command/value:yes|yes]] [[Command/value:no|no]] </td> | <td>[[Command/value:yes|yes]] [[Command/value:no|no]] </td> | ||
Line 76: | Line 79: | ||
<td class="cmd">[[Command/keyword:referencing|referencing]]</td> | <td class="cmd">[[Command/keyword:referencing|referencing]]</td> | ||
<td>[[Command/value:on|on]] [[Command/value:off|off]] </td> | <td>[[Command/value:on|on]] [[Command/value:off|off]] </td> | ||
− | |||
− | |||
− | |||
− | |||
</tr> | </tr> | ||
<tr valign="top" class="third"> | <tr valign="top" class="third"> | ||
Line 100: | Line 99: | ||
<td class="cmd">[[Command/keyword:prefix|prefix]]</td> | <td class="cmd">[[Command/keyword:prefix|prefix]]</td> | ||
<td>[[Command/value:both|both]] [[Command/value:first|first]] [[Command/value:none|none]] </td> | <td>[[Command/value:both|both]] [[Command/value:first|first]] [[Command/value:none|none]] </td> | ||
+ | </tr> | ||
+ | <tr valign="top" class="third"> | ||
+ | <td class="cmd">[[Command/keyword:pagecommand|pagecommand]]</td> | ||
+ | <td>[[Command/value:command|command]]</td> | ||
+ | </tr> | ||
+ | <tr valign="top" class="third"> | ||
+ | <td class="cmd">[[Command/keyword:textcommand|textcommand]]</td> | ||
+ | <td>[[Command/value:command|command]]</td> | ||
+ | </tr> | ||
+ | <tr valign="top" class="third"> | ||
+ | <td class="cmd">[[Command/keyword:compress|compress]]</td> | ||
+ | <td>[[Command/value:yes|yes]] [[Command/value:no|no]] [[Command/value:text|text]]</td> | ||
+ | </tr> | ||
+ | <tr valign="top" class="third"> | ||
+ | <td class="cmd">[[Command/keyword:language|language]]</td> | ||
+ | <td>[[Command/value:language|language code]]</td> | ||
+ | </tr> | ||
+ | <tr valign="top" class="third"> | ||
+ | <td class="cmd">[[Command/keyword:method|method]]</td> | ||
+ | <td>[[Command/value:default|default]] [[Command/value:before|before]] [[Command/value:after|after]] [[Command/value:first|first]] [[Command/value:last|last]]</td> | ||
+ | </tr> | ||
+ | <tr valign="top" class="third"> | ||
+ | <td class="cmd">[[Command/keyword:pageleft|pageleft]]</td> | ||
+ | <td>[[Command/value:command|command]]</td> | ||
+ | </tr> | ||
+ | <tr valign="top" class="third"> | ||
+ | <td class="cmd">[[Command/keyword:pageright|pageright]]</td> | ||
+ | <td>[[Command/value:command|command]]</td> | ||
</tr> | </tr> | ||
</table> | </table> | ||
− | |||
== Description == | == Description == | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | + | The options are as follows: | |
− | unknownreference | + | <table cellspacing="4" cellpadding="2"> |
− | next or previous one and there is no previous or next reference. | + | <tr> |
− | + | <th>Option</th> | |
− | alternative: | + | <th>Description</th> |
− | </ | + | </tr> |
+ | <tr> | ||
+ | <td>n</td> | ||
+ | <td>number of columns</td> | ||
+ | </tr> | ||
+ | <tr> | ||
+ | <td>balance</td> | ||
+ | <td>balance columns?</td> | ||
+ | </tr> | ||
+ | <tr> | ||
+ | <td>align</td> | ||
+ | <td>balance related (it’s difficult; try which combination suits you)</td> | ||
+ | </tr> | ||
+ | <tr> | ||
+ | <td>style</td> | ||
+ | <td>style of the indicator letters</td> | ||
+ | </tr> | ||
+ | <tr> | ||
+ | <td>pagestyle</td> | ||
+ | <td>style of page number</td> | ||
+ | </tr> | ||
+ | <tr> | ||
+ | <td>textstyle</td> | ||
+ | <td>style of index word</td> | ||
+ | </tr> | ||
+ | <tr> | ||
+ | <td>indicator</td> | ||
+ | <td>create letter sections?</td> | ||
+ | </tr> | ||
+ | <tr> | ||
+ | <td>coupling</td> | ||
+ | <td>special feature for screen documents (no effect in MkIV?)</td> | ||
+ | </tr> | ||
+ | <tr> | ||
+ | <td>check</td> | ||
+ | <td>set {{cmd|seeindex}} entry as entered without verifying. Default no.</td> | ||
+ | </tr> | ||
+ | <tr> | ||
+ | <td>(section)number</td> | ||
+ | <td>print part/... numbers?</td> | ||
+ | </tr> | ||
+ | <tr> | ||
+ | <td>criterium</td> | ||
+ | <td>for part/chapter/section registers</td> | ||
+ | </tr> | ||
+ | <tr> | ||
+ | <td>distance</td> | ||
+ | <td>between text and pagenumber as well as indentation of nested entries</td> | ||
+ | </tr> | ||
+ | <tr> | ||
+ | <td>symbol</td> | ||
+ | <td>for pagenumber (a=a,b,c; n=1,2,3; 1=dots; 2=blocks)</td> | ||
+ | </tr> | ||
+ | <tr> | ||
+ | <td>interaction</td> | ||
+ | <td>which part should be clickable?</td> | ||
+ | </tr> | ||
+ | <tr> | ||
+ | <td>expansion</td> | ||
+ | <td>When the entry is a command, it is expanded before writing to the register</td> | ||
+ | </tr> | ||
+ | <tr> | ||
+ | <td>referencing</td> | ||
+ | <td>create references for letter sections (like "index:a")?</td> | ||
+ | </tr> | ||
+ | <tr> | ||
+ | <td>textcommand</td> | ||
+ | <td>custom command for index word</td> | ||
+ | </tr> | ||
+ | <tr> | ||
+ | <td>pagecommand</td> | ||
+ | <td>custom command for page number</td> | ||
+ | </tr> | ||
+ | <tr> | ||
+ | <td>location</td> | ||
+ | <td>?</td> | ||
+ | </tr> | ||
+ | <tr> | ||
+ | <td>compress</td> | ||
+ | <td>collapse page numbers (i.e. make “10–13” from “10,11,12,13”); “<tt>text</tt>” (new in April 2019) makes “10ff.”. You can configure the latter via {{cmd|setuplabeltext}}<tt>[en][following:singular=f.,following:plural=ff.]</tt></td> | ||
+ | </tr> | ||
+ | <tr> | ||
+ | <td>maxwidth</td> | ||
+ | <td>Set the maximum length for the text of the index entry in the registerlist (the command uses {{cmd|limitatetext}} to do this)</td> | ||
+ | </tr> | ||
+ | <tr> | ||
+ | <td>unknownreference</td> | ||
+ | <td>insert a horizontal space before and after the reference in the text if you use interactive mode to move from one entry in the text to next or previous one and there is no previous or next reference.</td> | ||
+ | </tr> | ||
+ | <tr> | ||
+ | <td>alternative</td> | ||
+ | <td>?</td> | ||
+ | </tr> | ||
+ | <tr> | ||
+ | <td>language</td> | ||
+ | <td>language code like in {{cmd|language}}, influences sorting; see definitions in {{src|sort-lan.mkiv}}</td> | ||
+ | </tr> | ||
+ | <tr> | ||
+ | <td>method</td> | ||
+ | <td>sets up the sorter used for {{cmd|placeregister}}, explained at [[Command/keyword:method]]</td> | ||
+ | </tr> | ||
+ | <tr> | ||
+ | <td>pageleft</td> | ||
+ | <td>custom command before the first page number</td> | ||
+ | </tr> | ||
+ | <tr> | ||
+ | <td>pageright</td> | ||
+ | <td>custom command after the last page number</td> | ||
+ | </tr> | ||
+ | </table> | ||
+ | Some options don’t seem to have any effect, at least in MkIV. | ||
+ | == Example == | ||
− | + | Here is an example for MkII: | |
<context source="yes" text="yields"> | <context source="yes" text="yields"> | ||
Line 162: | Line 279: | ||
I found it safer to put \register command after punctuation e.g.: Mamut.\nickname{Mamut} [P.K.] | I found it safer to put \register command after punctuation e.g.: Mamut.\nickname{Mamut} [P.K.] | ||
+ | |||
+ | For the MkIV version of setting the pagestyle, and more, see the material on {{cmd|defineprocessor}} that is on [[Registers#Prcoessors|this page]]. | ||
+ | |||
+ | == pageleft and pageright == | ||
+ | |||
+ | They were introduced in ConTeXt MkIV version 1.02 (2018.05.12 00:07). | ||
+ | |||
+ | You can use them, for example, to move the page numbers to the right, with: | ||
+ | |||
+ | <pre> | ||
+ | \setupregister[index][pageleft=\wordright\bgroup,pageright=\egroup] | ||
+ | </pre> | ||
+ | |||
+ | See [http://www.mail-archive.com/ntg-context@ntg.nl/msg87812.html this thread] | ||
+ | on the mailing list. | ||
== See also == | == See also == | ||
− | <!-- something like | + | <!-- something like {{cmd|goto}} --> |
− | == ConTeXt-Forum == | + | == Help from ConTeXt-Mailinglist/Forum == |
+ | All issues with: | ||
{{Forum|{{SUBPAGENAME}}}} | {{Forum|{{SUBPAGENAME}}}} | ||
− | [[Category: | + | [[Category:Command/Registers|setupregister]] |
Revision as of 19:02, 24 July 2019
\setupregister
Syntax
\setupregister[...][...][...,...=...,...] | |
[...] | singular |
[...] | name |
n | number |
balance | yes no |
align | yes no |
style | normal bold slanted boldslanted type cap small... command |
pagestyle | normal bold slanted boldslanted type cap small... command |
textstyle | normal bold slanted boldslanted type cap small... command |
indicator | yes no |
coupling | yes no |
check | yes no |
sectionnumber | yes no |
criterium | section local all |
distance | dimension |
symbol | 1 2 ... n a ... none |
interaction | pagenumber text |
expansion | yes no command |
referencing | on off |
location | left middle right |
maxwidth | dimension |
unknownreference | empty none |
alternative | a b A B |
prefix | both first none |
pagecommand | command |
textcommand | command |
compress | yes no text |
language | language code |
method | default before after first last |
pageleft | command |
pageright | command |
Description
The options are as follows:
Option | Description |
---|---|
n | number of columns |
balance | balance columns? |
align | balance related (it’s difficult; try which combination suits you) |
style | style of the indicator letters |
pagestyle | style of page number |
textstyle | style of index word |
indicator | create letter sections? |
coupling | special feature for screen documents (no effect in MkIV?) |
check | set \seeindex entry as entered without verifying. Default no. |
(section)number | print part/... numbers? |
criterium | for part/chapter/section registers |
distance | between text and pagenumber as well as indentation of nested entries |
symbol | for pagenumber (a=a,b,c; n=1,2,3; 1=dots; 2=blocks) |
interaction | which part should be clickable? |
expansion | When the entry is a command, it is expanded before writing to the register |
referencing | create references for letter sections (like "index:a")? |
textcommand | custom command for index word |
pagecommand | custom command for page number |
location | ? |
compress | collapse page numbers (i.e. make “10–13” from “10,11,12,13”); “text” (new in April 2019) makes “10ff.”. You can configure the latter via \setuplabeltext[en][following:singular=f.,following:plural=ff.] |
maxwidth | Set the maximum length for the text of the index entry in the registerlist (the command uses \limitatetext to do this) |
unknownreference | insert a horizontal space before and after the reference in the text if you use interactive mode to move from one entry in the text to next or previous one and there is no previous or next reference. |
alternative | ? |
language | language code like in \language, influences sorting; see definitions in sort-lan.mkiv |
method | sets up the sorter used for \placeregister, explained at Command/keyword:method |
pageleft | custom command before the first page number |
pageright | custom command after the last page number |
Some options don’t seem to have any effect, at least in MkIV.
Example
Here is an example for MkII:
\defineregister[nickname][nicknames] \setupregister [nickname] [partnumber=no,alternative=A,criterium=all,n=3,balance=yes,pagestyle=normal] \setupregister [nickname][foto][pagestyle=bold] \starttext Text about Mamut\nickname{Mamut}. \placefigure[] {Kuba\nickname[foto::]{Kuba} on the photo.} {\externalfigure[kuba][width=0.2\textwidth]} \page And text about Kuba\nickname{Kuba}. \completenickname \stoptext
yields
I found it safer to put \register command after punctuation e.g.: Mamut.\nickname{Mamut} [P.K.]
For the MkIV version of setting the pagestyle, and more, see the material on \defineprocessor that is on this page.
pageleft and pageright
They were introduced in ConTeXt MkIV version 1.02 (2018.05.12 00:07).
You can use them, for example, to move the page numbers to the right, with:
\setupregister[index][pageleft=\wordright\bgroup,pageright=\egroup]
See this thread on the mailing list.
See also
Help from ConTeXt-Mailinglist/Forum
All issues with: