[documentation-guide] some new includes

Pete Travis immanetize at fedoraproject.org
Wed Nov 23 06:17:48 UTC 2011


commit acdba7b430cf46ac1d20c3a98dc40716e0529e91
Author: Pete Travis <me at petetravis.com>
Date:   Thu Nov 10 22:26:54 2011 -0700

    some new includes

 ...book_tags-structure-block_elements-qandaset.xml |   48 ++++++++++++++++++++
 ...guide-docbook_tags-structure-block_elements.xml |   30 ++++++++++++
 2 files changed, 78 insertions(+), 0 deletions(-)
---
diff --git a/en-US/sect-documentation_guide-docbook_tags-structure-block_elements-qandaset.xml b/en-US/sect-documentation_guide-docbook_tags-structure-block_elements-qandaset.xml
new file mode 100644
index 0000000..3eb071e
--- /dev/null
+++ b/en-US/sect-documentation_guide-docbook_tags-structure-block_elements-qandaset.xml
@@ -0,0 +1,48 @@
+<?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;
+]>
+<section id="sect-documentation_guide-docbook_tags-structure-block_elements-qandaset">
+<title>The QandAset</title>
+					<qandaset>
+							<qandaentry>
+								<question><label>Q:</label>
+									<para>What is a <sgmltag>&lt;qandaset&gt;</sgmltag>?</para>
+								</question>
+								<answer><label>A:</label>
+									<para>This is a <sgmltag>&lt;qandaset&gt;</sgmltag></para>
+								</answer>
+							</qandaentry>
+							<qandaentry>
+								<question><label>Question:</label>
+								<para>What does the code look like?</para>
+								</question>
+								<answer><label>Answer:</label>
+									<programlisting>
+<![CDATA[
+<qandaset>
+	<qandaentry>
+		<question><label>Q:</label>
+			<para>What is a <sgmltag>&lt;qandaset&gt;</sgmltag>?</para>
+		</question>
+		<answer><label>A:</label>
+			<para>This is a <sgmltag>&lt;qandaset&gt;</sgmltag></para>
+		</answer>
+	</qandaentry>
+	<qandaentry>
+		<question><label>Question:</label>
+			<para>What does the code look like?</para>
+		</question>
+		<answer><label>Answer:</label>
+			<para>Like this. Recursion redacted for safety.</para>
+		</answer>
+	</qandaentry>
+</qandaset>											
+]]>
+									</programlisting>
+								</answer>
+							</qandaentry>
+						</qandaset>
+
+</section>
\ No newline at end of file
diff --git a/en-US/sect-documentation_guide-docbook_tags-structure-block_elements.xml b/en-US/sect-documentation_guide-docbook_tags-structure-block_elements.xml
new file mode 100644
index 0000000..d27e240
--- /dev/null
+++ b/en-US/sect-documentation_guide-docbook_tags-structure-block_elements.xml
@@ -0,0 +1,30 @@
+<?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;
+]>
+
+<section id="sect-documentation_guide-docbook_tags-structure-block_elements">
+				<title>DocBook Block Elements</title>
+					<para>Some common block elements in action</para>
+						<abstract>
+						
+						<para>
+							An <sgmltag>&lt;abstract&gt;</sgmltag> is used to summarize a body of content.  
+							This block element is an abstract, and contains an unparsed <sgmltag>&lt;abstract&gt;</sgmltag>
+							tag for easy identification. It is also serving it's intended purpose - summarizing the content
+							of the section that contains it.  All of the elements in this section will follow this format.
+						</para>		
+										
+						</abstract>					
+						
+						<example><title>An example of <sgmltag>&lt;example&gt;</sgmltag></title>
+						<para>These blocks are used, unsuprisingly, to provide an example. They have a title, can have an <code>id</code>, and are commonly kept in seperate files and referenced by <code>Xincludes</code></para>
+						</example>
+						
+						<note><title>This is a <sgmltag>&lt;note&gt;</sgmltag> tag.</title>
+							<para> Use them as an admonition to the reader, for additional insight that needs special consideration. Should be used sparingly, since your main copy will have most of the information the reader needs.</para>
+						</note>
+						
+						<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="sect-documentation_guide-docbook_tags-structure-block_elements-qandaset.xml" />
+</section>
\ No newline at end of file


More information about the docs-commits mailing list