LiteralLayout

Guide to the DocBook DTD
Prev		Next

LiteralLayout

Name

LiteralLayout -- Wrapper for lines set off from the main text that are not tagged as Screens, Examples, or ProgramListing, in which line breaks and leading white space are to be regarded as significant

Content Model

  (LineAnnotation | #PCDATA | FootnoteRef | XRef | Abbrev
  | Acronym | Citation | CiteRefEntry | CiteTitle | Emphasis
  | FirstTerm | ForeignPhrase | GlossTerm | Footnote | Phrase
  | Quote | Trademark | WordAsWord | Link | OLink | ULink
  | Action | Application | ClassName | Command
  | ComputerOutput | Database | Email | EnVar | ErrorCode
  | ErrorName | ErrorType | Filename | Function | GUIButton
  | GUIIcon | GUILabel | GUIMenu | GUIMenuItem | GUISubmenu
  | Hardware | Interface | InterfaceDefinition | KeyCap
  | KeyCode | KeyCombo | KeySym | Literal | Markup | MediaLabel
  | MenuChoice | MouseButton | MsgText | Option | Optional
  | Parameter | Prompt | Property | Replaceable | ReturnValue
  | SGMLTag | StructField | StructName | Symbol | SystemItem
  | Token | Type | UserInput | Anchor | Author | AuthorInitials
  | CorpAuthor | ModeSpec | OtherCredit | ProductName
  | ProductNumber | RevHistory | Comment | Subscript
  | Superscript | InlineGraphic | InlineEquation | Synopsis
  | CmdSynopsis
  | FuncSynopsis)+

Attributes

This element has common and Role attributes.

Name	Value(s)	Type	Default Value
Format	(linespecific)	NOTATION	linespecific
Width	NUMBER	#IMPLIED

Tag Minimization

Both the start- and end-tags are required for this element.

Description

Wrapper for lines set off from the main text that are not tagged as Screens, Examples, or ProgramListing, in which line breaks and leading white space are to be regarded as significant. It contains in-line elements, and has common and Width attributes, for specifying a number representing the maximum width of the contents.

Parents

These elements contain LiteralLayout: Appendix, Article, BiblioDiv, Bibliography, BlockQuote, Callout, Caution, Chapter, Dedication, Example, Figure, Footnote, GlossDef, GlossDiv, Glossary, Important, Index, IndexDiv, InformalExample, LegalNotice, ListItem, MsgExplan, MsgText, Note, Para, PartIntro, Preface, Procedure, RefSect1, RefSect2, RefSect3, RefSynopsisDiv, Sect1, Sect2, Sect3, Sect4, Sect5, SetIndex, Sidebar, SimpleSect, Step, Tip, Warning, entry.

Children

LiteralLayout contains these elements: Abbrev, Acronym, Action, Anchor, Application, Author, AuthorInitials, Citation, CiteRefEntry, CiteTitle, ClassName, CmdSynopsis, Command, Comment, ComputerOutput, CorpAuthor, Database, Email, Emphasis, EnVar, ErrorCode, ErrorName, ErrorType, Filename, FirstTerm, Footnote, FootnoteRef, ForeignPhrase, FuncSynopsis, Function, GUIButton, GUIIcon, GUILabel, GUIMenu, GUIMenuItem, GUISubmenu, GlossTerm, Hardware, InlineEquation, InlineGraphic, Interface, InterfaceDefinition, KeyCap, KeyCode, KeyCombo, KeySym, LineAnnotation, Link, Literal, Markup, MediaLabel, MenuChoice, ModeSpec, MouseButton, MsgText, OLink, Option, Optional, OtherCredit, #PCDATA, Parameter, Phrase, ProductName, ProductNumber, Prompt, Property, Quote, Replaceable, ReturnValue, RevHistory, SGMLTag, StructField, StructName, Subscript, Superscript, Symbol, Synopsis, SystemItem, Token, Trademark, Type, ULink, UserInput, WordAsWord, XRef.

In some contexts, additional elements may be allowed by inclusions in parent elements. Similarly, in some contexts, some of these elements may be invalid due to exclusions in parent elements.

Attributes

Width: Width indicates the width of the longest line in the element to which it pertains, in number of characters.
Format: Line ends and leading white space must be preserved in output.

Examples

<LITERALLAYOUT>
Line breaks and leading white space are 
significant in LiteralLayout.
So the above sentence should appear as two lines; the next line
   should appear indented.
</LITERALLAYOUT>

Prev	Home	Next
Literal	Up	LoT