nigel.stanger / XML
Browse code
Completely rewrote format
• Added details of attributes, defaults, and other notes.
• Added build date elements.
• Added conditional processing elements.
master
1 parent 15e4731 commit d62e0de812969c4dc60aa0ae0ea65bf5c057aac0
Nigel Stanger authored on 2 Mar 2019
Patch
Showing 1 changed file
View
216
■■■■■
 quick-reference.markdown
# 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-rule>`, `<hrule>`, `<hr`> |
| horizontal skip | `<horizontal-skip>`, `<hskip>` |
| newline (markup) | `<newline-internal>` |
| newline (output) | `<newline>`, `<line-break>`, `<br>` |
| no page break | `<no-break>`, `<mbox>` |
| page break | `<page-break>`, `<new-page>`, `<newpage>`, `<pagebreak>` |
| paragraph | `<paragraph>`, `<para>`, `<p>`, `<P>` |
| vertical skip | `<vertical-skip>`, `<vskip>` |
| Item | Element(s) | Attributes | Notes
| ---- | ---------- | ---------- | -----
| horizontal rule | `horizontal-rule` | |
| | `hr` | |
| | `hrule` | |
| horizontal skip | `horizontal-skip` | `size=fill|`*`<LaTeX length>`* | no effect in HTML
| | `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|`*`<LaTeX length>`*`]` | **inserts a paragraph skip**
| | `vskip` | |
 
### Text formatting and layout (`basic-text-formatting.xml`)
 
| Item | Element(s) |
| ---- | ---------- |
| bold face | `<bold>` |
| center | `<center>`, `<centering>`, `<centre>`, `<centring>` |
| emphasis | `<emph>`, `<em>` |
| foreign word | `<foreign>` |
| italics | `<italic>` |
| strikethrough | `<strike-through>`, `<line-through>`, `<strikethrough>`, `<linethrough>` |
| strong emphasis | `<strong>` |
| term | `<term>` |
| underline | `<underline>`, `<u>` |
| 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 | `<typewriter>`, `<monospace>`, `<tt>` |
| sans-serif type | `<sans-serif>`, `<sans>`, `<ss>`, `<sf>` |
| font family | `<font>`, `<typeface>` |
| “tiny” font size | `<tiny>` (= `<smaller>` × 4, `\tiny`) |
| “script” font size | `<scriptsize>` (= `<smaller>` × 3, `\scriptsize`) |
| “footnote” font size | `<footnotesize>` (= `<smaller>` × 2, `\footnotesize`) |
| “small” font size | `<small>` (= `<smaller>`, `\small`) |
| “large” font size | `<large>` (= `<larger>`, `\large`) |
| “Large” font size | `<Large>` (= `<larger>` × 2, `\Large`) |
| “LARGE” font size | `<LARGE>` (= `<larger>` × 3, `\LARGE`) |
| “huge” font size | `<huge>` (= `<larger>` × 4, `\huge`) |
| “Huge” font size | `<Huge>` (= `<larger>` × 5, `\Huge`) |
| superscript | `<superscript>` |
| subscript | `<subscript>` |
| 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) |
| ---- | ---------- |
| code (block) | `<code-block>` (also requires `<![CDATA[]]>`) |
| code (inline) | `<code>` |
| verbatim (block) | `<verbatim>`, `<verbatim-block>` |
| verbatim (inline) | `<inline-verbatim>`, `<verb>` |
| 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) |
| ---- | ---------- |
| bibliography | `<bibliography>` |
| bibliography entry | `<item>` (inside `<bibliography>`) |
| citation | `<cite>` |
| cited item | `<item>` (inside `<cite>`) |
 
modules/build-date.xml: <template name="build-date-internal">
modules/build-date.xml: <template name="build-date" match="build-date">
modules/conditional-processing.xml: <template name="process-when-latex" match="process-when[ contains( @format, 'latex' ) ]">
modules/conditional-processing.xml: <template name="process-when-html" match="process-when[ contains( @format, 'html' ) ]">
modules/conditional-processing.xml: <template name="process-when-error" match="process-when[ not( @format ) ]">
| 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>`
 
## 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` |
 
modules/cross-references.xml: <template name="reference" match="reference[@label]">
modules/cross-references.xml: <template name="broken-reference" match="reference[not( @label )]">
modules/cross-references.xml: <template name="section-reference" match="section" mode="reference">
modules/cross-references.xml: <template name="figure-reference" match="figure" mode="reference">