GNOME.org
 

[gnome-devel-docs/wip/develguide: 7/7] Update docs on adding help

commit 4ceeeeeba9054d70adfbad52097e3050b750a62f
Author: Ekaterina Gerasimova <kittykat3756 gmail com>
Date:   Wed Apr 30 13:20:10 2014 +0200

    Update docs on adding help

 .../C/{dev-help-appmenu.page => help-appmenu.page} |   11 +++++++--
 .../C/{dev-help-build.page => help-build.page}     |   23 ++++++++++---------
 .../C/{dev-help-write.page => help-write.page}     |   19 ++++++++-------
 devel-guide/C/{dev-help.page => help.page}         |    7 +++--
 devel-guide/Makefile.am                            |    8 +++---
 5 files changed, 38 insertions(+), 30 deletions(-)
---
diff --git a/devel-guide/C/dev-help-appmenu.page b/devel-guide/C/help-appmenu.page
similarity index 87%
rename from devel-guide/C/dev-help-appmenu.page
rename to devel-guide/C/help-appmenu.page
index 63f5ebf..27e7580 100644
--- a/devel-guide/C/dev-help-appmenu.page
+++ b/devel-guide/C/help-appmenu.page
@@ -1,11 +1,12 @@
 <page xmlns="http://projectmallard.org/1.0/";
       xmlns:its="http://www.w3.org/2005/11/its";
       type="topic" style="task"
-      id="dev-help-appmenu">
+      id="help-appmenu">
 
   <info>
-    <link type="seealso" xref="dev-help"/>
-    <revision version="0.1" date="2013-06-19" status="review"/>
+    <link type="seealso" xref="help"/>
+    <revision pkgversion="3.10" date="2013-06-19" status="review"/>
+    <revision pkgversion="3.14" date="2014-04-30" status="review"/>
 
     <credit type="author copyright">
       <name>Radina Matic</name>
@@ -85,4 +86,8 @@
   <code>"help:<input>applicationname</input>/index#<input>sectionid</input>"</code>.</p>
 
   </example>
+
+  <p><cmd 
href="https://git.gnome.org/browse/gnome-logs/commit/?id=f180685fdbce554ccec5c6fb13bf8b1e2b21e88f";>gnome-logs</cmd>
+  has an example in C.</p>
+
 </page>
diff --git a/devel-guide/C/dev-help-build.page b/devel-guide/C/help-build.page
similarity index 85%
rename from devel-guide/C/dev-help-build.page
rename to devel-guide/C/help-build.page
index 4c6aed2..a2c80f0 100644
--- a/devel-guide/C/dev-help-build.page
+++ b/devel-guide/C/help-build.page
@@ -1,11 +1,12 @@
 <page xmlns="http://projectmallard.org/1.0/";
       xmlns:its="http://www.w3.org/2005/11/its";
       type="topic" style="task"
-      id="dev-help-build">
+      id="help-build">
 
   <info>
-    <link type="next" xref="dev-help-appmenu"/>
-    <revision version="0.1" date="2013-06-18" status="review"/>
+    <link type="next" xref="help-appmenu"/>
+    <revision pkgversion="3.10" date="2013-06-18" status="review"/>
+    <revision pkgversion="3.14" date="2014-04-30" status="review"/>
 
     <credit type="author copyright">
       <name>Radina Matic</name>
@@ -32,16 +33,16 @@
   <file its:translate="no">/usr/share/help/<input>locale</input>/<input>HELP_ID</input></file> directory.</p>
 
   <p>Add the following lines in the file <file>configure.ac</file>:</p>
-  
+
   <code>YELP_HELP_INIT</code>
-  
+
   <code>AC_CONFIG_FILES([
 help/Makefile
 ])</code>
 
   <p>Add the following line to the <file>Makefile.am</file>:</p>
   <code>SUBDIRS = help</code>
-               
+
   <p>Add a <file>help/Makefile.am</file>, it should list the help files in your
   project that you want to install:</p>
 <code>
@@ -49,18 +50,18 @@ help/Makefile
 
 HELP_ID = <input>applicationname</input>
 
-# Media files
-HELP_MEDIA = \
-       figures/icon.png
-
 # Help pages
 HELP_FILES = \
        index.page \
        introduction.page \
        anotherpage.page
 
+# Media files
+HELP_MEDIA = \
+       media/icon.png
+
 # Translated languages, blank if no translations exist
