Difference between revisions of "Command/setregisterentry"

From Wiki
Jump to navigation Jump to search
m (typo)
m (typo)
Line 1: Line 1:
 
<cd:commandgroup name="setregisterentry" xmlns:cd="http://wiki.contextgarden.net/commanddoc/20200807">
 
<cd:commandgroup name="setregisterentry" xmlns:cd="http://wiki.contextgarden.net/commanddoc/20200807">
 
<cd:shortdesc><!-- a short command summary goes here -->
 
<cd:shortdesc><!-- a short command summary goes here -->
The command <tt>\setregisterentry</tt> is used for putting the entry to the register.
+
The command <tt>\setregisterentry</tt> writes entry to the register.
 
</cd:shortdesc>
 
</cd:shortdesc>
 
<cd:variants>
 
<cd:variants>

Revision as of 14:43, 12 October 2020


\setregisterentry

Summary

The command \setregisterentry writes entry to the register.

Settings

\setregisterentry[...][...=...,...][...=...,...]
[...]name
labelname
keystext processor->text
entriestext processor->text
keys:1text
keys:2text
keys:3text
entries:1text
entries:2text
entries:3text
alternativetext
keyvalue

Description

\setregisterentry is more structured form of the regular \index command. With it's more complex and robust structure it is suitable for automatic workflows.

When processing the command on Lua end, one has to take care of colons in the key:1 and entry:1 paramaters by enclosing them in inside ["..."], see example bellow.

Examples

Three levels, different sorting, comma in the entry

\setupregister[index][balance=no]

\starttext

\chapter{Alfred Hitchcock}

The Skin Game (1931)    \setregisterentry[index]
                        [keys:1=Hitchcock Alfred,
                        entries:1={Hitchcock, Alfred},
                        keys:2=1931,
                        entries:2=1931,
                        keys:3=Skin Game,
                        entries:3={Skin Game, The}]

Mary (1931)             \setregisterentry[index]
                        [keys:1=Hitchcock Alfred,
                        entries:1={Hitchcock, Alfred},
                        keys:2=1931,
                        entries:2=1931,
                        keys:3=Mary,
                        entries:3=Mary]

Rich and Strange (1931)	\setregisterentry[index]
                        [keys:1=Hitchcock Alfred,
                        entries:1={Hitchcock, Alfred},
                        keys:2=1931,
                        entries:2=1931,
                        keys:3=Rich and Strange,
                        entries:3=Rich and Strange]

Number Seventeen (1932) \setregisterentry[index]
                        [keys:1=Hitchcock Alfred,
                        entries:1={Hitchcock, Alfred},
                        keys:2=1932,
                        entries:2=1932,
                        keys:3=Number Seventeen,
                        entries:3=Number Seventeen]


\blank

\placeregister[index]   % without title

\stoptext

Processing on Lua end

\startluacode
context.setregisterentry({ "MyIndex" },
    { ["keys:1"]="sorting key", ["entries:1"]="displayed entry"})
\stopluacode

Notes

See also

Help from ConTeXt-Mailinglist/Forum

All issues with: