diff options
-rw-r--r-- | sigmodr/doc/glossary.docbook | 47 | ||||
-rw-r--r-- | sigmodr/doc/index.docbook | 2 | ||||
-rw-r--r-- | sigmodr/doc/introduction.docbook | 17 |
3 files changed, 58 insertions, 8 deletions
diff --git a/sigmodr/doc/glossary.docbook b/sigmodr/doc/glossary.docbook new file mode 100644 index 00000000..521b327e --- /dev/null +++ b/sigmodr/doc/glossary.docbook @@ -0,0 +1,47 @@ +<chapter> + +<chapterinfo> + +<authorgroup> +<author> +&Ben.Boeckel; +&Ben.Boeckel.mail; +</author> +<!-- TRANS:ROLES_OF_TRANSLATORS --> +</authorgroup> + +<date>2009-08-08</date> + +</chapterinfo> + +<title>Glossary</title> + +<glosslist> + +<glossentry id="gloss-sigen"> +<glossterm>Sigen</glossterm> +<glossdef> +<para>Sigen is a term made from the initial letters of <quote>SIgma Game ENgine +</quote>.</para> +</glossdef> +</glossentry> + +<glossentry id="gloss-sigmod"> +<glossterm>&sigmod;</glossterm> +<glossdef> +<para>A &sigmod; is a game file for use in &sigen;.</para> +</glossdef> +</glossentry> + +<glossentry id="gloss-validation"> +<glossterm>Validation</glossterm> +<glossdef> +<para>Validation is used to verify that all internal references exist, values +are within the bounds imposed by the rules or the engine, and that important +text values are not empty.</para> +</glossdef> +</glossentry> + +</glosslist> + +</chapter> diff --git a/sigmodr/doc/index.docbook b/sigmodr/doc/index.docbook index a74a85e0..4fcd1d2e 100644 --- a/sigmodr/doc/index.docbook +++ b/sigmodr/doc/index.docbook @@ -14,6 +14,7 @@ <!ENTITY sigmodr-editing-beginning SYSTEM "editing-beginning.docbook" > <!ENTITY sigmodr-editing-sigmod SYSTEM "editing-sigmod.docbook" > <!ENTITY sigmodr-reporting-bugs SYSTEM "reporting-bugs.docbook" > +<!ENTITY sigmodr-glossary SYSTEM "glossary.docbook" > <!ENTITY % English "INCLUDE" > <!-- change language only here --> <!ENTITY % addindex "INCLUDE" > ]> @@ -62,6 +63,7 @@ &sigmodr-editing-beginning; &sigmodr-editing-sigmod; &sigmodr-reporting-bugs; +&sigmodr-glossary; <appendix id="information"> diff --git a/sigmodr/doc/introduction.docbook b/sigmodr/doc/introduction.docbook index 08c49799..d589e9d1 100644 --- a/sigmodr/doc/introduction.docbook +++ b/sigmodr/doc/introduction.docbook @@ -20,16 +20,17 @@ <title>What is &sigmodr;?</title> -<para>&sigmodr; is an editor for <glossterm>&sigmod;</glossterm> files. It -features a user-friendly interface for editing the various data structures of a -&sigmod;.</para> +<para>&sigmodr; is an editor for <glossterm linkend="gloss-sigmod">&sigmod; +</glossterm> files. It features a user-friendly interface for editing the +various data structures of a &sigmod;.</para> <para>It provides an easy way to edit and verify &sigmod; files. With <link -linkend="validation" >validation</link>, users can verify that all of the -internal links and references to other data sources are valid. It can also -download &sigmod; files for editing and upload &sigmod;s using the -FreeDesktop.org <ulink url="http://ghns.freedesktop.org/"><acronym>GHNS -</acronym></ulink> specification.</para> +linkend="validation"><glossterm linkend="gloss-validation">validation +</glossterm></link>, users can verify that all of the internal links and +references to other data sources are valid. It can also download &sigmod; files +for editing and upload &sigmod;s using the FreeDesktop.org <ulink +url="http://ghns.freedesktop.org/"><acronym>GHNS</acronym></ulink> +specification.</para> </sect1> |