-HELP_LINGUAS = en_GB 
+HELP_LINGUAS = en_GB
 </code>
 
 </page>
diff --git a/devel-guide/C/dev-help-write.page b/devel-guide/C/help-write.page
similarity index 91%
rename from devel-guide/C/dev-help-write.page
rename to devel-guide/C/help-write.page
index 9ed7196..f9d3f25 100644
--- a/devel-guide/C/dev-help-write.page
+++ b/devel-guide/C/help-write.page
@@ -1,11 +1,12 @@
 <page xmlns="http://projectmallard.org/1.0/";
       xmlns:its="http://www.w3.org/2005/11/its";
       type="topic" style="task"
-      id="dev-help-write">
+      id="help-write">
 
   <info>
-    <link type="next" xref="dev-help-build"/>
-    <revision version="0.1" date="2013-06-19" status="review"/>
+    <link type="next" xref="help-build"/>
+    <revision pkgversion="3.10" date="2013-06-19" status="review"/>
+    <revision pkgversion="3.14" date="2014-04-30" status="review"/>
 
     <credit type="author">
       <name>Ekaterina Gerasimova</name>
@@ -25,11 +26,11 @@
 
   <p>Write some <link href="http://www.projectmallard.org/";>Mallard</link>
   pages and add them to <file>help/C/</file>.</p>
-  
+
   <p>Most projects should have an <file>index.page</file> and some content
   pages, although you may not need an <file>index.page</file> if you are
   dropping plugin help into another project.</p>
-  
+
   <example>
     <listing>
       <title><file>help/C/index.page</file></title>
@@ -57,7 +58,7 @@
 </page>
 ]]></code>
     </listing>
-  
+
     <listing>
       <title><file>help/C/introduction.page</file></title>
 <code><![CDATA[
@@ -73,13 +74,13 @@
     <link type="seealso" xref="anotherpageid"/>
 -->
     <revision pkgversion="3.9" date="2013-06-19" status="stub"/>
- 
+
     <credit type="author">
       <name>Your Name</name>
       <email its:translate="no">mail example com</email>
       <years>2013</years>
     </credit>
- 
+
     <include href="legal.xml" xmlns="http://www.w3.org/2001/XInclude"/>
 
     <desc>Welcome to _Application name_</desc>
@@ -93,5 +94,5 @@
 ]]></code>
     </listing>
   </example>
- 
+
 </page>
diff --git a/devel-guide/C/dev-help.page b/devel-guide/C/help.page
similarity index 86%
rename from devel-guide/C/dev-help.page
rename to devel-guide/C/help.page
index 8b620f4..05231e2 100644
--- a/devel-guide/C/dev-help.page
+++ b/devel-guide/C/help.page
@@ -1,14 +1,15 @@
 <page xmlns="http://projectmallard.org/1.0/";
       xmlns:its="http://www.w3.org/2005/11/its";
       type="topic" style="task"
-      id="dev-help">
+      id="help">
 
   <info>
     <link type="guide" xref="index" group="help"/>
-    <link type="next" xref="dev-help-write"/>
+    <link type="next" xref="help-write"/>
     <link type="seealso" xref="dev-translate"/>
 
-    <revision version="0.1" date="2013-06-18" status="review"/>
+    <revision pkgversion="3.10" date="2013-06-18" status="review"/>
+    <revision pkgversion="3.14" date="2014-04-30" status="review"/>
 
     <credit type="author copyright">
       <name>Radina Matic</name>
diff --git a/devel-guide/Makefile.am b/devel-guide/Makefile.am
index 7ef7822..65f62b1 100644
--- a/devel-guide/Makefile.am
+++ b/devel-guide/Makefile.am
@@ -3,10 +3,6 @@
 HELP_ID = devel-guide
 
 HELP_FILES = \
-        dev-help-appmenu.page \
-        dev-help-build.page \
-        dev-help.page \
-        dev-help-write.page \
         dev-launching-desktop.page \
         dev-launching-icons.page \
         dev-launching-mime.page \
@@ -22,6 +18,10 @@ HELP_FILES = \
         extension-icon-working.page \
         extension-twitter.page \
         extension-widget.page \
+        help-appmenu.page \
+        help-build.page \
+        help.page \
+        help-write.page \
        index.page \
        legal.xml
[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]