GitBucket
4.21.2
XML authoring framework quick reference
Conventions
- All items, elements, and attributes are listed in alphabetical order. When there are multiple elements for the same item, there is no preference for any particular element over another, as long as the resulting markup is well-formed.
- Typical EBNF-style notation applies:
[ ]indicates optional,|indicates alternation,{ }indicates repetition, etc. - bold indicates a default value.
Basic formatting
Page elements (basic-page-elements.xml)
| Item | Element(s) | Attributes | Notes | ||||
|---|---|---|---|---|---|---|---|
| horizontal rule | horizontal-rule |
||||||
hr |
|||||||
hrule |
|||||||
| horizontal skip | horizontal-skip |
`size=fill | *`* |
HTML: no effect | |||
hskip |
|||||||
| forced line break | br |
||||||
line-break |
|||||||
newline |
|||||||
| no page break | mbox |
||||||
no-break |
|||||||
| page break | new-page |
[caption-text=<string>] |
“continues over…” |
||||
newpage |
[print-caption=no` |
yes]` | |||||
page-break |
|||||||
pagebreak |
|||||||
| paragraph | P |
`[align=center | left | right]` | |||
p |
[border=no` |
yes]` | |||||
para |
`[indent=no | **yes**]` |
|||||
paragraph |
|||||||
| vertical skip | vertical-skip |
`[size=fill | large | medium | small | **]` |
inserts a paragraph skip |
vskip |
Text formatting and layout (basic-text-formatting.xml)
| Item | Element(s) | Attributes | Notes |
|---|---|---|---|
| bold face | bold |
||
| center | center |
||
centering |
|||
centre |
|||
centring |
|||
| emphasis | em |
||
emph |
|||
| foreign word | foreign |
||
| italics | italic |
||
| strikethrough | line-through |
||
linethrough |
|||
strike-through |
|||
strikethrough |
|||
| strong emphasis | strong |
||
| term | term |
||
| underline | u |
||
underline |
Font size and style (fonts.xml)
| Item | Element(s) | Attributes | Notes |
|---|---|---|---|
| monospaced type | monospace |
||
tt |
|||
typewriter |
|||
| sans-serif type | sans |
||
sans-serif |
|||
sf |
|||
ss |
|||
| font family | font |
[fontspec-options=<string>] |
XeLaTeX: fontspec package options |
typeface |
[html=<name>] |
HTML: CSS font name(s) | |
[latex=<name>] |
LaTeX: LaTeX font name | ||
[xelatex=<name>] |
XeLaTeX: fontspec font name |
||
| “tiny” font size | tiny |
HTML: <smaller> × 4 |
|
LaTeX: \tiny |
|||
| “script” font size | scriptsize |
HTML: <smaller> × 3 |
|
LaTeX: \scriptsize |
|||
| “footnote” font size | footnotesize |
HTML: <smaller> × 2 |
|
LaTeX: \footnotesize |
|||
| “small” font size | small |
HTML: <smaller> |
|
LaTeX: \small |
|||
| “large” font size | large |
HTML: <larger> |
|
LaTeX: \large |
|||
| “Large” font size | Large |
HTML: <larger> × 2 |
|
LaTeX: \Large |
|||
| “LARGE” font size | LARGE |
HTML: <larger> × 3 |
|
LaTeX: \LARGE |
|||
| “huge” font size | huge |
HTML: <larger> × 4 |
|
LaTeX: \huge |
|||
| “Huge” font size | Huge |
HTML: <larger> × 5 |
|
LaTeX: \Huge |
|||
| superscript | superscript |
||
| subscript | subscript |
Inline code and code blocks (code-formatting.xml)
| Item | Element(s) | Attributes | Notes | |
|---|---|---|---|---|
| code (block) | code-block |
`[allow-breaks=no | **yes**]` |
code-block requires <![CDATA[ … ]]> |
[language=<name>] |
LaTeX: listings language name |
|||
| code (inline) | code |
[language=<name>] |
LaTeX: listings language name |
|
| verbatim (block) | verbatim |
|||
verbatim-block |
||||
| verbatim (inline) | inline-verbatim |
|||
verb |
Bibliographies (bibliography.xml)
| Item | Element(s) | Attributes | Notes |
|---|---|---|---|
| bibliography | bibliography |
[name=<section title>] |
“References” |
| bibliography entry | item |
label=<string> |
within <bibliography> |
| citation | cite |
||
| cited item | item |
label=<string> |
within <cite> |
Maths
Equations, etc. (maths.xml)
| Item | Element(s) | Attributes | Notes |
|---|---|---|---|
| calligraphic text | calligraphic |
LaTeX: \mathcal |
|
cursive |
|||
| denominator | denominator |
within <fraction> |
|
| digit group separator | digit-group-separator |
thin space | |
digitsep |
|||
| equation array | equation-array |
||
| equation array row | row |
within <equation-array> |
|
text |
|||
| formula | math |
`[style=display | **inline**]` |
| fraction | fraction |
||
| log-like function | function |
||
| numerator | numerator |
within <fraction> |
|
| subscript | subscript |
within <math> |
|
| superscript | superscript |
within <math> |
|
| variable | var |
||
variable |
Symbols (mathematical-symbols.xml)
| Item | Element(s) | Attributes | Notes | |
|---|---|---|---|---|
| + | plus |
U+002B PLUS SIGN | ||
plus-sign |
||||
| × | times |
U+00D7 MULTIPLICATION SIGN | ||
multiply |
||||
multiplication |
||||
multiplication-sign |
||||
| − | minus |
U+2212 MINUS SIGN | ||
minus-sign |
||||
subtract |
||||
| ∕ | divide |
U+2215 DIVISION SLASH | ||
division |
||||
division-slash |
||||
| = | eq |
U+003D EQUALS SIGN | ||
equality |
||||
equals |
||||
equals-sign |
||||
| ≠ | ne |
U+2260 NOT EQUAL TO | ||
not-equal-to |
||||
not-equals |
||||
inequality |
||||
| ≈ | almost-equal-to |
U+2248 ALMOST EQUAL TO | ||
approx |
||||
approximately-equal-to |
||||
approximately-equals |
||||
| > | greater-than |
U+003E GREATER-THAN SIGN | ||
greater-than-sign |
||||
gt |
||||
| ≥ | ge |
U+2265 GREATER-THAN OR EQUAL TO | ||
greater-equals |
||||
greater-than-or-equal-to |
||||
| < | less-than |
U+003C LESS-THAN SIGN | ||
less-than-sign |
||||
lt |
||||
| ≤ | le |
U+2264 LESS-THAN OR EQUAL TO | ||
less-equals |
||||
less-than-or-equal-to |
||||
| ∅ | empty-set |
U+2205 EMPTY SET | ||
empty-set-sign |
||||
null |
||||
| ∈ | element |
U+2208 ELEMENT OF | ||
element-of |
||||
element-sign |
||||
is-an-element-of |
||||
is-element-of |
||||
| ∉ | is-not-an-element-of |
U+2209 NOT AN ELEMENT OF | ||
is-not-element-of |
||||
not-an-element-of |
||||
not-element |
||||
not-element-of |
||||
not-element-sign |
||||
| ∩ | cap |
U+2229 INTERSECTION | ||
intersect |
||||
intersect-operator |
||||
intersection |
||||
| ∪ | cup |
U+222A UNION | ||
union |
||||
union-operator |
||||
| ⊂ | is-a-subset-of |
U+2282 SUBSET OF | ||
is-subset-of |
||||
strict-subset |
||||
subset |
||||
subset-of |
||||
subset-sign |
||||
| ⊃ | is-a-superset-of |
U+2283 SUPERSET OF | ||
is-superset-of |
||||
superset |
||||
superset-of |
||||
superset-sign |
||||
| ⊆ | inclusive-subset |
U+2286 SUBSET OF OR EQUAL TO | ||
is-a-subset-of-or-equal-to |
||||
is-subset-of-or-equal-to |
||||
subset-of-or-equal-to |
||||
subset-or-equal |
||||
| ⊇ | inclusive-superset |
U+2287 SUPERSET OF OR EQUAL TO | ||
is-a-superset-of-or-equal-to |
||||
is-superset-of-or-equal-to |
||||
superset-of-or-equal-to |
||||
superset-or-equal |
||||
| ¬ | neg |
U+00AC NOT SIGN | ||
negation |
||||
logical-negation |
||||
logical-negation-operator |
||||
logical-not |
||||
logical-not-operator |
||||
not |
||||
not-sign |
||||
| ∧ | and |
U+2227 LOGICAL AND | ||
and-operator |
||||
hat |
||||
logical-and |
||||
logical-and-operator |
||||
wedge |
||||
| ∨ | logical-or |
U+2228 LOGICAL OR | ||
logical-or-operator |
||||
or |
||||
or-operator |
||||
vee |
||||
| →, ⇒ | implies |
`[weight=double | **single**]` |
U+2192 RIGHTWARDS ARROW |
rarr |
U+21D2 RIGHTWARDS DOUBLE ARROW | |||
rarrow |
||||
right-arrow |
||||
rightarrow |
||||
rightwards-arrow |
||||
| ←, ⇐ | larr |
`[weight=double | **single**]` |
U+2190 LEFTWARDS ARROW |
larrow |
U+21D0 LEFTWARDS DOUBLE ARROW | |||
left-arrow |
||||
leftarrow |
||||
leftwards-arrow |
Greek (greek-characters.xml)
| Item | Element(s) | Attributes | Notes |
|---|---|---|---|
| α | alpha |
U+03B1 GREEK SMALL LETTER ALPHA | |
| Α | capital-alpha |
U+0391 GREEK CAPITAL LETTER ALPHA | |
| β | beta |
U+03B2 GREEK SMALL LETTER BETA | |
| Β | capital-beta |
U+0392 GREEK CAPITAL LETTER BETA | |
| γ | gamma |
U+03B3 GREEK SMALL LETTER GAMMA | |
| Γ | capital-gamma |
U+0393 GREEK CAPITAL LETTER GAMMA | |
| δ | delta |
U+03B4 GREEK SMALL LETTER DELTA | |
| Δ | capital-delta |
U+0394 GREEK CAPITAL LETTER DELTA | |
| ε | epsilon |
U+03B5 GREEK SMALL LETTER EPSILON | |
| Ε | capital-epsilon |
U+0395 GREEK CAPITAL LETTER EPSILON | |
| ζ | zeta |
U+03B6 GREEK SMALL LETTER ZETA | |
| Ζ | capital-zeta |
U+0396 GREEK CAPITAL LETTER ZETA | |
| η | eta |
U+03B7 GREEK SMALL LETTER ETA | |
| Η | capital-eta |
U+0397 GREEK CAPITAL LETTER ETA | |
| θ | theta |
U+03B8 GREEK SMALL LETTER THETA | |
| Θ | capital-theta |
U+0398 GREEK CAPITAL LETTER THETA | |
| ι | iota |
U+03B9 GREEK SMALL LETTER IOTA | |
| Ι | capital-iota |
U+0399 GREEK CAPITAL LETTER IOTA | |
| κ | kappa |
U+03BA GREEK SMALL LETTER KAPPA | |
| Κ | capital-kappa |
U+039A GREEK CAPITAL LETTER KAPPA | |
| λ | lambda |
U+03BB GREEK SMALL LETTER LAMBDA | |
| Λ | capital-lambda |
U+039B GREEK CAPITAL LETTER LAMBDA | |
| μ | mu |
U+03BC GREEK SMALL LETTER MU | |
| Μ | capital-mu |
U+039C GREEK CAPITAL LETTER MU | |
| ν | nu |
U+03BD GREEK SMALL LETTER NU | |
| Ν | capital-nu |
U+039D GREEK CAPITAL LETTER NU | |
| ξ | xi |
U+03BE GREEK SMALL LETTER XI | |
| Ξ | capital-xi |
U+039E GREEK CAPITAL LETTER XI | |
| ο | omicron |
U+03BF GREEK SMALL LETTER OMICRON | |
| Ο | capital-omicron |
U+039F GREEK CAPITAL LETTER OMICRON | |
| π | pi |
U+03C0 GREEK SMALL LETTER PI | |
| Π | capital-pi |
U+03A0 GREEK CAPITAL LETTER PI | |
| ρ | rho |
U+03C1 GREEK SMALL LETTER RHO | |
| Ρ | capital-rho |
U+03A1 GREEK CAPITAL LETTER RHO | |
| σ | sigma |
U+03C2 GREEK SMALL LETTER SIGMA | |
| Σ | capital-sigma |
U+03A3 GREEK CAPITAL LETTER SIGMA | |
| τ | tau |
U+03C4 GREEK SMALL LETTER TAU | |
| Τ | capital-tau |
U+03A4 GREEK CAPITAL LETTER TAU | |
| υ | upsilon |
U+03C5 GREEK SMALL LETTER UPSILON | |
| Υ | capital-upsilon |
U+03A5 GREEK CAPITAL LETTER UPSILON | |
| φ | phi |
U+03C6 GREEK PHI SYMBOL (for consistency with LaTeX) | |
| Φ | capital-phi |
U+03A6 GREEK CAPITAL LETTER PHI | |
| χ | chi |
U+03C7 GREEK SMALL LETTER CHI | |
| Χ | capital-chi |
U+03A7 GREEK CAPITAL LETTER CHI | |
| ψ | psi |
U+03C8 GREEK SMALL LETTER PSI | |
| Ψ | capital-psi |
U+03A8 GREEK CAPITAL LETTER PSI | |
| ω | omega |
U+03C9 GREEK SMALL LETTER OMEGA | |
| Ω | capital-omega |
U+03A9 GREEK CAPITAL LETTER OMEGA |
Miscellaneous
Document build date (build-date.xml)
| Item | Element(s) | Attributes | Notes |
|---|---|---|---|
| displayed build date | build-date |
[format=<XML date picture>] |
YYYY-MM-DD hh:mm:ss |
| `[style=footer | **inline**]` |
Conditional processing (conditional-processing.xml)
| Item | Element(s) | Attributes | Notes |
|---|---|---|---|
| process when format | process-when |
`format=latex | html` |
Global elements (global-elements.xml)
| Item | Element(s) | Attributes | Notes | ||
|---|---|---|---|---|---|
| assessment due date | DueDate |
`[style={bold | italic | underline}]` | requires top-level <due-date> |
only relevant if /document/@class = "assignment" |
|||||
| Blackboard URL | Blackboard |
https://blackboard.otago.ac.nz/ |
|||
| full paper code | PaperCode |
e.g., “INFO 202” | |||
| Oracle “name” | OracleServer |
e.g., “Oracle11g” | |||
| Oracle release number | OracleServerRelease |
e.g., “2” | |||
| Oracle version number | OracleServerVersion |
e.g., “11.2” | |||
| paper number | PaperNumber |
e.g., “202” | |||
| period paper offered | PaperPeriod |
e.g., “Second Semester” | |||
| subject code | SubjectCode |
“INFO” |
|||
| year paper offered | PaperYear |
[offset=<integer>] |
0 |
modules/cross-references.xml: modules/cross-references.xml: modules/cross-references.xml: modules/cross-references.xml: modules/cross-references.xml: modules/cross-references.xml: modules/cross-references.xml: modules/cross-references.xml: modules/cross-references.xml: modules/cross-references.xml: modules/emoticons.xml: modules/floaters.xml: modules/floaters.xml: modules/floaters.xml: modules/floaters.xml: modules/floaters.xml: modules/footnotes.xml: modules/footnotes.xml: modules/hyperlinks.xml: modules/hyperlinks.xml: modules/hyperlinks.xml: modules/hyperlinks.xml: modules/hyperlinks.xml: modules/hyperlinks.xml: modules/hyperlinks.xml: modules/hyperlinks.xml: modules/images.xml: modules/images.xml: modules/images.xml: modules/inclusions.xml: modules/inclusions.xml: modules/latex.xml: modules/latex.xml: modules/latex.xml: modules/latex.xml: modules/latex.xml: modules/latex.xml: modules/latex.xml: modules/lists.xml: modules/lists.xml: modules/lists.xml: modules/lists.xml: modules/lists.xml: modules/lists.xml: modules/lists.xml: modules/lists.xml: modules/lists.xml: modules/menus.xml: modules/menus.xml: modules/meta-elements.xml: modules/meta-elements.xml: modules/meta-elements.xml: modules/miscellaneous-symbols.xml: modules/miscellaneous-symbols.xml: modules/miscellaneous-symbols.xml: modules/miscellaneous-symbols.xml: modules/miscellaneous-symbols.xml: modules/miscellaneous-symbols.xml: modules/miscellaneous-symbols.xml: modules/miscellaneous-symbols.xml: modules/miscellaneous-symbols.xml: modules/miscellaneous-symbols.xml: modules/miscellaneous-symbols.xml: modules/miscellaneous-symbols.xml: modules/miscellaneous-symbols.xml:
modules/miscellaneous-symbols.xml:
modules/miscellaneous-symbols.xml: modules/miscellaneous-symbols.xml: modules/miscellaneous-symbols.xml: modules/miscellaneous-symbols.xml: modules/miscellaneous-symbols.xml: modules/miscellaneous-symbols.xml: modules/miscellaneous-symbols.xml: modules/multi-column.xml: modules/multi-column.xml: modules/native-code.xml: modules/native-code.xml: modules/number-formatting.xml: modules/obsolete.xml: modules/obsolete.xml: modules/obsolete.xml: modules/obsolete.xml: modules/obsolete.xml: modules/obsolete.xml: modules/otago-specific.xml: modules/otago-specific.xml: modules/otago-specific.xml: modules/paper-calendar-dates.xml: modules/paper-calendar-dates.xml: modules/paper-calendar-dates.xml: modules/paper-calendar-dates.xml: modules/paper-calendar.xml: modules/paper-calendar.xml: modules/paper-calendar.xml: modules/paper-calendar.xml: modules/paper-calendar.xml: modules/paper-calendar.xml: modules/paper-calendar.xml: modules/paper-calendar.xml: modules/paper-calendar.xml: modules/paper-calendar.xml: modules/paper-calendar.xml: modules/paper-calendar.xml: modules/paper-calendar.xml: modules/paper-calendar.xml: modules/paper-calendar.xml: modules/paper-calendar.xml: modules/paper-calendar.xml: modules/paper-calendar.xml: modules/paper-calendar.xml: modules/q-and-a.xml: modules/q-and-a.xml: modules/q-and-a.xml: modules/q-and-a.xml: modules/quotations.xml: modules/quotations.xml: modules/quotations.xml: modules/quotations.xml: modules/quotations.xml: modules/relational-algebra.xml: modules/relational-algebra.xml: modules/relational-algebra.xml: modules/relational-algebra.xml: modules/relational-algebra.xml: modules/relational-algebra.xml: modules/sectioning.xml: modules/sectioning.xml: modules/sectioning.xml: modules/special-characters.xml: modules/special-characters.xml: modules/special-characters.xml: modules/special-characters.xml: modules/tabular.xml: modules/tabular.xml: modules/tabular.xml: modules/tabular.xml: modules/tabular.xml: modules/tabular.xml: modules/tabular.xml: modules/tabular.xml: modules/tabular.xml: modules/tabular.xml: modules/tabular.xml: modules/tabular.xml: modules/tabular.xml: modules/titling.xml: modules/titling.xml: modules/titling.xml: modules/titling.xml: modules/titling.xml: modules/titling.xml: modules/titling.xml: modules/titling.xml: modules/titling.xml: modules/titling.xml: modules/titling.xml: modules/titling.xml: modules/titling.xml: modules/titling.xml: modules/titling.xml: