summaryrefslogtreecommitdiffstats
path: root/sigmodr/doc/introduction.docbook
blob: 97cd3c3f68a1301bc0b1bf41495518ee0874ac50 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
<chapter id="introduction">

<chapterinfo>

<authorgroup>
<author>
&Ben.Boeckel;
&Ben.Boeckel.mail;
</author>
<!-- TRANS:ROLES_OF_TRANSLATORS -->
</authorgroup>

<date>2009-08-08</date>

</chapterinfo>

<title>Introduction</title>

<sect1 id="what-is-sigmodr">

<title>What is &sigmodr;?</title>

<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"><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>

<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>