From 2a1fc3435510dfe18860483fc14cfd5f4ce83aad Mon Sep 17 00:00:00 2001 From: azerr Date: Wed, 22 Feb 2023 11:02:50 +0100 Subject: [PATCH] RNG attribute completion doesn't generate the proper prefix if the namespace is not declared Fixes #1489 Signed-off-by: azerr --- .../CMRelaxNGAttributeDeclaration.java | 26 +- .../relaxng/pattern/CMRelaxNGDocument.java | 8 +- .../pattern/CMRelaxNGElementDeclaration.java | 19 +- .../model/CMAttributeDeclaration.java | 2 + .../ContentModelCompletionParticipant.java | 73 +- .../CMDTDAttributeDeclaration.java | 7 +- .../CMXSDAttributeDeclaration.java | 5 + .../XMLCompletionBasedOnRelaxNGTest.java | 43 + .../src/test/resources/relaxng/docbook.rng | 15292 ++++++++++++++++ 9 files changed, 15450 insertions(+), 25 deletions(-) create mode 100644 org.eclipse.lemminx/src/test/resources/relaxng/docbook.rng diff --git a/org.eclipse.lemminx/src/main/java/com/thaiopensource/relaxng/pattern/CMRelaxNGAttributeDeclaration.java b/org.eclipse.lemminx/src/main/java/com/thaiopensource/relaxng/pattern/CMRelaxNGAttributeDeclaration.java index 6005e7743..5181d0aad 100644 --- a/org.eclipse.lemminx/src/main/java/com/thaiopensource/relaxng/pattern/CMRelaxNGAttributeDeclaration.java +++ b/org.eclipse.lemminx/src/main/java/com/thaiopensource/relaxng/pattern/CMRelaxNGAttributeDeclaration.java @@ -14,6 +14,7 @@ import java.util.Collection; import java.util.List; +import org.eclipse.lemminx.dom.DOMElement; import org.eclipse.lemminx.extensions.contentmodel.model.CMAttributeDeclaration; import org.eclipse.lemminx.extensions.contentmodel.model.CMElementDeclaration; import org.eclipse.lemminx.services.extensions.ISharedSettingsRequest; @@ -38,12 +39,35 @@ public class CMRelaxNGAttributeDeclaration implements CMAttributeDeclaration { private final CMRelaxNGElementDeclaration cmElement; private final AttributePattern pattern; + + private String prefix; + + private boolean computedPrefix; + private boolean required; private List values; public CMRelaxNGAttributeDeclaration(CMRelaxNGElementDeclaration element, AttributePattern pattern) { this.cmElement = element; this.pattern = pattern; + this.computedPrefix = false; + } + + @Override + public String getPrefix() { + String namespaceURI = getNamespace(); + if (namespaceURI == null) { + return null; + } + if (computedPrefix) { + return prefix; + } + DOMElement element = ((CMRelaxNGElementDeclaration) getOwnerElementDeclaration()).getDOMElement(); + if (element != null) { + prefix = element.getPrefix(namespaceURI); + } + computedPrefix = true; + return prefix; } @Override @@ -60,7 +84,7 @@ public String getNamespace() { public CMElementDeclaration getOwnerElementDeclaration() { return cmElement; } - + Name getJingName() { NameClass nameClass = pattern.getNameClass(); if (nameClass instanceof SimpleNameClass) { diff --git a/org.eclipse.lemminx/src/main/java/com/thaiopensource/relaxng/pattern/CMRelaxNGDocument.java b/org.eclipse.lemminx/src/main/java/com/thaiopensource/relaxng/pattern/CMRelaxNGDocument.java index 5cd7b7359..7441050f2 100644 --- a/org.eclipse.lemminx/src/main/java/com/thaiopensource/relaxng/pattern/CMRelaxNGDocument.java +++ b/org.eclipse.lemminx/src/main/java/com/thaiopensource/relaxng/pattern/CMRelaxNGDocument.java @@ -193,7 +193,7 @@ private static Position createValidPosition(int line, int character) { } private DOMRange getDeclaredTypeRange(DOMNode originNode, Locator locator) { - DOMNode node = findNode(locator); + DOMNode node = findNodeAt(locator); if (node == null) { return null; } @@ -207,7 +207,7 @@ private DOMRange getDeclaredTypeRange(DOMNode originNode, Locator locator) { return null; } - private DOMDocument getDocument(String systemId) { + public DOMDocument getDocument(String systemId) { DOMDocument document = documents.get(systemId); if (document != null) { return document; @@ -236,7 +236,7 @@ public String getDocumentation(Locator locator) { } public String getDocumentation(Locator locator, String value) { - DOMNode node = findNode(locator); + DOMNode node = findNodeAt(locator); if (node == null) { return null; } @@ -289,7 +289,7 @@ private DOMElement getDocumentationElement(DOMElement element, String value) { return null; } - DOMNode findNode(Locator locator) { + DOMNode findNodeAt(Locator locator) { if (locator == null) { return null; } diff --git a/org.eclipse.lemminx/src/main/java/com/thaiopensource/relaxng/pattern/CMRelaxNGElementDeclaration.java b/org.eclipse.lemminx/src/main/java/com/thaiopensource/relaxng/pattern/CMRelaxNGElementDeclaration.java index b34a4772d..1d6d87660 100644 --- a/org.eclipse.lemminx/src/main/java/com/thaiopensource/relaxng/pattern/CMRelaxNGElementDeclaration.java +++ b/org.eclipse.lemminx/src/main/java/com/thaiopensource/relaxng/pattern/CMRelaxNGElementDeclaration.java @@ -60,6 +60,8 @@ public class CMRelaxNGElementDeclaration implements CMElementDeclaration { private Set possibleRequiredElementNames; + private DOMElement domElement; + CMRelaxNGElementDeclaration(CMRelaxNGDocument document, ElementPattern pattern) { this.cmDocument = document; this.pattern = pattern; @@ -81,9 +83,9 @@ public String getNamespace() { @Override public String getPrefix(String namespaceURI) { - DOMNode node = cmDocument.findNode(pattern.getLocator()); - if (node != null && node.isElement()) { - return ((DOMElement) node).getPrefix(namespaceURI); + DOMElement element = getDOMElement(); + if (element != null) { + return element.getPrefix(namespaceURI); } return null; } @@ -96,6 +98,17 @@ private Name getJingName() { return null; } + public DOMElement getDOMElement() { + if (domElement != null) { + return domElement; + } + DOMNode node = cmDocument.findNodeAt(pattern.getLocator()); + if (node != null && node.isElement()) { + domElement = (DOMElement) node; + } + return domElement; + } + @Override public Collection getAttributes() { if (attributes == null) { diff --git a/org.eclipse.lemminx/src/main/java/org/eclipse/lemminx/extensions/contentmodel/model/CMAttributeDeclaration.java b/org.eclipse.lemminx/src/main/java/org/eclipse/lemminx/extensions/contentmodel/model/CMAttributeDeclaration.java index 7e8f782d3..7921b3caf 100644 --- a/org.eclipse.lemminx/src/main/java/org/eclipse/lemminx/extensions/contentmodel/model/CMAttributeDeclaration.java +++ b/org.eclipse.lemminx/src/main/java/org/eclipse/lemminx/extensions/contentmodel/model/CMAttributeDeclaration.java @@ -24,6 +24,8 @@ */ public interface CMAttributeDeclaration { + String getPrefix(); + /** * Returns the declared attribute local name. * diff --git a/org.eclipse.lemminx/src/main/java/org/eclipse/lemminx/extensions/contentmodel/participants/ContentModelCompletionParticipant.java b/org.eclipse.lemminx/src/main/java/org/eclipse/lemminx/extensions/contentmodel/participants/ContentModelCompletionParticipant.java index b6c53d9cb..473813cbb 100644 --- a/org.eclipse.lemminx/src/main/java/org/eclipse/lemminx/extensions/contentmodel/participants/ContentModelCompletionParticipant.java +++ b/org.eclipse.lemminx/src/main/java/org/eclipse/lemminx/extensions/contentmodel/participants/ContentModelCompletionParticipant.java @@ -39,6 +39,7 @@ import org.eclipse.lemminx.services.extensions.completion.ICompletionResponse; import org.eclipse.lemminx.uriresolver.CacheResourceDownloadingException; import org.eclipse.lemminx.utils.StringUtils; +import org.eclipse.lemminx.utils.XMLPositionUtility; import org.eclipse.lsp4j.CompletionItem; import org.eclipse.lsp4j.CompletionItemKind; import org.eclipse.lsp4j.MarkupContent; @@ -302,30 +303,70 @@ public void onAttributeName(boolean generateValue, ICompletionRequest request, I private void fillAttributesWithCMAttributeDeclarations(DOMElement parentElement, Range fullRange, CMElementDeclaration elementDeclaration, boolean canSupportSnippet, boolean generateValue, ICompletionRequest request, ICompletionResponse response) { - + if (parentElement == null) { + return; + } Collection attributes = elementDeclaration.getAttributes(); if (attributes == null) { return; } for (CMAttributeDeclaration attributeDeclaration : attributes) { - if (parentElement != null) { - String prefix = parentElement.getPrefix(attributeDeclaration.getNamespace()); - String attrName = attributeDeclaration.getName(prefix); - if (!parentElement.hasAttribute(attrName)) { - CompletionItem item = new AttributeCompletionItem(attrName, canSupportSnippet, fullRange, - generateValue, - attributeDeclaration.getDefaultValue(), attributeDeclaration.getEnumerationValues(), - request.getSharedSettings()); - if (request.isResolveDocumentationSupported()) { - addResolveData(request, item, AttributeNameCompletionResolver.PARTICIPANT_ID); + String prefix = null; + boolean declareNamespace = false; + String namespaceURI = attributeDeclaration.getNamespace(); + if (!StringUtils.isEmpty(namespaceURI)) { + // The schema defines the attribute with a namespace (ex : + // http://www.w3.org/1999/xlink) + // Try to get the prefix from the XML document (ex: "), "\r\n" + + "\r\n" + + " \r\n" + + ""; + testCompletionFor(xml, // + 30, // + c("role", te(2, 19, 2, 19, "role=\"\""), "role"), // + c("xlink:actuate", te(2, 19, 2, 19, "xlink:actuate=\"\""), + Arrays.asList(te(1, 43, 1, 43, " xmlns:xlink=\"http://www.w3.org/1999/xlink\"")), // + "xlink:actuate")); + } + + @Test + public void completionOnAttributesWithPrefix() throws BadLocationException { + // completion on <| + String xml = "\r\n" + + "\r\n" + + " \r\n" + + ""; + testCompletionFor(xml, // + 30, // + c("xlink:actuate", te(2, 19, 2, 19, "xlink:actuate=\"\""), + Arrays.asList(te(1, 43, 1, 43, " xmlns:xlink=\"http://www.w3.org/1999/xlink\"")), // + "xlink:actuate")); + + xml = "\r\n" + + "\r\n" + + " \r\n" + + ""; + testCompletionFor(xml, // + 30, // + c("xlink:actuate", te(2, 19, 2, 19, "xlink:actuate=\"\""), + Arrays.asList(te(1, 43, 1, 43, " xmlns:xlink=\"http://www.w3.org/1999/xlink\"")), // + "xlink:actuate")); + } + + // role,xml:id,version,xml:lang,xml:base,remap,xreflabel,revisionflag,dir,arch,audience,condition,conformance,os,revision,security,userlevel,vendor,wordsize,annotations,linkend,xlink:href,xlink:type,xlink:role,xlink:arcrole,xlink:title,xlink:show,xlink:actuate,label,status + private static void testCompletionFor(String value, Integer expectedCount, CompletionItem... expectedItems) throws BadLocationException { XMLAssert.testCompletionFor(new XMLLanguageService(), value, null, null, "src/test/resources/relaxng/test.xml", diff --git a/org.eclipse.lemminx/src/test/resources/relaxng/docbook.rng b/org.eclipse.lemminx/src/test/resources/relaxng/docbook.rng new file mode 100644 index 000000000..4a561d84a --- /dev/null +++ b/org.eclipse.lemminx/src/test/resources/relaxng/docbook.rng @@ -0,0 +1,15292 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + Any attribute including in any attribute in any namespace. + + + + + + Any element from almost any namespace + + + + + + + + + + + + + + + +
+ + + Designates the computer or chip architecture to which the element applies + + + + + Designates the intended audience to which the element applies, for example, system administrators, programmers, or new users. + + + + + provides a standard place for application-specific effectivity + + + + + Indicates standards conformance characteristics of the element + + + + + Indicates the operating system to which the element is applicable + + + + + Indicates the editorial revision to which the element belongs + + + + + Indicates something about the security level associated with the element to which it applies + + + + + Indicates the level of user experience for which the element applies + + + + + Indicates the computer vendor to which the element applies. + + + + + Indicates the word size (width in bits) of the computer architecture to which the element applies + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Points to the element whose content is to be used as the text of the link + + + + + + Points to an internal link target by identifying the value of its xml:id attribute + + + + + + Points to one or more internal link targets by identifying the value of their xml:id attributes + + + + + + Identifies a link target with a URI + + + + + + Identifies the XLink link type + simple + An XLink simple link + + + + + Identifies the XLink role of the link + + + + + + Identifies the XLink arcrole of the link + + + + + + + Identifies the XLink title of the link + + + + + + new + An application traversing to the ending resource should load it in a new window, frame, pane, or other relevant presentation context. + replace + An application traversing to the ending resource should load the resource in the same window, frame, pane, or other relevant presentation context in which the starting resource was loaded. + embed + An application traversing to the ending resource should load its presentation in place of the presentation of the starting resource. + other + The behavior of an application traversing to the ending resource is unconstrained by XLink. The application should look for other markup present in the link to determine the appropriate behavior. + none + The behavior of an application traversing to the ending resource is unconstrained by this specification. No other markup is present to help the application determine the appropriate behavior. + + + + + Identifies the XLink show behavior of the link + + + + + + onLoad + An application should traverse to the ending resource immediately on loading the starting resource. + onRequest + An application should traverse from the starting resource to the ending resource only on a post-loading event triggered for the purpose of traversal. + other + The behavior of an application traversing to the ending resource is unconstrained by this specification. The application should look for other markup present in the link to determine the appropriate behavior. + none + The behavior of an application traversing to the ending resource is unconstrained by this specification. No other markup is present to help the application determine the appropriate behavior. + + + + + Identifies the XLink actuate behavior of the link + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Identifies the unique ID value of the element + + + + + + Specifies the DocBook version of the element and its descendants + + + + + Specifies the natural language of the element and its descendants + + + + + Specifies the base URI of the element and its descendants + + + + + + Provides the name or similar semantic identifier assigned to the content in some previous markup scheme + + + + + Provides the text that is to be generated for a cross reference to the element + + + + + Specifies a keyword or keywords identifying additional style information + + + + + changed + The element has been changed. + added + The element is new (has been added to the document). + deleted + The element has been deleted. + off + Explicitly turns off revision markup for this element. + + + + + Identifies the revision status of the element + + + + + + ltr + Left-to-right text + rtl + Right-to-left text + lro + Left-to-right override + rlo + Right-to-left override + + + + + Identifies the direction of text in an element + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Specifies the format of the data + + + + + Indentifies the location of the data by URI + + + + Identifies the location of the data by external identifier (entity name) + + + + + + + continues + Line numbering continues from the immediately preceding element with the same name. + restarts + Line numbering restarts (begins at 1, usually). + + + + + Determines whether line numbering continues from the previous element or restarts. + + + + + + numbered + Lines are numbered. + unnumbered + Lines are not numbered. + + + + + Determines whether lines are numbered. + + + + + + Specifies the initial line number. + + + + + + Identifies the language (i.e. programming language) of the verbatim content. + + + + + Can be used to indicate explicitly that whitespace in the verbatim environment is preserved. Whitespace must always be preserved in verbatim environments whether this attribute is specified or not. + preserve + Whitespace must be preserved. + + + + + + + + + + + + + + + + + + + + + + + + Specifies an identifying string for presentation purposes + + + + + Specifies the width (in characters) of the element + + + + + + compact + The spacing should be "compact". + normal + The spacing should be "normal". + + + + + Specifies (a hint about) the spacing of the content + + + + + + 0 + The element should be rendered in the current text flow (with the flow column width). + 1 + The element should be rendered across the full text page. + + + + + Indicates if the element is rendered across the column or the page + + + + + + Identifies the language (i.e. programming language) of the content. + + + + + optional + The content describes an optional step or steps. + required + The content describes a required step or steps. + + + + + Specifies if the content is required or optional. + + + + + + Specifies style information to be used when rendering the float + + + + + Specifies the width of the element + + + + + Specifies the depth of the element + + + + + Specifies the width of the content rectangle + + + + + Specifies the depth of the content rectangle + + + + + 0 + False (do not scale-to-fit; anamorphic scaling may occur) + 1 + True (scale-to-fit; anamorphic scaling is forbidden) + + + + + Specifies the scaling factor + + + + + + center + Centered horizontally + char + Aligned horizontally on the specified character + justify + Fully justified (left and right margins or edges) + left + Left aligned + right + Right aligned + + + + + bottom + Aligned on the bottom of the region + middle + Centered vertically + top + Aligned on the top of the region + + + + + doi + A document object identifier. + isbn + An international standard book number. + isrn + An international standard technical report number (ISO 10444). + issn + An international standard serial number. + libraryofcongress + A Library of Congress reference number. + pubsnumber + A publication number (an internal number or possibly organizational standard). + uri + A Uniform Resource Identifier + + + + + + Identifies the kind of bibliographic identifier + + + + + + + Identifies the nature of the non-standard bibliographic identifier + + + + + + + Identifies the kind of bibliographic identifier + other + Indicates that the identifier is some 'other' kind. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + The text of the title of a section of a document or of a formal block-level element + + + + + + +
+
+ + + + + + + + + + + + + + + The abbreviation of a title + + + + + + +
+
+ + + + + + + + + + + + + + + The subtitle of a document + + + + + + +
+
+ + + + + + + + + + + + + + A wrapper for information about a component or other block + + + + + + + + + +
+
+ + + + + + + + + + + + + + A wrapper for information about a component or other block with a required title + + + + + + + + + +
+
+ + + + + + + + + + + + + + A wrapper for information about a component or other block with only a title + + + + + + + + + +
+
+ + + + + + + + + + + + + + A wrapper for information about a component or other block with only a required title + + + + + + + + + +
+
+ + + + + + + + + + + + + + A wrapper for information about a component or other block without a title + + + + + + +
+
+ + + + + + Identifies the controlled vocabulary used by this set's terms + + + + + + + + + + + + + + + + + + A set of terms describing the subject matter of a document + + + + + + +
+
+ + + + + + Specifies a ranking for this subject relative to other subjects in the same set + + + + + + + + + + + + + + + + + One of a group of terms describing the subject matter of a document + + + + + + +
+
+ + + + + + + + + + + + + + + A term in a group of terms describing the subject matter of a document + + + + +
+
+ + + + + + + + + + + + + + + A set of keywords describing the content of a document + + + + + + +
+
+ + + + + + + + + + + + + + + One of a set of keywords describing the content of a document + + + + +
+ + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + A list of operations to be performed in a well-defined sequence + + + + + + + + + + +
+
+ + + + + + + + + + + + + + + + + + + + + + A unit of action in a procedure + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + + + + + + + + + + + + + + + + + + + + Alternative steps in a procedure + + + + + + + +
+
+ + + + + + + + + + + + + + + + + + A wrapper for steps that occur within steps in a procedure + + + + + + +
+
+ + + + + + + + + + + + + + + + + + A portion of a document that is isolated from the main narrative flow + + + sidebar must not occur in the descendants of sidebar + + + + + + + + + +
+
+ + + + + + + + + + + + + + + + + + A summary + + + + + + + +
+
+ + + + + + + + + + + + + + + + + + A short description or note about a person + + + + + + + +
+
+ + + + + + + + + + + + + + + + + + A quotation set off from the main text + + + + + + + + + + +
+
+ + + + + + + + + + + + + + + The source of a block quote or epigraph + + + + + + + + + + + + +
+
+ + + sect1 + Render as a first-level section + sect2 + Render as a second-level section + sect3 + Render as a third-level section + sect4 + Render as a fourth-level section + sect5 + Render as a fifth-level section + + + + + + Indicates how the bridge head should be rendered + + + + + + + Identifies the nature of the non-standard rendering + + + + + + + Indicates how the bridge head should be rendered + other + Identifies a non-standard rendering + + + + + + + + + + + + + + + + + + + + + + + + + + + + A free-floating heading + + + + + + +
+
+ + + + + + + + + + + + + + + A remark (or comment) intended for presentation in a draft manuscript + + + + +
+
+ + + + + + + + + + + + + + + + + + A short inscription at the beginning of a document or component + + + + + + + + + + + + + +
+
+ + + + + + Identifies the desired footnote mark + + + + + + + + + + + + + + + + + + A footnote + + + footnote must not occur in the descendants of footnote + + + + + example must not occur in the descendants of footnote + + + + + figure must not occur in the descendants of footnote + + + + + table must not occur in the descendants of footnote + + + + + equation must not occur in the descendants of footnote + + + + + indexterm must not occur in the descendants of footnote + + + + + sidebar must not occur in the descendants of footnote + + + + + task must not occur in the descendants of footnote + + + + + epigraph must not occur in the descendants of footnote + + + + + caution must not occur in the descendants of footnote + + + + + important must not occur in the descendants of footnote + + + + + note must not occur in the descendants of footnote + + + + + tip must not occur in the descendants of footnote + + + + + warning must not occur in the descendants of footnote + + + + + + + + +
+
+ + + + + + + + + + + + + + + + + + A paragraph with a title + + + + + + + + +
+
+ + + + + + + + + + + + + + + + + + A paragraph + + + The root element must have a version attribute. + + + + + + + + + + + + +
+
+ + + + + + + + + + + + + + + + + + A paragraph that contains only text and inline markup, no block elements + + + + + + + +
+
+ + + + + + Identifies the type of mark to be used on items in this list + + + + + + + + + + + + + + + + + + + + + + + + A list in which each entry is marked with a bullet or other dingbat + + + + + + + + + + +
+
+ + + + + + continues + Specifies that numbering should begin where the preceding list left off + restarts + Specifies that numbering should begin again at 1 + + + + + Indicates how list numbering should begin relative to the immediately preceding list + + + + + + Specifies the initial line number. + + + + + + ignore + Specifies that numbering should ignore list nesting + inherit + Specifies that numbering should inherit from outer-level lists + + + + + Indicates whether or not item numbering should be influenced by list nesting + + + + + + arabic + Specifies Arabic numeration (1, 2, 3, …) + upperalpha + Specifies upper-case alphabetic numeration (A, B, C, …) + loweralpha + Specifies lower-case alphabetic numeration (a, b, c, …) + upperroman + Specifies upper-case Roman numeration (I, II, III, …) + lowerroman + Specifies lower-case Roman numeration (i, ii, iii …) + + + + + Indicates the desired numeration + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + A list in which each entry is marked with a sequentially incremented label + + + + + + + + + + +
+
+ + + + + + Specifies the keyword for the type of mark that should be used on this + item, instead of the mark that would be used by default + + + + + + + + + + + + + + + + + + A wrapper for the elements of a list item + + + + + + +
+
+ + + + + + + + + + + + + + + + + + A segmented list, a list of sets of elements + + + + + + + + + + +
+
+ + + + + + + + + + + + + + + The title of an element of a list item in a segmented list + + + + + + +
+
+ + + + + + + + + + + + + + + A list item in a segmented list + + + The number of seg elements must be the same as the number of segtitle elements in the parent segmentedlist + + + + + + + + +
+
+ + + + + + + + + + + + + + + An element of a list item in a segmented list + + + + + + +
+
+ + + + + + horiz + A tabular presentation in row-major order. + vert + A tabular presentation in column-major order. + inline + An inline presentation, usually a comma-delimited list. + + + + + Specifies the type of list presentation. + + + + + + Specifies the number of columns for horizontal or vertical presentation + + + + + + + + + + + + + + + + + + + + + An undecorated list of single words or short phrases + + + + + + +
+
+ + + + + + + + + + + + + + + An element of a simple list + + + + + + +
+
+ + + + + + Indicates a length beyond which the presentation system may consider a term too long and select an alternate presentation for that term, item, or list + + + + + + + + + + + + + + + + + + + + + + + A list in which each entry is composed of a set of one or more terms and an associated description + + + + + + + + + + +
+
+ + + + + + + + + + + + + + + A wrapper for a set of terms and the associated description in a variable list + + + + + + + +
+
+ + + + + + + + + + + + + + + The word or phrase being defined or described in a variable list + + + + + + +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + A formal example, with a title + + + example must not occur in the descendants of example + + + + + figure must not occur in the descendants of example + + + + + table must not occur in the descendants of example + + + + + equation must not occur in the descendants of example + + + + + caution must not occur in the descendants of example + + + + + important must not occur in the descendants of example + + + + + note must not occur in the descendants of example + + + + + tip must not occur in the descendants of example + + + + + warning must not occur in the descendants of example + + + + + + + + + + + + +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + A displayed example without a title + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + +
+ + + + + + monospaced + The literal layout should be formatted with a monospaced font + normal + The literal layout should be formatted with the current font + + + + + Specifies the class of literal layout + + + + + + + + + + + + + + + + + + + A block of text in which line breaks and white space are to be reproduced faithfully + + + + +
+
+ + + + + + + + + + + + + + + + + + + + + + Text that a user sees or might see on a computer screen + + + + +
+
+ + + + + + + + + + + + + + + + + + A representation of what the user sees or might see on a computer screen + + + + + +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + A formal figure, generally an illustration, with a title + + + example must not occur in the descendants of figure + + + + + figure must not occur in the descendants of figure + + + + + table must not occur in the descendants of figure + + + + + equation must not occur in the descendants of figure + + + + + caution must not occur in the descendants of figure + + + + + important must not occur in the descendants of figure + + + + + note must not occur in the descendants of figure + + + + + tip must not occur in the descendants of figure + + + + + warning must not occur in the descendants of figure + + + + + + + + + + + + +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + A untitled figure + + + + + + + + + + +
+ + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + A displayed media object (video, audio, image, etc.) + + + + + + + + + + + + + +
+
+ + + + + + + + + + + + + + + + + + An inline media object (video, audio, image, and so on) + + + + + + + + + + +
+
+ + + + + + + + + + + + + + + + + + A wrapper for video data and its associated meta-information + + + + + +
+
+ + + + + + + + + + + + + + + + + + A wrapper for audio data and its associated meta-information + + + + + +
+ + + + + + + +
+ + + + + + + + + + + + + + + + + + A wrapper for image data and its associated meta-information + + + + + +
+
+ + + + + + + + + + + + + + + + + + A wrapper for a text description of an object and its associated meta-information + + + + + + + + + + + +
+
+ + + + + + + + + Specifies the (horizontal) alignment of the video data + + + + + + + + + Specifies the vertical alignment of the video data + + + + + + + + + + + + + + + + + + + + + Determines if anamorphic scaling is forbidden + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Pointer to external video data + + + + +
+
+ + + + + + + + + + + + + + + + + + Pointer to external audio data + + + + +
+
+ + + + + + + + + Specifies the (horizontal) alignment of the image data + + + + + + + + + Specifies the vertical alignment of the image data + + + + + + + + + + + + + + + + + + + + + Determines if anamorphic scaling is forbidden + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Pointer to external image data + + + + +
+
+ + + + + + Identifies the encoding of the text in the external file + + + + + + + + + + + + + + + + + + + + Pointer to external text data + + + + +
+
+ + + + + + + + + + + + + + + + + + A caption + + + example must not occur in the descendants of caption + + + + + figure must not occur in the descendants of caption + + + + + table must not occur in the descendants of caption + + + + + equation must not occur in the descendants of caption + + + + + sidebar must not occur in the descendants of caption + + + + + task must not occur in the descendants of caption + + + + + caution must not occur in the descendants of caption + + + + + important must not occur in the descendants of caption + + + + + note must not occur in the descendants of caption + + + + + tip must not occur in the descendants of caption + + + + + warning must not occur in the descendants of caption + + + + + + + + + +
+
+ + + + + + + + + + + + + + + + A real-world address, generally a postal address + + + + + + + + + + + + + + + + + + + + +
+
+ + + + + + + + + + + + + + + A street address in an address + + + + +
+
+ + + + + + + + + + + + + + + A post office box in an address + + + + +
+
+ + + + + + + + + + + + + + + A postal code in an address + + + + +
+
+ + + + + + + + + + + + + + + The name of a city in an address + + + + +
+
+ + + + + + + + + + + + + + + A state or province in an address + + + + +
+
+ + + + + + + + + + + + + + + The name of a country + + + + +
+
+ + + + + + + + + + + + + + + A telephone number + + + + +
+
+ + + + + + + + + + + + + + + A fax number + + + + +
+
+ + + + + + + + + + + + + + + Uncategorized information in address + + + + +
+
+ + + + + + + + + + + + + + + The institutional affiliation of an individual + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + + + + + + + + + + + + + + A brief description of an affiliation + + + + +
+
+ + + + + + + + + + + + + + + The title of an individual in an organization + + + + +
+
+ + + consortium + A consortium + corporation + A corporation + informal + An informal organization + nonprofit + A non-profit organization + + + + + Specifies the nature of the organization + + + + + + Specifies the nature of the organization + other + Indicates a non-standard organization class + + + Identifies the non-standard nature of the organization + + + + + + + + + + + + + + + + + + + + + + + + + + The name of an organization + + + + +
+
+ + + + + + + + + + + + + + + A division of an organization + + + + + + +
+
+ + + + + + + + + + + + + + + The page numbers of an article as published + + + + +
+
+ + + + + + + + + + + + + + + The personal name of an individual + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + The name of an individual author + + + + +
+
+ + + + + + + + + + + + + + + Wrapper for author information when a document has multiple authors or collabarators + + + + + + + + + + +
+
+ + + + + + + + + + + + + + + Identifies a collaborator + + + + + + + + + + + + + + +
+
+ + + + + + + + + + + + + + + The initials or other short identifier for an author + + + + +
+
+ + + + + + + + + + + + + + + A person and associated metadata + + + + + + + + + + + + + +
+
+ + + + + + + + + + + + + + + An organization and associated metadata + + + + + + + + + + + + + +
+
+ + + + + + + + + + + + + + + A wrapper for document meta-information about a conference + + + + + + + + + + + + +
+
+ + + + + + + + + + + + + + + The dates of a conference for which a document was written + + + + +
+
+ + + + + + + + + + + + + + + The title of a conference for which a document was written + + + + +
+
+ + + + + + + + + + + + + + + An identifier, frequently numerical, associated with a conference for which a document was written + + + + +
+
+ + + + + + + + + + + + + + + The sponsor of a conference for which a document was written + + + + +
+
+ + + + + + + + + + + + + + + The contract number of a document + + + + +
+
+ + + + + + + + + + + + + + + The sponsor of a contract + + + + +
+
+ + + + + + + + + + + + + + + Copyright information about a document + + + + + + + + + +
+
+ + + + + + + + + + + + + + + The year of publication of a document + + + + +
+
+ + + + + + + + + + + + + + + The name of the individual or organization that holds a copyright + + + + +
+ + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + Additional content for the cover of a publication + + + + + + +
+ + + + + + + + + +
+ + + + + + + + + + + + + + + The date of publication or revision of a document + + + + +
+
+ + + + + + + + + + + + + + + The name or number of an edition of a document + + + + +
+
+ + + + + + + + + + + + + + + The name of the editor of a document + + + + +
+
+ + + + + + + + + + + + + + + + An identifier for a document + + + + +
+
+ + + + + + + + + + + + + + + + A citation of a bibliographic identifier + + + + +
+
+ + + + + + + + + + + + + + + + The source of a document + + + + +
+
+ + + hasformat + The described resource pre-existed the referenced resource, which is essentially the same intellectual content presented in another format + haspart + The described resource includes the referenced resource either physically or logically + hasversion + The described resource has a version, edition, or adaptation, namely, the referenced resource + isformatof + The described resource is the same intellectual content of the referenced resource, but presented in another format + ispartof + The described resource is a physical or logical part of the referenced resource + isreferencedby + The described resource is referenced, cited, or otherwise pointed to by the referenced resource + isreplacedby + The described resource is supplanted, displaced, or superceded by the referenced resource + isrequiredby + The described resource is required by the referenced resource, either physically or logically + isversionof + The described resource is a version, edition, or adaptation of the referenced resource; changes in version imply substantive changes in content rather than differences in format + references + The described resource references, cites, or otherwise points to the referenced resource + replaces + The described resource supplants, displaces, or supersedes the referenced resource + requires + The described resource requires the referenced resource to support its function, delivery, or coherence of content + + + + + + Identifies the type of relationship + + + + + + + + Identifies the type of relationship + othertype + The described resource has a non-standard relationship with the referenced resource + + + + A keyword that identififes the type of the non-standard relationship + + + + + + + + + + + + + + + + + + + + + + + + + + The relationship of a document to another + + + + +
+
+ + + dcmipoint + The DCMI Point identifies a point in space using its geographic coordinates + iso3166 + ISO 3166 Codes for the representation of names of countries + dcmibox + The DCMI Box identifies a region of space using its geographic limits + tgn + The Getty Thesaurus of Geographic Names + + + + + + Specifies the type of spatial coverage + + + + + + + + Specifies the type of spatial coverage + otherspatial + Identifies a non-standard type of coverage + + + + A keyword that identifies the type of non-standard coverage + + + + + + + + + + + + dcmiperiod + A specification of the limits of a time interval + w3c-dtf + W3C Encoding rules for dates and times—a profile based on ISO 8601 + + + + + + Specifies the type of temporal coverage + + + + + + + + Specifies the type of temporal coverage + othertemporal + Specifies a non-standard type of coverage + + + + A keyword that identifies the type of non-standard coverage + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + The spatial or temporal coverage of a document + + + + +
+
+ + + + + + + + + + + + + + + + + + A statement of legal obligations or requirements + + + + + + + +
+
+ + + copyeditor + A copy editor + graphicdesigner + A graphic designer + other + Some other contributor + productioneditor + A production editor + technicaleditor + A technical editor + translator + A translator + + + + + + Identifies the nature of the contributor + + + + + + + Identifies the nature of the non-standard contribution + + + + + + + Identifies the nature of the contributor + other + Identifies a non-standard contribution + + + + + + + + + + + + + + + + + + + + + + + + + + A person or entity, other than an author or editor, credited in a document + + + + +
+
+ + + + + + + + + + + + + + + The numbers of the pages in a book, for use in a bibliographic entry + + + + +
+
+ + + + + + + + + + + + + + + A summary of the contributions made to a document by a credited source + + + + +
+
+ + + + + + + + + + + + + + + The title of a person + + + + +
+
+ + + + + + + + + + + + + + + The first name of a person + + + + +
+
+ + + + + + + + + + + + + + + A family name; in western cultures the last name + + + + +
+
+ + + + + + + + + + + + + + + The portion of a person's name indicating a relationship to ancestors + + + + +
+
+ + + + + + + + + + + + + + + A component of a persons name that is not a first name, surname, or lineage + + + + +
+
+ + + + + + + + + + + + + + + The printing history of a document + + + + + + +
+
+ + + + + + + + + + + + + + + The date of publication of a document + + + + +
+
+ + + + + + + + + + + + + + + The publisher of a document + + + + + + + +
+
+ + + + + + + + + + + + + + + The name of the publisher of a document + + + + +
+
+ + + + + + + + + + + + + + + Information about a particular release of a document + + + + +
+
+ + + + + + + + + + + + + + + + + + A history of the revisions to a document + + + + + + + +
+
+ + + + + + + + + + + + + + + An entry describing a single revision in the history of the revisions to a document + + + + + + + + + + + + + + + + + + + +
+
+ + + + + + + + + + + + + + + A document revision number + + + + +
+
+ + + + + + + + + + + + + + + A description of a revision to a document + + + + +
+
+ + + + + + + + + + + + + + + A extended description of a revision to a document + + + + + + +
+
+ + + + + + + + + + + + + + + Numbers of the volumes in a series of books + + + + +
+
+ + + + + + + + + + + + + + + The volume number of a document in a set (as of books in a set or articles in a journal) + + + + +
+
+ + + + + + + + + + + + + + + The number of an issue of a journal + + + + +
+
+ + + + + + + + + + + + + + + A software or application package + + + + +
+
+ + + + + + + + + + + + + + + An email address + + + + +
+
+ + + + + + + + + + + + + + + A comment on a line in a verbatim listing + + + + +
+
+ + + command + A command + function + A function + option + An option + + + + + Identifies the class of parameter + + + + + + + + + + + + + + + + + + + + + A value or a symbolic reference to a value + + + + +
+ + + + + + +
+ + + command + A command + function + A function + option + An option + parameter + A parameter + + + + + Identifies the nature of the replaceable text + + + + + + + + + + + + + + + + + + + + + Content that may or must be replaced by the user + + + + + + +
+
+ + + + Identifies the type of URI specified + + + + + + + + + + + + + + + + + + + A Uniform Resource Identifier + + + + +
+
+ + + + + + + + + + + + + + + An abbreviation, especially one followed by a period + + + + + + + + + + + +
+
+ + + + + + + + + + + + + + + An often pronounceable word made from the initial (or selected) letters of a name or phrase + + + + + + + + + + + +
+
+ + + + + + + + + + + + + + + An inline bibliographic reference to another published work + + + + + + +
+
+ + + + + + + + + + + + + + + A citation to a reference page + + + + + + + +
+
+ + + + + + + + + + + + + + + The title of a reference page + + + + + + +
+
+ + + + + + + + + + + + + + + A reference volume number + + + + +
+
+ + + article + An article + bbs + A bulletin board system + book + A book + cdrom + A CD-ROM + chapter + A chapter (as of a book) + dvd + A DVD + emailmessage + An email message + gopher + A gopher page + journal + A journal + manuscript + A manuscript + newsposting + A posting to a newsgroup + part + A part (as of a book) + refentry + A reference entry + section + A section (as of a book or article) + series + A series + set + A set (as of books) + webpage + A web page + wiki + A wiki page + + + + + Identifies the nature of the publication being cited + + + + + + + + + + + + + + + + + + + + + The title of a cited work + + + + + + +
+
+ + + + + + + + + + + + + + + Emphasized text + + + + + + +
+
+ + + A limited span of emphasized text + + + + + + + + + +
+
+ + + + + + + + + + + + + + + A word or phrase in a language other than the primary language of the document + + + + + + + + + +
+
+ + + + + + + + + + + + + + + A span of text + + + + + + +
+
+ + + A limited span of text + + + + +
+
+ + + + + + + + + + + + + + + An inline quotation + + + + + + +
+
+ + + + + + + + + + + + + + + A subscript (as in H2 +O, the molecular formula for water) + + + + +
+
+ + + + + + + + + + + + + + + A superscript (as in x^2, the mathematical notation for x multiplied by itself) + + + + +
+
+ + + copyright + A copyright + registered + A registered copyright + service + A service + trade + A trademark + + + + + Identifies the class of trade mark + + + + + + + + + + + + + + + + + + + + + A trademark + + + + +
+
+ + + + + + + + + + + + + + + A word meant specifically as a word and not representing anything else + + + + +
+
+ + + + + + + + + + + + + + + + + + + + + A cross reference to a footnote (a footnote mark) + + + @linkend on footnoteref must point to a footnote. + + + + + + +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + A cross reference to another part of the document + + + + +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + A hypertext link + + + + + + +
+
+ + + + + + + + + Holds additional information that may be used by the applicatoin when resolving the link + + + + + Specifies the URI of the document in which the link target appears + + + + + + Specifies the location of the link target in the document + + + + + Identifies application-specific customization of the link behavior + + + + + + + + + + + + + + + + + + + + + + + + + + + + A link that addresses its target indirectly + + + + + + +
+
+ + + + + + + + + + + + + + A spot in the document + + + + +
+
+ + + + + + + + + + + + + + A text-only annotation, often used for accessibility + + + + + + + + + +
+ + + Identifies the editorial or publication status of the element on which it occurs + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + A collection of books + + + The root element must have a version attribute. + + + + + + + + + + + + + + + +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + A book + + + The root element must have a version attribute. + + + + + + + + + + + + + +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + The dedication of a book or other component + + + The root element must have a version attribute. + + + + + + + + + +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + Acknowledgements of a book or other component + + + The root element must have a version attribute. + + + + + + + + + +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + Text at the back of a book describing facts about its production + + + The root element must have a version attribute. + + + + + + + + + +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + An appendix in a Book or Article + + + The root element must have a version attribute. + + + + + + + +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + A chapter, as of a book + + + The root element must have a version attribute. + + + + + + + +
+ + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + A division in a book + + + The root element must have a version attribute. + + + + + + + + + + + + +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + Introductory matter preceding the first chapter of a book + + + The root element must have a version attribute. + + + + + + + +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + An introduction to the contents of a part + + + + + +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + A recursive section + + + The root element must have a version attribute. + + + + + + + + + + +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + A section of a document with no subdivisions + + + + + + + +
+ + + +
+ + + + + + faq + A collection of frequently asked questions. + journalarticle + An article in a journal or other periodical. + productsheet + A description of a product. + specification + A specification. + techreport + A technical report. + whitepaper + A white paper. + + + + + Identifies the nature of the article + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + An article + + + The root element must have a version attribute. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + Identifies one or more annotations that apply to this element + + +
+ + + + + + Identifies one ore more elements to which this annotation applies + + + + + + + + + + + + + + + + + + + An annotation + + + annotation must not occur in the descendants of annotation + + + + + + + + + +
+ + + + Specifies the XLink traversal-from + + + + + + + + Specifies the XLink label + + + + + + + + Specifies the XLink traversal-to + + + + +
+ + + + + + + + + + + + Identifies the XLink link type + extended + An XLink extended link + + + + + + + + + + + + + An XLink extended link + + + + + + + + + +
+
+ + + + + + + + + + + + Identifies the XLink link type + locator + An XLink locator link + + + + + + + + + + + + + + + + + An XLink locator in an extendedlink + + + + +
+
+ + + + + + + + + + + + Identifies the XLink link type + arc + An XLink arc link + + + + + + + + + + + + + + + + + + + + + + + + + An XLink arc in an extendedlink + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + A top-level section of document + + + The root element must have a version attribute. + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + A subsection within a Sect1 + + + The root element must have a version attribute. + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + A subsection within a Sect2 + + + The root element must have a version attribute. + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + A subsection within a Sect3 + + + The root element must have a version attribute. + + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + A subsection within a Sect4 + + + The root element must have a version attribute. + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + A collection of reference entries + + + The root element must have a version attribute. + + + + + + + + + + + + +
+
+ + + + + + + + + + + + + + + + + + + + + + + + A reference page (originally a UNIX man-style reference page) + + + The root element must have a version attribute. + + + + + + + + + + + + + + + + + + + +
+
+ + + + + + + + + + + + + + + Meta-information for a reference entry + + + + + + + + + + + + + + + + +
+ + + source + The name of the software product or component to which this topic applies + version + The version of the software product or component to which this topic applies + manual + The section title of the reference page (e.g., User Commands) + sectdesc + The section title of the reference page (believed synonymous with "manual" but in wide use) + software + The name of the software product or component to which this topic applies (e.g., SunOS x.y; believed synonymous with "source" but in wide use) + + + + + + Identifies the kind of miscellaneous information + + + + + + + Identifies the nature of non-standard miscellaneous information + + + + + + Identifies the kind of miscellaneious information + other + Indicates that the information is some 'other' kind. + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + Meta-information for a reference entry other than the title and volume number + + + + +
+
+ + + + + + + + + + + + + + + The name, purpose, and classification of a reference page + + + + + + + + + + + + + +
+
+ + + + + + + + + + + + + + + A description of the topic of a reference page + + + + + + +
+
+ + + + + + + + + + + + + + + The name of (one of) the subject(s) of a reference page + + + + + + +
+
+ + + + + + + + + + + + + + + A short (one sentence) synopsis of the topic of a reference page + + + + + + +
+
+ + + + + + + + + + + + + + + The scope or other indication of applicability of a reference entry + + + + + + + + + +
+
+ + + + + + + + + + + + + + + + + + A syntactic synopsis of the subject of the reference page + + + + + + + + + + + + + + + +
+
+ + + + + + + + + + + + + + + + + + + + + + + + A recursive section in a refentry + + + The root element must have a version attribute. + + + + + + + + + + + + + + + + + + + +
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + A major subsection of a reference entry + + + The root element must have a version attribute. + + + + + + + + + + + + + + + + + +
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + A subsection of a refsect1 + + + The root element must have a version attribute. + + + + + + + + + + + + + + + + + +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + A subsection of a refsect2 + + + The root element must have a version attribute. + + + + + + + + + +
+ + + + + + + + + + Specifies the base form of the term, the one that appears in the glossary. This allows adjectival, plural, and other variations of the term to appear in the element. The element content is the default base form. + + + +
+ + + + + + + + + + + + + + + + + + A wrapper for a list of glossary entries + + + + + + + + + + + + +
+
+ + + + + + Specifies the string by which the element's content is to be sorted; if unspecified, the content is used + + + + + + + + + + + + + + + + + An entry in a Glossary or GlossList + + + + + + + + + + + + + + + + + + + +
+
+ + + + + + Specifies a list of keywords for the definition + + + + + + + + + + + + + + + + + A definition in a GlossEntry + + + + + + + + + +
+
+ + + + + + Identifies the other term + + + + + + + + + + + + + + + + + + A cross-reference from one glossentry + to another + + + @otherterm on glosssee must point to a glossentry. + + + + + + + + +
+
+ + + + + + Identifies the other term + + + + + + + + + + + + + + + + + + A cross-reference from one GlossEntry to another + + + @otherterm on glossseealso must point to a glossentry. + + + + + + + + +
+
+ + + + + + + + + + + + + + + + The first occurrence of a term + + + @linkend on firstterm must point to a glossentry. + + + + + + + + +
+
+ + + + + + + + + + + + + + + + A glossary term + + + @linkend on glossterm must point to a glossentry. + + + + + + + + +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + A glossary + + + The root element must have a version attribute. + + + + + + + + + + + + + + + + + + + + +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + A division in a Glossary + + + + + + + + + + +
+
+ + + + + + + + + + + + + + + + + + + An inline definition of a term + + + A termdef must contain exactly one firstterm + + + + + + + + +
+ + + Identifies the relationship between the bibliographic elemnts + + +
+ + + + + + + + + + + + + + + An entry in a Bibliography + + + + + + +
+
+ + + + + + + + + + + + + + + An entry in a Bibliography + + + + + + + + + +
+
+ + + + + + + + + + + + + + + + + + + + + A raw container for related bibliographic information + + + + + + +
+
+ + + + + + + + + + + + + + + + + + + + + A cooked container for related bibliographic information + + + + + + + + + +
+
+ + + + + + + + + + + + + + + Untyped bibliographic information + + + + +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + A bibliography + + + The root element must have a version attribute. + + + + + + + + + + + + + + + + + + + + +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + A section of a Bibliography + + + + + + + + + + + + + +
+
+ + + + + + + + + + + + + + + + + + A wrapper for a list of bibliography entries + + + + + + + + + + + + + + + +
+
+ + + + + + + + + + + + The units (for example, pages) used to identify the beginning and ending of a reference. + + + + + + Identifies the beginning of a reference; the location within the work that is being referenced. + + + + + + Identifies the end of a reference. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + A cross-reference to a bibliographic entry + + + + +
+ + + normal + Normal + preferred + Preferred + + + + + Specifies the significance of the term + + + + + + Specifies the IDs of the elements to which this term applies + + + + + + Indicates the page on which this index term occurs in some version of the printed document + + + + + all + All indexes + global + The global index (as for a combined index of a set of box) + local + The local index (the index for this document only) + + + + + Specifies the scope of the index term + + + + + + Specifies the string by which the term is to be sorted; if unspecified, the term content is used + + + + + Specifies the target index for this term + + +
+ + + + + + + + + + + + + + + A set of index terms in the meta-information of a document + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + Identifies the class of index term + singular + A singular index term + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + A wrapper for an indexed term + + + + +
+
+ + + + + + Identifies the class of index term + startofrange + The start of a range + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + A wrapper for an indexed term that covers a range + + + + +
+
+ + + + + + Identifies the class of index term + endofrange + The end of a range + + + + + Points to the start of the range + + + + + + + + + + + + + + + + + Identifies the end of a range associated with an indexed term + + + + +
+
+ + + + + + + +
+
+ + + + + + + + + + + + + + + + + + The primary word or phrase under which an index term should be sorted + + + + + + +
+
+ + + + + + + + + + + + + + + + + + A secondary word or phrase in an index term + + + + + + +
+
+ + + + + + + + + + + + + + + + + + A tertiary word or phrase in an index term + + + + + + +
+
+ + + + + + + + + + + + + + + Part of an index term directing the reader instead to another entry in the index + + + + + + +
+
+ + + + + + + + + + + + + + + Part of an index term directing the reader also to another entry in the index + + + + + + +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + An index to a book or part of a book + + + The root element must have a version attribute. + + + + + + + + + + + + + + + + + + +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + An index to a set of books + + + The root element must have a version attribute. + + + + + + + + + + + + + + + + + +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + A division in an index + + + + + + + + + + + + + +
+
+ + + + + + + + + + + + + + + An entry in an index + + + + + + + + + + + + + + + + + + + + +
+
+ + + + + + + + + + + + + + + + + A primary term in an index entry, not in the text + + + + + + +
+
+ + + + + + + + + + + + + + + + + A secondary term in an index entry, rather than in the text + + + + + + +
+
+ + + + + + + + + + + + + + + + + A tertiary term in an index entry, rather than in the text + + + + + + +
+
+ + + + + + + + + + + + + + + + + A See +entry in an index, rather than in the text + + + + + + +
+
+ + + + + + + + + + + + + + + + + A See also + entry in an index, rather than in the text + + + + + + +
+ + + Indicates the page on which this element occurs in some version of the printed document + + +
+ + + + + + + + + + + + + + + + + + A table of contents + + + The root element must have a version attribute. + + + + + + + + + + + + + + + +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + A division in a table of contents + + + + + + + + + + + + + +
+
+ + + + + + + + + + + + + + + + + + + + + + + A component title in a table of contents + + + + + + +
+ + + +
+ + + + + + + + + + + + + + + A task to be completed + + + + + + + + + + + + + + + + + +
+
+ + + + + + + + + + + + + + + + + + A summary of a task + + + + + + + +
+
+ + + + + + + + + + + + + + + + + + The prerequisites for a task + + + + + + + +
+
+ + + + + + + + + + + + + + + + + + Information related to a task + + + + + + + +
+ + + calspair + Coordinates expressed as a pair of CALS graphic coordinates. + linecolumn + Coordinates expressed as a line and column. + linecolumnpair + Coordinates expressed as a pair of lines and columns. + linerange + Coordinates expressed as a line range. + + + + + + Identifies the units used in the coords attribute The default units vary according to the type of callout specified: calspair + for graphics and linecolumn + for line-oriented elements. + + + + + + + + Indicates that non-standard units are used for this area +. In this case otherunits + must be specified. + other + Coordinates expressed in some non-standard units. + + + + Identifies the units used in the coords + attribute when the units + attribute is other +. This attribute is forbidden otherwise. + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + A list of callout +s + + + + + + + + + + +
+
+ + + + + + Identifies the areas described by this callout. + + + + + + + + + + + + + + + A called out + description of a marked Area + + + + + + +
+
+ + + + + + + + + + + + + + + + + + A program listing with associated areas used in callouts + + + + + + + + + +
+
+ + + + + + + + + + + + + + + + A collection of regions in a graphic or code example + + + + + + + + + +
+
+ + + + + + Point to the callout +s which refer to this area. (This provides bidirectional linking which may be useful in online presentation.) + + + + + + Specifies an identifying number or string that may be used in presentation. The area label might be drawn on top of the figure, for example, at the position indicated by the coords attribute. + + + + + Provides the coordinates of the area. The coordinates must be interpreted using the units + specified. + + + + + + + + + + + + + + + + + + + + + + + + A region defined for a Callout in a graphic or code example + + + + + + +
+
+ + + + + + + + + + + + + + + + + + + + + + + A region defined for a Callout in a graphic or code example + + + + + + +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + A set of related areas in a graphic or code example + + + + + + +
+
+ + + + + + + + + + + + + + + + + + A screen with associated areas used in callouts + + + + + + + + + +
+
+ + + + + + + + + + + + + + + + + + A wrapper for an image object with callouts + + + + + + + + + + + +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + The location of a callout embedded in text + + + + +
+
+ + + + + + + + + + + + + + + + + + + + + A cross reference to a co + + + + +
+
+ + + + + + + + + + + + + + + + + + A set of EBNF productions + + + + + + + + + + +
+
+ + + + + + + + + + + + + + + A production in a set of EBNF productions + + + + + + + + +
+
+ + + + + + + + + + + + + + + The left-hand side of an EBNF production + + + + +
+
+ + + + + + + + + + + + + + + The right-hand side of an EBNF production + + + + + + + + + + + +
+
+ + + + + + Specifies a URI that points to a production +where the nonterminal + is defined + + + + + + + + + + + + + + + + A non-terminal in an EBNF production + + + + +
+
+ + + + + + + + + + + + + + + A constraint in an EBNF production + + + + +
+
+ + + + + + + + + + + + + + + A cross-reference to an EBNF production + + + + +
+
+ + + + + + + + + + + + + + + + + + The definition of a constraint in an EBNF production + + + + + + + +
+ + + Specifies the alignment character when align + is set to char +. + + + + + Specifies the percentage of the column's total width that should appear to the left of the first occurance of the character identified in char + when align + is set to char +. + + 0 + 100 + + + + + + Specifies how the table is to be framed. Note that there is no way to obtain a border on only the starting edge (left, in left-to-right writing systems) of the table. + + all + Frame all four sides of the table. In some environments with limited control over table border formatting, such as HTML, this may imply additional borders. + bottom + Frame only the bottom of the table. + none + Place no border on the table. In some environments with limited control over table border formatting, such as HTML, this may disable other borders as well. + sides + Frame the left and right sides of the table. + top + Frame the top of the table. + topbot + Frame the top and bottom of the table. + + + + + + Specifies the presence or absence of the column separator + + 0 + No column separator rule. + 1 + Provide a column separator rule on the right + + + + + + Specifies the presence or absence of the row separator + + 0 + No row separator rule. + 1 + Provide a row separator rule below + + + + + + Specifies the orientation of the table + + land + 90 degrees counter-clockwise from the rest of the text flow. + port + The same orientation as the rest of the text flow. + + + + + + Specifies the table style + + + + + Indicates whether or not the entries in the first column should be considered row headers + + firstcol + Indicates that entries in the first column of the table are functionally row headers (analogous to the way that a thead provides column headers). + norowheader + Indicates that entries in the first column have no special significance with respect to column headers. + + + + + + Specifies the horizontal alignment of text in an entry. + + center + Centered. + char + Aligned on a particular character. + justify + Left and right justified. + left + Left justified. + right + Right justified. + + + + + + Specifies the vertical alignment of text in an entry. + + bottom + Aligned on the bottom of the entry. + middle + Aligned in the middle. + top + Aligned at the top of the entry. + + + + + + Specifies a column specification by name. + + + + + Specifies a starting column by name. + + + + + Specifies a span by name. + + + + + + Specifies a starting column by name. + + + Specifies an ending column by name. + + + + + + + + + + + + + + Provides a name for a column specification. + + + + + Provides a name for a span specification. + + +
+ + + + + + Additional style information for downstream processing; typically the name of a style. + + + + + The number of columns in the table. Must be an integer greater than zero. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + A wrapper for the main content of a table, or part of a table + + + + + + + + + + + + + + + + +
+
+ + + + + + The number of the column to which this specification applies. Must be greater than any preceding column number. Defaults to one more than the number of the preceding column, if there is one, or one. + + + + + + Specifies the width of the column. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Specifications for a column in a table + + + + +
+
+ + + + + + Specifies a starting column by name. + + + + + Specifies an ending column by name. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Formatting information for a spanned column in a table + + + + +
+
+ + + + + + + + + + + + + + + + + + A table header consisting of one or more rows + + + + + + + + + +
+
+ + + + + + + + + + + + + + + + + + A table footer consisting of one or more rows + + + + + + + + + +
+
+ + + + + + + + + + + + + + + + + + A wrapper for the rows of a table or informal table + + + + + + +
+
+ + + + + + + + + + + + + + + + + + + + + A row in a table + + + + + + + + + +
+
+ + + + + + Specifies the number of additional rows which this entry occupies. Defaults to zero. + + + + + + Specifies the rotation of this entry. A value of 1 (true) rotates the cell 90 degrees counter-clockwise. A value of 0 (false) leaves the cell unrotated. + + 0 + Do not rotate the cell. + 1 + Rotate the cell 90 degrees counter-clockwise. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + A cell in a table + + + + + + + + + + + +
+
+ + + + + + Additional style information for downstream processing; typically the name of a style. + + + + + The number of columns in the entry table. Must be an integer greater than zero. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + A subtable appearing in place of an Entry in a table + + + + + + + + + + + + + +
+
+ + + + + + + + + + + + + + + + + + A table header consisting of one or more rows + + + + + + + + + +
+
+ + + + + + + + + + + + + + + + + + A wrapper for the rows of a table or informal table + + + + + + +
+
+ + + + + + + + + + + + + + + + + + + + + A row in a table + + + + + + +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Indicates if the short or long title should be used in a List of Tables + + 0 + Indicates that the full title should be used. + 1 + Indicates that the short short title (titleabbrev) should be used. + + + + + + Indicates if the table should appear in a List of Tables + + 0 + Indicates that the table should not occur in the List of Tables. + 1 + Indicates that the table should appear in the List of Tables. + + + + + + + + + + + + + + A formal table in a document + + + example must not occur in the descendants of table + + + + + figure must not occur in the descendants of table + + + + + equation must not occur in the descendants of table + + + + + informaltable must not occur in the descendants of table + + + + + caution must not occur in the descendants of table + + + + + important must not occur in the descendants of table + + + + + note must not occur in the descendants of table + + + + + tip must not occur in the descendants of table + + + + + warning must not occur in the descendants of table + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + A table without a title + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + This attribute assigns a class name or set of class names to an element. Any number of elements may be assigned the same class name or names. Multiple class names must be separated by white space characters. + + + + + This attribute specifies style information for the current element. + + + + + This attribute offers advisory information about the element for which it is set. + + + + + + + + This attribute specifies the base language of an element's attribute values and text content. The default value of this attribute is unknown. + + + + + + + + Occurs when the pointing device button is clicked over an element. + + + + + Occurs when the pointing device button is double clicked over an element. + + + + + Occurs when the pointing device button is pressed over an element. + + + + + Occurs when the pointing device button is released over an element. + + + + + Occurs when the pointing device is moved onto an element. + + + + + Occurs when the pointing device is moved while it is over an element. + + + + + Occurs when the pointing device is moved away from an element. + + + + + Occurs when a key is pressed and released over an element. + + + + + Occurs when a key is pressed down over an element. + + + + + Occurs when a key is released over an element. + + + + + + + + + + + + + + + + + Specifies the alignment of data and the justification of text in a cell. + + left + Left-flush data/Left-justify text. This is the default value for table data. + center + Center data/Center-justify text. This is the default value for table headers. + right + Right-flush data/Right-justify text. + justify + Double-justify text. + char + Align text around a specific character. If a user agent doesn't support character alignment, behavior in the presence of this value is unspecified. + + + + + + This attribute specifies a single character within a text fragment to act as an axis for alignment. The default value for this attribute is the decimal point character for the current language as set by the lang attribute (e.g., the period in English and the comma in French). User agents are not required to support this attribute. + + + + + When present, this attribute specifies the offset to the first occurrence of the alignment character on each line. If a line doesn't include the alignment character, it should be horizontally shifted to end at the alignment position. When charoff is used to set the offset of an alignment character, the direction of offset is determined by the current text direction (set by the dir attribute). In left-to-right texts (the default), offset is from the left margin. In right-to-left texts, offset is from the right margin. User agents are not required to support this attribute. + + + + [0-9]+% + + + + + + + + + + Specifies the vertical position of data within a cell. + + top + Cell data is flush with the top of the cell. + middle + Cell data is centered vertically within the cell. This is the default value. + bottom + Cell data is flush with the bottom of the cell. + baseline + All cells in the same row as a cell whose valign attribute has this value should have their textual data positioned so that the first text line occurs on a baseline common to all cells in the row. This constraint does not apply to subsequent text lines in these cells. + + + + + + + + + Provides a summary of the table's purpose and structure for user agents rendering to non-visual media such as speech and Braille. + + + + + Specifies the desired width of the entire table and is intended for visual user agents. When the value is a percentage value, the value is relative to the user agent's available horizontal space. In the absence of any width specification, table width is determined by the user agent. + + + + [0-9]+% + + + + + + + Specifies the width (in pixels only) of the frame around a table. + + + + + + Specifies which sides of the frame surrounding a table will be visible. + + void + No sides. This is the default value. + above + The top side only. + below + The bottom side only. + hsides + The top and bottom sides only. + lhs + The left-hand side only. + rhs + The right-hand side only. + vsides + The right and left sides only. + box + All four sides. + border + All four sides. + + + + + + Specifies which rules will appear between cells within a table. The rendering of rules is user agent dependent. + + none + No rules. This is the default value. + groups + Rules will appear between row groups (see thead, tfoot, and tbody) and column groups (see colgroup and col) only. + rows + Rules will appear between rows only. + cols + Rules will appear between columns only. + all + Rules will appear between all rows and columns. + + + + + + Specifies how much space the user agent should leave between the left side of the table and the left-hand side of the leftmost column, the top of the table and the top side of the topmost row, and so on for the right and bottom of the table. The attribute also specifies the amount of space to leave between cells. + + + + [0-9]+% + + + + + + + Specifies the amount of space between the border of the cell and its contents. If the value of this attribute is a pixel length, all four margins should be this distance from the contents. If the value of the attribute is a percentage length, the top and bottom margins should be equally separated from the content based on a percentage of the available vertical space, and the left and right margins should be equally separated from the content based on a percentage of the available horizontal space. + + + + [0-9]+% + + + + + + + + + + + Provides an abbreviated form of the cell's content and may be rendered by user agents when appropriate in place of the cell's content. Abbreviated names should be short since user agents may render them repeatedly. For instance, speech synthesizers may render the abbreviated headers relating to a particular cell before rendering that cell's content. + + + + + This attribute may be used to place a cell into conceptual categories that can be considered to form axes in an n-dimensional space. User agents may give users access to these categories (e.g., the user may query the user agent for all cells that belong to certain categories, the user agent may present a table in the form of a table of contents, etc.). Please consult an HTML reference for more details. + + + + + Specifies the list of header cells that provide header information for the current data cell. The value of this attribute is a space-separated list of cell names; those cells must be named by setting their id attribute. Authors generally use the headers attribute to help non-visual user agents render header information about data cells (e.g., header information is spoken prior to the cell data), but the attribute may also be used in conjunction with style sheets. + + + + + Specifies the set of data cells for which the current header cell provides header information. This attribute may be used in place of the headers attribute, particularly for simple tables. + + row + The current cell provides header information for the rest of the row that contains it + col + The current cell provides header information for the rest of the column that contains it. + rowgroup + The header cell provides header information for the rest of the row group that contains it. + colgroup + The header cell provides header information for the rest of the column group that contains it. + + + + + + Specifies the number of rows spanned by the current cell. The default value of this attribute is one (1 +). The value zero (0 +) means that the cell spans all rows from the current row to the last row of the table section (thead +, tbody +, or tfoot +) in which the cell is defined. + + + + + + Specifies the number of columns spanned by the current cell. The default value of this attribute is one (1 +). The value zero (0 +) means that the cell spans all columns from the current column to the last column of the column group (colgroup +) in which the cell is defined. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + A formal (captioned) HTML table in a document + + + example must not occur in the descendants of table + + + + + figure must not occur in the descendants of table + + + + + equation must not occur in the descendants of table + + + + + informaltable must not occur in the descendants of table + + + + + caution must not occur in the descendants of table + + + + + important must not occur in the descendants of table + + + + + note must not occur in the descendants of table + + + + + tip must not occur in the descendants of table + + + + + warning must not occur in the descendants of table + + + + + + +
+
+ + + + + + + + + An HTML table without a title + + + + +
+
+ + + + + + An HTML table caption + + + example must not occur in the descendants of caption + + + + + figure must not occur in the descendants of caption + + + + + table must not occur in the descendants of caption + + + + + equation must not occur in the descendants of caption + + + + + sidebar must not occur in the descendants of caption + + + + + task must not occur in the descendants of caption + + + + + caution must not occur in the descendants of caption + + + + + important must not occur in the descendants of caption + + + + + note must not occur in the descendants of caption + + + + + tip must not occur in the descendants of caption + + + + + warning must not occur in the descendants of caption + + + + + + + + +
+
+ + + + + + This attribute, whose value must be an integer > 0, specifies the number of columns spanned + by the col + element; the col + element shares its attributes with all the columns it spans. The default value for this attribute is 1 (i.e., a single column). If the span attribute is set to N > 1, the current col + element shares its attributes with the next N-1 columns. + + + + + + Specifies a default width for each column spanned by the current col + element. It has the same meaning as the width + attribute for the colgroup + element and overrides it. + + + + + + + + + Specifications for a column in an HTML table + + + + +
+
+ + + + + + This attribute, which must be an integer > 0, specifies the number of columns in a column group. In the absence of a span attribute, each colgroup + defines a column group containing one column. If the span attribute is set to N > 0, the current colgroup + element defines a column group containing N columns. User agents must ignore this attribute if the colgroup + element contains one or more col + elements. + + + + + + This attribute specifies a default width for each column in the current column group. In addition to the standard pixel, percentage, and relative values, this attribute allows the special form 0* + (zero asterisk) which means that the width of the each column in the group should be the minimum width necessary to hold the column's contents. This implies that a column's entire contents must be known before its width may be correctly computed. Authors should be aware that specifying 0* + will prevent visual user agents from rendering a table incrementally. This attribute is overridden for any column in the column group whose width is specified via a col + element. + + + + + + + + + A group of columns in an HTML table + + + + + + +
+
+ + + + + + + + + + A table header consisting of one or more rows in an HTML table + + + + + + +
+
+ + + + + + + + + + A table footer consisting of one or more rows in an HTML table + + + + + + +
+
+ + + + + + + + + + A wrapper for the rows of an HTML table or informal HTML table + + + + + + +
+
+ + + + + + + + + + A row in an HTML table + + + + + + + + + +
+
+ + + + + + + + + + + A table header entry in an HTML table + + + + + + + + + + + +
+
+ + + + + + + + + + + A table entry in an HTML table + + + + + + + + + + + +
+
+ + + + + + + + + + + + + + + + + + A detailed set of messages, usually error messages + + + + + + + + + + + + +
+
+ + + + + + + + + + + + + + + A wrapper for an entry in a message set + + + + + + + + + + + + +
+
+ + + + + + The audience to which the message relevant + + + + + The origin of the message + + + + + The level of importance or severity of a message + + + + + + + + + + + + + + + + + + + + + + + A wrapper for a simpler entry in a message set + + + + + + + +
+
+ + + + + + + + + + + + + + + + + + A message in a message set + + + + + + + + + + + +
+
+ + + + + + + + + + + + + + + + + + The primary component of a message in a message set + + + + + +
+
+ + + + + + + + + + + + + + + + + + A subcomponent of a message in a message set + + + + + +
+
+ + + + + + + + + + + + + + + + + + A related component of a message in a message set + + + + + +
+
+ + + + + + + + + + + + + + + The actual text of a message component in a message set + + + + + + +
+
+ + + + + + + + + + + + + + + Information about a message in a message set + + + + + + + + + + +
+
+ + + + + + + + + + + + + + + The level of importance or severity of a message in a message set + + + + +
+
+ + + + + + + + + + + + + + + The origin of a message in a message set + + + + +
+
+ + + + + + + + + + + + + + + The audience to which a message in a message set is relevant + + + + +
+
+ + + + + + + + + + + + + + + + + + Explanatory material relating to a message in a message set + + + + + + + +
+
+ + + + + + none + No labels + number + Numeric labels + qanda + "Q:" and "A:" labels + + + + + Specifies the default labelling + + + + + + + + + + + + + + + + + + + + + A question-and-answer set + + + + + + + + + + + + + + + +
+
+ + + + + + + + + + + + + + + + + + A titled division in a QandASet + + + + + + + + + + + + + + + +
+
+ + + + + + + + + + + + + + + + + + A question/answer set within a QandASet + + + + + + + + +
+
+ + + + + + + + + + + + + + + A question in a QandASet + + + + + + + + + +
+
+ + + + + + + + + + + + + + + An answer to a question posed in a QandASet + + + + + + + + + +
+
+ + + + + + + + + + + + + + + A label on a Question or Answer + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + A displayed mathematical equation + + + example must not occur in the descendants of equation + + + + + figure must not occur in the descendants of equation + + + + + table must not occur in the descendants of equation + + + + + equation must not occur in the descendants of equation + + + + + caution must not occur in the descendants of equation + + + + + important must not occur in the descendants of equation + + + + + note must not occur in the descendants of equation + + + + + tip must not occur in the descendants of equation + + + + + warning must not occur in the descendants of equation + + + + + + + + + + + + + +
+
+ + + + + + + + + + + + + + + + + + A displayed mathematical equation without a title + + + + + + + + + + + +
+
+ + + + + + + + + + + + + + + A mathematical equation or expression occurring inline + + + + + + + +
+
+ + + + + + + + + + + + + + + A mathematical phrase, an expression that can be represented with ordinary text and a small amount of markup + + + + + + + + + + +
+
+ + + + + + + + + + + + Specifies that the format of the data is MathML + mathml + Specifies MathML. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + A MathML expression in a media object + + + + + + + +
+
+ + + Any element from the MathML namespace + + + + + + + + + + +
+
+ + + + + + + + + + + + Specifies that the format of the data is SVG + svg + Specifies SVG. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + An SVG drawing in a media object + + + + + + + +
+
+ + + Any element from the SVG namespace + + + + + + + + + + +
+ + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + A string of formatting markup in text that is to be represented literally + + + + +
+
+ + + + + + attribute + An attribute + attvalue + An attribute value + element + An element + emptytag + An empty element tag + endtag + An end tag + genentity + A general entity + localname + The local name part of a qualified name + namespace + A namespace + numcharref + A numeric character reference + paramentity + A parameter entity + pi + A processing instruction + prefix + The prefix part of a qualified name + comment + An SGML comment + starttag + A start tag + xmlpi + An XML processing instruction + + + + + Identifies the nature of the tag content + + + + + + Identifies the namespace of the tag content + + + + + + + + + + + + + + + + + + + + + A component of XML (or SGML) markup + + + + +
+
+ + + Identifies the class of symbol + limit + The value is a limit of some kind + + + + + + + + + + + + + + + + + + + + A name that is replaced by a value before processing + + + + +
+
+ + + + + + + + + + + + + + + A unit of information + + + + +
+
+ + + + + + + + + + + + + + + Inline text that is some literal value + + + + +
+
+ + + Identifies the (computer) language of the code fragment + + + + + + + + + + + + + + + + + + + + An inline code fragment + + + + + + + + + +
+
+ + + Identifies the class of constant + limit + The value is a limit of some kind + + + + + + + + + + + + + + + + + + + + A programming or system constant + + + + +
+
+ + + + + + copyright + A name with a copyright + registered + A name with a registered copyright + service + A name of a service + trade + A name which is trademarked + + + + + Specifies the class of product name + + + + + + + + + + + + + + + + + + The formal name of a product + + + + +
+
+ + + + + + + + + + + + + + + A number assigned to a product + + + + +
+
+ + + altkey + An alternate or secondary key + constraint + A constraint + datatype + A data type + field + A field + foreignkey + A foreign key + group + A group + index + An index + key1 + The first or primary key + key2 + An alternate or secondary key + name + A name + primarykey + The primary key + procedure + A (stored) procedure + record + A record + rule + A rule + secondarykey + The secondary key + table + A table + user + A user + view + A view + + + + + Identifies the class of database artifact + + + + + + + + + + + + + + + + + + + + + The name of a database, or part of a database + + + + +
+
+ + + hardware + A hardware application + software + A software application + + + + + Identifies the class of application + + + + + + + + + + + + + + + + + + + + + The name of a software program + + + + +
+
+ + + + + + + + + + + + + + + A physical part of a computer system + + + + +
+ + + + + + + + + + + + +
+ + + + + + + + + + + + + + + The text on a button in a GUI + + + + + + + + + + + +
+
+ + + + + + + + + + + + + + + Graphic and/or text appearing as a icon in a GUI + + + + + + + + + + + +
+
+ + + + + + + + + + + + + + + The text of a label in a GUI + + + + + + + + + + + +
+
+ + + + + + + + + + + + + + + The name of a menu in a GUI + + + + + + + + + + + +
+
+ + + + + + + + + + + + + + + The name of a terminal menu item in a GUI + + + + + + + + + + + +
+
+ + + + + + + + + + + + + + + The name of a submenu in a GUI + + + + + + + + + + + +
+
+ + + + + + + + + + + + + + + A selection or series of selections from a menu + + + + + + + + + + + + + + + + +
+
+ + + + + + + + + + + + + + + The conventional name of a mouse button + + + + +
+ + + + + + + + + + +
+ + + alt + The "Alt" key + backspace + The "Backspace" key + command + The "Command" key + control + The "Control" key + delete + The "Delete" key + down + The down arrow + end + The "End" key + enter + The "Enter" or "Return" key + escape + The "Escape" key + home + The "Home" key + insert + The "Insert" key + left + The left arrow + meta + The "Meta" key + option + The "Option" key + pagedown + The page down key + pageup + The page up key + right + The right arrow + shift + The "Shift" key + space + The spacebar + tab + The "Tab" key + up + The up arrow + + + + + + Identifies the function key + + + + + + + + Identifies the function key + other + Indicates a non-standard function key + + + + Specifies a keyword that identifies the non-standard key + + + + + + + + + + + + + + + + + + + + + + + + The text printed on a key on a keyboard + + + + +
+
+ + + + + + + + + + + + + + + The internal, frequently numeric, identifier for a key on a keyboard + + + + +
+ + + + + + + + + + +
+ + + click + A (single) mouse click. + double-click + A double mouse click. + press + A mouse or key press. + seq + Sequential clicks or presses. + simul + Simultaneous clicks or presses. + + + + + + Identifies the nature of the action taken. If keycombo + contains more than one element, simul + is the default, otherwise there is no default. + + + + + + + + Identifies the nature of the action taken + other + Indicates a non-standard action + + + + Identifies the non-standard action in some unspecified way. + + + + + + + + + + + + + + + + + + + + + + + + A combination of input actions + + + + + + +
+
+ + + + + + + + + + + + + + + The symbolic name of a key on a keyboard + + + + +
+
+ + + + + + + + + + + + + + + A graphical user interface (GUI) keyboard shortcut + + + + +
+
+ + + + + + + + + + + + + + + + + + + A key combination for an action that is also accessible through a menu + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + A character or string indicating the start of an input field in a computer display + + + + + + +
+
+ + + + + + + + + + + + + + + A software environment variable + + + + +
+
+ + + devicefile + A device + directory + A directory + extension + A filename extension + headerfile + A header file (as for a programming language) + libraryfile + A library file + partition + A partition (as of a hard disk) + symlink + A symbolic link + + + + + Identifies the class of filename + + + + + + Specifies the path of the filename + + + + + + + + + + + + + + + + + + + + + + + The name of a file + + + + +
+
+ + + + + + + + + + + + + + + The name of an executable program or other software command + + + + +
+
+ + + + + + + + + + + + + + + Data, generally text, displayed or presented by a computer + + + + + + +
+
+ + + + + + + + + + + + + + + Data entered by the user + + + + + + +
+
+ + + + + + Specifies the character that should separate the command and its top-level arguments + + + + + Indicates the displayed length of the command; this information may be used to intelligently indent command synopses which extend beyond one line + + + + + + + + + + + + + + + + + + + + + + + + + + + + + A syntax summary for a software command + + + + + + + + + + + + + + + +
+ + + norepeat + Can not be repeated. + repeat + Can be repeated. + + + + + Indicates whether or not repetition is possible. + + + + + + opt + Formatted to indicate that it is optional. + plain + Formatted without indication. + req + Formatted to indicate that it is required. + + + + + Indicates optionality. + + + + + + Indicates optionality. + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + An argument in a CmdSynopsis + + + + + + + + + + + + + +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + A group of elements in a CmdSynopsis + + + + + + + + + + + + + +
+
+ + + + + + + + + + + + + + An explicit line break in a command synopsis + + + + +
+
+ + + + + + + + + + + + + + + A portion of a CmdSynopsis broken out from the main body of the synopsis + + + + + + + + + +
+
+ + + + + + + + + + + + + + + A reference to a fragment of a command synopsis + + + @linkend on synopfragmentref must point to a synopfragment. + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + A general-purpose element for representing the syntax of commands or functions + + + + +
+
+ + + + + + + + + + + + + + + + + + + + + The syntax summary for a function definition + + + + + + + + + + +
+
+ + + + + + + + + + + + + + + + Information supplementing the FuncDefs of a FuncSynopsis + + + + +
+
+ + + + + + + + + + + + + + + The prototype of a function + + + + + + + + + + + + + + + + + + + + + + +
+
+ + + + + + + + + + + + + + + A function (subroutine) name and its return type + + + + + + + + + + +
+
+ + + + + + + + + + + + + + + The name of a function or subroutine, as in a programming language + + + + +
+
+ + + + + + + + + + + + + + + An empty element in a function synopsis indicating that the function in question takes no arguments + + + + +
+
+ + + + + + + + + + + + + + + An empty element in a function synopsis indicating a variable number of arguments + + + + +
+
+ + + + + + opt + Formatted to indicate that it is optional. + req + Formatted to indicate that it is required. + + + + + Indicates optionality. + + + + + + + + + + + + + + + + + + Information about a function parameter in a programming language + + + + + + + + + + + + +
+
+ + + + + + + + + + + + + + + Parameters for a function referenced through a function pointer in a synopsis + + + + +
+
+ + + + + + class + This is the synopsis of a class + interface + This is the synopsis of an interface + + + + + Specifies the nature of the synopsis + + + + + + + + + + + + + + + + + + + + + The syntax summary for a class definition + + + + + + + + + + + + + + + +
+
+ + + + + + + + + + + + + + + + Information supplementing the contents of a ClassSynopsis + + + + +
+
+ + + + + + + + + + + + + + + A class in an object-oriented programming language + + + + + + + + + + +
+
+ + + + + + + + + + + + + + + An interface in an object-oriented programming language + + + + + + + + + + +
+
+ + + + + + + + + + + + + + + An exception in an object-oriented programming language + + + + + + + + + + +
+ + + Can be used to indicate that whitespace in the modifier should be preserved (for multi-line annotations, for example). + preserve + Extra whitespace and line breaks must be preserved. + + + +
+ + + + + + + + + + + + + + + + + + Modifiers in a synopsis + + + + +
+
+ + + + + + + + + + + + + + + The name of an interface + + + + +
+
+ + + + + + + + + + + + + + + The name of an exception + + + + +
+
+ + + + + + + + + + + + + + + + + + The name of a field in a class definition + + + + + + + + + + + + + +
+
+ + + + + + + + + + + + + + + The initializer for a FieldSynopsis + + + + +
+
+ + + + + + + + + + + + + + + + + + A syntax summary for a constructor + + + + + + + + + + + + + + + + + + + + +
+
+ + + + + + + + + + + + + + + + + + A syntax summary for a destructor + + + + + + + + + + + + + + + + + + + + +
+
+ + + + + + + + + + + + + + + + + + A syntax summary for a method + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + + + + + + + + + + + + + + The name of a method + + + + +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + Parameters to a method + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + + + + + + + + + + + + + + The name of a variable + + + + +
+
+ + + + + + + + + + + + + + + The value returned by a function + + + + +
+
+ + + + + + + + + + + + + + + The classification of a value + + + + +
+
+ + + + + + + + + + + + + + + The name of a class, in the object-oriented programming sense + + + + +
+
+ + + + + + + + + + + + + + + + + + + + + + A literal listing of all or part of a program + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + A note of caution + + + caution must not occur in the descendants of caution + + + + + important must not occur in the descendants of caution + + + + + note must not occur in the descendants of caution + + + + + tip must not occur in the descendants of caution + + + + + warning must not occur in the descendants of caution + + + + + + +
+
+ + + + + + + + + + + + + + + An admonition set off from the text + + + caution must not occur in the descendants of important + + + + + important must not occur in the descendants of important + + + + + note must not occur in the descendants of important + + + + + tip must not occur in the descendants of important + + + + + warning must not occur in the descendants of important + + + + + + +
+
+ + + + + + + + + + + + + + + A message set off from the text + + + caution must not occur in the descendants of note + + + + + important must not occur in the descendants of note + + + + + note must not occur in the descendants of note + + + + + tip must not occur in the descendants of note + + + + + warning must not occur in the descendants of note + + + + + + +
+
+ + + + + + + + + + + + + + + A suggestion to the user, set off from the text + + + caution must not occur in the descendants of tip + + + + + important must not occur in the descendants of tip + + + + + note must not occur in the descendants of tip + + + + + tip must not occur in the descendants of tip + + + + + warning must not occur in the descendants of tip + + + + + + +
+
+ + + + + + + + + + + + + + + An admonition set off from the text + + + caution must not occur in the descendants of warning + + + + + important must not occur in the descendants of warning + + + + + note must not occur in the descendants of warning + + + + + tip must not occur in the descendants of warning + + + + + warning must not occur in the descendants of warning + + + + + + +
+ + + + + + + + +
+ + + + + + + + + + + + + + + An error code + + + + +
+
+ + + + + + + + + + + + + + + An error name + + + + +
+
+ + + + + + + + + + + + + + + An error message. + + + + +
+
+ + + + + + + + + + + + + + + The classification of an error message + + + + +
+ + + + + + +
+ + + daemon + A daemon or other system process (syslogd) + domainname + A domain name (example.com) + etheraddress + An ethernet address (00:05:4E:49:FD:8E) + event + An event of some sort (SIGHUP) + eventhandler + An event handler of some sort (hangup) + filesystem + A filesystem (ext3) + fqdomainname + A fully qualified domain name (my.example.com) + groupname + A group name (wheel) + ipaddress + An IP address (127.0.0.1) + library + A library (libncurses) + macro + A macro + netmask + A netmask (255.255.255.192) + newsgroup + A newsgroup (comp.text.xml) + osname + An operating system name (Hurd) + process + A process (gnome-cups-icon) + protocol + A protocol (ftp) + resource + A resource + server + A server (mail.example.com) + service + A service (ppp) + systemname + A system name (hephaistos) + username + A user name (ndw) + + + + + Identifies the nature of the system item + + + + + + + + + + + + + + + + + + + + + A system-related item or term + + + + + + +
+
+ + + + + + + + + + + + + + + An option for a software command + + + + +
+
+ + + + + + + + + + + + + + + Optional information + + + + +
+
+ + + + + + + + + + + + + + + A unit of data associated with some part of a computer system + + + + +
+