Changeset 33782

Timestamp:

2019-12-10T11:35:52+13:00 (4 years ago)

Author:

kjdon

Message:

updated README

File:

• documentation/trunk/tutorials/README.html (modified) (2 diffs)

documentation/trunk/tutorials/README.html

@@ -18 +18 @@
 <a name="requirements">
 </a>
-<h2><a name="requirements">Requirements</a></h2>
-<a name="requirements">To use this package to re-generate the
+<h2>Requirements</h2>
+To use this package to re-generate the
 Greenstone tutorial HTML, or generate a workshop, you need to have the
 following:
-</a>
+
 <ul>
-  <li><a name="requirements">Greenstone version 2.85 installed</a></li>
-  <li><a name="requirements">A Java runtime system</a></li>
+  <li>Greenstone version 2.87/3.09 installed</li>
+  <li>A Java runtime system</li>
 </ul>
 <a name="contents">
 </a>
-<h2><a name="contents">Contents of this package</a></h2>
+<h2>Contents of this package</h2>
 <dl>
-<dt><b>README.html</b></dt><dd>This file</dd>
-<dt><b>xml-source</b></dt><dd>The raw XML files for the tutorials
-<ul>
-<li><b>tutorial_en.xml</b> The main tutorial XML file, in English. Valid for 2.85</li>
+  <dt><b>README.html</b></dt><dd>This file</dd>
+  <dt><b>generate-html.sh/bat</b></dt><dd>Scripts for generating all the HTML</dd>
+  <dt><b>generate-workshop.sh/bat</b></dt><dd>Scripts for generating a workshop</dd>
+  <dt><b>xml-source</b></dt><dd>The raw XML files for the tutorials
+    <ul>
+<li><b>tutorial_en.xml</b> The main tutorial XML file, in English. Valid for 2.87/3.09</li>
 <li><b>tutorial_[fr|ru|es].xml</b> Translations (of an old version) of tutorial_en.xml. Valid for 2.70</li>
 </ul>
@@ -59 +61 @@
 <a name="generate-html">
 </a>
-<h2><a name="generate-html">Generating HTML files</a></h2>
-<ol>
-  <li><a name="generate-html">Run <tt>source setup.bash</tt> in the
+<h2>Generating HTML files</h2>
+<h3>The easy way</h3>
+<ol>
+  <li>Run <tt>source setup.bash/source gs3-setup.sh</tt> in the
 top level directory of your Greenstone installation</a></li>
+  <li>Run <tt>./generate-html.sh [2 or 3]</tt> in this tutorials directory, where 2/3 is which Greenstone version you want to generate tutorials for.  </li>
+</ol>
+Windows versions of these commands are like the
+following:
+<ol>
+  <li><tt>setup.bat/gs3-setup.bat</tt> in the top level directory of your gs2 or gs3 installation</li>
+  <li><tt>generate-html [2 or 3]</tt> in this tutorials directory</li>
+</ol>
+
+These commands will make an html folder, with en subfolder containing all the English pages, plus index.html and wiki-index.txt.
+
+This is currently set up to only generate the English version of the HTML. The French, Spanish and Russion translations are for 2.70 and haven't been updated, so we don't need to do them each time. But if they did get translated, and you want to generate the other languages, do the following:
+<ol>
+  <li>Edit generate-html.sh, and add all the language codes to langs (langs="en fr es ru")</li>
+  <li>Edit xml-to-top-index.xsl, set the value of all-langs variable to 1</li>
+  <li>Re-run the generate-html.sh/bat script</li>
+</ol>
+
+<h3>The old complicated way</h3>
+<ol>
+  <li>Run <tt>source setup.bash</tt> in the
+    top level directory of your Greenstone installation</li>
   <li><a name="generate-html">Create a subdirectory in gsdl-tutorials
 for your output files. If you are using multiple languages and want to