Changeset 33782


Ignore:
Timestamp:
2019-12-10T11:35:52+13:00 (5 years ago)
Author:
kjdon
Message:

updated README

File:
1 edited

Legend:

Unmodified
Added
Removed
  • documentation/trunk/tutorials/README.html

    r25468 r33782  
    1818<a name="requirements">
    1919</a>
    20 <h2><a name="requirements">Requirements</a></h2>
    21 <a name="requirements">To use this package to re-generate the
     20<h2>Requirements</h2>
     21To use this package to re-generate the
    2222Greenstone tutorial HTML, or generate a workshop, you need to have the
    2323following:
    24 </a>
     24
    2525<ul>
    26   <li><a name="requirements">Greenstone version 2.85 installed</a></li>
    27   <li><a name="requirements">A Java runtime system</a></li>
     26  <li>Greenstone version 2.87/3.09 installed</li>
     27  <li>A Java runtime system</li>
    2828</ul>
    2929<a name="contents">
    3030</a>
    31 <h2><a name="contents">Contents of this package</a></h2>
     31<h2>Contents of this package</h2>
    3232<dl>
    33 <dt><b>README.html</b></dt><dd>This file</dd>
    34 <dt><b>xml-source</b></dt><dd>The raw XML files for the tutorials
    35 <ul>
    36 <li><b>tutorial_en.xml</b> The main tutorial XML file, in English. Valid for 2.85</li>
     33  <dt><b>README.html</b></dt><dd>This file</dd>
     34  <dt><b>generate-html.sh/bat</b></dt><dd>Scripts for generating all the HTML</dd>
     35  <dt><b>generate-workshop.sh/bat</b></dt><dd>Scripts for generating a workshop</dd>
     36  <dt><b>xml-source</b></dt><dd>The raw XML files for the tutorials
     37    <ul>
     38<li><b>tutorial_en.xml</b> The main tutorial XML file, in English. Valid for 2.87/3.09</li>
    3739<li><b>tutorial_[fr|ru|es].xml</b> Translations (of an old version) of tutorial_en.xml. Valid for 2.70</li>
    3840</ul>
     
    5961<a name="generate-html">
    6062</a>
    61 <h2><a name="generate-html">Generating HTML files</a></h2>
    62 <ol>
    63   <li><a name="generate-html">Run <tt>source setup.bash</tt> in the
     63<h2>Generating HTML files</h2>
     64<h3>The easy way</h3>
     65<ol>
     66  <li>Run <tt>source setup.bash/source gs3-setup.sh</tt> in the
    6467top level directory of your Greenstone installation</a></li>
     68  <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>
     69</ol>
     70Windows versions of these commands are like the
     71following:
     72<ol>
     73  <li><tt>setup.bat/gs3-setup.bat</tt> in the top level directory of your gs2 or gs3 installation</li>
     74  <li><tt>generate-html [2 or 3]</tt> in this tutorials directory</li>
     75</ol>
     76
     77These commands will make an html folder, with en subfolder containing all the English pages, plus index.html and wiki-index.txt.
     78
     79This 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:
     80<ol>
     81  <li>Edit generate-html.sh, and add all the language codes to langs (langs="en fr es ru")</li>
     82  <li>Edit xml-to-top-index.xsl, set the value of all-langs variable to 1</li>
     83  <li>Re-run the generate-html.sh/bat script</li>
     84</ol>
     85
     86<h3>The old complicated way</h3>
     87<ol>
     88  <li>Run <tt>source setup.bash</tt> in the
     89    top level directory of your Greenstone installation</li>
    6590  <li><a name="generate-html">Create a subdirectory in gsdl-tutorials
    6691for your output files. If you are using multiple languages and want to
Note: See TracChangeset for help on using the changeset viewer.