Difference between revisions of "Command/setupregister"

From ConTeXt wiki
(Create reference page)
 
m (cleanup)
Line 1: Line 1:
<!-- please remove this and the following line if you have checked this page -->
 
{{Reference_Cleanup}}
 
 
{{Reference
 
{{Reference
 
|name=setupregister
 
|name=setupregister
Line 140: Line 138:
 
== Example ==
 
== Example ==
  
<pre class="example">
+
<context source="yes" text="yields">
 
\defineregister[nickname][nicknames]
 
\defineregister[nickname][nicknames]
  
Line 152: Line 150:
 
\placefigure[]
 
\placefigure[]
 
   {Kuba\nickname[foto::]{Kuba} on the photo.}
 
   {Kuba\nickname[foto::]{Kuba} on the photo.}
   {\externalfigure[kuba][width=\textwidth]}
+
   {\externalfigure[kuba][width=0.2\textwidth]}
  
 
\page
 
\page
Line 160: Line 158:
 
\stoptext  
 
\stoptext  
  
</pre>
+
</context>
  
  

Revision as of 07:36, 14 April 2010

\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
command oneargument
location left middle right
maxwidth dimension
unknownreference empty none
alternative a b A B
prefix both first none


Description

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: 


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


See also