DEFLANGPRIMARY attribute. Valid values are EN
(English, the default) and DE (German).
MAKEINDEXNAME
serves as unique identifier for the specific index. The
corresponding INDEX and INSERTINDEX elements refer to this
identifier.
CATEGORYNAMETOPIC
[lt ]&DOCTYPE manual PUBLIC "-//Witware//DTD InfoPrism//EN;[gt ]&;[lt ]&ITL;[gt ]&anual Exampl;[lt ]&TITL;[gt ]&;[lt ]&UTHOR EMAIL="rumble@chaos.de;[gt ]&ina Rumbl;[lt ]&AUTHO;[gt ]&;[lt ]&TAMP YEAR=1997 MONTH=4 DAY=7 HOUR=15 MINUTE=1 SECS=37 TZ="met dst;[gt ]&This is an example of an InfoPrism document;The authors of the document should appear in
AUTHOR elements. At least one element is required. The optional EMAIL attribute specifies the email address of the author.
The STAMP element contains information about the time of the
last modification of the document. This element and the HOUR,
MINUTE, SECS and TZ attributes are
optional.
The TOC element directs the translator to include a table of contents in the generated document. The table of contents is labeled with a default given by each translator. You may override this with a TITLE element inside of the TOC
element:
[lt ]&-- appropriate for german documents -->;[lt ]&OC;[lt ]&ITLE>Inhaltsverzeichni;[lt ]&TITLE;[lt ]&TOC;
MAJORHEADINGTITLE element.
For sake of flexibility, InfoPrism knows only of one sectioning element:
SECTION. This allows you to:
Any section may have up to three title elements:
TITLE (mandatory)DESCR (optional)SHORT
(optional)
TITLE contains the section title, DESCR a section
description and SHORT a short section title.
Within sections, text can be arranged in a set of paragraphs by using the P element. However, the P element should not be
placed immediately before or after the PRE/EXAMPLE element.
The UL element defines an unordered, the OL defines an
ordered list of items. Each item in an UL or an OL
list is contained within an LI element.
The DL element defines an glossary list. This list type, also known
as a definition list, presents a list of items, each with a descriptive
paragraph. Therefore a DL list can contain two elements:
DTDDEXAMPLE element marks text as an example that is not part
of the running text, such as computer input or output. This element
preserves the line breaks and space characters in the original text. The
PRE element is a synonym for the EXAMPLE element.
LABEL and REF elements. The LABEL
element is the place to that the cross-reference points to. The
mandatory attribute NAME has an unique identifier for that
label as value. To reference this label, insert a REF element.
The mandatory attribute NAME has the identifier as value and
the attribute TEXT may be highlighted in the formatted
document.
LINK element. The mandatory attribute DOC
specifies the document name, usually the file name without the format
specific extension.
Several resources located locally or anywhere in the world can be identified by URLs. The URL element and the HTMLURL represent
links to those resources. The URL is specified by the URL
attribute. The NAME attribute holds the "name" of the resource.
InfoPrism allows you to specify a special formatting style for phrases. This is useful to put an on one or more words in your document and may result in sort of in the formatted document.
The phrase highlighting elements are similar to HTML and can be divided into logical and physical highlighting elements. The advantage of logical elements that the physical appearance of the formatted text is not fixed by the document. Only in the cases where a certain font is absolutely required, physical elements should be used.
| Element | Purpose | Default font | Example |
|---|---|---|---|
| CITE | citation | italics | Veni, vidi, vici! |
| CODE | example of typed code | fixed-width font | exit 0;
|
| DFN | definition | bold or bold italics | define |
| EM, EMPH | emphasis | italics | important |
| KBD | keyboard input | cat /etc/passwd | |
| SAMP | literal characters | as is | |
| S, STRONG | stronger emphasis | italics | strong |
| VAR | variable name | errno |
Use the CODE element to indicate text that is a piece of a
program and which consists of entire syntactic tokens. It is appropriate for
print "Hello world\n";
The KBD element marks a block of text as keyboard input.
The VAR element marks a block of text as a metasyntactic
variable. A metasyntactic variable is something stands for
another piece fo text. For example, you should use a metasyntactic variable
in the documentation of a function to describe the arguments that are passed
to that function. Do not use the VAR element for the names of
particular variables in programming languages.
The SAMP element marks a block of text as literal example or a
sequence of characters in a file, string, pattern, etc. Any time you are
referring to single characters, you should use the SAMP
element unless the KBD element is more appropriate. Basically,
this element is a catchall for whatever is not covered by the CODE
and KBD elements.
The DFN element marks a block of text as the definition of a
term. Use this element only in passages whose purpose is to introduce a term
which will be used again or which the reader ought to know.
CITE element indicates that the text enclosed is cited
from some reference.
TABLE element and its companions CAPTION,
TR, TH and TD. A table is an array of cells, which can be either header or data cells. Header cells usually describe the contents of a row or a column. Each row of the table is represented by the TR element. The CAPTION
element is used to provide a caption for the table. Tables cannot be nested.
The following table describes keywords for declared values in attribute lists:
| Keyword | Description | Example |
|---|---|---|
CDATA | character data | [lt ]&RL URL="http://sunsite.unc.edu/mdw/linux.html" NAME="LDP"; |
ID | unique ID value | [lt ]&AKEINDEX NAME=cp; |
IDREF | value referencing element with corresponding
ID value | [lt ]&RINTINDEX NAME=cp; |
IDREFS | list with values referencing elements with
corresponding ID values | [lt ]&NDEX NAME="cp fn"; |
NOTATION | name that identifies the notation of the element's content | [lt ]&ATH mu=latex; |
NUMBER | number | [lt ]&IBYEAR no=1996; |
NUTOKENS | list of number tokens separated by spaces | [lt ]&IBCITE key=sgmlimp pages="241 242 243"; |
| Entity | Output | Description |
|---|---|---|
| [amp ]´ | [aacute] | small a, acute accent |
| [amp ]´ | [Aacute] | capital A, acute accent |
| [amp ]¨ | [auml ] | small a, dieresis or umlaut mark |
| [amp ]¨ | [Auml ] | capital A, dieresis or umlaut mark |
| [amp ]¨ | [ouml ] | small o, dieresis or umlaut mark |
| [amp ]¨ | [Ouml ] | capital O, dieresis or umlaut mark |
| [amp ]&zlig; | [szlig ] | small sharp s, German (sz ligature) |
| [amp ]¨ | [uuml ] | small u, dieresis or umlaut mark |
| [amp ]¨ | [Uuml ] | capital U, dieresis or umlaut mark |
Every index must be defined in the preamble with the MAKEINDEX element.
Each INDEX element generates an index entry for the indices
selected by the value of the NAME attribute. The contents of the
INDEX element are normally not inserted in the running text. This behaviour can be reversed by embedding the text in an EXPOSE or an EP element. The closing tag of
these elements may be omitted.
Contents of INDEX element | Corresponding text |
|---|---|
append | |
[lt ]&XPOSE>appen;[lt ]&EXPOSE> comman; | append |
section <EP>counter | counter |
Another way to create an index entry is by specifying a value for the
INDEX attribute of the LABEL element.
To generate an index, you must include an INSERTINDEX element
at the place where the index is to appear. Usually, the indices are located
at the end of the document.
BIBARTICLEBIBAUTHOR, BIBTITLE, BIBJOURNAL
, BIBYEARBIBVOLUME, BIBNUMBER, BIBPAGES
, BIBMONTH, BIBNOTE BIBBOOKBIBAUTHOR or BIBEDITOR, BIBTITLE
, BIBPUBLISHER, BIBYEARBIBVOLUME or BIBNUMBER,
BIBSERIES, BIBADDRESS, BIBEDITION,
BIBMONTH, BIBNOTE BIBNPARTICLEBIBAUTHOR or BIBINITIALS,
BIBTITLE, BIBJOURNAL, BIBYEARBIBNUMBER, BIBPAGES, BIBMONTH
, BIBNOTE BIBNEWSARTICLEBIBAUTHOR, BIBTITLE,
BIBNEWSGROUPS, BIBDATE, BIBMSGID
Now a comprehensive list of all data field elements:
BIBADDRESS
BIBAUTHORBIBEDITIONBIBEDITORBIBINITIALS
BIBJOURNALBIBMONTH
ABBR attribute: "jan", "feb", ...) BIBNOTE
BIBNUMBERNO attribute) BIBPAGES
BIBPUBLISHER in the RANGE attribute.BIBSERIESBIBTITLE element gives
its title and an optional BIBSERIES element gives the name of a series or multivolume set in which the book is published. BIBTITLEBIBVOLUMENO attribute) BIBYEARNO attribute)
ip as follows: ]>Now, any reference to InfoPrism in the text can be replaced with
[amp ]&p;
.
Note that the first declaration of an entity overrides subsequent declarations.