Merge pull request #92 from gergelypolonkai/help

Add help contents

help/C/chart-parts.page

@@ -0,0 +1,58 @@
+<page xmlns="http://projectmallard.org/1.0/"
+      xmlns:its="http://www.w3.org/2005/11/its"
+      xmlns:xi="http://www.w3.org/2001/XInclude"
+      type="guide" style="2column task"
+      id="chart-parts">
+  <info>
+    <revision version="0.1" date="2014-09-27" status="candidate"/>
+    <link type="guide" xref="index#chart-reading"/>
+
+    <credit type="author copyright">
+      <name>Gergely Polonkai</name>
+      <email its:translate="no">gergely@polonkai.eu</email>
+      <years>2013-2014</years>
+    </credit>
+
+    <xi:include href="legal.xml"/>
+
+    <desc>Parts of a natal chart</desc>
+  </info>
+
+  <title>Parts of a natal chart</title>
+
+  <section>
+    <title>The chart wheel</title>
+    <p>The chart wheel consists of several rings.</p>
+
+    <list>
+      <item><p>The outermost ring hold the <link xref="#planets">planets</link>.</p></item>
+      <item><p>The next ring shows the symbols of the zodiac.</p></item>
+      <item><p>The third ring holds the degree signs. The longest lines denote each 10°, the mid-sized ones appear at every 5°, and the small ones show every 1°.</p></item>
+      <item><p>The next ring is the most wide, giving place for the <link xref="#aspects">aspect and antiscion lines</link>.</p></item>
+      <item><p>The fifth ring contains the house numbers.</p></item>
+      <item><p>The innermost ring contains the <link xref="#moon">Moon phase</link> at the time of the chart.</p></item>
+    </list>
+  </section>
+
+  <section id="planets">
+    <title>Planets</title>
+
+    <p>The planets’ ring shows all the planets included in the current <link xref="display-themes">display theme</link>.</p>
+  </section>
+
+  <section id="aspects">
+    <title>Aspects and antiscia</title>
+
+    <p>Depending on the user’s choice, the fourth ring of the chart holds the aspect or the antiscion lines.</p>
+
+    <p>Aspect lines are color coded: green lines mark the harmonic, red lines the disharmonic aspects.</p>
+
+    <note><p>Neither the naming nor the categories are cast into stone. Some astrologer schools state that an aspect may be harmonic or disharmonic based on the planets involve.</p></note>
+  </section>
+
+  <section id="moon">
+    <title>The Moon phase</title>
+
+    <p>The innermost circle depicts the Moon at the time of the chart. Most schools never inspect this aspect of a moment, as they don’t think it has any impact on the person’s life. We included this information merely for educational reasons.</p>
+  </section>
+</page>

help/C/display-themes.page

@@ -0,0 +1,45 @@
+<page xmlns="http://projectmallard.org/1.0/"
+      xmlns:its="http://www.w3.org/2005/11/its"
+      xmlns:xi="http://www.w3.org/2001/XInclude"
+      type="guide"
+      id="display-themes">
+    <info>
+        <revision version="0.1" date="2013-09-22" status="candidate" />
+        <link type="guide" xref="index#customization" />
+
+        <credit type="author copyright">
+            <name>Gergely Polonkai</name>
+            <email its:translate="no">gergely@polonkai.eu</email>
+            <years>2013</years>
+        </credit>
+
+        <xi:include href="legal.xml" />
+
+        <desc>Using display themes</desc>
+    </info>
+
+    <title>Choosing the right display theme</title>
+
+    <p><app>Astrognome</app> has the concept of display themes. A display theme is a ruleset of which planets, aspects and antiscia should the chart view and the table views show.</p>
+
+    <p><app>Astrognome</app> has three built in themes:</p>
+
+    <terms>
+      <item>
+        <title>Everything</title>
+        <p>This displays everything <app>Astrognome</app> knows about: each planet, comet, theoretical/imaginary points, everything.</p>
+      </item>
+
+      <item>
+        <title>Classic</title>
+        <p>This is the classic view, used by the early astrologers. It shows planets only up to Saturn, and uses only the Ptolemaic (major) aspects. Also, it doesn’t show any antiscia.</p>
+      </item>
+
+      <item>
+        <title>No comets</title>
+        <p>This is the same as Everything, except it doesn’t include the comets and dwarf planets (<app>Astrognome</app>, like most astrologers, treat Pluto as a planet, not a dwarf).</p>
+      </item>
+    </terms>
+
+    <p>You can choose the right display theme with the display theme chooser above the chart, or change the default display theme in the <link xref="preferences">Preferences</link> dialog.</p>
+</page>

help/C/getting-started.page

