[documentation-guide] Added a file to demonstrate and explain docbook tags. Missed adding the file to git on the last com
Pete Travis
immanetize at fedoraproject.org
Wed Nov 23 06:17:27 UTC 2011
commit 3e837a5803c016615f690c05002e71c6e0dc96b3
Author: Pete Travis <me at petetravis.com>
Date: Wed Nov 2 08:11:15 2011 -0600
Added a file to demonstrate and explain docbook tags. Missed adding the file to git on the last commit.
Basic structure has been defined, and other supported tags roughly categorized. Very much a work in progress.
en-US/docbook-demonstration.xml | 328 +++++++++++++++++++++++++++++++++++++++
1 files changed, 328 insertions(+), 0 deletions(-)
---
diff --git a/en-US/docbook-demonstration.xml b/en-US/docbook-demonstration.xml
new file mode 100644
index 0000000..f269433
--- /dev/null
+++ b/en-US/docbook-demonstration.xml
@@ -0,0 +1,328 @@
+<?xml version='1.0' encoding='utf-8' ?>
+<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
+<!ENTITY % BOOK_ENTITIES SYSTEM "documentation-guide.ent">
+%BOOK_ENTITIES;
+]>
+<chapter id="chap-documentation_guide-docbook_tags">
+ <title>A visual guide to DocBook tags</title>
+ <para>In this section, we'll look at the accepted DocBook XML tags
+ as defined by <command>publican print_known</command>.
+ We will also describe and use them inline, so the effect of
+ each tag can be demonstrated.
+ </para>
+
+
+ <section id="sect-documentation_guide-docbook_tags-structure">
+ <title>Structure Tags</title>
+ <para>DocBook publications are structured in outline form.</para>
+ <section id="sect-documentation_guide-docbook_tags-structure-id_attr">
+ <title>Identify your content: The <code>id</code> Attribute</title>
+ <para>All structure tags should have an <code>id</code> attribute. Uniquely identifying
+ a chapter or section allows it to be linked to, avoids unfortunate page breaks, and makes
+ your code more readable. Convention is to first state the type of element,
+ then describe the element relative to the whole document.
+ </para>
+ <example>
+ <title>A generic <code>id</code> attribute in action</title>
+ <para>id="sect-book_name-chapter_name-section_name-subsection"</para>
+ </example>
+ </section>
+ <section id="sect-documentation_guide-docbook_tags-structure-book">
+ <title>The top node: <sgmltag><book></sgmltag></title>
+ <para>The <sgmltag><book></sgmltag> element defines the root of the document.
+ It encloses the entirety of the work. Publican will generate these tags when
+ creating a document.
+ </para>
+ </section>
+ <section id="sect-documentation_guide-docbook_tags-structure-chapter">
+ <title>Splitting it up: <sgmltag><chapter></sgmltag></title>
+ <para>Smaller divisions of a book are contained in a<sgmltag><chapter></sgmltag>.
+ Each <sgmltag><chapter></sgmltag> should have a <sgmltag><title></sgmltag>
+ and contain several <sgmltag><sections></sgmltag></para>
+ </section>
+ <section id="sect-documentation_guide-docbook_tags-structure-section">
+ <title>Useful pieces: <sgmltag><section></sgmltag></title>
+ <para> The <sgmltag><section></sgmltag> is where we begin to show our content.
+ Most other tags will be contained in a <sgmltag><section></sgmltag>.</para>
+ <section id="sect-documentation_guide-docbook_tags-structure-section-nesting">
+ <title>Nesting <sgmltag><section></sgmltag> elements</title>
+ <para><sgmltag><section></sgmltag> elements can be nested as much as needed.
+ Grouping related content in a <sgmltag><section></sgmltag> allows it to be moved or edited atomically.
+ </para>
+ </section>
+ </section>
+
+
+ </section>
+
+ <section id="sect-documentation_guide-docbook_tags-block_formatting"></section>
+
+</chapter>
+
+<!--
+!!!vocabulary!!!
+!inline avoid? abbrev
+!inline acronym
+!inline application
+!inline arg
+!block blockquote
+!inline formatting emphasis
+!inline formatting literal
+!block formatting literallayout
+!inline important
+!inline role-attribute? hardware
+!inline foreignphrase
+!inline filename
+!depricated interface
+!inline coding interfacename
+!depricated isbn
+!inline directions keycap
+!inline directions keycombo
+!inline dependent directions menuchoice
+!inline directions mousebutton
+!inline directions step
+!inline directions substeps
+!inline directions stepalternatives
+!inline formatting remark
+!inline formatting replaceable
+!inline directions/coding package
+!inline directions option
+!inline formatting systemitem
+!inline formatting term
+!inline trademark
+!inline coding? type
+!inline depricated ulink
+!block structure uri
+!inline directions userinput
+!inline wordasword
+
+
+
+
+
+!!!structure!!!
+!depricated indexterm
+!inline index secondary
+!inline index see
+!inline index seealso
+!inline index tertiary
+!block aside abstract
+!block subset answer
+!block appendix
+!depricated appendixinfo
+!dependent block area
+!dependent block areaset
+!dependent block areaspec
+!inline confused accel
+!structure root article
+!depricated articleinfo
+!inline descriptive author
+!inline descriptive authorgroup
+!block subset bibliodiv
+!block subset biblioentry
+!block subset bibliography
+!used - book
+!depricated? bookinfo
+!inline structure callout
+!inline structure calloutlist
+!used - chapter
+!depricated? - chapterinfo
+!block dependent columns colspec
+!block example
+!block dependent table entry
+!inline lists seg
+!inline lists seglistitem
+!inline lists segmentedlist
+!inline lists segtitle
+!inline formatting sgmltag
+!inline address shortaffil
+!block structure simpara
+!inline lists simplelist
+!block tables table
+!block tables depricated tbody
+!block dependent table td
+!block tables depricated tr
+!inline lists variablelist
+!inline lists varlistentry
+!block table tgroup
+!block table depricated thead
+!depricated informaltable
+!block lists itemizedlist
+!block dependent lists listitem
+!inline lists member
+!root structure part
+!root structure partintro
+!block directions procedure
+!inline formatting phrase
+!block asides note
+!root structure preface
+!inline descriptive primary
+!block dependent qanda qandaentry
+!block block dependent qanda qandaset
+!block dependent qanda question
+!block para formalpara
+!inline special group
+!block root index
+!block lists orderedlist
+!block? directions <pre> screen
+!block formatting para
+!block aside warning
+!block tables row
+!structure title
+!used section
+!inline structure subtitle
+!suppr special xi:fallback
+!special suppr xi:include
+!suppressed structure ~comment
+
+
+
+
+
+!!!citations references embeds !!!
+!inline dependent citerefentry
+!inline citetitle
+!block images figure
+!inline citations productname
+!inline citations productnumber
+!inline citations programlisting
+!inline citations programlistingco
+!inline citations refentry
+!depricated refentryinfo
+!inline citations refentrytitle
+!supressed citations reference
+!supressed citations refmeta
+!inline/block citations refname
+!block citations refnamediv
+!inline citations refpurpose
+!inline citations refsection
+!block dependent image imagedata
+!block dependent image imageobject
+!block dependent image inlinemediaobject
+!inline firstterm
+!block special footnote
+!block special footnote footnoteref
+!block dependent images avoid! mediaobject
+!inline structure xref
+!block dependent images textobject
+!inline citations/bib issuenum
+!inline dependent citations manvolnum
+
+
+
+
+
+!!!meta!!!
+!inline/block affiliation
+!block descriptive colophon
+!inline/block descriptive contrib
+!inline/block descriptive copyright
+!depricated corpauthor
+!inline/block descriptive edition
+!inline/block descriptive editor
+!inline descriptive keyword
+!inline descriptive keywordset
+!block descriptive container legalnotice
+!inline descriptive othercredit
+!inline descriptive pubdate
+!inline/descriptive publisher
+!inline/descriptive publishername
+!depricated pubsnumber
+!block.inline descriptive revdescription
+!block/inline descriptive revhistory
+!block/inline descriptive revision
+!block/inline descriptive revnumber
+!inline descriptive year
+!inline subset(copyright) descriptive holder
+!inline/block/supressed descriptive subject
+!inline// descriptive subjectset
+!inline// descriptive subjectterm
+
+
+
+
+
+!!!contact!!!
+!block address
+!inline city
+!inline dependent address country
+!depricated coutry
+!inline date
+!inline dependent address email
+!inline address firstname
+!inline address pob
+!inline address postcode
+!inline address orgdiv
+!inline address state
+!inline address orgname
+!inline address phone
+!inline address othername
+!inline dependent address fax
+!inline address honorific
+!inline address jobtitle
+!inline address surname
+!inline address street
+
+
+
+
+
+!!!coding!!!
+!inline coding classname
+!inline coding cmdsynopsis
+!inline coding code
+!inline coding command
+!inline coding computeroutput
+!inline gui guibutton
+!inline gui guilabel
+!inline gui guimenu
+!inline gui guimenuitem
+!inline gui guisubmenu
+!inline coding envar
+!coding exceptionname
+!inline coding function
+!inline coding methodname
+!inline coding/directions prompt
+!inline coding/whatever property
+!inline coding/directins attr=class parameter
+!inline coding/directions varname
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+-->
\ No newline at end of file
More information about the docs-commits
mailing list