[documentation-guide] rewriting cheatsheet, adding more brevity
Pete Travis
immanetize at fedoraproject.org
Wed Nov 23 06:17:37 UTC 2011
commit 037335de65d3036725c7e4c66623eb3a59470717
Author: Pete Travis <me at petetravis.com>
Date: Wed Nov 2 22:30:38 2011 -0600
rewriting cheatsheet, adding more brevity
en-US/docbook-demonstration.xml | 205 ++++++++++++++++++++++----------------
1 files changed, 119 insertions(+), 86 deletions(-)
---
diff --git a/en-US/docbook-demonstration.xml b/en-US/docbook-demonstration.xml
index f269433..c4868da 100644
--- a/en-US/docbook-demonstration.xml
+++ b/en-US/docbook-demonstration.xml
@@ -5,10 +5,11 @@
]>
<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>.
+ <para>In this section, we'll look at the most common DocBook XML tags
+ as accepted by <command>publican print_known</command>.
We will also describe and use them inline, so the effect of
- each tag can be demonstrated.
+ each tag can be demonstrated. More detailed information can be found at
+ <ulink url="http://www.docbook.org">http://www.docbook.org</ulink> .
</para>
@@ -27,13 +28,26 @@
<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 id="sect-documentation_guide-docbook_tags-structure-basic_outline">
+ <title>Basic Docbook Structure</title>
+ <screen>
+ <sgmltag><!-- This is a comment. Visible in source, not publication. --></sgmltag>
+ <sgmltag><book></sgmltag>
+ <sgmltag> <chapter></sgmltag>
+ <sgmltag> <chapter></sgmltag>
+ <sgmltag> <section></sgmltag>
+ <sgmltag> <section></sgmltag>
+ <sgmltag> <section></sgmltag><sgmltag><!-- Sections can be nested! --></sgmltag>
+ </screen>
+
+
</section>
+ </section>
+
+</chapter>
+<!--
+
<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>.
@@ -56,111 +70,95 @@
</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!!!
+::index::
!depricated indexterm
!inline index secondary
!inline index see
!inline index seealso
!inline index tertiary
-!block aside abstract
-!block subset answer
+::appendix::
!block appendix
!depricated appendixinfo
+
+::asides::
+!block aside abstract
+!block subset answer
+
+!block example
+!block asides note
+
+::bibliography::
+!block subset bibliodiv
+!block subset biblioentry
+!block subset bibliography
+
+
!dependent block area
!dependent block areaset
!dependent block areaspec
!inline confused accel
+
+::outline form::
!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 structure simpara
+!root structure part
+!root structure partintro
+!structure title
+!used section
+!inline structure subtitle
+!block para formalpara
+!root structure preface
+
+::table::
!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
+
+::lists::
+!inline lists seg
+!inline lists seglistitem
+!inline lists segmentedlist
+!inline lists segtitle
+!inline lists simplelist
+!inline lists variablelist
+!inline formatting sgmltag
+!inline address shortaffil
+!inline lists varlistentry
!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
+
+::questions and answers::
!block dependent qanda qandaentry
!block block dependent qanda qandaset
!block dependent qanda question
-!block para formalpara
+
+
+
+!block directions procedure
+!inline formatting phrase
+
+
+
+
+
!inline special group
!block root index
!block lists orderedlist
@@ -168,15 +166,47 @@
!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
-
+!!!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
!!!citations references embeds !!!
@@ -212,7 +242,8 @@
-!!!meta!!!
+!!!meta!!!!
+inline descriptive primary
!inline/block affiliation
!block descriptive colophon
!inline/block descriptive contrib
@@ -237,7 +268,8 @@
!inline/block/supressed descriptive subject
!inline// descriptive subjectset
!inline// descriptive subjectterm
-
+!inline descriptive author
+!inline descriptive authorgroup
@@ -288,7 +320,8 @@
!inline coding/directions varname
-
+!inline structure callout
+!inline structure calloutlist
More information about the docs-commits
mailing list