@@ -0,0 +1,23 @@
+<page xmlns="http://projectmallard.org/1.0/"
+      xmlns:its="http://www.w3.org/2005/11/its"
+      xmlns:xi="http://www.w3.org/2001/XInclude"
+      type="guide" style="2column task"
+      id="getting-started">
+    <info>
+        <revision version="0.1" date="2013-09-11" status="candidate" />
+        <title type="link">Astrognome</title>
+        <title type="text">Astrognome</title>
+
+        <credit type="author copyright">
+            <name>Gergely Polonkai</name>
+            <email its:translate="no">gergely@polonkai.eu</email>
+            <years>2013</years>
+        </credit>
+
+        <xi:include href="legal.xml" />
+
+        <desc>Astrologers' software</desc>
+    </info>
+
+    <title>Astrognome Help</title>
+</page>

help/C/image-export.page

@@ -0,0 +1,32 @@
+<page xmlns="http://projectmallard.org/1.0/"
+      xmlns:its="http://www.w3.org/2005/11/its"
+      xmlns:xi="http://www.w3.org/2001/XInclude"
+      type="guide"
+      id="image-export">
+    <info>
+        <revision version="0.1" date="2013-09-22" status="candidate" />
+        <link type="guide" xref="index#getting-started" />
+
+        <credit type="author copyright">
+            <name>Gergely Polonkai</name>
+            <email its:translate="no">gergely@polonkai.eu</email>
+            <years>2013</years>
+        </credit>
+
+        <xi:include href="legal.xml" />
+
+        <desc>Exporting images of charts</desc>
+    </info>
+
+    <title>Exporting images</title>
+
+    <p><app>Astrognome</app> can save your natal charts in different image formats:</p>
+
+    <list>
+      <item><p>SVG (vectorized, also used internally by <app>Astrognome</app>)</p></item>
+      <item><p>JPEG</p></item>
+      <item><p>PNG</p></item>
+    </list>
+
+    <p>To use this feature, use <guiseq><gui style="button">Gear menu</gui> <gui style="menuitem">Export as image…</gui></guiseq>.</p>
+</page>

help/C/index.page

@@ -19,5 +19,23 @@
         <desc>Astrologers' software</desc>
     </info>
 
-    <title>Astrognome Help</title>
+    <title>
+      <media type="image" mime="image/png" its:translate="no" src="figures/astrognome-icon.png">
+      </media>
+      Astrognome Help
+    </title>
+
+    <section id="getting-started" style="2column">
+      <title>Getting started</title>
+    </section>
+
+    <section id="chart-reading" style="2column">
+      <title>Reading the charts</title>
+
+      <note><p>Every astrologer inspects and reads charts in different ways. The goal of this section is not to teach the users of such a technique, but to describe the different parts of the charts generated by <app>Astrognome</app>.</p></note>
+    </section>
+
+    <section id="customization" style="2column">
+      <title>Customization</title>
+    </section>
 </page>

help/C/introduction.page

@@ -16,10 +16,19 @@
 
         <xi:include href="legal.xml" />
 
-        <desc>What is <app>Astrognome</app>?</desc>
+        <desc>Introduction</desc>
     </info>
 
     <title>Introduction</title>
 
