HomeMiscellaneousSymbolsQuery commands
User Manual UDO > The UDO syntax > Miscellaneous Index


To add entries for the index you can use the !index command or the (!idx) or (!index) placeholders. You can and should use these commands as often as possible.

To add an entry with the !index command use it this way:

!index Index entry

The entry appears inside the index of LaTeX, inside the index of a Texinfo file that was printed with TeX, inside the index of an ST-Guide hypertext, inside the search dialog of Windows Help and inside the index of an RTF file.

To insert a multi-index you can separate the index entries with a double exclamation mark. You can use up to three indices in one line. You should use multi-indices when it is obvious that a potential reader looks for an entry in different ways.

If you think that a reader might look for Index entry or Entry, Index you should use the following index commands:

!index Index entry
!index Entry !! Index

If you use the placeholder (!idx) you can use up to four parameters. The following examples show how the commands are converted for LaTeX, Windows Help and RTF:

UDO: an (!idx) [entry]
LaTeX: an entry\index{entry}
RTF: an {\xe\v entry}entry
Win: an {K{\footnote K entry}}entry
else: an entry

UDO: a (!idx) [word] [entry]
LaTeX: a word\index{entry}
RTF: a {\xe\v Index}Wort
Win: a {K{\footnote K entry}}word
else: a word

UDO: a (!idx) [word] [entry] [subentry]
LaTeX: a word\index{entry!subentry}
RTF: a {\xe\v entry, subentry}word
Win: a {K{\footnote K entry, subentry}}word
else: a word

UDO: a (!idx) [word] [entry] [subentry] [subsubentry]
LaTeX: a word\index{entry!subentry!subsubentry}
RTF: a {\xe\v entry, subentry, subsubentry}word
Win: a {K{\footnote K entry, subentry, subsubentry}}word
else: a word


  1. The conversion of these index commands can be suppressed with the switch !no_index inside the preamble.
  2. Chapter names, labels and aliases aren't added to the index in no destination format. But you can automatize this with the following switches: !use_nodes_inside_index, !use_label_inside_index and !use_alias_inside_index.
  3. If a chapter contains the command !ignore_index the chapter name won't be added to the index even if you use the switch !use_nodes_inside_index inside the preamble of your source file.
  4. If you convert to LaTeX and you use !index commands inside your source file UDO will add the commands that are necessary for Makeindex automatically. Special characters of an index entry are converted especially for Makeindex.
  5. You have to use the parameters inside brackets. If you want to use a bracket inside a parameter you have to insert a !. If you don't UDO will think that the placeholder ended. An example:
    wrong: (!idx [Copyright (c) 1995])
    right: (!idx [Copyright (c!) 1995])

Copyright © www.udo-open-source.org (Contact)
Last updated on May 19, 2014

HomeMiscellaneousSymbolsQuery commands