The default value of this attribute is unknown. Description A caution is an admonition, usually set off from the main text. In some types of documentation, the semantics of admonitions are clearly defined a caution might imply the possibility of harm to equipment whereas a warning might imply harm to a person. However, DocBook makes no such assertions. Sometimes outputs a graphical icon or other symbol as well.
Description A chapter is a chapter of a book. The first chapter of a document usually restarts page numbering. Typically, chapters are numbered and presented in the table of contents. Pictures and figures … Top Level Section … Not a Real Section This paragraph appears to be under a Sect3 heading, but it's really in the same Sect1 as the preceding paragraph.
Description The content of a citation is assumed to be a reference string, perhaps identical to an abbreviation in an entry in a bibliography. Aho, Ravi Sethi, and Jeffrey D. AddisonWesley Publishing Company. Compilers, Principles, Techniques, and Tools. Description A citebiblioid identifies a citation to another work by bibliographic identifier. Description This element is a citation to a refentry. It must include a refentrytitle that should exactly match the title of a refentry.
Processing expectations This element implicitly links to the refentry with the same refentrytitle in the same volume, as defined by manvolnum.
Formatted inline. Usually the manvolnum is put in parentheses. See Also citation, citebiblioid, citetitle Examples Example citerefentry For a further description of print formats, consult the printf 3S manual page.
For a further description of print formats, consult the printf manual page. Often italicized for books and quoted for articles. Description The name of a city in an address. In an address, this element may inherit the verbatim qualities of an address. Description The classname tag is used to identify the name of a class. This is likely to occur only in documentation about object-oriented programming systems, languages, and architectures.
DocBook Element Reference classsynopsis DocBook does not contain a complete set of inlines appropriate for describing objectoriented programming environments.
While it has classname, for example, it has nothing suitable for methods. This will be addressed in a future version of DocBook.
See Also property, symbol, token, type Examples Example classname All user-interface components must be descendants of the Widget class. All user-interface components must be descendants of the Widget class. This is one of the few places where DocBook attempts to model as well as describe.
Unlike funcsynopsis, which was designed with C language function prototypes in mind, the content model of classsynopsis was designed to capture a wide range of object-oriented language semantics.
Processing expectations For the most part, the processing application is expected to generate all of the parentheses, semicolons, commas, and so on required in the rendered synopsis. The DocBook Element Reference classsynopsisinfo exception to this rule is that the spacing and other punctuation inside a parameter that is a pointer to a function must be provided in the source markup. See classsynopsis. Unlike the other info elements, classsynopsisinfo is not a container for metainformation.
Instead, classsynopsisinfo is a verbatim environment for adding additional information to a class synopsis. DocBook Element Reference cmdsynopsis Attributes Common attributes and common linking attributes. A cmdsynopsis operates under the following general model: commands have arguments that may be grouped; arguments and groups may be required or optional and may be repeated. In the UNIX world, this character is almost universally the dash or hyphen, although plus signs and double dashes have become more common in recent years.
The DocBook processing expectations on this point are intentionally vague. In some environments it may be most convenient to generate these characters automatically; in other environments it may be more convenient to insert them literally in the content.
Whichever processing model you choose, note that this will be an interchange issue if you share documents with other users see Appendix D. Plain arguments are required, but are not decorated with brackets. The same brackets and ellipses that are used to indicate these characteristics on arguments are used on groups. The processing system is free to introduce line breaks where required, but the sbr element may be introduced by the author to provide an explicit break location.
See callout. Attributes Common attributes ID required. System startup code for DOS. Some sort of Windows 3. Compare this example with the example for screenco. Attributes align Specifies the alignment of data and the justification of text in a cell. This is the default value for table data.
This is the default value for table headers. The default value for this attribute is the decimal point character for the current language as set by the lang attribute e. User agents are not required to support this attribute. 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. The default value for this attribute is 1 i. This is the default value. This constraint does not apply to subsequent text lines in these cells.
It has the same meaning as the width attribute for the colgroup element and overrides it. DocBook Element Reference colgroup onmousedown Occurs when the pointing device button is pressed over an element. In the absence of a span attribute, each colgroup defines a column group containing one column. User agents must ignore this attribute if the colgroup element contains one or more col elements.
This attribute is overridden for any column in the column group whose width is specified via a col element. Description This element identifies a collaborative partner in a document. It associates the name of a collaborator with his or her affiliation.
Description A colophon, if present, almost always occurs at the very end of a book. It contains factual information about the book, especially about its production, and includes details about typographic style, the fonts used, the paper used, and perhaps the binding method of the book. Font geeks like Norm think every book should have one. Final production was performed with Troff.
Each colspec refers to a single column. Columns are numbered sequentially from left to right in the table. If the colnum attribute is not specified, the colspec is for the next column after the preceding colspec or column 1 if it is the first colspec.
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. Description This element holds the name of an executable program or the text of a command that a user enters to execute a program. In UNIX, ls is used to get a directory listing. Description A computeroutput identifies lines of text generated by a computer program messages, results, or other output.
Note that computeroutput is not a verbatim environment, but an inline. See Also constant, envar, filename, lineannotation, literal, literallayout, markup, option, optional, parameter, programlisting, prompt, replaceable, screen, screenshot, synopsis, systemitem, tag, userinput, varname Examples Example computeroutput The output from the date command, Sun Nov 16, , DocBook Element Reference confdates uses fixed-width fields so that it can easily be parsed.
The output from the date command, Sun Nov 16, , uses fixed-width fields so that it can easily be parsed. Description A confdates element holds the dates of a conference for which a document was written or at which it was presented. Description If a document—for example, an article—is written in connection with a conference, the elements in this wrapper are used to hold information about the conference: titles, sponsors, addresses, dates, etc.
Description See confgroup. DocBook Element Reference conftitle Processing expectations May be formatted inline or as a displayed block, depending on context. It is most often used to identify system limitations or other defined constants.
See Also command, computeroutput, literal, markup, option, optional, parameter, prompt, replace able, tag, userinput, varname Examples Example constant In ACL, main::PCS contains the path component separator character. Description A constraint is a cross-reference to a description of a constraint that cannot be expressed in the grammar generally logical rather than syntactic constraints.
Description A constraintdef contains a description of a constraint that cannot be expressed in the grammar generally logical rather than syntactic constraints. Unlike a methodsynopsis, which it closely resembles, it may not identify a return type and the methodname is optional in some languages, constructor names can be generated automatically.
Description The contractnum element that occurs in bibliographic metadata contains information about the contract number of a contract under which a document was written. Description The contractsponsor element that occurs in bibliographic metadata contains information about the sponser of a contract under which a document was written.
Description The contrib element contains a summary or description of the contributions made by an author, editor, or other credited source. Description The copyright element holds information about the date s and holder s of a document copyright. If an extended block of text describing the copyright or other legal status is required, use legalnotice. The copyright element is confined to meta-information. For copyright statements in running text, see trademark. Use one co and one or more coref elements when you want to indicate that the same callout should appear in several places.
A coref is not a cross-reference to a callout use xref for that ; rather, it is an indication that the callout appears semantically in more than one place. Description The name of a country, typically in an address. Description The cover element contains additional material to be printed on the cover of a publication.
Multiple cover elements may be used to hold material for the inside and outside front and back covers, the spine, dust jackets, etc. The title, authors, and other bibliographic metadata that appears in the info element should not be repeated inside the cover.
The intent is merely that cover can contain any additional material required. Examples The following example shows a cover tag as it might have appeared in the source for the first edition of this book.
Published by O'Reilly Media, Inc. Richard L. October First Edition. Nutshell Handbook, the Nutshell Handbook logo, and the… Many of the designations used by manufacturers… While every precaution has been taken in the preparation… The Official Documentation for DocBook O'Reilly Media Dover Archives DocBook is a system for writing structured documents using… DocBook: The Definitive Guide is the… A brief introduction to … A guide to creating documents with the DocBook schema… … In an era of collaborative creation of technology, … Norman Walsh is a … DocBook Element Reference database Preface DocBook provides a system … In this example, we assume that the first cover element contains additional material for the front cover and the second cover element contains additional material for the back cover.
Please note that Year has been extended to four digits. The ProjectStatus database has been updated. A dateTime value. A gYearMonth value.
A gYear value. Description The date element identifies a date. DocBook does not specify the format of the date. Description A dedication is a page or section, most often at the very beginning of a book before any other body matter , containing a tribute to something frequently someone in connection with the writing or publication of the book.
Frequently appears on a page by itself at the beginning of a book. Parsing Jokes What did the lexer say to the angle bracket? Unlike a methodsynopsis, which it closely resembles, it may not identify a return type and the methodname is optional in some languages, destructors have an immutable name which may be generated automatically. Description The edition contains the name or number of the edition of the document. Description The name of the editor of a document. Description Inline markup identifying an email address.
An email may generate surrounding punctuation, such as angle brackets. In some processing environments, email may automatically generate a hypertext link a mailto: URL. See Also address, city, country, fax, otheraddr, phone, pob, postcode, state, street emphasis db. Description An emphasis element indicates that certain text should be stressed in some way. This pattern defines the emphasis element with a very limited content model.
Emphasized text is traditionally presented in italics or boldface. A role attribute of bold or strong is often used to generate boldface, if italics is the default presentation. An emphasis is often used wherever its typographic presentation is desired, even when other markup might theoretically be more appropriate. See Also abbrev, acronym, emphasis db. Nonymous's book Power Snacking.
The most important example of this phenomenon occurs in A. Each entry may specify its starting column. Entries that do not explicitly specify a starting column begin implicitly in the column that is immediately adjacent to the preceding cell. Note that entrys with the morerows attribute from preceding rows implicitly occupy cells in the succeeding rows.
A row is not required to be full. It is legal for some entries to be completely absent at the beginning, middle, or end of a row. The content of entry is formatted to fit within the table cell that it occupies. Horizontal and vertical spanning may allow the content of an entry to occupy several physical cells. Defaults to zero. A value of 1 true rotates the cell 90 degrees counter-clockwise.
A value of 0 false leaves the cell unrotated. An entry table may occur in a row instead of an entry. An entrytbl has most of the elements of a table but may not include itself, thus limiting nesting to a single level. Whether this is by accident or by design is unclear, but it has always been that way in CALS. The content of entrytbl is formatted, as a table, to fit within the table cell that it occupies.
Horizontal and vertical spanning may allow an entrytbl to occupy several physical cells in the table that contains it. If multiple entrytbls occur in a single row, formatters that support entrytbl are not required to ensure that subrows within the various tables are vertically aligned.
Many formatters are incapable of supporting entrytbls. Must be an integer greater than zero. Description An epigraph is a short inscription, often a quotation or poem, set at the beginning of a document or component. Epigraphs are usually related somehow to the content that follows them and may help set the tone for the component.
Description An equation is a formal mathematical equation with an optional rather than a required title. If the MathML Module is used, equation can also contain the mml:math element. For an inline equation, use inlineequation. Processing systems that number equations or build a table of equations at the beginning of a document may have difficulty correctly formatting documents that contain both equations with titles and equations without titles.
You are advised to use informalequation for equations without titles. Description An error code. Error codes are often numeric, but in some environments they may be symbolic constants. DocBook provides four elements for identifying the parts of an error message: error code, for the alphanumeric error code e.
This is usually a recoverable nonfatal error. Description An errorname holds the symbolic name of an error. Prior to DocBook V4. However, this left no element for symbolic names, so the errortext element was added and the semantics of the error elements adjusted slightly. Description An errortext holds the text of an error message.
However, this left no element for symoblic names, so the errortext element was added and the semantics of the error elements adjusted slightly. Description The errortype element identifies a class of error. Description An example is a formal example with a title. Examples often contain programlistings or other large block elements. Frequently, they are given xml:ids and referenced from the text with xref or link. DocBook does not specify the location of the example within the final displayed flow of text; it may float or remain where it is located.
A list of examples may be generated at the beginning of a document. If a label is specified, that label will be used for identifying the example and in generated cross-references. If unspecified, examples are often, but not always, numbered. If a width is specified, formatters may use this value to determine scaling or rotation. A DSSSL Function define node-list-filter-by-gi nodelist gilist ;; Returns the node-list that contains every element of the original ;; nodelist whose gi is in gilist let loop result empty-node-list nl nodelist if node-list-empty?
DocBook Element Reference extendedlink Description The exceptionname element is used to identify the name of an exception. Description An XLink extended link. See XLink for more details. Description A fax is a fax number in an address. Description A figure is a formal example with a title. Figures often contain mediaobjects, or other large display elements. Frequently, they are given IDs and referenced from the text with xref or link.
A figure may contain multiple display elements. DocBook does not specify how these elements are to be presented with respect to one another. DocBook does not specify the location of the figure within the final displayed flow of text; it may float or remain where it is located. A list of figures may be generated at the beginning of a document. It may be a simple name or may include a path or other elements specific to the operating system.
The symbolic constants for error numbers are defined in errno. This is also used for forenames and sometimes nicknames. A firstname is an alternative to givenname.
Description This element marks the first occurrence of a word or term in a given context. A firstterm is often given special typographic treatment, such as italics. This allows adjectival, plural, and other variations of the term to appear in the element. Hamilton Kindle.
Post a Comment. Monday, January 20, [E Most helpful customer reviews 1 of 1 people found the following review helpful. See all 1 customer reviews Hamilton PDF. Labels: Ebooks. No comments:. Newer Post Older Post Home.
Graham Miln 2, 3 3 gold badges 31 31 silver badges 32 32 bronze badges. Jens Hicham Bakir Hicham Bakir 21 1 1 bronze badge. Tom Tom 23 3 3 bronze badges. The link is down. Devin Rader 10k 1 1 gold badge 18 18 silver badges 32 32 bronze badges.
Gangnus Gangnus Sign up or log in Sign up using Google. Sign up using Facebook. Sign up using Email and Password. Post as a guest Name. Email Required, but never shown. The Overflow Blog. Who owns this outage? Installing the DocBook Stylesheets B. DocBook Variants and Future Directions 1. DocBook Variants 2. Future Directions 2. DocBook Assembly Mechanism C. Resources 1.
Latest Versions of DocBook Schemas 2. Introductory Material on the Web 4. References and Technical Notes on the Web 5. Related Standards 7. Internet RFC s 8. Books and Printed Resources 9. XML Tools D. Interchanging DocBook Documents E. List of Figures 3. The Pythagorean Theorem Illustrated. List of Tables 1. Renamed elements 1. Recommended mapping for removed elements 3. List of Examples 1. DocBook V4. A typical book 2. A typical chapter 2. A typical article 2. A sample reference page 4.
A fragment of a CSS stylesheet 4. Buy on Amazon. Book description If you need a reliable tool for technical documentation, this clear and concise reference will help you take advantage of DocBook, the popular XML schema originally developed to document computer and hardware projects.
Show and hide more. Table of contents Product information.
0コメント