Difference between revisions of "Command/setupregister"

From Wiki
Jump to navigation Jump to search
m (--> registers)
m
Line 76: Line 76:
 
     <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 valign="top" class="third">
 
    <td class="cmd">[[Command/keyword:command|command]]</td>
 
    <td>[[Command/value:oneargument|oneargument]] </td>
 
 
   </tr>
 
   </tr>
 
   <tr valign="top" class="third">
 
   <tr valign="top" class="third">
Line 100: Line 96:
 
     <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:compress|compress]]</td>
 +
    <td>[[Command/value:yes|yes]] [[Command/value:no|no]]</td>
 
   </tr>
 
   </tr>
 
</table>
 
</table>
Line 105: Line 105:
  
 
== Description ==  
 
== Description ==  
<pre>
 
n: number of columns
 
balance: balance columns?
 
align: ?
 
style: overall style(?)
 
pagestyle: style of page number
 
textstyle: style of index word
 
indicator: create letter sections?
 
coupling: special feature for screen documents
 
(section)number: print part/... numbers?
 
criterium: for part/chapter/section registers
 
distance: between text and pagenumber
 
symbol: for pagenumber (a=a,b,c; n=1,2,3; 1=dots; 2=blocks)
 
interaction: which part should be clickable?
 
expansion: ?
 
referencing: create references for letter sections (like "index:a")?
 
command: DOES NOT EXIST! use textcommand and pagecommand instead!
 
textcommand: custom command for index word
 
pagecommand: custom command for page number
 
location: ?
 
 
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:
 
</pre>
 
  
 +
The options are as follows:
  
 +
* n: number of columns
 +
* balance: balance columns?
 +
* align: ?
 +
* style: overall style(?)
 +
* pagestyle: style of page number
 +
* textstyle: style of index word
 +
* indicator: create letter sections?
 +
* coupling: special feature for screen documents
 +
* (section)number: print part/... numbers?
 +
* criterium: for part/chapter/section registers
 +
* distance: between text and pagenumber
 +
* symbol: for pagenumber (a=a,b,c; n=1,2,3; 1=dots; 2=blocks)
 +
* interaction: which part should be clickable?
 +
* expansion: ?
 +
* 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
 +
* maxwidth: Set the maximum length for the text of the index entry in the registerlist (the command uses {{cmd|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:
  
 
== Example ==
 
== Example ==

Revision as of 00:55, 14 January 2014

\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
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
compress yes no


Description

The options are as follows:

  • n: number of columns
  • balance: balance columns?
  • align: ?
  • style: overall style(?)
  • pagestyle: style of page number
  • textstyle: style of index word
  • indicator: create letter sections?
  • coupling: special feature for screen documents
  • (section)number: print part/... numbers?
  • criterium: for part/chapter/section registers
  • distance: between text and pagenumber
  • symbol: for pagenumber (a=a,b,c; n=1,2,3; 1=dots; 2=blocks)
  • interaction: which part should be clickable?
  • expansion: ?
  • 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
  • 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:

Example

\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.]

See also

Help from ConTeXt-Mailinglist/Forum

All issues with: