r20891 - htdocs/branches/beta - More work on documentation page.

Sun Jul 10 02:28:44 EDT 2011

Author: cmarchi
Date: 2011-07-10 02:28:44 -0400 (Sun, 10 Jul 2011)
New Revision: 20891
Trac: http://svn.gnucash.org/trac/changeset/20891

Modified:
   htdocs/branches/beta/docs.phtml
Log:
More work on documentation page.

Modified: htdocs/branches/beta/docs.phtml
===================================================================

--- htdocs/branches/beta/docs.phtml	2011-07-10 06:25:01 UTC (rev 20890)
+++ htdocs/branches/beta/docs.phtml	2011-07-10 06:28:44 UTC (rev 20891)
@@ -60,10 +60,12 @@
   </li>
 </ul>
 
-<h2>GnuCash v2.4 <?=T_("(current stable release)");?></h2>
+<div class="featureborder">
+<h2 class="featuretitle">GnuCash v2.4 <?=T_("(current stable release)");?></h2>
+</div>
 
-<p><?php echo T_("If you have a question about how to use GnuCash, you are in the right place. The first thing you should do is read the Help Manual and the Concepts Guide, most of your questions can probably be answered by these documents.");?></p>
-<p><?php echo T_("The Help Manual is designed to be a quick reference of how to accomplish specific tasks and how to use the features in GnuCash. The Concepts Guide is designed to be an in depth guide to the concepts behind using GnuCash with a tutorial to show how to put those concepts into practice.");?></p>
+<p class="justify"><?php echo T_("If you have a question about how to use GnuCash, you are in the right place. The first thing you should do is read the Help Manual and the Concepts Guide, most of your questions can probably be answered by these documents.");?></p>
+<p class="justify"><?php echo T_("The Help Manual is designed to be a quick reference of how to accomplish specific tasks and how to use the features in GnuCash. The Concepts Guide is designed to be an in depth guide to the concepts behind using GnuCash with a tutorial to show how to put those concepts into practice.");?></p>
 
 
 <ul>
@@ -106,10 +108,10 @@
   </li>
 </ul>
 
-<p><?php echo T_("Please send an email to the <a href='mailto:gnucash-user at lists.gnucash.org'>gnucash-user</a> mailing list if you cannot find a satisfactory answer to your question within either the Help Manual or the Concepts Guide. We <b>want</b> feedback from you, it is only through your comments that we know how to modify the documentation.");?></p>
-<p><?php echo T_("Additionally, you can talk to someone via IRC at irc.gnome.org channel \"#gnucash\" about your question.  Another resource is the <a href='http://wiki.gnucash.org/wiki/'>English</a> or <a href='http://linuxwiki.de/GnuCash'>Deutsch</a> GnuCash wikis. A wiki is an interactive website where registered users can ask and answer questions.");?></p>
+<p class="justify"><?php echo T_("Please send an email to the <a href='mailto:gnucash-user at lists.gnucash.org'>gnucash-user</a> mailing list if you cannot find a satisfactory answer to your question within either the Help Manual or the Concepts Guide. We <b>want</b> feedback from you, it is only through your comments that we know how to modify the documentation.");?></p>
+<p class="justify"><?php echo T_("Additionally, you can talk to someone via IRC at irc.gnome.org channel \"#gnucash\" about your question.  Another resource is the <a href='http://wiki.gnucash.org/wiki/'>English</a> or <a href='http://linuxwiki.de/GnuCash'>Deutsch</a> GnuCash wikis. A wiki is an interactive website where registered users can ask and answer questions.");?></p>
 
-<p><?php echo T_("Some people have written HOWTO guides or tutorials. Note: the information presented in these sources may or may not be updated to the most recent version of GnuCash. If you are interested in doing development work on these documents, you should contact the original authors.");?></p>
+<p class="justify"><?php echo T_("Some people have written HOWTO guides or tutorials. Note: the information presented in these sources may or may not be updated to the most recent version of GnuCash. If you are interested in doing development work on these documents, you should contact the original authors.");?></p>
 <ul>
   <li><a href="http://www.austintek.com/gnucash/ncsa-gnucash-talk.html"><?php
 	echo T_("Joe Mack's Tutorial");?></a></li>
@@ -117,8 +119,10 @@
 	echo T_("Dave Gilbert's User Guide (Pdf)");?></a></li>
 </ul>
 
