diff options
author | Ben Boeckel <MathStuf@gmail.com> | 2009-08-03 17:26:23 -0400 |
---|---|---|
committer | Ben Boeckel <MathStuf@gmail.com> | 2009-08-03 17:26:23 -0400 |
commit | 83c653673ee793df8458304b68902e4bfcbf7147 (patch) | |
tree | abbaf3986a6adba3bd8b12684e15be9059a4eeaf /sigmodr | |
parent | 33434540576e5462d736293e4540571709690a16 (diff) | |
download | sigen-83c653673ee793df8458304b68902e4bfcbf7147.tar.gz sigen-83c653673ee793df8458304b68902e4bfcbf7147.tar.xz sigen-83c653673ee793df8458304b68902e4bfcbf7147.zip |
Rewrite the introduction
Diffstat (limited to 'sigmodr')
-rw-r--r-- | sigmodr/doc/introduction.docbook | 28 |
1 files changed, 21 insertions, 7 deletions
diff --git a/sigmodr/doc/introduction.docbook b/sigmodr/doc/introduction.docbook index 0d2025c5..1c42cefa 100644 --- a/sigmodr/doc/introduction.docbook +++ b/sigmodr/doc/introduction.docbook @@ -11,11 +11,25 @@ </chapterinfo> <title>Overview</title> - <para> - <emphasis>&sigmodr;</emphasis> is an editor for Sigmod files. It can also - <link linkend="validation" >validate</link> Sigmod files. It can also - download Sigmod files for editing, upload Sigmods using the FreeDesktop.org - <ulink url="http://ghns.freedesktop.org/" ><abbrev>GHNS</abbrev></ulink> - specification. - </para> + <sect1 id="what-is-sigmodr"> + <title>What is &sigmodr;?</title> + <para>&sigmodr; is an editor for &sigmod; 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> + </sect1> + + <sect1 id="sigmod-files"> + <title>&sigmod; files</title> + <para>&sigmod; files are &XML; file with all of the information, such as + rules, maps, and species information, and media, including audio and images, + necessary to use the &sigmod; embedded in the file. All binary data is stored + in base64 encoding to avoid control characters from disrupting parsing + of the file.</para> + </sect1> </chapter> |