summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorBen Boeckel <MathStuf@gmail.com>2009-01-30 02:46:34 -0500
committerBen Boeckel <MathStuf@gmail.com>2009-01-30 02:46:34 -0500
commitfaf90473fb6f91ec21b703cf0aad56874e5cb4e8 (patch)
tree4987cff59bd90cc0c6f21f67191125d8900b1fd8
parent8f139adc02ade718352638caaf019800018ffc7b (diff)
downloadsigen-faf90473fb6f91ec21b703cf0aad56874e5cb4e8.tar.gz
sigen-faf90473fb6f91ec21b703cf0aad56874e5cb4e8.tar.xz
sigen-faf90473fb6f91ec21b703cf0aad56874e5cb4e8.zip
Started documentation for Sigmodr
-rw-r--r--sigmodr/CMakeLists.txt2
-rw-r--r--sigmodr/doc/CMakeLists.txt5
-rw-r--r--sigmodr/doc/index.docbook47
-rw-r--r--sigmodr/doc/introduction.docbook13
4 files changed, 67 insertions, 0 deletions
diff --git a/sigmodr/CMakeLists.txt b/sigmodr/CMakeLists.txt
index 69f79ec7..7020ee8b 100644
--- a/sigmodr/CMakeLists.txt
+++ b/sigmodr/CMakeLists.txt
@@ -336,6 +336,8 @@ TARGET_LINK_LIBRARIES(sigmodr
sigmod
)
+ADD_SUBDIRECTORY(doc)
+
INSTALL(
TARGETS
sigmodr
diff --git a/sigmodr/doc/CMakeLists.txt b/sigmodr/doc/CMakeLists.txt
new file mode 100644
index 00000000..68f910ca
--- /dev/null
+++ b/sigmodr/doc/CMakeLists.txt
@@ -0,0 +1,5 @@
+KDE4_CREATE_HANDBOOK(
+ index.docbook
+ INSTALL_DESTINATION
+ ${HTML_INSTALL_DIR}/en
+)
diff --git a/sigmodr/doc/index.docbook b/sigmodr/doc/index.docbook
new file mode 100644
index 00000000..f01ec54c
--- /dev/null
+++ b/sigmodr/doc/index.docbook
@@ -0,0 +1,47 @@
+<?xml version="1.0"?>
+<!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" "dtd/kdex.dtd" [
+ <!ENTITY sigmodr "<application>Sigmodr</application>" >
+ <!ENTITY Ben.Boeckel "<personname><firstname>Ben</firstname><surname>Boeckel</surname></personname>" >
+ <!ENTITY Ben.Boeckel.mail "<email>MathStuf@gmail.com</email>" >
+ <!ENTITY sigen "the Sigma Game Engine" >
+ <!ENTITY sigenwww "http://benboeckel.net/sigen" >
+ <!ENTITY kappname "&sigmodr;" >
+ <!ENTITY sigmodr-introduction SYSTEM "introduction.docbook" >
+ <!ENTITY % English "INCLUDE" > <!-- change language only here -->
+ <!ENTITY % addindex "IGNORE" >
+]>
+<book>
+ <bookinfo>
+ <authorgroup>
+ <author>&Ben.Boeckel; &Ben.Boeckel.mail;</author>
+ <!-- TRANS:ROLES_OF_TRANSLATORS -->
+ </authorgroup>
+ <copyright>
+ <year>2009</year>
+ <holder>&Ben.Boeckel;</holder>
+ </copyright>
+ <legalnotice>&FDLNotice;</legalnotice>
+ <date>2009-01-30</date>
+ <releaseinfo>0.1</releaseinfo>
+ <abstract>
+ <para>&sigmodr; is an editor for Sigmods</para>
+ </abstract>
+ <keywordset>
+ <keyword>KDE</keyword>
+ <keyword>Sigen</keyword>
+ <keyword>Sigmod</keyword>
+ <keyword>Sigmodr</keyword>
+ <keyword>Editor</keyword>
+ </keywordset>
+ </bookinfo>
+ &sigmodr-introduction;
+ <appendix id="Information">
+ <title>Information</title>
+ <para>&sigmodr; is a part of &sigen;</para>
+ <para>For further information about &sigen;, please visit <ulink url="&sigenwww;">&sigenwww;</ulink>.</para>
+ <para>For further information about &sigmodr;, please visit <ulink url="&sigenwww;/sigmodr">&sigenwww;/sigmodr</ulink>.</para>
+ <!-- TRANS:CREDIT_FOR_TRANSLATORS -->
+ &underFDL;
+ </appendix>
+ &documentation.index;
+</book>
diff --git a/sigmodr/doc/introduction.docbook b/sigmodr/doc/introduction.docbook
new file mode 100644
index 00000000..4a979747
--- /dev/null
+++ b/sigmodr/doc/introduction.docbook
@@ -0,0 +1,13 @@
+<chapter id="introduction">
+ <chapterinfo>
+ <authorgroup>
+ <author>&Ben.Boeckel;</author>
+ <!-- TRANS:ROLES_OF_TRANSLATORS -->
+ </authorgroup>
+ <date>2009-01-30</date>
+ </chapterinfo>
+ <title>Overview</title>
+
+ <para><emphasis>&sigmodr;</emphasis> is an editor for Sigmod files. It supports <!--<link linkend="validation" >validation</link>--> of Sigmod files,
+ </para>
+</chapter> \ No newline at end of file