admin
The admin
element is used to enclose some empty elements
that describe informations that should go inside the Texinfo header. The
order for these elements is not important, as Texinfo source will be
build in the right one. It follows a summary table and then the detailed
description.
Element | Attribute | Content | Description or Texinfo equivalence
|
setfilename | empty | @setfilename
| |
content | Info file name
| ||
settitle | empty | @settitle
| |
content | title
| ||
setchapternewpage | empty | @setchapternewpage
| |
content | on, off, odd | tell how to separate chapters
| |
footnotestyle | empty | @footnotestyle
| |
content | end, separate | where to place footnotes
| |
headings | empty | @headings
| |
content | on, off, single, double, singleafter, doubleafter | how headings should work
| |
defindex | empty | @defindex
| |
name | define a two letter index name
| ||
defcodeindex | empty | @defcodeindex
| |
name | define a two letter index name with @code items
| ||
synindex | empty | @synindex
| |
from | source index, as a two letters name
| ||
to | destination index, as a two letters name
| ||
syncodeindex | empty | @syncodeindex
| |
from | source index, as a two letters name
| ||
to | destination index, with @code items
| ||
infodir | empty or literal @direntry
| Info directory information
| |
cat | The @dircategory argument
|
setfilename | Element |
This element is empty and is used to define the file name for
Info, with the Texinfo command @setfilename .
Use this element like this, only with the opening tag: <setfilename content="sgmltexi.info"> |
settitle | Element |
This element is empty and is used to define the title for
Info, with the Texinfo command @settitle .
Use this element like this, only with the opening tag: <settitle content="Sgmltexi"> |
setchapternewpage | Element |
This element is empty and is used to define the Texinfo command
@setchapternewpage .
Use this element like this, only with the opening tag: <setchapternewpage content="on"> This element is not essential. |
footnotestyle | Element |
This element is empty and is used to define the Texinfo command
@footnotestyle .
Use this element like this, only with the opening tag: <footnotestyle content="end"> This element is not essential. |
heading | Element |
This element is empty and is used to define the Texinfo command
@headings .
Use this element like this, only with the opening tag: <headings content="double"> This element is not essential. |
defindex | Element |
defcodeindex | Element |
These two empty elements are used to define the Texinfo commands
@defindex and @defcodeindex .
Use these elements like this, only with the opening tag: <defindex name="sg"> <defcodeindex name="xx"> These elements are used only as needed, for as many user defined index that are to be created. |
synindex | Element |
syncodeindex | Element |
These two elements are used to copy one index into another, like
the command @synindex and
@syncodeindex do with Texinfo.
Use this element like this, only with the opening tag: <syncodeindex from="fn" to="cp"> This element is used only as needed, for as many user defined index that are to be created. |
infodir | Element |
This element is used to define the Info directory menu
item, when the file is installed with
install-info .
This element can be used empty, like this: <infodir cat="Texinfo documentation system"> But this element can be used also more explicitly, like this: <infodir cat="Texinfo documentation system"> * Sgmltexi: (sgmltexi). SGML for Texinfo. * Sgmltexi install: (sgmltexi)install. Install Sgmltexi. </infodir> This element is used only if needed. If the element is use empty,
only one line inside the |