GNOME.org
 

[emerillon] Added help framework documentation by Mario Blättermann

commit 375cfae0e762549e54e90a95a65fa7bb695b620b
Author: Mario Blättermann <mariobl gnome org>
Date:   Sun Jun 6 21:43:13 2010 +0200

    Added help framework documentation by Mario Blättermann

 Makefile.am                     |    8 +++--
 configure.ac                    |    1 +
 help/C/about.page               |   39 +++++++++++++++++++++++++
 help/C/index.page               |   24 ++++++++++++++++
 help/C/intro.page               |   52 ++++++++++++++++++++++++++++++++++
 help/C/legal.xml                |    9 ++++++
 help/C/license.page             |   59 +++++++++++++++++++++++++++++++++++++++
 help/C/plugins-copylink.page    |   26 +++++++++++++++++
 help/C/plugins-mapposition.page |   26 +++++++++++++++++
 help/C/plugins-placemarks.page  |   26 +++++++++++++++++
 help/C/plugins.page             |   41 +++++++++++++++++++++++++++
 help/C/usage.page               |   26 +++++++++++++++++
 help/Makefile.am                |   20 +++++++++++++
 help/emerillon.omf.in           |    9 ++++++
 14 files changed, 363 insertions(+), 3 deletions(-)
---
diff --git a/Makefile.am b/Makefile.am
index 8f70cd2..db634a2 100644
--- a/Makefile.am
+++ b/Makefile.am
@@ -1,13 +1,15 @@
-SUBDIRS = cut-paste emerillon data plugins po bindings docs
+SUBDIRS = cut-paste emerillon data plugins po bindings help docs
 
 EXTRA_DIST = 			\
 	autogen.sh		\
 	ChangeLog		\
 	README			\
-	AUTHORS
+	AUTHORS			\
+	gnome-doc-utils.make
 
 DISTCLEANFILES = 		\
-	ChangeLog
+	ChangeLog		\
+	gnome-doc-utils.make
 
 DISTCHECK_CONFIGURE_FLAGS =		\
 	--disable-scrollkeeper		\
diff --git a/configure.ac b/configure.ac
index 645e0b8..a1bd021 100644
--- a/configure.ac
+++ b/configure.ac
@@ -171,6 +171,7 @@ data/emerillon.desktop.in
 docs/Makefile
 docs/reference/Makefile
 docs/reference/version.xml
+help/Makefile
 plugins/Makefile
 bindings/Makefile
 bindings/vala/Makefile