-<h2><?php echo T_("Older GnuCash Documentation");?></h2>
-<p><?php echo T_("This section contains all the older GnuCash documentation. If you are using one of these old versions of GnuCash, it is highly recommended that you upgrade to the latest stable version.");?></p>
+<div class="featureborder">
+<h2 class="featuretitle"><?php echo T_("Older GnuCash Documentation");?></h2>
+</div>
+<p class="justify"><?php echo T_("This section contains all the older GnuCash documentation. If you are using one of these old versions of GnuCash, it is highly recommended that you upgrade to the latest stable version.");?></p>
 <ul>
   <li><b>GnuCash v2.2</b>:
     <ul><b><?php echo T_("Help Manual");?></b>:
@@ -158,19 +162,21 @@
   <a href="<?=$top_dir;?>/docs/v1.6/pt_PT/"><?php echo T_("Portugese");?></a></li>
 </ul>
 
-<h2><?php echo T_("Documentation Development");?></h2>
+<div class="featureborder">
+<h2 class="featuretitle"><?php echo T_("Documentation Development");?></h2>
+</div>
 
 <h3><?php echo T_("Introduction");?></h3>
-<p><?php echo T_("The GnuCash documentation is stored in xml files. More precisely, it uses the GNOME2 XML docbook system. This is a relatively flexible system that takes xml files as input and can generate documentation in several different output formats (html, pdf,...).");?></p>
-<p><?php echo T_("If you wish to review or write GnuCash documentation, you will need to know xml. Some basic knowledge of the docbook system may be useful as well");?></p>
-<p><?php echo T_("The following links are for further sites that can help with the documentation and review process.");?>
+<p class="justify"><?php echo T_("The GnuCash documentation is stored in xml files. More precisely, it uses the GNOME2 XML docbook system. This is a relatively flexible system that takes xml files as input and can generate documentation in several different output formats (html, pdf,...).");?></p>
+<p class="justify"><?php echo T_("If you wish to review or write GnuCash documentation, you will need to know xml. Some basic knowledge of the docbook system may be useful as well");?></p>
+<p class="justify"><?php echo T_("The following links are for further sites that can help with the documentation and review process.");?>
 <ul>
 <li><a href='http://www.docbook.org'> DocBook: The Definitive Guide.</a></li>
 <li><a href='http://www.sagehill.net/docbookxsl/'>DocBook XSL: The Complete Guide</a>.</li>
 <li><a href='http://library.gnome.org/devel/hig-book/stable/'> GNOME Human Interface Guidelines</a></li>
 <li><a href='http://wiki.gnucash.org/wiki/Translation#How_to_translate_the_GnuCash_guide_and.2For_help_files'>How_to_translate_the_GnuCash_guide_and/or_help_files</a>: <?php echo T_("While this GnuCash wiki page is really about translating the documentation, it holds some useful information on working with docbook files.");?></li>
 </ul></p>
-<p><?php echo T_("We suggest also subscribing to ");?><a href='mailto:gnucash-devel at lists.gnucash.org'>gnucash-devel</a>.</p>
+<p class="justify"><?php echo T_("We suggest also subscribing to ");?><a href='mailto:gnucash-devel at lists.gnucash.org'>gnucash-devel</a>.</p>
 
 <h3><?php echo T_("Gnome Documentation guidelines");?></h3>
 <?php echo T_("As stated earlier, the new docs are based on the GNOME2 XML docbook system. Everyone wishing to help please follow these guides where possible when reviewing and/or writing docs.");?></p>
@@ -180,23 +186,23 @@
 </ul>
 
 <h3><?php echo T_("Where to get the documentation source");?></h3>
-<p><?php echo T_("You will need a recent copy of the documentation source. For this you can check out the documentation module from the GnuCash svn. Reviewers could also start from the <a href='http://sourceforge.net/projects/gnucash/files/gnucash-docs/'>current docs tarball</a>.");?></p>
-<p><?php echo T_("For those not familiar with svn, the GnuCash wiki has a <a href='http://wiki.gnucash.org/wiki/Subversion'>description</a> tailored to the GnuCash code. To get the documentation source instead of the program source, replace 'gnucash' with 'gnucash-docs' in the mentioned svn commands, like this:");?></p>
+<p class="justify"><?php echo T_("You will need a recent copy of the documentation source. For this you can check out the documentation module from the GnuCash svn. Reviewers could also start from the <a href='http://sourceforge.net/projects/gnucash/files/gnucash-docs/'>current docs tarball</a>.");?></p>
+<p class="justify"><?php echo T_("For those not familiar with svn, the GnuCash wiki has a <a href='http://wiki.gnucash.org/wiki/Subversion'>description</a> tailored to the GnuCash code. To get the documentation source instead of the program source, replace 'gnucash' with 'gnucash-docs' in the mentioned svn commands, like this:");?></p>
 <pre>svn checkout http://code.gnucash.org/repo/gnucash-docs/trunk gnucash-docs</pre>
 
 <h3><?php echo T_("Writers");?></h3>