-    <p><app>Astrognome</app> is an astrologers' software for the GNOME Desktop.</p>
+    <p><app>Astrognome</app> is an astrologers’ software for the GNOME Desktop which can be used to create natal charts.</p>
+
+    <p><app>Astrognome</app> can display positions of the Solar System’s planets and several comets and theoretical/imaginary points on the sky (see also <link xref="chart-parts"/>.</p>
+
+    <figure>
+      <title>Astrognome</title>
+      <desc>Screenshot of Astrognome</desc>
+      <media type="image" src="figures/astrognome.png" width="700">
+      </media>
+    </figure>
 </page>

help/C/keyboard-navigation.page

@@ -0,0 +1,51 @@
+<page xmlns="http://projectmallard.org/1.0/"
+      xmlns:its="http://www.w3.org/2005/11/its"
+      xmlns:xi="http://www.w3.org/2001/XInclude"
+      type="guide"
+      id="keyboard-navigation">
+    <info>
+        <revision version="0.1" date="2013-09-22" status="candidate" />
+        <link type="guide" xref="index#getting-started" />
+
+        <credit type="author copyright">
+            <name>Gergely Polonkai</name>
+            <email its:translate="no">gergely@polonkai.eu</email>
+            <years>2013</years>
+        </credit>
+
+        <xi:include href="legal.xml" />
+
+        <desc>Navigating with the keyboard</desc>
+    </info>
+
+    <title>Navigating with the keyboard</title>
+
+    <p>You can switch between views with predefined keys:</p>
+
+    <terms>
+      <item>
+        <title>List view</title>
+        <p><keyseq><key>Alt</key><key>Left Arrow</key></keyseq>, or if your keyboard has one, <key>Back</key>. Naturally, this will do nothing in the list view.</p>
+      </item>
+
+      <item>
+        <title>Chart edit</title>
+        <p><key>F4</key>. This, and the following keys only work if a chart is loaded (e.g. not in the list view).</p>
+      </item>
+
+      <item>
+        <title>Chart view</title>
+        <p><key>F5</key></p>
+      </item>
+
+      <item>
+        <title>Aspect and antiscion tables</title>
+        <p><key>F6</key></p>
+      </item>
+
+      <item>
+        <title>Point tables</title>
+        <p><key>F7</key></p>
+      </item>
+    </terms>
+</page>

help/C/preferences.page

@@ -0,0 +1,48 @@
+<page xmlns="http://projectmallard.org/1.0/"
+      xmlns:its="http://www.w3.org/2005/11/its"
+      xmlns:xi="http://www.w3.org/2001/XInclude"
+      type="guide"
+      id="preferences">
+    <info>
+        <revision version="0.1" date="2013-09-22" status="candidate" />
+        <link type="guide" xref="index#customization" />
+
+        <credit type="author copyright">
+            <name>Gergely Polonkai</name>
+            <email its:translate="no">gergely@polonkai.eu</email>
+            <years>2013</years>
+        </credit>
+
+        <xi:include href="legal.xml" />
+
+        <desc>Preferences</desc>
+    </info>
+
+    <title>Preferences</title>
+
+    <p>You can set different aspects of <app>Astrognome</app> in the Preferences dialog, which is accessible by pressing <keyseq><key>Ctrl</key><key>P</key></keyseq>, or from <guiseq><gui style="menu">Astrognome</gui> <gui style="menuitem">Preferences</gui></guiseq>.</p>
+
+    <note><p>All settings, except the default house system and default display theme have immediate effects in all open Astrognome windows.</p></note>
+
+    <section>
+      <title>New windows start maximized</title>
+
+      <p>If this option is enabled, newly created windows will be maximized by default.</p>
+    </section>
+
+    <section>
+      <title>Use UTF-8 characters for planet/aspect symbols</title>
+      <p>The <link href="http://en.wikipedia.org/wiki/List_of_Unicode_characters">UTF-8 standard</link> lists several planet and aspect symbols. If you want to see these characters in the aspect, antiscion and point tables, check this box</p>
+    </section>
+
+    <section>
+      <title>Default house system</title>
+      <p>The house system to use by default in new charts.</p>
+      <note><p><app>Astrognome</app> saves the house system information with every chart. This means if you load a chart, that saved house system will be used instead of the default one.</p></note>
+    </section>
+
+    <section>
+      <title>Default display theme</title>
+      <p>The default <link xref="display-themes">display theme</link> to use in newly opened charts.</p>
+    </section>
+</page>

help/C/your-first-chart.page

@@ -0,0 +1,35 @@
+<page xmlns="http://projectmallard.org/1.0/"
+      xmlns:its="http://www.w3.org/2005/11/its"
+      xmlns:xi="http://www.w3.org/2001/XInclude"
+      type="guide"
+      id="your-first-chart">
+    <info>
+        <revision version="0.1" date="2013-09-22" status="candidate" />
+        <link type="guide" xref="index#getting-started" />
+
+        <credit type="author copyright">
+            <name>Gergely Polonkai</name>
+            <email its:translate="no">gergely@polonkai.eu</email>
+            <years>2013</years>
+        </credit>
+
+        <xi:include href="legal.xml" />
+
+        <desc>Creating natal charts</desc>
+    </info>
+
+    <title>Your first chart</title>
+
+    <p>Creating a natal chart is as easy as pressing <keyseq><key>Ctrl</key><key>N</key></keyseq> (or using either <guiseq><gui style="menu">Astrognome</gui> <gui style="menuitem">New chart</gui></guiseq>) and entering a name, a date and a location. To show the actual chart, press <key>F5</key> or use <guiseq><gui style="button">View menu</gui> <gui style="menuitem">Chart</gui></guiseq>.</p>
+
+    <figure>
+      <title>Chart edit</title>
+      <desc>Editing a chart’s data</desc>
+      <media type="image" src="figures/chart-edit.png" width="700">
+      </media>
+    </figure>
+
+    <note>
+      <p>Creating a new chart while viewing one will open a new window. If you are on the chart list screen, the current window will be used.</p>
+    </note>
+</page>

help/Makefile.am

@@ -9,6 +9,13 @@ HELP_MEDIA = $(NULL)
 HELP_FILES = \
 	index.page        \
 	introduction.page \
+	display-themes.page \
+	getting-started.page \
+	image-export.page \
+	keyboard-navigation.page \
+	preferences.page \
+	troubleshooting.page \
+	your-first-chart.page \
 	legal.xml         \
 	$(NULL)