diff --git a/help/C/about.page b/help/C/about.page
new file mode 100644
index 0000000..9e0bd97
--- /dev/null
+++ b/help/C/about.page
@@ -0,0 +1,39 @@
+<page xmlns="http://projectmallard.org/1.0/";
+      xmlns:e="http://projectmallard.org/experimental/";
+      type="topic"
+      id="about">
+
+  <info>
+    <link type="seealso" xref="index"/>
+    <revision version="0.1" date="2010-06-04" status="incomplete"/>
+    <desc>
+      Information about this application.
+    </desc>
+    <credit type="author">
+      <name>Mario Blättermann</name>
+      <email>mariobl gnome org</email>
+    </credit>
+    <license>
+      <p>Creative Commons Share Alike 3.0</p>
+    </license>    
+  </info>
+
+    <title>About <app>Emerillon</app></title>
+
+    <p>
+      Currently, certain people have contributed to <app>Emerillon</app>. For a
+      complete list, see the <link href="http://git.gnome.org/browse/emerillon/tree/AUTHORS";>authors list</link>.
+    </p>
+    <p>
+      To report a bug or make a suggestion regarding this application or
+      this manual, write a bug report to
+      <link href="https://bugzilla.gnome.org/browse.cgi?product=emerillon";>GNOME Bugzilla</link>.
+    </p>
+
+    <p> This program is distributed under the terms of the GNU
+      General Public license as published by the Free Software
+      Foundation; either version 2 of the License, or (at your option)
+      any later version. A copy of this license can be found at this
+      <link href="ghelp:gpl">link</link>, or in the file
+      COPYING included with the source code of this program. </p>
+</page>
diff --git a/help/C/index.page b/help/C/index.page
new file mode 100644
index 0000000..8b9ec27
--- /dev/null
+++ b/help/C/index.page
@@ -0,0 +1,24 @@
+<page xmlns="http://projectmallard.org/1.0/";
+      type="guide"
+      id="index">
+
+  <info>
+    <revision version="0.1" date="2009-08-01" status="final"/>
+
+    <credit type="author">
+      <name>Mario Blättermann</name>
+      <email>mariobl gnome org</email>
+    </credit>
+<!--
+    <copyright>
+      <year>2010</year>
+      <name>GNOME Documentation Project</name>
+    </copyright>
+-->
+    <license><p>Creative Commons Share Alike 3.0</p></license>
+    <include href="legal.xml" xmlns="http://www.w3.org/2001/XInclude"; />
+  </info>
+
+  <title>Emerillon</title>
+
+</page>
diff --git a/help/C/intro.page b/help/C/intro.page
new file mode 100644
index 0000000..236fe3b
--- /dev/null
+++ b/help/C/intro.page
@@ -0,0 +1,52 @@
+<page xmlns="http://projectmallard.org/1.0/";
+  type="guide"
+  id="intro">
+  
+  <info>
+    <link type="guide" xref="index"/>
+    <desc>A brief description of what <app>Emerillon</app> aims to be.</desc>
+    <revision version="0.1" date="2010-06-04" status="incomplete"/>
+    <credit type="author">
+      <name>Mario Blättermann</name>
+      <email>mariobl gnome org</email>
+    </credit>
+<!--
+    <copyright>
+      <year>2010</year>
+      <name>GNOME Documentation Project</name>
+    </copyright>
+-->
+    <license><p>Creative Commons Share Alike 3.0</p></license>
+
+    <include href="legal.xml" xmlns="http://www.w3.org/2001/XInclude"; />
+  </info>
+
+  <title>Introduction</title>
+  
+  <p>
+    Emerillon is a map viewer. Aiming at simple user interface, Emerillon
+    is a powerful, extensible application. It is pronounced <em>Ey-may-ree-yon</em>.
+  </p>
+  <p>
+    It features <link href="http://www.openstreetmap.org/";>OpenStreetMap</link>
+    based maps: the street map, the cycling map and the transportation map. Use it to:
+  </p>
+	   <list>
+		<item>
+		<p>Browse maps,</p>
+		</item>
+		<item>
+		<p>Search the map for places,</p>
+		</item>
+		<item>
+		<p>Placemark places for later quick access.</p>
+		</item>
+	   </list>
+  <p>
+    Emerillon is named after the �mérillon, one of the three boats that visited New France
+    under <link href="http://en.wikipedia.org/wiki/Jacques_Cartier";>Jacques
+    Cartier's</link> command in 1535. �mérillon is also French for
+    <link href="http://en.wikipedia.org/wiki/Merlin_(bird)">Merlin Falcons</link>. 
+  </p>
+
+</page>
diff --git a/help/C/legal.xml b/help/C/legal.xml
new file mode 100644
index 0000000..6f643be
--- /dev/null
+++ b/help/C/legal.xml
@@ -0,0 +1,9 @@
+<license xmlns="http://projectmallard.org/1.0/";
+         href="http://creativecommons.org/licenses/by-sa/3.0/us/";>
+<p>This work is licensed under a
+<link href="http://creativecommons.org/licenses/by-sa/3.0/us/";>Creative Commons
+Attribution-Share Alike 3.0 United States License</link>.</p>
+<p>As a special exception, the copyright holders give you permission to copy,
+modify, and distribute the example code contained in this document under the
+terms of your choosing, without restriction.</p>
+</license>
diff --git a/help/C/license.page b/help/C/license.page
new file mode 100644
index 0000000..88f6730
--- /dev/null
+++ b/help/C/license.page
@@ -0,0 +1,59 @@
+<page xmlns="http://projectmallard.org/1.0/";
+  type="topic"
+  id="license">
+  
+  <info>
+    <link type="seealso" xref="index"/>
+    <revision version="0.1" date="2010-06-04" status="draft"/>
+    <desc>Legal information.</desc>
+  </info>
+
+  <title>License</title>
+  <p>
+    <!-- 
+    Translators: try to use the same translation as the one provided by the CreativeCommons website. 
+    If there is no translation for your language, consider providing one to CreativeCommons.
+    -->
+    This work is distributed under a CreativeCommons Attribution-Share Alike
+    3.0 Unported license.
+  </p>
+  <p>
+    You are free:
+  </p>
+  <terms>
+    <item>
+      <title><em>To share</em></title>
+      <p>To copy, distribute and transmit the work.</p>
+    </item>
+    <item>
+      <title><em>To remix</em></title>
+      <p>To adapt the work.</p> 
+    </item>
+  </terms>
+  <p>
+    Under the following conditions:
+  </p>
+  <terms>
+    <item>
+      <title><em>Attribution</em></title>
+      <p>
+        You must attribute the work in the manner specified by the author or 
+        licensor (but not in any way that suggests that they endorse you or 
+        your use of the work).  
+      </p>
+    </item>
+    <item>
+      <title><em>Share Alike</em></title>
+      <p>
+        If you alter, transform, or build upon this work, you may distribute the 
+        resulting work only under the same, similar or a compatible license.  
+      </p>
+    </item>
+  </terms>
+  <p>
+    <!-- Translators: there are no official localized versions of the legal code, only the deed is localized. -->
+    For the full text of the license, see the 
+    <link href="http://creativecommons.org/licenses/by-sa/3.0/legalcode";>CreativeCommons website</link>, 
+    or read the full <link href="http://creativecommons.org/licenses/by-sa/3.0/";>Commons Deed</link>. 
+  </p>
+</page>
diff --git a/help/C/plugins-copylink.page b/help/C/plugins-copylink.page
new file mode 100644
index 0000000..50b0edf
--- /dev/null
+++ b/help/C/plugins-copylink.page
@@ -0,0 +1,26 @@
+<page xmlns="http://projectmallard.org/1.0/";
+  type="guide"
+  id="plugins-copylink">
+  
+  <info>
+    <link type="guide" xref="plugins#plugins-shipped"/>
+    <desc>Copy a link to online map services to the current position.</desc>
+    <revision version="0.1" date="2010-06-04" status="incomplete"/>
+    <credit type="author">
+      <name>Mario Blättermann</name>
+      <email>mariobl gnome org</email>
+    </credit>
+<!--
+    <copyright>
+      <year>2010</year>
+      <name>GNOME Documentation Project</name>
+    </copyright>
+-->
+    <license><p>Creative Commons Share Alike 3.0</p></license>
+
+    <include href="legal.xml" xmlns="http://www.w3.org/2001/XInclude"; />
+  </info>
+
+  <title>Copy Link</title>
+
+</page>
diff --git a/help/C/plugins-mapposition.page b/help/C/plugins-mapposition.page
new file mode 100644
index 0000000..91691cb
--- /dev/null
+++ b/help/C/plugins-mapposition.page
@@ -0,0 +1,26 @@
+<page xmlns="http://projectmallard.org/1.0/";
+  type="guide"
+  id="plugins-mapposition">
+  
+  <info>
+    <link type="guide" xref="plugins#plugins-shipped"/>
+    <desc>Displays the position at the middle of the map in the statusbar.</desc>
+    <revision version="0.1" date="2010-06-04" status="incomplete"/>
+    <credit type="author">
+      <name>Mario Blättermann</name>
+      <email>mariobl gnome org</email>
+    </credit>
+<!--
+    <copyright>
+      <year>2010</year>
+      <name>GNOME Documentation Project</name>
+    </copyright>
+-->
+    <license><p>Creative Commons Share Alike 3.0</p></license>
+
+    <include href="legal.xml" xmlns="http://www.w3.org/2001/XInclude"; />
+  </info>
+
+  <title>Map Position</title>
+
+</page>
diff --git a/help/C/plugins-placemarks.page b/help/C/plugins-placemarks.page
new file mode 100644
index 0000000..e26a798
--- /dev/null
+++ b/help/C/plugins-placemarks.page
@@ -0,0 +1,26 @@
+<page xmlns="http://projectmallard.org/1.0/";
+  type="guide"
+  id="plugins-placemarks">
+  
+  <info>
+    <link type="guide" xref="plugins#plugins-shipped"/>
+    <desc>Save places and zoom levels.</desc>
+    <revision version="0.1" date="2010-06-04" status="incomplete"/>
+    <credit type="author">
+      <name>Mario Blättermann</name>
+      <email>mariobl gnome org</email>
+    </credit>
+<!--
+    <copyright>
+      <year>2010</year>
+      <name>GNOME Documentation Project</name>
+    </copyright>
+-->
+    <license><p>Creative Commons Share Alike 3.0</p></license>
+
+    <include href="legal.xml" xmlns="http://www.w3.org/2001/XInclude"; />
+  </info>
+
+  <title>Placemarks</title>
+
+</page>
diff --git a/help/C/plugins.page b/help/C/plugins.page
new file mode 100644
index 0000000..0075812
--- /dev/null
+++ b/help/C/plugins.page
@@ -0,0 +1,41 @@
+<page xmlns="http://projectmallard.org/1.0/";
+  type="guide"
+  id="plugins">
+  
+  <info>
+    <link type="guide" xref="index"/>
+    <desc>Use plugins to extend the functionality.</desc>
+    <revision version="0.1" date="2010-06-04" status="incomplete"/>
+    <credit type="author">
+      <name>Mario Blättermann</name>
+      <email>mariobl gnome org</email>
+    </credit>
+<!--
+    <copyright>
+      <year>2010</year>
+      <name>GNOME Documentation Project</name>
+    </copyright>
+-->
+    <license><p>Creative Commons Share Alike 3.0</p></license>
+
+    <include href="legal.xml" xmlns="http://www.w3.org/2001/XInclude"; />
+  </info>
+
+  <title>Plugins</title>
+
+  <p>
+    Plugins add some more features to <app>Emerillon</app> and can extend
+    its functionality. Some plugins are already shipped with <app>Emerillon</app>
+    by default, and some more you can get from the emerillon-plugins package
+    of your distribution.
+  </p>
+  
+  <section id="plugins-shipped" style="2column">
+    <title>Plugins shipped with <app>Emerillon</app></title>
+  </section>
+
+  <section id="plugins-external" style="2column">
+    <title>External Plugins</title>
+  </section>
+
+</page>
diff --git a/help/C/usage.page b/help/C/usage.page
new file mode 100644
index 0000000..8b231a0
--- /dev/null
+++ b/help/C/usage.page
@@ -0,0 +1,26 @@
+<page xmlns="http://projectmallard.org/1.0/";
+  type="guide"
+  id="usage">
+  
+  <info>
+    <link type="guide" xref="index"/>
+    <desc>How to use <app>Emerillon</app>.</desc>
+    <revision version="0.1" date="2010-06-04" status="incomplete"/>
+    <credit type="author">
+      <name>Mario Blättermann</name>
+      <email>mariobl gnome org</email>
+    </credit>
+<!--
+    <copyright>
+      <year>2010</year>
+      <name>GNOME Documentation Project</name>
+    </copyright>
+-->
+    <license><p>Creative Commons Share Alike 3.0</p></license>
+
+    <include href="legal.xml" xmlns="http://www.w3.org/2001/XInclude"; />
+  </info>
+
+  <title>Usage</title>
+
+</page>
diff --git a/help/Makefile.am b/help/Makefile.am
new file mode 100644
index 0000000..72885a9
--- /dev/null
+++ b/help/Makefile.am
@@ -0,0 +1,20 @@
+include $(top_srcdir)/gnome-doc-utils.make
+
+DOC_ID = emerillon
+DOC_INCLUDES = legal.xml
+
+DOC_FIGURES = 
+
+DOC_PAGES = about.page	\
+	index.page	\
+	intro.page	\
+	license.page	\
+	plugins-copylink.page	\
+	plugins-mapposition.page	\
+	plugins.page	\
+	plugins-placemarks.page	\
+	usage.page
+
+DOC_LINGUAS =
+
+dist-hook: doc-dist-hook
diff --git a/help/emerillon.omf.in b/help/emerillon.omf.in
new file mode 100644
index 0000000..fbf8345
--- /dev/null
+++ b/help/emerillon.omf.in
@@ -0,0 +1,9 @@
+<?xml version="1.0" standalone="no"?>
+<omf>
+  <resource>
+    <subject category="GNOME|Applications"/>
+    <type>manual</type>
+    <relation seriesid="075c6d9f-1dfd-d645-913b-12b9208efc6610"/>
+    <rights type="CC0" license.version="3.0" holder="GNOME Documentation Project"/>
+  </resource>
+</omf>
[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]