Gentoo GuideXML Guide

-GuideXML basics +DevBook XML basics -GuideXML design goals +DevBook XML design goals

-The guideXML syntax is lightweight yet expressive, so that it is easy to +The DevBook XML syntax is lightweight yet expressive, so that it is easy to learn yet also provides all the features we need for the creation of web documentation. The number of tags is kept to a minimum just those we need. This makes it easy to transform guide into other formats, such as DocBook @@ -18,7 +18,7 @@ XML/SGML or web-ready HTML.

-The goal is to make it easy to create and transform guideXML +The goal is to make it easy to create and transform DevBook XML documents.

@@ -27,21 +27,21 @@ documents.

-GuideXML +Devbook XML Basic structure

-Let's start learning the GuideXML syntax. We'll start with the the initial -tags used in a GuideXML document: +Let's start learning the DevBook XML syntax. We'll start with the initial tags +used in a DevBook XML document:

- + <?xml version="1.0" encoding="UTF-8"?> <guide self="appendices/devbook-guide/"> <chapter> -<title>Gentoo GuideXML Guide</title> +<title>Gentoo DevBook XML Guide</title>

@@ -88,7 +88,7 @@ title. Here's an example section with a single subsection, consisting of a paragraph:

- + <section> <title>This is my section</title> <subsection> @@ -408,8 +408,8 @@ for adding images without captions, borders, etc.

-GuideXML supports a simplified table syntax similar to that of HTML. To start a -table, use a <table> tag. Start a row with a <tr> +DevBook XML supports a simplified table syntax similar to that of HTML. To start +a table, use a <table> tag. Start a row with a <tr> tag. However, for inserting actual table data, we don't support the HTML <td> tag; instead, use the <th> if you are inserting a header, and <ti> if you are inserting a normal informational @@ -495,7 +495,7 @@ admonitions. A definition list comprises:

-GuideXML makes it really easy to reference other parts of the document using +DevBook XML makes it really easy to reference other parts of the document using hyperlinks. You can create a link pointing to another chapter, like Ebuild File Format, by typing <uri link="::ebuild-writing/file-format/">Ebuild File @@ -544,8 +544,8 @@ Both sections are described next.

-Newlines must be placed immediately after every -GuideXML-tag (both opening as closing), except for: +Newlines must be placed immediately after every DevBook XML tag +(both opening as closing), except for: <version>, <date>, <title>, <th>, <ti>, <li>, <i>, <e>, @@ -577,7 +577,7 @@ parent XML-tags are <tr> (from <table>), <ul>, <ol> and <dl>. If indentation is used, it must be two spaces for each indentation. That means no tabs and not more spaces. Besides, tabs are not allowed in -GuideXML documents. +DevBook XML documents.