-<p><?php echo T_("Get a copy of the documentation source as described above and start making changes. When you are satisfied with your changes you can create a patch by running the following command in the base directory of the documentation (usually gnucash-docs, unless you renamed it):");?></p>
+<p class="justify"><?php echo T_("Get a copy of the documentation source as described above and start making changes. When you are satisfied with your changes you can create a patch by running the following command in the base directory of the documentation (usually gnucash-docs, unless you renamed it):");?></p>
 <pre>svn diff > my-patch-name.patch</pre>
-<p><?php echo T_("Next attach your patch to a bug report against the documentation component for the GnuCash project in <a href='http://bugzilla.gnome.org/'>Gnome's bugzilla database</a> and send an email to <a href='mailto:gnucash-devel at lists.gnucash.org'>gnucash-devel</a> mailing list to inform other developers on your work. See also <a href='http://wiki.gnucash.org/wiki/Bugzilla'>GnuCash' wiki page on bugzilla</a> for more details about patch submission.");?></p>
+<p class="justify"><?php echo T_("Next attach your patch to a bug report against the documentation component for the GnuCash project in <a href='http://bugzilla.gnome.org/'>Gnome's bugzilla database</a> and send an email to <a href='mailto:gnucash-devel at lists.gnucash.org'>gnucash-devel</a> mailing list to inform other developers on your work. See also <a href='http://wiki.gnucash.org/wiki/Bugzilla'>GnuCash' wiki page on bugzilla</a> for more details about patch submission.");?></p>
 <div class="dialog note">
-<p><?php echo T_("<b>NOTE:</b> It used to be ok also to send your patch directly to the gnucash-devel list. This is discouraged now, as a patch is easily forgotten between the many list discussions. Attach patches to bugs in Bugzilla instead (either an existing bug or a new one). If you insist on sending a patch to gnucash-devel, it should be attached, not inlined.");?></p>
-<p><?php echo T_("Please let other writers know which section you wish to tackle. Please forward this to <a href='mailto:gnucash-devel at lists.gnucash.org'>gnucash-devel</a> so that people can say 'hey I'm doing that already' or 'go ahead and do it'.");?></p>
-<p><?php echo T_("You may also want to retain a local copy of the old documentation to refer to when writing. This still has a lot of useful information in it which hasn't been transferred to the new docs");?></p>
+<p class="justify"><?php echo T_("<b>NOTE:</b> It used to be ok also to send your patch directly to the gnucash-devel list. This is discouraged now, as a patch is easily forgotten between the many list discussions. Attach patches to bugs in Bugzilla instead (either an existing bug or a new one). If you insist on sending a patch to gnucash-devel, it should be attached, not inlined.");?></p>
+<p class="justify"><?php echo T_("Please let other writers know which section you wish to tackle. Please forward this to <a href='mailto:gnucash-devel at lists.gnucash.org'>gnucash-devel</a> so that people can say 'hey I'm doing that already' or 'go ahead and do it'.");?></p>
+<p class="justify"><?php echo T_("You may also want to retain a local copy of the old documentation to refer to when writing. This still has a lot of useful information in it which hasn't been transferred to the new docs");?></p>
 </div>
     
 <h3><?php echo T_("Reviewers");?></h3>
-<p><?php echo T_("Get a copy of the documentation source as described above and start commenting on it.");?></p>
-<p><?php echo T_("The best way of retaining comments about docs in an easy to find way for everyone would be to use <a href='http://bugzilla.gnome.org/'>bugzilla.gnome.org</a> to file the bugs under documentation. This can also be done using bug-buddy.");?></p>
+<p class="justify"><?php echo T_("Get a copy of the documentation source as described above and start commenting on it.");?></p>
+<p class="justify"><?php echo T_("The best way of retaining comments about docs in an easy to find way for everyone would be to use <a href='http://bugzilla.gnome.org/'>bugzilla.gnome.org</a> to file the bugs under documentation. This can also be done using bug-buddy.");?></p>
 
 </div>
 <?php include("externals/footer.phtml"); ?>

