[gnome-devel-docs] Review help pages for new platform overview

[David King <davidk src gnome org>]

commit 2f925012d2ff386d6e64e877500ac82d38e12b8a
Author: David King <amigadave amigadave com>
Date:   Wed Jun 19 21:57:36 2013 +0100

    Review help pages for new platform overview

 new-platform-overview/dev-help-appmenu.page |   10 +++++-----
 new-platform-overview/dev-help-build.page   |   11 ++++++-----
 new-platform-overview/dev-help-write.page   |   12 ++++++------
 new-platform-overview/dev-help.page         |    2 +-
 4 files changed, 18 insertions(+), 17 deletions(-)
---
diff --git a/new-platform-overview/dev-help-appmenu.page b/new-platform-overview/dev-help-appmenu.page
index f274c5d..fcddad7 100644
--- a/new-platform-overview/dev-help-appmenu.page
+++ b/new-platform-overview/dev-help-appmenu.page
@@ -5,7 +5,7 @@
 
   <info>
     <link type="seealso" xref="dev-help"/>
-    <revision version="0.1" date="2013-06-19" status="stub"/>
+    <revision version="0.1" date="2013-06-19" status="review"/>
 
     <credit type="author copyright">
       <name>Radina Matic</name>
@@ -34,10 +34,10 @@
 
   <example>
   <note>
-    <p>The example, based on
+    <p>This example, based on
     <app href="https://git.gnome.org/browse/cheese/tree/src/cheese-main.vala";>Cheese</app>,
     assumes that your application is written in Vala. It will be slightly
-    different for other languages.</p>
+    different for other programming languages.</p>
   </note>
 
   <p>Add the <gui style="menuitem">Help</gui> item to the list of actions:</p>
@@ -63,8 +63,8 @@
   section.append_item (item);</input>
 </code>
 
-  <p>Open <app>Yelp</app> when the <gui style="menuitem">Help</gui> button is
-  clicked:</p>
+  <p>View the help with <app>Yelp</app> when the
+  <gui style="menuitem">Help</gui> menu item is clicked:</p>
 
 <code>
   private void on_help ()
diff --git a/new-platform-overview/dev-help-build.page b/new-platform-overview/dev-help-build.page
index 2050111..b9c7143 100644
--- a/new-platform-overview/dev-help-build.page
+++ b/new-platform-overview/dev-help-build.page
@@ -4,8 +4,8 @@
       id="dev-help-build">
 
   <info>
-     <link type="next" xref="dev-help-appmenu"/>
-     <revision version="0.1" date="2013-06-18" status="stub"/>
+    <link type="next" xref="dev-help-appmenu"/>
+    <revision version="0.1" date="2013-06-18" status="review"/>
 
     <credit type="author copyright">
       <name>Radina Matic</name>
@@ -29,7 +29,7 @@
   </links>
 
   <p>Help is normally installed into the
-  <file its:translate="no">usr/share/help/$lang/HELP_ID</file> directory.</p>
+  <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>
   
@@ -42,7 +42,8 @@ help/Makefile
   <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 look like:</p>
+  <p>Add a <file>help/Makefile.am</file>, it should list the help files in your
+  project that you want to install:</p>
 <code>
 @YELP_HELP_RULES@
 
@@ -58,7 +59,7 @@ HELP_FILES = \
        introduction.page \
        anotherpage.page
 
-# Translated languages
+# Translated languages, blank if no translations exist
 HELP_LINGUAS = en_GB 
 </code>
 
diff --git a/new-platform-overview/dev-help-write.page b/new-platform-overview/dev-help-write.page
index bafcecd..6a0d53b 100644
--- a/new-platform-overview/dev-help-write.page
+++ b/new-platform-overview/dev-help-write.page
@@ -5,7 +5,7 @@
 
   <info>
     <link type="next" xref="dev-help-build"/>
-    <revision version="0.1" date="2013-06-19" status="stub"/>
+    <revision version="0.1" date="2013-06-19" status="review"/>
 
     <credit type="author">
       <name>Ekaterina Gerasimova</name>
@@ -24,11 +24,11 @@
   </links>
 
   <p>Write some <link href="http://www.projectmallard.org/";>Mallard</link>
-  pages and add them to <file>help/C</file>.</p>
+  pages and add them to <file>help/C/</file>.</p>
   
-  <p>Most projects should have an index.page and some content pages, although
-  you may not need an <file>index.page</file> if you are dropping plugin help
-  into another project.</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>
@@ -67,6 +67,7 @@
       id="introduction">
 
   <info>
+    <link type="guide" xref="index"/>
 <!--
     <link type="guide" xref="index#features"/>
     <link type="seealso" xref="anotherpageid"/>
@@ -92,6 +93,5 @@
 ]]></code>
     </listing>
   </example>
-
  
 </page>
diff --git a/new-platform-overview/dev-help.page b/new-platform-overview/dev-help.page
index 5c1458e..be9aacb 100644
--- a/new-platform-overview/dev-help.page
+++ b/new-platform-overview/dev-help.page
@@ -8,7 +8,7 @@
     <link type="next" xref="dev-help-write"/>
     <link type="seealso" xref="dev-translate"/>
 
-    <revision version="0.1" date="2013-06-18" status="stub"/>
+    <revision version="0.1" date="2013-06-18" status="review"/>
 
     <credit type="author copyright">
       <name>Radina Matic</name>