A summary of the content with which it is associated.
Provided for compatibility with third-party documentation. Not used in Novell documentation.
An appendix in a book.
The name of a software program.
Provided for compatibility with third-party documentation. Not used in Novell documentation.
Holds information about the author of the document in which it occurs.
Provided for compatibility with third-party documentation. Not used in Novell documentation.
Wrapper for author information when a document has multiple authors or collaborators.
Provided for compatibility with third-party documentation. Not used in Novell documentation.
In DocSys, a wrapper that groups several elements together for profiling or to create a shared element.
A complete book.
In DocSys, this element is used to create the front matter for a Novell book.
In FrameMaker, creating a BookInfo file brings in all the required elements and the standard boilerplate content.
A free-floating heading.
A visual device for associating annotations with an image, program listing, or similar figure.
This element, along with co and calloutlist, allows you to cross-reference from running text to a line within a code sample that uses the screen element. It is not the same thing as a graphic callout. Not used in Novell documentation.
This element, along with co and callout, allows you to cross-reference from running text to a line within a code sample that uses the screen element. It is not the same thing as a graphic callout.
Not used in Novell documentation.
In DocSys versions dated 07-19-2012 and later, the Entry element is automatically renamed to Cell to be consistent with standard industry and word processor usage. The Entry element is no longer available.
In DocSys versions dated 07-19-2012 or later, this element is used in creating a NetIQ checklist table. It adds a sequence of numbers to the first paragraph in each table cell.
Chapter of a book.
Provides inline markup for the title of a cited work. In DocSys, it produces italicized text.
The location of a callout embedded in text.
Don’t use it in DocSys documentation.
Specifications for a column in a table.
The name of an executable program or other software command. In DocSys, it produces a monospace font.
The date a document is posted on the Novell Documentation Web site.
A DocSys element used only in the BookInfo file.
A text description of a graphic.
In DocSys, this element is used to provide accessibility for people who are visually impaired. Its content is converted to the alt= tag when the document is exported to HTML, so the text can be voiced in a screen reader. The text also pops up when you mouse over the graphic.
Emphasized text.
In DocSys9, you can use the Emphasis element to produce bold text within extended code or syntax examples that use the Screen element. For example, you might want to tell users to search for a particular line and change it in some way. In DocSys10, the Emphasis element produces italic text wherever it is used, so you should use the Strong element if you need inline bold text.
In Novell documentation, inline bold is approved for use only within the Screen element, and it is intended for use only in extended examples, not in examples that have a few lines or a single line.
When you update a DocSys9 document to DocSys10, all Emphasis elements within tables or within Screen elements are automatically updated to use the Strong element.
A DocSys element used for inline boilerplate words or phrases that are set up to change according to the desired output.
A software environment variable.
Not used in Novell documentation.
A formal example, with a title.
Not used in Novell documentation.
A figure with a title. In DocSys, inserting the Figure element also adds the ImageData, ImageObject, and MediaObject elements.
The name of a file. It can be a simple name or can include a path or other elements specific to the operating system.
The first name of a person.
Provided for compatibility with third-party documentation. Not used in Novell documentation.
A paragraph with a run-in title.
A glossary containing a collection of terms and brief descriptions or definitions of those terms.
A definition in a GlossEntry, containing the description or definition of a GlossTerm.
A division in a glossary, such as an alphabetical division. A glossary can contain any number of GlossEntry or GlossDiv elements, but it cannot contain a mixture of both at the same level.
A wrapper around a glossary term and its definition.
Identifies a term that appears in a glossary.
The name of a menu in a graphical user interface.
In DocSys, used to identify most graphical user interface items.
Points to an external entity containing graphical image data. Used with ImageObject and MediaObject to create a Figure, InformalFigure, or InlineMediaObject.
A wrapper for image data and its associated meta-information. Used with ImageData and MediaObject to create a Figure, InformalFigure, or InlineMediaObject.
An admonition set off from the text.
A wrapper for terms to be indexed.
The Index elements are valid in FrameMaker and can be used to create Help indexes, but we don’t have a process in place for adding indexes to books.
A figure without a title. In DocSys, inserting the InformalFigure element also adds the ImageData, ImageObject, and MediaObject elements.
A table without a title.
In DocSys, inserting the InformalTable element also brings in the TGroup, THead, TBody, Row, and Entry elements.
An inline media object (video, audio, image, and so on). In DocSys, inserting the InlinMediaObject element also adds the ImageObject and ImageData elements.
An introductory paragraph associated with a FormalPara element.
A DocSys element you can use when you want an introductory paragraph to stay with a FormalPara instead of being separated from it by a page break.
Avoid using this element to simply clean up page breaks, because it can create unexpected white space in localized documentation where page breaks appear in different places than they do in English documentation.
An introductory paragraph associated with a figure, table, procedure, or paragraph.
A DocSys element you can use when you want an introductory paragraph to stay with a figure, table, procedure, or another paragraph instead of being separated from it by a page break.
Avoid using this element to simply clean up page breaks, because it can create unexpected white space in localized documentation where page breaks appear in different places than they do in English documentation.
A list in which each entry is marked with a bullet, dash, or other symbol.
The text printed on a key on a keyboard.
Provided for compatibility with third-party documentation. Not used in Novell documentation.
For actions that require multiple keystrokes, mouse actions, or other physical input selections, the KeyCombo element provides a wrapper for the entire set of events.
Provided for compatibility with third-party documentation. Not used in Novell documentation.
A statement of legal obligations or requirements.
In DocSys, this element is used in the BookInfo file.
A hypertext link. Usually, Link surrounds the text that should be made “hot” (unlike XRef, which must generate the text).
Produces bold, italicized inline text for If statements in NetIQ procedures.
Use only in NetIQ documents, not Novell documents.
A wrapper for the elements of a list item.
A child of the ItemizedList and OrderedList elements.
Inline text that is a specific piece of data, taken literally from a computer system.
In DocSys, the inline equivalent of the Screen element.
A text description of a graphic.
A DocSys element used to provide accessibility for people who are visually impaired. The content of the element is converted to the longdesc= tag when the document is exported to HTML, so the text can be voiced in a screen reader. Unlike the Description element, the text does not pop up when you mouse over the graphic.
Provided for compatibility with third-party documentation. Not used in Novell documentation.
A displayed media object (video, audio, image, and so forth). Used with ImageObject and ImageData to create a Figure or InformalFigure.
An element of a SimpleList.
A selection or series of selections from a menu.
In DocSys, an element that wraps two or more GUIMenu items to indicate that they are a menu navigation path.
Explanatory material relating to a message in a message set. Contains a headword such as Source, Severity, Problem, Possible Cause, Explanation, or Action, followed by explanatory material.
A child of the SimpleMsgEntry element.
A detailed set of messages, usually error messages.
The actual text of a message component in a message set.
A child of the MsgSet element.
In DocSys, this element is used to create the front matter for a NetIQ book.
In FrameMaker, creating a NetIQBookInfo file brings in all the required elements and the standard boilerplate content.
A message set off from the text.
An an optional argument to a software command.
Not used in Novell documentation.
In DocSys, an element used to prevent choices or alternatives within a procedure from being separated from their introductory text.
Avoid using this element to simply clean up page breaks, because it can create unexpected white space in localized documentation where page breaks appear in different places than they do in English documentation.
A list in which each entry is marked with a sequentially incremented label, such as a numeral, letter, or other sequential symbol (for example, Roman numerals).
In DocSys, this element is used to create the front matter for an open source book.
In Frame, creating an OSBookInfo file brings in all the required elements and the standard boilerplate content. It is distinguished from the Bookinfo file because the format contains no Novell branding, and the boilerplate Legal Notices section contains the GNU Free Documentation License text.
In DocSys documentation for open source projects, a short document used to step an administrator or user through a high-level process such as installation or configuration, or when you want to acquaint a user with the basic interface for an application. It is distinguished from the QuickStart because the format contains no Novell branding and the boilerplate text in the QSLegal section contains the GNU Free Documentation License text.
Inserting an OSQuickStart element also brings in the Title, SubTitle, QSIntro, and QSLegal elements.
In DocSys open source documentation, an element used to create Readme file to be included with software or posted on a Web site. It is distinguished from the Readme because the format contains no Novell branding, and the boilerplate Legal Notices section contains the GNU Free Documentation License text.
Inserting a Readme element also brings in the Title and SubTitle elements, along with boilerplate Legal Notices text.
A paragraph.
A division in a book.
Introductory text, often an overview of the content of the Part.
A span of text. Used as a wrapper around a selection of words smaller than a paragraph so that it is possible to provide an ID or other attributes for them
In DocSys, this element is used for profiling phrases within a paragraph.
Introductory matter preceding the first chapter of a book.
In DocSys, a Preface is required content for a book.
The primary word or phrase under which an index term should be sorted.
The Index elements are valid in FrameMaker and can be used to create Help indexes, but we don’t have a process in place for adding indexes to books.
Encapsulates a task composed of steps.
The formal name of a product.
In DocSys, this element is used only in the BookInfo file. Don’t use it in running text.
A number assigned to a product.
Contains only text (no inline elements). In DocSys, this element is used only in the BookInfo file in templates prior to DocSys10.
A DocSys element that creates a page-wide introductory section for a QuickStart or OSQuickStart The rest of the Quick Start uses a two-column format.
A DocSys element that creates a statement of legal obligations or requirements for a QuickStart or OSQuickStart.
A DocSys element that creates a short document used to step an administrator or user through a high-level process such as installation or configuration, or when you want to acquaint a user with the basic interface for an application.
Inserting a QuickStart element also brings in the Title, SubTitle, QSIntro, and QSLegal elements.
An inline quotation.
A DocSys element that creates a Readme file to be included with software or posted on the Novell Documentation Web site.
Inserting a Readme element also brings in the Title and SubTitle elements, along with boilerplate Legal Notices text.
The scope or other indication of applicability of a reference entry.
In DocSys, this element is used for man pages and for developer documentation.
A wrapper for any small unit of reference documentation describing a single topic. Canonical examples are programming language functions and user commands (one refentry per function or command).
In DocSys, this element is used for man pages and for developer documentation.
The title of a reference page.
In DocSys, this element is used for man pages and for developer documentation.
Meta-information for a reference entry, including the title of the reference page, the number of the volume in which this reference page occurs, and possibly other miscellaneous information.
In DocSys, this element is used for man pages and for developer documentation.
The name of one of the subjects of a reference page.
In DocSys, this element is used for man pages and for developer documentation. You can adapt this information if you are creating developer documentation.
The name, purpose, and classification of a reference page. Usually a section heading in the same typographic style as a RefSect1 Title.
In DocSys, this element is used for man pages and for developer documentation. You can adapt this information if you are creating developer documentation.
A short (one sentence) synopsis of the topic of a reference page.
In DocSys, this element is used for man pages and for developer documentation. You can adapt this information if you are creating developer documentation.
A major subsection of a reference entry.
In DocSys, this element is used for man pages and for developer documentation. You can adapt this information if you are creating developer documentation.
A subsection of a RefSect1.
In DocSys, this element is used for man pages and for developer documentation. You can adapt this information if you are creating developer documentation.
A subsection of a RefSect2.
In DocSys, this element is used for man pages and for developer documentation. You can adapt this information if you are creating developer documentation.
A remark (or comment) intended for presentation in a draft manuscript.
In DocSys, Remark is a non-printing element, so anything marked with it is hidden during print prep.
Content that can or must be replaced by the user. In DocSys, it produces italicized text.
Text that a user sees or might see on a computer screen.
The standalone equivalent of the Literal element. In DocSys, it produces a monospaced font.
In DocSys, non-printing text used to describe the steps needed for the localization team to take a screen shot.
A secondary word or phrase in an index term.
The Index elements are valid in FrameMaker and can be used to create Help indexes, but we don’t have a process in place for adding indexes to books.
A top-level section of document. Sometimes called a “first-level heading.”
A subsection within a Sect1. Sometimes called a “second-level heading.”
A subsection within a Sect2. Sometimes called a “third-level heading.”
A subsection within a Sect3. Sometimes called a “fourth-level heading”
In DocSys, a wrapper that groups all of the content under a heading for profiling or to create a shared element.
Part of an index term directing the reader to another entry in the index.
The Index elements are valid in FrameMaker and can be used to create Help indexes, but we don’t have a process in place for adding indexes to books.
Part of an index term directing the reader also to another entry in the index.
The Index elements are valid in FrameMaker and can be used to create Help indexes, but we don’t have a process in place for adding indexes to books.
A key combination for an action that is also accessible through a menu. Provided for compatibility with third-party documentation. Not used in Novell documentation.
A list, without bullets or numbers, made up of single words or short phrases.
In DocSys, inserting the SimpleList element also brings in the Member element.
A unit of action in a procedure.
Produces bold inline text.
Mostly used in NetIQ documents. Use it in Novell documents only when you need to emphasize or draw attention to a word or line within a Screen element.
Produces bold, italicized inline text.
Use only in NetIQ documents, not Novell documents.
A subscript (as in H2O). In DocSys documentation, use the Character Palette to insert subscripted text instead of using this element.
A wrapper for steps that occur within steps in a procedure.
A DocSys element that creates a subordinate title in an OSQuickStart, QuickStart, OSReadme, or Readme.
A DocSys element that automatically creates a list of headings as a subordinate Table of Contents within a section.
A superscript (as in x2). In DocSys documentation, use the Character Palette to insert superscripted text instead of using this element.
A family name; in western cultures, the “last name.”
Provided for compatibility with third-party documentation. Not used in Novell documentation.
A system-related item or term.
Provided for compatibility with third-party documentation. Not used in Novell documentation, except on the term root in Linux documentation.
A table with a title.
In DocSys, inserting the Table element also brings in the Title, TGroup, THead, TBody, Row and Entry elements.
A wrapper for the rows of a table or informal table.
A child element of the Table and InformalTable elements.
A DocSys element that creates a short document for a high-level overview of a product or process, similar to a Quick Start but with a different format and with NetIQ legal notices.
Use only for NetIQ documentation, not Novell documentation.
The word or phrase being defined or described in a variable list.
A tertiary word or phrase in an index term.
The Index elements are valid in FrameMaker and can be used to create Help indexes, but we don’t have a process in place for adding indexes to books.
An element containing only text, with no subordinate inline markup.
A wrapper for the main content of a table, or part of a table.
A child element of the Table and InformalTable elements.
A table header consisting of one or more rows.
A child element of the Table and InformalTable elements.
A suggestion to the user, set off from the text.
The text of the title of a section of a document.
The abbreviation of a title.
In DocSys, this element is used only in the BookInfo file. Don’t use it in running text.
A trademark.
Provided for compatibility with third-party documentation. The FrameMaker implementation of the DTD handles trademarks differently, so DocSys documentation doesn’t use this element.
A link that addresses its target by means of a URL.
A Uniform Resource Identifier. It does not automatically generate a link to the URI it identifies.
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.
Use this tag to reference a video ID that will appear as a link in PDF and as an embedded video in HTML. Currently, this tag handles YouTube video references only.
NOTE:If the capability is needed in the future to handle video references to other external or internal sites, you can request that the toolset be enhanced to support them.
An admonition set off from the text.
Produces bold inline text. Used for marking graphical user interface elements.
Use only in NetIQ documents, not Novell documents.
In DocSys, a cross-reference to another book within the documentation set for a product. It links to a target, and the cross-reference text is created or updated when you run the Update process within FrameMaker.
In DocSys, a cross-reference to another book within the documentation set for a product. It links to a target, but the cross-reference text is selected within the document and is not updated when you run the Update process within FrameMaker.
In DocSys, a cross-reference to a section within the same book. It links to a target, and the cross-reference text is created or updated when you run the Update process within FrameMaker.
In DocSys, a cross-reference to a section within the same book. It links to a target, but the cross-reference text is selected within the document and is not updated when you run the Update process within FrameMaker.
In DocSys, a cross-reference to another book within the documentation set for another product. It links to a target, and the cross-reference text is created or updated when you run the Update process within FrameMaker.
In DocSys, a cross-reference to another book within the documentation set for another product. It links to a target, but the cross-reference text is selected within the document and is not updated when you run the Update process within FrameMaker.
In DocSys, an element used for adding editing markup in Frame.
zEditAdd is a non-printing element, so anything marked with it is hidden during print prep.
In DocSys, an element used for adding editing markup in Frame.
zEditChange is a non-printing element, so anything marked with it is hidden during print prep.
In DocSys, an element used for adding editing markup in Frame.
zEditStrikeout is a non-printing element, so anything marked with it is hidden during print prep.