Adobe FrameMaker User Guide
Click here to see this page in full context
Home > Appendix > DITA 1.3 specification > Language reference: All-inclusive edition > Topic elements > Body elements
The body elements support the most common types of content authoring for topics: paragraphs, lists, phrases, figures, and other common types of exhibits in a document.
<alt> element provides alternate text for an image. It is equivalent to the @alt attribute on the <image> element; since the @alt attribute is deprecated, use the <alt> element instead. The <alt> element can be more easily edited or translated than the @alt attribute.<cite> element is used when you need a bibliographic citation. It specifically identifies the title of the resource. <dd> element contains the description of a term in a definition list entry (<dlentry>).<desc> element contains the description of the current element.<ddhd> element provides an optional heading or title for a column of descriptions or definitions in a definition list (<dl>).<div> element is used to organize subsets of content into logical groups that are not intended to be or should not be contained as a topic.<dl> element is a list of terms and corresponding definitions. The term (<dt>) is usually flush left. The description or definition (<dd>) is usually either indented and on the next line, or on the same line to the right of the term. However, actual rendering is up to the rendering engine.<dlentry> element groups a single entry in a definition list (<dl>). The <dlentry> element includes a term (<dt>) and one or more definitions or descriptions (<dd>) of that term.<dlhead> element contains optional headings for the term and description columns in a definition list (<dl>). The definition list heading might contain a heading for the column of terms (<dthd>) and a heading for the column of descriptions (<ddhd>).<dt> element contains a term in a definition list entry (<dlentry>).<draft-comment> element is designed to facilitate review and discussion of topic contents within the marked-up content. Use the <draft-comment> element to ask a question or to make a comment that you want others to review. To indicate the source of the draft comment or the status of the comment, use the @author, @time, or @disposition attributes.<dthd> element provides an optional heading for the column of terms in a definition list (<dl>).<example> element is a section that contains examples that illustrate or support the current topic.<fig> element is a figure (sometimes called an "exhibit") with an optional title for a wide variety of content. A figure commonly contains an image or artwork, but it can contain several kinds of text objects as well. A title is placed inside the figure to provide a caption that describes the content.<figgroup> element is used primarily for specialization, in order to create segments within a figure. The element can nest itself, which allows it to create complex specialized structures (such as the nestable groups of syntax within a syntax diagram). Figure groups can be used to contain multiple cross-references, footnotes or keywords.<fn> element is a footnote used to annotate text with notes that are inappropriate for inline inclusion. It is also used to indicate the source for facts or other material used in the text. <image> element to include artwork or images in a DITA topic.<keyword> element identifies a keyword or token, such as a single value from an enumerated list, the name of a command or parameter, product name, or a lookup key for a message.<li> element is a single item in an ordered (<ol>) or unordered (<ul>) list. When a DITA topic is rendered, numbers and alpha characters are typically displayed with list items in ordered lists, while bullets and dashes are typically displayed with list items in unordered lists.<lines> element contains text where line breaks are significant but white space is not. It can be used to represent dialogs, poetry, or other text fragments where line breaks are significant. The <lines> element is similar to <pre> in that line breaks are preserved, but the font style is not typically set to monospace, and extra spaces inside the lines are not preserved. <longdescref> element supports a reference to a text description of the graphic or object. This element replaces the deprecated @longdescref attribute on <image> and <object> elements.<longquoteref> element provides a reference to the source of a long quote.<lq> is used to provide extended content quoted from another source. Use the quote element <q> for short, inline quotations, and long quote <lq> for quotations that are too long for inline use, following normal guidelines for quoting other sources. The @href and @keyref attributes are available to specify the source of the quotation. The <longquoteref> element is available for more complex references to the source of a quote.<note> element contains information that expands on or calls attention to a particular point. This information is typically differentiated from the main text.<object> element corresponds to the HTML <object> element, and attribute semantics derive from their HTML definitions. For example, the @type attribute differs from the @type attribute on many other DITA elements.<ol> element includes a list of items sorted by sequence or order of importance.<p> element is a single paragraph containing a single main idea.<param> (parameter) element specifies a set of values that might be required by an <object> at runtime. Any number of <param> elements might appear in the content of an <object> in any order, but must be placed at the start of the content of the enclosing object. This element is comparable to the XHMTL <param> element, and its attributes' semantics derive from their HTML definitions. For example, the @type attribute differs from the @type attribute on many other DITA elements. <ph> element is used to enclose a phrase for reuse or conditional processing (for example, when part of a paragraph applies to a particular audience). It can be used by specializations of DITA to create semantic markup for content at the phrase level, which then allows (but does not require) specific processing or formatting.<pre> element contains text for which all line breaks and spaces are preserved. It is typically presented in a monospaced font. Do not use <pre> when a more semantically specific element is appropriate, such as <codeblock>.<q> element includes content quoted from another source. This element is used for short quotes that are displayed inline. Use the long quote element (<lq>) for quotations that should be set off from the surrounding text or that contain multiple paragraphs.<section> element represents an organizational division in a topic. Sections are used to organize subsets of information that are directly related to the topic. Multiple <section> elements within a single topic do not represent a hierarchy, but rather peer divisions of that topic. Sections cannot be nested. A <section> can have an optional title.<sectiondiv> element allows logical grouping of content within a section. There is no additional meaning associated with the <sectiondiv> element. The <sectiondiv> element does not contain a title; the lowest level of titled content within a topic is the section itself. If additional hierarchy is required, use nested topics instead of the section.<sl> element contains a simple list of items of short, phrase-like content, such as a list of materials in a kit or package.<sli> element is an item in a simple list (<sl>). Simple list items have phrase or text content, adequate for describing package contents, for example. When a DITA topic is formatted for output, the items of a simple list should be placed each on its own line, with no other prefix such as a number (as in an ordered list) or bullet (as in an unordered list).<term> element identifies words that might have or require extended definitions or explanations.<text> element associates no semantics with its content. It exists to serve as a container for text where a container is needed (for example, as a target for content references, or for use within restricted content models in specializations).<tm> element identifies a term or phrase that is trademarked. Trademarks include registered trademarks, service marks, slogans, and logos.<ul> element is a list of items in which the order of list items is not significant. List items are typically styled on output with a "bullet" character, depending on nesting level.<xref> element to provide an inline cross reference. It is commonly used to link to a different location within the current topic, a different topic, a specific location in another topic, or an external resource. The target of the cross-reference is specified using the @href or @keyref attributes.