programlisting
programlisting — A literal listing of all or part of a program.
Synopsis
- Sequence of:
info? (db.titleforbidden.info)- One of:
- Zero or more of:
- text
lineannotation- Bibliography inlines
![[-]](figs/web/nav/down.gif)
- Computer-output inlines
altanchorannotationbibliorefcocodecommandcomputeroutputconstantemailenvarfilenameindexterm(db.indexterm.endofrange)indexterm(db.indexterm.singular)indexterm(db.indexterm.startofrange)inlinemediaobjectlinkliteralmarkupnonterminalolinkoptionoptionalpackageparameterpromptpropertyremarkreplaceablesubscriptsuperscriptsymbolsystemitemtagtermdeftokenuriuserinputxref
- Error inlines
- Graphic inlines
- GUI inlines
- Indexing inlines
- Keyboard inlines
- Linking inlines
- Markup inlines
- Math inlines
- Object-oriented programming inlines
- Operating system inlines
- Product inlines
- Programming inlines
- Publishing inlines
- Technical inlines
- Ubiquitous inlines
altanchorannotationbibliorefindexterm(db.indexterm.endofrange)indexterm(db.indexterm.singular)indexterm(db.indexterm.startofrange)inlinemediaobjectlinkolinkremarksubscriptsuperscriptxref
- User-input inlines
accelaltanchorannotationbibliorefcocodecommandcomputeroutputconstantemailenvarfilenameguibuttonguiiconguilabelguimenuguimenuitemguisubmenuindexterm(db.indexterm.endofrange)indexterm(db.indexterm.singular)indexterm(db.indexterm.startofrange)inlinemediaobjectkeycapkeycodekeycombokeysymlinkliteralmarkupmenuchoicemousebuttonnonterminalolinkoptionoptionalpackageparameterpromptpropertyremarkreplaceableshortcutsubscriptsuperscriptsymbolsystemitemtagtermdeftokenuriuserinputxref
textobject
- Zero or more of:
Attributes
Common attributes and common linking attributes.
Additional attributes:
- continuation (enumeration)
- “continues”
- “restarts”
- linenumbering (enumeration)
- “numbered”
- “unnumbered”
- startinglinenumber (integer)
- language
- xml:space (enumeration)
- “preserve”
- width (nonNegativeInteger)
Description
A programlisting is a verbatim environment for
program source or source fragment listings. The
programlistings are often placed in
examples or figures so that they
can be cross-referenced from the text.
Processing expectations
Formatted as a displayed block. This element is displayed
“verbatim”; whitespace and line breaks within this element are
significant. The programlistings are usually
displayed in a fixed-width font.
Other markup within a programlisting is
recognized. Contrast this with systems like LaTeX, in which verbatim
environments disable markup recognition. If you want to disable markup
recognition, you must use a CDATA
section:
1 <programlisting> 2 <![CDATA[ This is a programlisting so white space and line 4 breaks are significant. But it is also a CDATA section so <emphasis>tags</emphasis> and &entities; 6 are not recognized. The only markup that is recognized is the end-of-section marker, which is two 8 "]"'s in a row followed by a >. 10 ]]> 12 </programlisting>
Two markup tags have special significance in
programlistings: co and
lineannotation. A co identifies
the location of a callout. A
lineannotation is a comment, added by the
documentor—not the programmer.
Attributes
Common attributes and common linking attributes.
- continuation
Determines whether line numbering continues from the previous element or restarts.
Enumerated values: “continues” Line numbering continues from the immediately preceding element with the same name.
“restarts” Line numbering restarts (begins at 1, usually).
- language
Identifies the language (i.e. programming language) of the verbatim content.
- linenumbering
Determines whether lines are numbered.
Enumerated values: “numbered” Lines are numbered.
“unnumbered” Lines are not numbered.
- startinglinenumber
Specifies the initial line number.
- width
Specifies the width (in characters) of the element
- xml:space
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.
Enumerated values: “preserve” Whitespace must be preserved.
Parents ![[+]](figs/web/nav/right.gif)
Children
See Also
computeroutput, lineannotation, literallayout, screen, screenshot, synopsis, userinput