diff --git a/api/document/templates/document/editor_akn.html b/api/document/templates/document/editor_akn.html index 32ad8a493..17563bd09 100644 --- a/api/document/templates/document/editor_akn.html +++ b/api/document/templates/document/editor_akn.html @@ -25,6 +25,203 @@
See the + M-16-19 XML for a complete example. +
+ +Block tags define the structure of the document. Several assume text in a +child content tag (see also, "Inline Tags"), and some assume a +num tag indicating the paragraph/footnote marker (following Akoma +Ntoso conventions). The block tags generally all have the same set of +(optional) attributes: +
+Tag | +Description | +Expects content | +Expects num | +Attribute notes | +Child notes | +
---|---|---|---|---|---|
policy | +The root XML node. Should only appear once in a doc. + | No | +No | +- | +Children should generally be a preamble followed by + secs or sec contents if no headings are + present. | +
preamble | +Container which holds metadata about the policy. When displaying the + document, this data is referenced, but not directly displayed. | +No | +No | +- | +Children should be of types published, policyNum, + policyTitle, from, and subject. | +
published | +Text version of publication date. | +Yes | +No | +- | +None | +
policyNum | +Text version of the policy number (e.g. "M-16-19"). | +Yes | +No | +- | +None | +
from | +Text version of the "from" field from the policy preamble. | +Yes | +Text label, e.g. "From:" | +- | +None | +
subject | +Text version of the "subject" field from the policy preamble. | +Yes | +Text label, e.g. "Subject:" | +- | +None | +
sec | +A section within the document. Can be nested and is closely related + to headings. | +No | +No | +title is used to determine Table of Contents | +First child should be a heading, followed by a sequence of + para, list, table, etc. or other + sec. | +
heading | +Wraps the text of a document header. This is not used when + determining section titles; see the title attribute of + sec. | +Yes | +No | +- | +None | +
para | +A paragraph of text. May contain sub-paragraphs and other block + elements (it is not a simple HTML <p>) | +Yes | +No | +- | +Children might include footnotes, lists, etc. or + other paras (sub-paragraphs). | +
footnote | +Content of a footnote. Should be contained within the paragraph that + has a corresponding citation. | +Yes | +Footnote number | +emblem should also be the footnote number | +None | +
list | +Container for listitems. | +No | +No | +- | +Children should be of type listitem. | +
listitem | +Represents an element of a list (ordered or unordered). Includes the + bullet, list marker, etc. | +No | +Bullet or list marker, e.g. "a)" or "●" | +emblem should match the num for ordered lists | +Children can be paras, tables, etc. or nested + lists. | +
math | +Indicates that its contents should be rendered as LaTeX-style + math. | +Yes | +No | +- | +None | +
table, thead, etc. | +Correspond to their HTML counterparts | +th, caption | +No | +- | +Each cell can contain para, math, etc. | +
Within a content tag, we include several "inline" tags to wrap +text. Each type may have unique, semantic attributes. All can be nested.
+
Tag | +Description | +Attributes | +
---|---|---|
cite | +Triggers the <cite> HTML tag | +None | +
footnote_citation | +Links to a specific footnote, as defined by its text body | +None | +
external_link | +Links to an url via a <a> | +href the full url to link | +