[documentation-guide: 1/2] added new section to XML chapter

Laura lnovich at fedoraproject.org
Sun Mar 23 13:34:35 UTC 2014


commit c76fa368ce6c3632b93b588a4c2f96e6099e6cd4
Author: Laura Novich <lnovich at redhat.com>
Date:   Sun Mar 23 14:32:15 2014 +0100

    added new section to XML chapter

 en-US/tools.xml |   50 ++++++++++++++++++++++++++++++++++++++++++++++----
 1 files changed, 46 insertions(+), 4 deletions(-)
---
diff --git a/en-US/tools.xml b/en-US/tools.xml
index eb9fad0..2a3ae1b 100644
--- a/en-US/tools.xml
+++ b/en-US/tools.xml
@@ -10,19 +10,61 @@
 	</para>
 	<section>
 		<title>XML Concepts</title>
-		<para/>
+		<para>
+		<firstterm>Extensible Markup Language</firstterm> or XML is the language that is used in Docbook. We use docbook to write all of the documentation, so it is a good idea to be familiar with XML terminiolgy and with resources to use in order to edit and check your XML.
+		</para>
+		<para>
+		XML is a markup language similar to HTML and SGML, the unique difference is that the tags <sgmltag class="starttag">what-goes-in-brackets</sgmltag> can be specialized, as long as they are valid for the DTD (which in Fedora Docs is held by Docbook). Your best friend for tags, and how to use them will be found at the <ulink url="http://www.docbook.org/tdg/en/html/part2.html">DocBook tag Reference</ulink>.
+		</para>
+		<para>Here is some information that will help you be able to talk about XML correctly so that if you need to ask a question you won't embarrass yourself.
+		</para>
+		<itemizedlist>
+		   <listitem>
+		    <para>
+		      XML has a tree like hirarchy where tags are nested. The outer most tag is the parent, and all the tags inside it are children. 
+		    </para>
+		   </listitem>
+		   <listitem>
+		    <para>
+		      Once you look at a tag it may have several components:
+		    </para>
+		    <itemizedlist>
+		      <listitem>
+		        <para>
+		          <sgmltag class="starttag">element</sgmltag> this is the tag name. It can be a parent or a child.
+		        </para>
+		      </listitem>
+		      <listitem>
+		        <para>
+		          <sgmltag class="attribute">attribute</sgmltag> - an attribute gives a special characteristic to an element. To see which elements take which attributes refer to the <ulink url="http://www.docbook.org/tdg/en/html/part2.html">DocBook tag Reference</ulink>
+		        </para>
+		      </listitem>
+		      <listitem>
+		        <para>
+		          <sgmltag class="attvalue">="value"</sgmltag> - attributes have values assigned to them. They can be numerical or they can be text strings. For valid attribute values, refer to the <ulink url="http://www.docbook.org/tdg/en/html/part2.html">DocBook tag Reference</ulink>.
+		        </para>
+		      </listitem>
+		    </itemizedlist>
+		    </listitem>
+		</itemizedlist>
 	</section>
 	<section>
 		<title>xmllint</title>
-		<para/>
+		<para>
+		   some stuff to go here
+		</para>
 	</section>
 	<section>
 		<title>xsltproc</title>
-		<para/>
+		<para>
+		   some more stuff here
+		</para>
 	</section>
 	<section>
 		<title>xmltidy</title>
-		<para/>
+		<para>
+		   and even more here
+		</para>
 	</section>
 </chapter>
 <!--


More information about the docs-commits mailing list