GNOME.org
 

[emerillon-plugins] Add basic documentation

commit f73ad4a86100fb985794016b03c2a5d2d91f8368
Author: Mario Blättermann <mariobl gnome org>
Date:   Tue Jun 22 16:40:37 2010 +0200

    Add basic documentation

 Makefile.am                      |    6 ++++--
 README                           |    7 +++++++
 configure.ac                     |   12 ++++++++++++
 help/C/legal.xml                 |    9 +++++++++
 help/C/plugins-bixi.page         |   25 +++++++++++++++++++++++++
 help/C/plugins-image-export.page |   25 +++++++++++++++++++++++++
 help/C/plugins-sample-vala.page  |   26 ++++++++++++++++++++++++++
 help/Makefile.am                 |   11 +++++++++++
 8 files changed, 119 insertions(+), 2 deletions(-)
---
diff --git a/Makefile.am b/Makefile.am
index 085ed26..1d91e16 100644
--- a/Makefile.am
+++ b/Makefile.am
@@ -1,13 +1,15 @@
-SUBDIRS = plugins po
+SUBDIRS = plugins po help
 
 EXTRA_DIST =			\
 	autogen.sh		\
+	gnome-doc-utils.make	\
 	ChangeLog
 
 DISTCLEANFILES = 		\
 	intltool-extract 	\
 	intltool-merge 		\
-	intltool-update
+	intltool-update		\
+	gnome-doc-utils.make
 
 DISTCHECK_CONFIGURE_FLAGS = --with-plugins=really-all
 
diff --git a/README b/README
index e69de29..bd98ff0 100644
--- a/README
+++ b/README
@@ -0,0 +1,7 @@
+Note to developers
+==================
+
+If you create a plugin, you are supposed to also create a help page for it
+or fix the buildsystem, sorry ;)
+The page name should be in the format plugins-<name_used_in_configure.ac>.page.
+
diff --git a/configure.ac b/configure.ac
index 94fc8d2..e010ef5 100644
--- a/configure.ac
+++ b/configure.ac
@@ -43,6 +43,11 @@ GETTEXT_PACKAGE=emerillon-plugins
 AC_SUBST(GETTEXT_PACKAGE)
 AC_DEFINE_UNQUOTED(GETTEXT_PACKAGE,"$GETTEXT_PACKAGE", [Gettext package])
 
+# *************
+# Documentation
+# *************
+GNOME_DOC_INIT
+
 # **********
 # GNOME Libs
 # **********
@@ -343,6 +348,12 @@ PLUGINS=$(echo $PLUGINS | tr ' ' '\n' | sort | uniq | tr '\n' ' ')
 AC_SUBST([DIST_PLUGINS])
 AC_SUBST([BUILD_PLUGINS],[$PLUGINS])
 
+for plug in $PLUGINS
+do
+	DOC_PLUGIN_PAGE="$DOC_PLUGIN_PAGE plugins-$plug.page"
+done
+AC_SUBST([DOC_PLUGIN_PAGE])
+
 # ****
 # Misc
 # ****
@@ -353,6 +364,7 @@ AC_SUBST(PLUGIN_LIBTOOL_FLAGS)
 
 AC_CONFIG_FILES([
 Makefile
+help/Makefile
 plugins/Makefile
 plugins/bixi/Makefile
 plugins/image-export/Makefile
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/plugins-bixi.page b/help/C/plugins-bixi.page
new file mode 100644
index 0000000..3fb97b0
--- /dev/null
+++ b/help/C/plugins-bixi.page
@@ -0,0 +1,25 @@
+<page xmlns="http://projectmallard.org/1.0/";
+  type="guide"
+  id="plugins-bixi">
+  
+  <info>
+    <link type="guide" xref="plugins#plugins-external"/>
+    <desc>Displays stations from the Bixi network with available bikes and empty docks.</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>Creative Commons Share Alike 3.0</license>
+
+    <include href="legal.xml" xmlns="http://www.w3.org/2001/XInclude"; />
+  </info>
+
+  <title>Montreal Public Bike System</title>
+
+</page>
diff --git a/help/C/plugins-image-export.page b/help/C/plugins-image-export.page
new file mode 100644
index 0000000..6fd98e4
--- /dev/null
+++ b/help/C/plugins-image-export.page
@@ -0,0 +1,25 @@
+<page xmlns="http://projectmallard.org/1.0/";
+  type="guide"
+  id="plugins-image-export">
+  
+  <info>
+    <link type="guide" xref="plugins#plugins-external"/>
+    <desc>Export the map as a PNG image.</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>Creative Commons Share Alike 3.0</license>
+
+    <include href="legal.xml" xmlns="http://www.w3.org/2001/XInclude"; />
+  </info>
+
+  <title>Image Exporter</title>
+
+</page>
diff --git a/help/C/plugins-sample-vala.page b/help/C/plugins-sample-vala.page
new file mode 100644
index 0000000..5cfd355
--- /dev/null
+++ b/help/C/plugins-sample-vala.page
@@ -0,0 +1,26 @@
+<page xmlns="http://projectmallard.org/1.0/";
+  type="guide"
+  id="plugins-sample-vala">
+  
+  <info>
+    <link type="guide" xref="plugins#plugins-external"/>
+    <desc>Sample plugin written in Vala</desc>
+    <revision version="0.1" date="2010-06-04" status="incomplete"/>
+    <credit type="author">
+      <name>Å?ukasz JernaÅ?</name>
+      <email>deejay1 srem org</email>
+    </credit>
+    <copyright>
+      <year>2010</year>
+      <name>GNOME Documentation Project</name>
+    </copyright>
+
+    <license>Creative Commons Share Alike 3.0</license>
+
+    <include href="legal.xml" xmlns="http://www.w3.org/2001/XInclude"; />
+  </info>
+
+  <title>Vala Sample Plugin</title>
+  <p>This is a sample plugin written in <link href="http://live.gnome.org/Vala";>Vala</link>
+     which can be used as template to create other plugins</p>
+</page>
diff --git a/help/Makefile.am b/help/Makefile.am
new file mode 100644
index 0000000..93342a4
--- /dev/null
+++ b/help/Makefile.am
@@ -0,0 +1,11 @@
+include $(top_srcdir)/gnome-doc-utils.make
+
+DOC_ID = emerillon
+
+DOC_FIGURES = 
+
+DOC_PAGES = $(DOC_PLUGIN_PAGE)
+
+DOC_LINGUAS = 
+
+dist-hook: doc-dist-hook
[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]