Skip to content
Samuel Fang edited this page Jun 4, 2021 · 7 revisions

XML Tags

This section serves to document the different XML tags used.

General

  • COMMENT: can be added anywhere in the text; will displayed only in the comparison edition, and are rendered there in grey. COMMENT makes a "span" element in HTML, meant for inline comments.

  • WEB_ONLY: can be added anywhere in the text; will only go in the web editions (JS and split). To get the right color-coding in the comparison edition, WEB_ONLY needs to be inside of SPLIT tags. WEB_ONLY makes a "div" element in HTML, meant for paragraphs.

  • PDF_ONLY: can be added anywhere in the text; will only go in the PDF edition. Content shows up inline in the PDF. (currently rendered using a DIV paragraph in the comparison edition)

  • EXERCISE: mark a textbook exercise; must have a LABEL tag as their first element.

  • SOLUTION: add a solution to an EXERCISE; must be inside of the EXERCISE tag that it refers to.

  • LABEL: have a NAME attribute so that other sections can refer with a REF tag to the element that has the LABEL.

  • REF: have a NAME attribute to refer to elements that are tagged with LABEL.

  • META: within <SNIPPET><JAVASCRIPT>...</JAVASCRIPT></SNIPPET> and in normal text, this will produce an italics font intended for meta variables. <META> elements must not enclose any other elements. No math allowed in <META>.

  • METAPHRASE: within <SNIPPET><JAVASCRIPT>...</JAVASCRIPT></SNIPPET> and in normal text, this will produce an italics font within angle brackets, intended for meta-level phrases. <METAPHRASE> elements may include <JAVASCRIPTINLINE> elements, but no other elements. No math allowed in <METAPHRASE>.

  • JAVASCRIPTINLINE: will render the enclosed string as program syntax. <JAVASCRIPTINLINE> elements must not enclose any other elements. The element may enclose the characters {, }, %, and $, all rendered literally. In addition, the content of <JAVASCRIPTINLINE> must not start with a blank character.

  • SCHEMEINLINE: same as JAVASCRIPTINLINE

  • SPACE adds a non-breaking space.

  • FIXED_SPACE adds a non-breaking space in the same formatting as JAVASCRIPTINLINE.

Index

See INDEX for more information.

Snippet

See SNIPPET for more information.

Figure

See FIGURE for more information.

Section (similar: CHAPTER, SUBSECTION, SUBSUBSECTION)

See SECTION for more information.

Split

See SPLIT for more information

Symbols

These tags are replaced by their corresponding symbols.

Tag Symbol
<APOS> '
<WJ>
<>
<>
<>
<>
<>
<>
<>
<>
<>
<>
<>

APOS: "'", WJ: "", AACUTE_LOWER: "á", AACUTE_UPPER: "Á", AGRAVE_LOWER: "à", AGRAVE_UPPER: "À", ACIRC_LOWER: "â", EACUTE_LOWER: "é", EACUTE_UPPER: "É", EGRAVE_LOWER: "è", EGRAVE_UPPER: "È", ECIRC_LOWER: "ê", OUML_LOWER: "ö", OUML_UPPER: "Ö", UUML_LOWER: "ü", UUML_UPPER: "Ü", CCEDIL_LOWER: "ç", ELLIPSIS: "…", AMP: "\&", DOLLAR: "\$", SECT: "§",

ALLOW_BREAK: "###", // will be replaced in processSnippet depending on rendering target (PDF, HTML, etc.)

EMDASH: "—", ENDASH: "–",

BREAK: "\n",

SPACE: "", FIXED_SPACE: "{\tt}"

Clone this wiki locally