diff --git a/quick-reference.markdown b/quick-reference.markdown index c60d07b..976c683 100644 --- a/quick-reference.markdown +++ b/quick-reference.markdown @@ -1,76 +1,132 @@ # 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) | -| ---- | ---------- | -| horizontal rule | ``, ``, ` | -| horizontal skip | ``, `` | -| newline (markup) | `` | -| newline (output) | ``, ``, `
` | -| no page break | ``, `` | -| page break | ``, ``, ``, `` | -| paragraph | ``, ``, `

`, `

` | -| vertical skip | ``, `` | +| Item | Element(s) | Attributes | Notes +| ---- | ---------- | ---------- | ----- +| horizontal rule | `horizontal-rule` | | +| | `hr` | | +| | `hrule` | | +| horizontal skip | `horizontal-skip` | `size=fill|`*``* | no effect in HTML +| | `hskip` | | +| forced line break | `br` | | +| | `line-break` | | +| | `newline` | | +| no page break | `mbox` | | +| | `no-break` | | +| page break | `new-page` | `[caption-text=`*``*`]` | “**`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) | -| ---- | ---------- | -| bold face | `` | -| center | `

`, ``, ``, `` | -| emphasis | ``, `` | -| foreign word | `` | -| italics | `` | -| strikethrough | ``, ``, ``, `` | -| strong emphasis | `` | -| term | `` | -| underline | ``, `` | +| 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) | -| ---- | ---------- | -| monospaced type | ``, ``, `` | -| sans-serif type | ``, ``, ``, `` | -| font family | ``, `` | -| “tiny” font size | `` (= `` × 4, `\tiny`) | -| “script” font size | `` (= `` × 3, `\scriptsize`) | -| “footnote” font size | `` (= `` × 2, `\footnotesize`) | -| “small” font size | `` (= ``, `\small`) | -| “large” font size | `` (= ``, `\large`) | -| “Large” font size | `` (= `` × 2, `\Large`) | -| “LARGE” font size | `` (= `` × 3, `\LARGE`) | -| “huge” font size | `` (= `` × 4, `\huge`) | -| “Huge” font size | `` (= `` × 5, `\Huge`) | -| superscript | `` | -| subscript | `` | +| Item | Element(s) | Attributes | Notes +| ---- | ---------- | ---------- | ----- +| monospaced type | `monospace` | | +| | `tt` | | +| | `typewriter` | | +| sans-serif type | `sans` | | +| | `sans-serif` | | +| | `sf` | | +| | `ss` | | +| font family | `font` | `[fontspec-options=`*``*`]` | XeLaTeX: `fontspec` package options +| | `typeface` | `[html=`*``*`]` | HTML: CSS font name(s) +| | | `[latex=`*``*`]` | LaTeX: LaTeX font name +| | | `[xelatex=`*``*`]` | XeLaTeX: `fontspec` font name +| “tiny” font size | `tiny` | | HTML: `` × 4 +| | | | LaTeX: `\tiny` +| “script” font size | `scriptsize` | | HTML: `` × 3 +| | | | LaTeX: `\scriptsize` +| “footnote” font size | `footnotesize` | | HTML: `` × 2 +| | | | LaTeX: `\footnotesize` +| “small” font size | `small` | | HTML: `` +| | | | LaTeX: `\small` +| “large” font size | `large` | | HTML: `` +| | | | LaTeX: `\large` +| “Large” font size | `Large` | | HTML: `` × 2 +| | | | LaTeX: `\Large` +| “LARGE” font size | `LARGE` | | HTML: `` × 3 +| | | | LaTeX: `\LARGE` +| “huge” font size | `huge` | | HTML: `` × 4 +| | | | LaTeX: `\huge` +| “Huge” font size | `Huge` | | HTML: `` × 5 +| | | | LaTeX: `\Huge` +| superscript | `superscript` | | +| subscript | `subscript` | | ### Inline code and code blocks (`code-formatting.xml`) -| Item | Element(s) | -| ---- | ---------- | -| code (block) | `` (also requires ``) | -| code (inline) | `` | -| verbatim (block) | ``, `` | -| verbatim (inline) | ``, `` | +| Item | Element(s) | Attributes | Notes +| ---- | ---------- | ---------- | ----- +| code (block) | `code-block` | `[allow-breaks=no|`**`yes`**`]` | `code-block` requires `` +| | | `[language=`*``*`]` | LaTeX: `listings` language name +| code (inline) | `code` | `[language=`*``*`]` | LaTeX: `listings` language name +| verbatim (block) | `verbatim` | | +| | `verbatim-block` | | +| verbatim (inline) | `inline-verbatim` | | +| | `verb` | | ## Bibliographies (`bibliography.xml`) -| Item | Element(s) | -| ---- | ---------- | -| bibliography | `` | -| bibliography entry | `` (inside ``) | -| citation | `` | -| cited item | `` (inside ``) | +| Item | Element(s) | Attributes | Notes +| ---- | ---------- | ---------- | ----- +| bibliography | `bibliography` | `[name=`*`
`*`]` | “**`References`**” +| bibliography entry | `item` | `label=`*``* | within `` +| citation | `cite` | | +| cited item | `item` | `label=`*``* | within `` -modules/build-date.xml: