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 @@

Help

Shift+++F
Replace all
+ +

XML Tags

+

See the + M-16-19 XML for a complete example. +

+ +

Block Tags

+

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: +

+
+
id
+
Unique identifier of the node. Automatically computed; can be ignored + when editing docs
+ +
emblem
+
Semantic identifier of this node. For example, if a list item begins + with "b.", we would give an emblem of "b"
+ +
title
+
Used to determine the table of contents for nested sections
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TagDescriptionExpects contentExpects numAttribute notesChild notes
policyThe root XML node. Should only appear once in a doc. + NoNo-Children should generally be a preamble followed by + secs or sec contents if no headings are + present.
preambleContainer which holds metadata about the policy. When displaying the + document, this data is referenced, but not directly displayed.NoNo-Children should be of types published, policyNum, + policyTitle, from, and subject.
publishedText version of publication date.YesNo-None
policyNumText version of the policy number (e.g. "M-16-19").YesNo-None
fromText version of the "from" field from the policy preamble.YesText label, e.g. "From:"-None
subjectText version of the "subject" field from the policy preamble.YesText label, e.g. "Subject:"-None
secA section within the document. Can be nested and is closely related + to headings.NoNotitle is used to determine Table of ContentsFirst child should be a heading, followed by a sequence of + para, list, table, etc. or other + sec.
headingWraps the text of a document header. This is not used when + determining section titles; see the title attribute of + sec.YesNo-None
paraA paragraph of text. May contain sub-paragraphs and other block + elements (it is not a simple HTML <p>)YesNo-Children might include footnotes, lists, etc. or + other paras (sub-paragraphs).
footnoteContent of a footnote. Should be contained within the paragraph that + has a corresponding citation.YesFootnote numberemblem should also be the footnote numberNone
listContainer for listitems.NoNo-Children should be of type listitem.
listitemRepresents an element of a list (ordered or unordered). Includes the + bullet, list marker, etc.NoBullet or list marker, e.g. "a)" or "●"emblem should match the num for ordered listsChildren can be paras, tables, etc. or nested + lists.
mathIndicates that its contents should be rendered as LaTeX-style + math.YesNo-None
table, thead, etc.Correspond to their HTML counterpartsth, captionNo-Each cell can contain para, math, etc.
+ +

Inline Tags

+

Within a content tag, we include several "inline" tags to wrap +text. Each type may have unique, semantic attributes. All can be nested.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
TagDescriptionAttributes
citeTriggers the <cite> HTML tagNone
footnote_citationLinks to a specific footnote, as defined by its text bodyNone
external_linkLinks to an url via a <a>href the full url to link
{% endblock %} {% block editor-js %} diff --git a/api/package-lock.json b/api/package-lock.json index 22679a884..6f755c61a 100644 --- a/api/package-lock.json +++ b/api/package-lock.json @@ -7335,6 +7335,15 @@ "orderedmap": "1.0.0" } }, + "prosemirror-schema-list": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/prosemirror-schema-list/-/prosemirror-schema-list-1.0.0.tgz", + "integrity": "sha512-NPs+URTmYvU15dkMYxVIAb1i7/xZjDH+OWr3tlmF7Pvs0CYGUqTK4kFQDvlxs36s5jzl62nwD1/s7X+qToNAoQ==", + "requires": { + "prosemirror-model": "1.1.0", + "prosemirror-transform": "1.0.2" + } + }, "prosemirror-state": { "version": "1.1.0", "resolved": "https://registry.npmjs.org/prosemirror-state/-/prosemirror-state-1.1.0.tgz",