Newer
Older
XML / quick-reference.markdown
  1. # XML authoring framework quick reference
  2.  
  3. ## Conventions
  4.  
  5. * All items and elements are listed in alphabetical order. Attributes are listed in alphabetical order with required attributes first. 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.
  6. * Typical EBNF-style notation applies: `[ ]` indicates optional, `|` indicates alternation, `{ }` indicates repetition, etc.
  7. * **bold** indicates a default value.
  8.  
  9. ## Basic formatting
  10.  
  11. ### Page elements (`basic-page-elements.xml`)
  12.  
  13. | Item | Element(s) | Attributes | Notes
  14. | ---- | ---------- | ---------- | -----
  15. | horizontal rule | `horizontal-rule` | |
  16. | | `hr` | |
  17. | | `hrule` | |
  18. | horizontal skip | `horizontal-skip` | `size=fill|`*`<LaTeX length>`* | HTML: no effect
  19. | | `hskip` | |
  20. | forced line break | `br` | |
  21. | | `line-break` | |
  22. | | `newline` | |
  23. | no page break | `mbox` | |
  24. | | `no-break` | |
  25. | page break | `new-page` | `[caption-text=`*`<string>`*`]` | “**`continues over…`**”
  26. | | `newpage` | `[print-caption=`**`no`**`|yes]` |
  27. | | `page-break` | |
  28. | | `pagebreak` | |
  29. | paragraph | `P` | `[align=center|left|right]` |
  30. | | `p` | `[border=`**`no`**`|yes]` |
  31. | | `para` | `[indent=no|`**`yes`**`]` |
  32. | | `paragraph` | |
  33. | vertical skip | `vertical-skip` | `[size=fill|large|medium|small|`*`<LaTeX length>`*`]` | **inserts a paragraph skip**
  34. | | `vskip` | |
  35.  
  36. ### Text formatting and layout (`basic-text-formatting.xml`)
  37.  
  38. | Item | Element(s) | Attributes | Notes
  39. | ---- | ---------- | ---------- | -----
  40. | bold face | `bold` | |
  41. | center | `center` | |
  42. | | `centering` | |
  43. | | `centre` | |
  44. | | `centring` | |
  45. | emphasis | `em` | |
  46. | | `emph` | |
  47. | foreign word | `foreign` | |
  48. | italics | `italic` | |
  49. | strikethrough | `line-through` | |
  50. | | `linethrough` | |
  51. | | `strike-through` | |
  52. | | `strikethrough` | |
  53. | strong emphasis | `strong` | |
  54. | term | `term` | |
  55. | underline | `u` | |
  56. | | `underline` | |
  57.  
  58. ### Number formatting (`number-formatting.xml`)
  59.  
  60. | Item | Element(s) | Attributes | Notes
  61. | ---- | ---------- | ---------- | -----
  62. | formatted number | `number` | |
  63.  
  64. ### Font size and style (`fonts.xml`)
  65.  
  66. | Item | Element(s) | Attributes | Notes
  67. | ---- | ---------- | ---------- | -----
  68. | monospaced type | `monospace` | |
  69. | | `tt` | |
  70. | | `typewriter` | |
  71. | sans-serif type | `sans` | |
  72. | | `sans-serif` | |
  73. | | `sf` | |
  74. | | `ss` | |
  75. | font family | `font` | `[fontspec-options=`*`<string>`*`]` | XeLaTeX: `fontspec` package options
  76. | | `typeface` | `[html=`*`<name>`*`]` | HTML: CSS font name(s)
  77. | | | `[latex=`*`<name>`*`]` | LaTeX: LaTeX font name
  78. | | | `[xelatex=`*`<name>`*`]` | XeLaTeX: `fontspec` font name
  79. | tiny font size | `tiny` | | HTML: `<smaller>` × 4
  80. | | | | LaTeX: `\tiny`
  81. | script font size | `scriptsize` | | HTML: `<smaller>` × 3
  82. | | | | LaTeX: `\scriptsize`
  83. | footnote font size | `footnotesize` | | HTML: `<smaller>` × 2
  84. | | | | LaTeX: `\footnotesize`
  85. | small font size | `small` | | HTML: `<smaller>`
  86. | | | | LaTeX: `\small`
  87. | large font size | `large` | | HTML: `<larger>`
  88. | | | | LaTeX: `\large`
  89. | Large font size | `Large` | | HTML: `<larger>` × 2
  90. | | | | LaTeX: `\Large`
  91. | LARGE font size | `LARGE` | | HTML: `<larger>` × 3
  92. | | | | LaTeX: `\LARGE`
  93. | huge font size | `huge` | | HTML: `<larger>` × 4
  94. | | | | LaTeX: `\huge`
  95. | Huge font size | `Huge` | | HTML: `<larger>` × 5
  96. | | | | LaTeX: `\Huge`
  97. | superscript | `superscript` | |
  98. | subscript | `subscript` | |
  99.  
  100. ### Inline code and code blocks (`code-formatting.xml`)
  101.  
  102. | Item | Element(s) | Attributes | Notes
  103. | ---- | ---------- | ---------- | -----
  104. | code (block) | `code-block` | `[allow-breaks=no|`**`yes`**`]` | `code-block` requires `<![CDATA[ … ]]>`
  105. | | | `[language=`*`<name>`*`]` | LaTeX: `listings` language name
  106. | code (inline) | `code` | `[language=`*`<name>`*`]` | LaTeX: `listings` language name
  107. | verbatim (block) | `verbatim` | |
  108. | | `verbatim-block` | |
  109. | verbatim (inline) | `inline-verbatim` | |
  110. | | `verb` | |
  111.  
  112. ### Quoted text (`quotations.xml`)
  113.  
  114. | Item | Element(s) | Attributes | Notes
  115. | ---- | ---------- | ---------- | -----
  116. | inline quoted text | `quote` | `[single=`**`no`**`|yes]` |
  117. | | `q` | `[single=`**`no`**`|yes]` |
  118. | | `qq` | | double quotes only
  119. | block quotation | `quotation` | `[align=center|centre|`**`left`**`|right]` |
  120.  
  121. ### Footnotes (`footnotes.xml`)
  122.  
  123. | Item | Element(s) | Attributes | Notes
  124. | ---- | ---------- | ---------- | -----
  125. | footnote | `footnote` | |
  126.  
  127. ### Miscellaneous symbols (`miscellaneous-symbols.xml`)
  128.  
  129. | Item | Element(s) | Attributes | Notes
  130. | ---- | ---------- | ---------- | -----
  131. | # | `hash` | | U+0023 NUMBER SIGN
  132. | | `number-sign` | |
  133. | | `sharp` | |
  134. | $ | `dollar` | | U+0024 DOLLAR SIGN
  135. | | `dollar-sign` | |
  136. | % | `percent` | | U+0025 PERCENT SIGN
  137. | | `percent-sign` | |
  138. | | `percentage-sign` | |
  139. | & | `ampersand` | | U+0026 AMPERSAND
  140. | \ | `backslash` | | U+005C REVERSE SOLIDUS
  141. | _ | `low-line` | | U+005F LOW LINE
  142. | | `underscore` | |
  143. | { | `left-brace` | | U+007B LEFT CURLY BRACKET
  144. | | `left-curly-brace` | |
  145. | | `left-curly-bracket` | |
  146. | } | `right-brace` | | U+007D RIGHT CURLY BRACKET
  147. | | `right-curly-brace` | |
  148. | | `right-curly-bracket` | |
  149. | ° | `degree-sign` | | U+00B0 DEGREE SIGN
  150. | | `degrees` | |
  151. | § | `section-sign` | | U+00A7 SECTION SIGN
  152. | © | `copyright-sign` | | U+00A9 COPYRIGHT SIGN
  153. | | `paragraph-sign` | | U+00B6 PILCROW SIGN
  154. | | `pilcrow` | |
  155. | | `pilcrow-sign` | |
  156. | (number dash) | `figure-dash` | | U+2012 FIGURE DASH
  157. | | `number-dash` | |
  158. | (en dash) | `en-dash` | | U+2013 EN DASH
  159. | | `endash` | |
  160. | | `n-dash` | |
  161. | | `ndash` | |
  162. | (em dash) | `em-dash` | | U+2014 EM DASH
  163. | | `emdash` | |
  164. | | `m-dash` | |
  165. | | `mdash` | |
  166. | | `apostrophe` | | U+2019 RIGHT SINGLE QUOTATION MARK
  167. | | `right-single-quotation-mark` | |
  168. | | `dag` | | U+2020 DAGGER
  169. | | `dagger` | |
  170. | | `ddag` | | U+2021 DOUBLE DAGGER
  171. | | `ddagger` | |
  172. | | `double-dagger` | |
  173. | | `dots` | | U+2026 HORIZONTAL ELLIPSIS
  174. | | `ellipsis` | |
  175. | | `ellipsis-sign` | |
  176. | | `etc` | |
  177. | | `horizontal-ellipsis` | |
  178. | | `tm` | | U+2122 TRADE MARK SIGN
  179. | | `trade-mark-sign` | |
  180. | | `trademark` | |
  181. | | `trademark-sign` | |
  182. | LaTeX logo | `LaTeX` | |
  183. | | `latex` | |
  184.  
  185. ### Special characters (`special-characters.xml`)
  186.  
  187. | Item | Element(s) | Attributes | Notes
  188. | ---- | ---------- | ---------- | -----
  189. | discretionary hyphen | `hyphen` | |
  190. | forced space | `space` | | U+0020 SPACE
  191. | non-breaking space | `nbsp` | |
  192. | | `no-break-space` | |
  193. | | `non-breaking-space` | |
  194. | thin space | `thin-space` | |
  195. | | `thinspace` | |
  196.  
  197. ## Document content
  198.  
  199. ### Root document (`xml2xslt.xsl`)
  200.  
  201. | Item | Element(s) | Attributes | Notes
  202. | ---- | ---------- | ---------- | -----
  203. | document | `document` | `class=calendar|fragment|general|laboratory|tutorial` |
  204. | | | `[auto-latex-build-date=no|`**`yes`**`]` |
  205. | | | `[generate-latex-toc=`**`no`**`|yes]` | doesnt override document class ToC
  206. | | | `[latex-class-options=`*`<string>`*`]` |
  207. | | | `[latex-document-class=`*`<string>`*`]` | **`article`**
  208. | | | `[latex-font-size=`*`<string>`*`]` | **`12pt`**
  209. | | | `[latex-paper-size=`*`<string>`*`]` | **`a4paper`**
  210. | | | `[sequence-number=`*`<integer>`*`]` |
  211. | | | `[suppress-latex-title=`**`no`**`|yes]` |
  212.  
  213. ### Sections (`sectioning.xml`)
  214.  
  215. | Item | Element(s) | Attributes | Notes
  216. | ---- | ---------- | ---------- | -----
  217. | section | `section` | `[label=`*`<string>`*`]` |
  218. | section title | `title` | | within `<section>`
  219.  
  220. ### Document title (`titling.xml`)
  221.  
  222. These all occur at the top level of the enclosing `<document>` element.
  223.  
  224. | Item | Element(s) | Attributes | Notes
  225. | ---- | ---------- | ---------- | -----
  226. | document author | `author` | |
  227. | document date | `date` | |
  228. | assessment due date | `due-date` | | only relevant if `/document/@class = "assignment"`
  229. | document title | `title` | |
  230. | document sub-title | `subtitle` | |
  231.  
  232. ### Lists (`lists.xml`)
  233.  
  234. | Item | Element(s) | Attributes | Notes
  235. | ---- | ---------- | ---------- | -----
  236. | definition | `DD` | |
  237. | | `dd` | |
  238. | | `definition` | |
  239. | | `description` | |
  240. | | `discourse` | |
  241. | definition list | `definition-list` | |
  242. | | `description-list` | |
  243. | | `DL` | |
  244. | | `dl` | |
  245. | keyword | `DT` | `[linebreak=`**`no`**`|yes]` |
  246. | | `dt` | |
  247. | | `keyword` | |
  248. | | `term` | |
  249. | | `topic` | |
  250. | list item | `item` | `[label=`*`<string>`*`]` | `label` for ordered lists only
  251. | | | `[value=`*`<integer>`*`]` | `value` for ordered lists only
  252. | ordered list | `enumerate` | `[start=`*`<integer>`*`]` | **`1`**
  253. | | `enumerated-list` | |
  254. | | `numbered-list` | |
  255. | | `OL` | |
  256. | | `ol` | |
  257. | | `ordered-list` | |
  258. | | `question-list` | |
  259. | unordered list | `bullet-list` | |
  260. | | `bullet-points` | |
  261. | | `bulleted-list` | |
  262. | | `itemised-list` | |
  263. | | `itemize` | |
  264. | | `UL` | |
  265. | | `ul` | |
  266. | | `unordered-list` | |
  267.  
  268. ### Tabular material (`tabular.xml`)
  269.  
  270. | Item | Element(s) | Attributes | Notes
  271. | ---- | ---------- | ---------- | -----
  272. | caption | `caption` | | onyl within long tables
  273. | cell | `cell` | `[align=center|`**`left`**`|right]` |
  274. | | | `[columns=`*`<integer>`*`]` | **`1`**
  275. | | | `[header=`**`no`**`|yes]` |
  276. | | | `[rows=`*`<integer>`*`]` | **`1`** (somewhat broken?)
  277. | column | `column` | `[align=center|centre|`**`left`**`|right]` |
  278. | | | `[left-border="|"]` | i.e., literal `|`
  279. | | | `[right-border="|"]` | i.e., literal `|`
  280. | horizontal rule | `row-rule` | `[columns=`*`<integer>`*`]` | **`1`**
  281. | | | `[weight=double|`*`single`*`]` |
  282. | row | `row` | `[page-break=no|`**`yes`**`]` | LaTeX only
  283. | | | `[valign=bottom|middle|top]` | HTML only
  284. | tabular body | `tabular-body` | |
  285. | tabular footer | `tabular-footer` | |
  286. | tabular header | `tabular-header` | |
  287. | tabular layout | `tabular` | `[align=center|centre|`**`left`**`|right]` |
  288. | | | `[border=`*`<integer>`*`]` | **`0`**; HTML only
  289. | | | `[long-table=`**`no`**`|yes]` | LaTeX only
  290. | | | `[rotate=`*`<integer>`*`]` | LaTeX only
  291. | | | `[scale=`*`<decimal>`*`]` | LaTeX only
  292. | | | `[valign=bottom|`**`center|centre`**`|top]` | LaTeX only
  293.  
  294. ### Images (`images.xml`)
  295.  
  296. | Item | Element(s) | Attributes | Notes
  297. | ---- | ---------- | ---------- | -----
  298. | image | `image` | `basename=`*`<filename>`* | without suffix
  299. | | | `format=`*`<string>`* | e.g., png”, pdf
  300. | | | `location=`*`<path>`* |
  301. | | | `[inline=`**`no`**`|yes]` | image will be scaled to line height
  302. | | | `[latex-options=`*`<string>]`* | pass-through LaTeX options
  303. | zoomable image | `provide-large-version` | | within `<image>`
  304.  
  305. ### Floating elements (`floaters.xml`)
  306.  
  307. | Item | Element(s) | Attributes | Notes
  308. | ---- | ---------- | ---------- | -----
  309. | caption | `caption` | | within `<figure>` or `<table>`
  310. | figure | `figure` | `[border-placement=box|`**`none`**`|{bottom|left|right|top}]` |
  311. | | | `[label=`*`<string>]`* |
  312. | | | `[latex-placement=`*`<string>]`* | LaTeX only; usually `b|h|p|t`
  313. | multipart table | `part` | | within `<table>`
  314. | table | `table` | `[border-placement=box|`**`none`**`|{bottom|left|right|top}]` |
  315. | | | `[label=`*`<string>]`* |
  316. | | | `[latex-placement=`*`<string>]`* |
  317.  
  318. ### Cross references (`cross-references.xml`)
  319.  
  320. | Item | Element(s) | Attributes | Notes
  321. | ---- | ---------- | ---------- | -----
  322. | page label | `page` | `label=`*`<string>`* |
  323. | reference | `reference` | `label=`*`<string>`* |
  324. | | | `[include-pageref=`**`no`**`|yes]` |
  325.  
  326. ### Bibliographies (`bibliography.xml`)
  327.  
  328. | Item | Element(s) | Attributes | Notes
  329. | ---- | ---------- | ---------- | -----
  330. | bibliography | `bibliography` | `[name=`*`<section title>`*`]` | “**`References`**”
  331. | bibliography entry | `item` | `label=`*`<string>`* | within `<bibliography>`
  332. | citation | `cite` | |
  333. | cited item | `item` | `label=`*`<string>`* | within `<cite>`
  334.  
  335. ## Maths
  336.  
  337. ### Equations, etc. (`maths.xml`)
  338.  
  339. | Item | Element(s) | Attributes | Notes
  340. | ---- | ---------- | ---------- | -----
  341. | calligraphic text | `calligraphic` | | LaTeX: `\mathcal`
  342. | | `cursive` | |
  343. | denominator | `denominator` | | within `<fraction>`
  344. | digit group separator | `digit-group-separator` | | **thin space**
  345. | | `digitsep` | |
  346. | equation array | `equation-array` | |
  347. | equation array row | `row` | | within `<equation-array>`
  348. | | `text` | |
  349. | formula | `math` | `[style=display|`**`inline`**`]` |
  350. | fraction | `fraction` | |
  351. | log-like function | `function` | |
  352. | numerator | `numerator` | | within `<fraction>`
  353. | subscript | `subscript` | | within `<math>`
  354. | superscript | `superscript` | | within `<math>`
  355. | variable | `var` | |
  356. | | `variable` | |
  357.  
  358. ### Symbols (`mathematical-symbols.xml`)
  359.  
  360. | Item | Element(s) | Attributes | Notes
  361. | ---- | ---------- | ---------- | -----
  362. | + | `plus` | | U+002B PLUS SIGN
  363. | | `plus-sign` | |
  364. | × | `times` | | U+00D7 MULTIPLICATION SIGN
  365. | | `multiply` | |
  366. | | `multiplication` | |
  367. | | `multiplication-sign` | |
  368. | | `minus` | | U+2212 MINUS SIGN
  369. | | `minus-sign` | |
  370. | | `subtract` | |
  371. | | `divide` | | U+2215 DIVISION SLASH
  372. | | `division` | |
  373. | | `division-slash` | |
  374. | = | `eq` | | U+003D EQUALS SIGN
  375. | | `equality` | |
  376. | | `equals` | |
  377. | | `equals-sign` | |
  378. | | `ne` | | U+2260 NOT EQUAL TO
  379. | | `not-equal-to` | |
  380. | | `not-equals` | |
  381. | | `inequality` | |
  382. | | `almost-equal-to` | | U+2248 ALMOST EQUAL TO
  383. | | `approx` | |
  384. | | `approximately-equal-to` | |
  385. | | `approximately-equals` | |
  386. | > | `greater-than` | | U+003E GREATER-THAN SIGN
  387. | | `greater-than-sign` | |
  388. | | `gt` | |
  389. | | `ge` | | U+2265 GREATER-THAN OR EQUAL TO
  390. | | `greater-equals` | |
  391. | | `greater-than-or-equal-to` | |
  392. | < | `less-than` | | U+003C LESS-THAN SIGN
  393. | | `less-than-sign` | |
  394. | | `lt` | |
  395. | | `le` | | U+2264 LESS-THAN OR EQUAL TO
  396. | | `less-equals` | |
  397. | | `less-than-or-equal-to` | |
  398. | | `empty-set` | | U+2205 EMPTY SET
  399. | | `empty-set-sign` | |
  400. | | `null` | |
  401. | | `element` | | U+2208 ELEMENT OF
  402. | | `element-of` | |
  403. | | `element-sign` | |
  404. | | `is-an-element-of` | |
  405. | | `is-element-of` | |
  406. | | `is-not-an-element-of` | | U+2209 NOT AN ELEMENT OF
  407. | | `is-not-element-of` | |
  408. | | `not-an-element-of` | |
  409. | | `not-element` | |
  410. | | `not-element-of` | |
  411. | | `not-element-sign` | |
  412. | | `cap` | | U+2229 INTERSECTION
  413. | | `intersect` | |
  414. | | `intersect-operator` | |
  415. | | `intersection` | |
  416. | | `cup` | | U+222A UNION
  417. | | `union` | |
  418. | | `union-operator` | |
  419. | | `is-a-subset-of` | | U+2282 SUBSET OF
  420. | | `is-subset-of` | |
  421. | | `strict-subset` | |
  422. | | `subset` | |
  423. | | `subset-of` | |
  424. | | `subset-sign` | |
  425. | | `is-a-superset-of` | | U+2283 SUPERSET OF
  426. | | `is-superset-of` | |
  427. | | `superset` | |
  428. | | `superset-of` | |
  429. | | `superset-sign` | |
  430. | | `inclusive-subset` | | U+2286 SUBSET OF OR EQUAL TO
  431. | | `is-a-subset-of-or-equal-to` | |
  432. | | `is-subset-of-or-equal-to` | |
  433. | | `subset-of-or-equal-to` | |
  434. | | `subset-or-equal` | |
  435. | | `inclusive-superset` | | U+2287 SUPERSET OF OR EQUAL TO
  436. | | `is-a-superset-of-or-equal-to` | |
  437. | | `is-superset-of-or-equal-to` | |
  438. | | `superset-of-or-equal-to` | |
  439. | | `superset-or-equal` | |
  440. | ¬ | `neg` | | U+00AC NOT SIGN
  441. | | `negation` | |
  442. | | `logical-negation` | |
  443. | | `logical-negation-operator` | |
  444. | | `logical-not` | |
  445. | | `logical-not-operator` | |
  446. | | `not` | |
  447. | | `not-sign` | |
  448. | | `and` | | U+2227 LOGICAL AND
  449. | | `and-operator` | |
  450. | | `hat` | |
  451. | | `logical-and` | |
  452. | | `logical-and-operator` | |
  453. | | `wedge` | |
  454. | | `logical-or` | | U+2228 LOGICAL OR
  455. | | `logical-or-operator` | |
  456. | | `or` | |
  457. | | `or-operator` | |
  458. | | `vee` | |
  459. | →, | `implies` | `[weight=double|`**`single`**`]` | U+2192 RIGHTWARDS ARROW
  460. | | `rarr` | | U+21D2 RIGHTWARDS DOUBLE ARROW
  461. | | `rarrow` | |
  462. | | `right-arrow` | |
  463. | | `rightarrow` | |
  464. | | `rightwards-arrow` | |
  465. | ←, | `larr` | `[weight=double|`**`single`**`]` | U+2190 LEFTWARDS ARROW
  466. | | `larrow` | | U+21D0 LEFTWARDS DOUBLE ARROW
  467. | | `left-arrow` | |
  468. | | `leftarrow` | |
  469. | | `leftwards-arrow` | |
  470.  
  471. ### Relational algebra (`relational-algebra.xml`)
  472.  
  473. | Item | Element(s) | Attributes | Notes
  474. | ---- | ---------- | ---------- | -----
  475. | project operator (π) | `project` | | U+03C0 GREEK SMALL LETTER PI
  476. | | `project-operator` | |
  477. | | `relational-project` | |
  478. | extend operator (ε) | `extend` | | U+03B5 GREEK SMALL LETTER EPSILON
  479. | | `extend-operator` | |
  480. | | `relational-extend` | |
  481. | rename operator (ρ) | `relational-rename` | | U+03C1 GREEK SMALL LETTER RHO
  482. | | `rename` | |
  483. | | `rename-operator` | |
  484. | restrict operator (σ) | `restrict` | | U+03C2 GREEK SMALL LETTER SIGMA
  485. | | `restrict-operator` | |
  486. | | `relational-restrict` | |
  487. | join operator (⋈) | `bowtie` | | U+22C8 BOWTIE
  488. | | `inner-join` | | (or U+2A1D JOIN)
  489. | | `join` | |
  490. | | `join-operator` | |
  491. | | `natural-join` | |
  492. | | `relational-join` | |
  493. | outer join operator | `outer-join` | `[type=`**`full`**`|left|right]` | U+27D5 LEFT OUTER JOIN
  494. | | `outer-join-operator` | | U+27D6 RIGHT OUTER JOIN
  495. | | `relational-outer-join` | | U+27D7 FULL OUTER JOIN
  496.  
  497. ### Greek (`greek-characters.xml`)
  498.  
  499. | Item | Element(s) | Attributes | Notes
  500. | ---- | ---------- | ---------- | -----
  501. | α | `alpha` | | U+03B1 GREEK SMALL LETTER ALPHA
  502. | Α | `capital-alpha` | | U+0391 GREEK CAPITAL LETTER ALPHA
  503. | β | `beta` | | U+03B2 GREEK SMALL LETTER BETA
  504. | Β | `capital-beta` | | U+0392 GREEK CAPITAL LETTER BETA
  505. | γ | `gamma` | | U+03B3 GREEK SMALL LETTER GAMMA
  506. | Γ | `capital-gamma` | | U+0393 GREEK CAPITAL LETTER GAMMA
  507. | δ | `delta` | | U+03B4 GREEK SMALL LETTER DELTA
  508. | Δ | `capital-delta` | | U+0394 GREEK CAPITAL LETTER DELTA
  509. | ε | `epsilon` | | U+03B5 GREEK SMALL LETTER EPSILON
  510. | Ε | `capital-epsilon` | | U+0395 GREEK CAPITAL LETTER EPSILON
  511. | ζ | `zeta` | | U+03B6 GREEK SMALL LETTER ZETA
  512. | Ζ | `capital-zeta` | | U+0396 GREEK CAPITAL LETTER ZETA
  513. | η | `eta` | | U+03B7 GREEK SMALL LETTER ETA
  514. | Η | `capital-eta` | | U+0397 GREEK CAPITAL LETTER ETA
  515. | θ | `theta` | | U+03B8 GREEK SMALL LETTER THETA
  516. | Θ | `capital-theta` | | U+0398 GREEK CAPITAL LETTER THETA
  517. | ι | `iota` | | U+03B9 GREEK SMALL LETTER IOTA
  518. | Ι | `capital-iota` | | U+0399 GREEK CAPITAL LETTER IOTA
  519. | κ | `kappa` | | U+03BA GREEK SMALL LETTER KAPPA
  520. | Κ | `capital-kappa` | | U+039A GREEK CAPITAL LETTER KAPPA
  521. | λ | `lambda` | | U+03BB GREEK SMALL LETTER LAMBDA
  522. | Λ | `capital-lambda` | | U+039B GREEK CAPITAL LETTER LAMBDA
  523. | μ | `mu` | | U+03BC GREEK SMALL LETTER MU
  524. | Μ | `capital-mu` | | U+039C GREEK CAPITAL LETTER MU
  525. | ν | `nu` | | U+03BD GREEK SMALL LETTER NU
  526. | Ν | `capital-nu` | | U+039D GREEK CAPITAL LETTER NU
  527. | ξ | `xi` | | U+03BE GREEK SMALL LETTER XI
  528. | Ξ | `capital-xi` | | U+039E GREEK CAPITAL LETTER XI
  529. | ο | `omicron` | | U+03BF GREEK SMALL LETTER OMICRON
  530. | Ο | `capital-omicron` | | U+039F GREEK CAPITAL LETTER OMICRON
  531. | π | `pi` | | U+03C0 GREEK SMALL LETTER PI
  532. | Π | `capital-pi` | | U+03A0 GREEK CAPITAL LETTER PI
  533. | ρ | `rho` | | U+03C1 GREEK SMALL LETTER RHO
  534. | Ρ | `capital-rho` | | U+03A1 GREEK CAPITAL LETTER RHO
  535. | σ | `sigma` | | U+03C2 GREEK SMALL LETTER SIGMA
  536. | Σ | `capital-sigma` | | U+03A3 GREEK CAPITAL LETTER SIGMA
  537. | τ | `tau` | | U+03C4 GREEK SMALL LETTER TAU
  538. | Τ | `capital-tau` | | U+03A4 GREEK CAPITAL LETTER TAU
  539. | υ | `upsilon` | | U+03C5 GREEK SMALL LETTER UPSILON
  540. | Υ | `capital-upsilon` | | U+03A5 GREEK CAPITAL LETTER UPSILON
  541. | φ | `phi` | | U+03C6 GREEK PHI SYMBOL (for consistency with LaTeX)
  542. | Φ | `capital-phi` | | U+03A6 GREEK CAPITAL LETTER PHI
  543. | χ | `chi` | | U+03C7 GREEK SMALL LETTER CHI
  544. | Χ | `capital-chi` | | U+03A7 GREEK CAPITAL LETTER CHI
  545. | ψ | `psi` | | U+03C8 GREEK SMALL LETTER PSI
  546. | Ψ | `capital-psi` | | U+03A8 GREEK CAPITAL LETTER PSI
  547. | ω | `omega` | | U+03C9 GREEK SMALL LETTER OMEGA
  548. | Ω | `capital-omega` | | U+03A9 GREEK CAPITAL LETTER OMEGA
  549.  
  550. ## Teaching related items
  551.  
  552. ### Otago specific elements (`otago-specific.xml`)
  553.  
  554. | Item | Element(s) | Attributes | Notes
  555. | ---- | ---------- | ---------- | -----
  556. | paper code | `paper` | |
  557. | paper number | `paper-number` | | within `<paper>`
  558. | subject code | `subject-code` | | within `<paper>`
  559.  
  560. ### Questions and answers (`q-and-a.xml`)
  561.  
  562. | Item | Element(s) | Attributes | Notes
  563. | ---- | ---------- | ---------- | -----
  564. | answer | `answer` | `[hide=`**`no`**`|yes]` |
  565. | exercise | `exercise` | `label=`*`<string>`* | numbered exercise, in box
  566. | question | `question` | |
  567.  
  568. ### Teaching dates (`paper-calendar-dates.xml`)
  569.  
  570. Note that `paper-calendar-dates.xml` is generated for a particular year by `generate-calendar-dates.php`.
  571.  
  572. | Item | Element(s) | Attributes | Notes
  573. | ---- | ---------- | ---------- | -----
  574. | date | `TeachingPeriodDate` | `period=FY|S1|S2|SS|YY` |
  575. | | | `week=`*`<integer>`* | within period
  576. | | | `[format=day|day-short|day-short+year|day+long-name|` |
  577. | | | `day+short-name|day+year|`**`ISO`**`|`*`<XML date picture>`*`]` |
  578. | | | `[offset=(+|-)`*`<XSLT duration>`*`]` | e.g., P1D”, “-P4D
  579. | date range | `TeachingPeriodDateRange` | `format=long|short` |
  580. | | | `period=FY|S1|S2|SS|YY` |
  581. | | | `week=`*`<integer>`* | within period
  582. | | | `[wrap=no|`**`yes`**`]` |
  583.  
  584. ### Teaching calendar (`paper-calendar.xml`)
  585.  
  586. | Item | Element(s) | Attributes | Notes
  587. | ---- | ---------- | ---------- | -----
  588. | assessment | `assessment` | `[rows=`*`<integer>`*`]` | **`calendar/@lectures-per-week`**
  589. | calendar table | `calendar` | `lectures-per-week=`*`<integer>`* |
  590. | | | `number-of-weeks=`*`<integer>`* |
  591. | | | `[number-laboratories=no|`**`yes`**`]` |
  592. | | | `[number-lectures=no|`**`yes`**`]` |
  593. | | | `[number-tutorials=no|`**`yes`**`]` |
  594. | footer row | `footer` | |
  595. | header row | `header` | |
  596. | note | `note` | `[num-columns=`*`<integer>`*`]` | **all columns**
  597. | laboratory | `laboratory` | `[number=no|yes]` | **`yes`** or **`calendar/@number-laboratories`**
  598. | | | `[rows=`*`<integer>`*`]` | **`calendar/@lectures-per-week`**
  599. | lecture | `lecture` | `[holiday=`**`no`**`|yes]` |
  600. | | | `[number=no|yes]` | **`yes`** or **`calendar/@number-lectures`**
  601. | | | `[rows=`*`<integer>`*`]` | **`1`**
  602. | page break | `latex-calendar-break` | `[caption=no|`**`yes`**`]` |
  603. | | | `[caption-text=`*`<string>`*`]` |
  604. | reading | `reading` | `[rows=`*`<integer>`*`]` | **`calendar/@lectures-per-week`**
  605. | section | `section` | `[rows=`*`<integer>`*`]` | **`calendar/@lectures-per-week`**
  606. | table heading | `heading` | `[num-columns=`*`<integer>`*`]` | **`1`**
  607. | table footing | `footing` | `[num-columns=`*`<integer>`*`]` | **`1`**
  608. | tutorial | `tutorial` | `[number=no|yes]` | **`yes`** or **`calendar/@number-tutorials`**
  609. | week | `week` | `[holiday=`**`no`**`|yes]` |
  610. | | | `[rows=`*`<integer>`*`]` | **`calendar/@lectures-per-week`**
  611.  
  612. ### Oracle documentation links (`oracle-docs.xsl`)
  613.  
  614. Note that `oracle-docs.xsl` is generated by `oracle-docs.perl`.
  615.  
  616. | Item | Element(s) | Attributes | Notes
  617. | ---- | ---------- | ---------- | -----
  618. | documentation root | `OraDocsURL` | |
  619. | Administrators Guide | `OraAdmin` | |
  620. | Advanced Application Developers Guide | `OraAppDevAdv` | |
  621. | Concepts | `OraConcepts` | |
  622. | Data Warehousing Guide | `OraDataWarehousing` | |
  623. | Documentation Library | `OraDocs` | |
  624. | Error Messages | `OraErrors` | |
  625. | Java Developers Guide | `OraJava` | |
  626. | JDBC Developers Guide | `OraJDBC` | |
  627. | JDBC Java API Reference (Javadoc) | `OraJDBCRef` | |
  628. | Performance Tuning Guide | `OraTuning` | |
  629. | Object-Relational Developers Guide | `OraAppDevOR` | |
  630. | PL/SQL Language Reference | `OraPLSQL` | |
  631. | PL/SQL Packages and Types Reference | `OraPLSQLPkgTyp` | |
  632. | Reference | `OraReference` | |
  633. | SQL Language Reference | `OraSQL` | |
  634.  
  635. ## Miscellaneous
  636.  
  637. ### Hyperlinks (`hyperlinks.xml`)
  638.  
  639. | Item | Element(s) | Attributes | Notes
  640. | ---- | ---------- | ---------- | -----
  641. | hyperlink | `hyperlink` | `[url=`*`<url>`*`]` | excluding anchor (i.e., after “#”)
  642. | | | `[label=`*`<string>`*`]` | HTML: anchor; LaTeX: label
  643. | | | `[target=`*`<string>`*`]` | HTML only (e.g., _blank”)
  644. | URL | `e-mail` | |
  645. | | `e-mail-address` | |
  646. | | `email` | |
  647. | | `email-address` | |
  648. | | `uri` | |
  649. | | `url` | |
  650.  
  651. ### Document build date (`build-date.xml`)
  652.  
  653. | Item | Element(s) | Attributes | Notes
  654. | ---- | ---------- | ---------- | -----
  655. | displayed build date | `build-date` | `[format=`*`<XML date picture>`*`]` | **`YYYY-MM-DD hh:mm:ss`**
  656. | | | `[style=footer|`**`inline`**`]` |
  657.  
  658. ### Conditional processing (`conditional-processing.xml`)
  659.  
  660. | Item | Element(s) | Attributes | Notes
  661. | ---- | ---------- | ---------- | -----
  662. | process when format | `process-when` | `format=latex|html` |
  663.  
  664. ### Native code (`native-code.xml`)
  665.  
  666. | Item | Element(s) | Attributes | Notes
  667. | ---- | ---------- | ---------- | -----
  668. | raw code | `raw-code` | `format=html|latex` |
  669. | raw LaTeX | `raw-latex` | |
  670. | raw HTML | `raw-html` | |
  671.  
  672. ### LaTeX specific (`latex.xml`)
  673.  
  674. | Item | Element(s) | Attributes | Notes
  675. | ---- | ---------- | ---------- | -----
  676. | document class | `latex-documentclass` | `[options=`*`<options>`*`]` |
  677. | | `documentclass` | |
  678. | document options | `latex-document-options` | |
  679. | LaTeX environment | `environment` | |
  680. | LaTeX packages | `latex-packages` | |
  681. | | `package` | `[options=`*`<options>`*`]` | within `<latex-packages>`
  682. | preamble commands | `latex-commands` | |
  683. | | `command` | | within `<latex-commands>`
  684. | | `hyphenation` | | within `<latex-commands>`
  685.  
  686. ### Global elements (`global-elements.xml`)
  687.  
  688. These essentially define global variables within the document.
  689.  
  690. | Item | Element(s) | Attributes | Notes
  691. | ---- | ---------- | ---------- | -----
  692. | assessment due date | `DueDate` | `[style={bold|italic|underline}]` | requires top-level `<due-date>`
  693. | | | | only relevant if `/document/@class = "assignment"`
  694. | Blackboard URL | `Blackboard` | | **`https://blackboard.otago.ac.nz/`**
  695. | full paper code | `PaperCode` | | e.g., INFO 202
  696. | Oracle name | `OracleServer` | | e.g., Oracle11*g*”
  697. | Oracle release number | `OracleServerRelease` | | e.g., 2
  698. | Oracle version number | `OracleServerVersion` | | e.g., 11.2
  699. | paper number | `PaperNumber` | | e.g., 202
  700. | period paper offered | `PaperPeriod` | | e.g., Second Semester
  701. | subject code | `SubjectCode` | | “**`INFO`**”
  702. | year paper offered | `PaperYear` | `[offset=`*`<integer>`*`]` | **`0`**
  703.  
  704. ### File inclusions (`inclusions.xml`)
  705.  
  706. | Item | Element(s) | Attributes | Notes
  707. | ---- | ---------- | ---------- | -----
  708. | include document | `include-document` | `basename=`*`<filename>`* | including suffix
  709. | | | `type=html|latex|plain|xml` | HTML: **`html`**
  710. | | | | LaTeX: **`latex`**
  711. | | | | `xml` currently unsupported
  712. | | | `[path=`*`<path>`*`]` | without trailiing /
  713.  
  714. ### Meta-elements (`meta-elements.xml`)
  715.  
  716. | Item | Element(s) | Attributes | Notes
  717. | ---- | ---------- | ---------- | -----
  718. | ignore markup | `omit` | |
  719. | to-do item | `check` | |
  720. | | `incomplete` | |
  721. | | `to-do` | |
  722. | | `todo` | |
  723. | XML comment | `comment` | |
  724.  
  725. ### Emoticons (`emoticons.xml`)
  726.  
  727. | Item | Element(s) | Attributes | Notes
  728. | ---- | ---------- | ---------- | -----
  729. | emoticon | `emoticon` | `[type=`**`happy`**`|meh|neutral|sad]` | happy = U+263A WHITE SMILING FACE
  730. | | `smiley` | | sad = U+2639 WHITE FROWNING FACE
  731.  
  732. ### Path-like elements (`path-like-elements.xml`)
  733.  
  734. | Item | Element(s) | Attributes | Notes
  735. | ---- | ---------- | ---------- | -----
  736. | file system path | `directory` | |
  737. | keystroke | `keys` | |
  738. | menu | `menu` | |
  739. | path item | `item` | | within `<directory>`, `<keys>`, or `<menu>`
  740. | alt graphics key | `alt-graphics-key` | |
  741. | alt key | `alt-key` | |
  742. | backspace key | `backspace-key` | |
  743. | caps lock key | `capslock-key` | |
  744. | command key (⌘) | `command-key` | |
  745. | control key | `control-key` | |
  746. | delete key | `delete-key` | |
  747. | down arrow key | `down-arrow-key` | |
  748. | enter key | `enter-key` | |
  749. | escape key | `escape-key` | |
  750. | left arrow key | `left-arrow-key` | |
  751. | return key | `return-key` | |
  752. | right arrow key | `right-arrow-key` | |
  753. | shift key | `shift-key` | |
  754. | space key | `space-key` | |
  755. | tab key | `tab-key` | |
  756. | up arrow key | `up-arrow-key` | |
  757. | windows key | `windows-key` | |
  758.  
  759. ### Multi-column layouts (`multi-column.xml`)
  760.  
  761. | Item | Element(s) | Attributes | Notes
  762. | ---- | ---------- | ---------- | -----
  763. | multi-column layout | `multi-column` | `[align=center|`**`left`**`|right]` |
  764. | | | `[vspace=big|medium|small|`*`<LaTeX length>`*`|`**_`<none>`_**`]` |
  765. | | | `[width=`*`<decimal>`*`]` | between `0` and **`1`**
  766. | column | `column` | `[align=center|`**`left`**`|right]` |
  767. | | | `[width=`*`<decimal>`*`]` | between `0` and `1`