Changeset 32021 for documentation


Ignore:
Timestamp:
2017-10-02T19:18:45+13:00 (7 years ago)
Author:
ak19
Message:

Some further changes to the GS2 tutorials for the GS2.87 release.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • documentation/trunk/tutorials/xml-source/tutorial_en.xml

    r31997 r32021  
    1010<Text id="0001">Greenstone tutorial exercises (2016)</Text>
    1111</Title>
    12 <MajorVersion number="2"><Version current="2.86"/></MajorVersion>
     12<MajorVersion number="2"><Version current="2.87"/></MajorVersion>
    1313<MajorVersion number="3"><Version current="3.08"/></MajorVersion>
    1414<SupplementaryText>
     
    382382<Text id="0193">Installing Greenstone</Text>
    383383</Title>
    384 <Version initial="2.60" current="2.86"/>
     384<Version initial="2.60" current="2.87"/>
    385385<Content>
    386386<Heading>
     
    441441</Bullet>
    442442</BulletList>
    443 <Text id="0218">To invoke the Greenstone Reader's Interface, go to the <i>Greenstone-2.86</i> item under <i>All Programs</i> on the Windows <i>Start</i> menu and select <i>Greenstone Server</i>, once the server window is displayed click &lt;<b>Enter Library</b>&gt;.</Text>
     443<Text id="0218">To invoke the Greenstone Reader's Interface, go to the <i>Greenstone-2.87</i> item under <i>All Programs</i> on the Windows <i>Start</i> menu and select <i>Greenstone Server</i>, once the server window is displayed click &lt;<b>Enter Library</b>&gt;.</Text>
    444444<Text id="0219">To invoke the Greenstone Librarian Interface, go to the same item and select <i>Librarian Interface (GLI)</i>.</Text>
    445445</Content>
     
    452452</Title>
    453453<Prerequisite id="install_greenstone"/>
    454 <Version initial="2.60" current="2.86"/>
     454<Version initial="2.60" current="2.87"/>
    455455<Content>
    456456<Comment>
     
    507507</Title>
    508508<SampleFiles folder="simple_html"/>
    509 <Version initial="2.60|3.06" current="2.86|3.08"/>
     509<Version initial="2.60|3.06" current="2.87|3.08"/>
    510510<Content>
    511511<Comment>
     
    519519  <MajorVersion number="2">
    520520<Menu>
    521 <Text id="0255a">Start &rarr; All Programs &rarr; Greenstone-2.86 &rarr; Librarian Interface (GLI)</Text>
     521<Text id="0255a">Start &rarr; All Programs &rarr; Greenstone-2.87 &rarr; Librarian Interface (GLI)</Text>
    522522</Menu>
    523523  </MajorVersion>
     
    615615</Title>
    616616<SampleFiles folder="images"/>
    617 <Version initial="2.60|3.06" current="2.86|3.08"/>
     617<Version initial="2.60|3.06" current="2.87|3.08"/>
    618618<Content>
    619619<Comment>
     
    870870</Title>
    871871<SampleFiles folder="Word_and_PDF"/>
    872 <Version initial="2.60|3.06" current="2.86|3.08"/>
     872<Version initial="2.60|3.06" current="2.87|3.08"/>
    873873<Content>
    874874<Comment>
     
    979979</Title>
    980980<Prerequisite id="word_pdf_collection"/>
    981 <Version initial="2.70w|3.06" current="2.86|3.08"/>
     981<Version initial="2.70w|3.06" current="2.87|3.08"/>
    982982<Content>
    983983<Comment>
     
    12421242<SampleFiles folder="pdfbox"/>
    12431243<Prerequisite id="word_pdf_collection"/>
    1244 <Version initial="2.85|3.06" current="2.86|3.08"/>
     1244<Version initial="2.85|3.06" current="2.87|3.08"/>
    12451245<Content>
    12461246<Comment>
     
    12871287</Title>
    12881288<SampleFiles folder="Word_and_PDF"/>
    1289 <Version initial="2.70|3.06" current="2.86|3.08"/>
     1289<Version initial="2.70|3.06" current="2.87|3.08"/>
    12901290<Content>
    12911291<Text id="ep-2">Greenstone converts PDF files to HTML using third-party software: <AutoText text="pdftohtml.pl" type="italics"/>. This lets users view these documents even if they don't have the PDF software installed. Unfortunately, sometimes the formatting of the resulting HTML files is not so good. This exercise explores some extra options to the PDF plugin which may produce a nicer version for display.</Text>
     
    15001500<Text id="ew-a">Enhanced Word document handling</Text>
    15011501</Title>
    1502 <Version initial="2.70w|3.06" current="2.86|3.08"/>
     1502<Version initial="2.70w|3.06" current="2.87|3.08"/>
    15031503<Prerequisite id="word_pdf_collection"/>
    15041504<Content>
     
    16241624</Title>
    16251625<Prerequisite id="word_pdf_collection"/>
    1626 <Version initial="2.85|3.06" current="2.86|3.08"/>
     1626<Version initial="2.85|3.06" current="2.87|3.08"/>
    16271627<Content>
    16281628<Comment>
     
    17851785<Text id="0403">Exporting a collection to CD-ROM/DVD</Text>
    17861786</Title>
    1787 <Version initial="2.60" current="2.86"/>
     1787<Version initial="2.60" current="2.87"/>
    17881788<Content>
    17891789<Comment>
     
    18111811</Title>
    18121812<SampleFiles folder="tudor"/>
    1813 <Version initial="2.60|3.06" current="2.86|3.08"/>
     1813<Version initial="2.60|3.06" current="2.87|3.08"/>
    18141814<Content>
    18151815<Comment>
     
    18731873</Title>
    18741874<Prerequisite id="large_html_collection"/>
    1875 <Version initial="2.60|3.06" current="2.86|3.08"/>
     1875<Version initial="2.60|3.06" current="2.87|3.08"/>
    18761876<Content>
    18771877<Comment>
     
    19821982</Title>
    19831983<Prerequisite id="large_html_collection"/>
    1984 <Version initial="2.60|3.06" current="2.86|3.08"/>
     1984<Version initial="2.60|3.06" current="2.87|3.08"/>
    19851985<Content>
    19861986<NumberedItem>
     
    22902290<Text id="st-1">Section tagging for HTML documents</Text>
    22912291</Title>
    2292 <Version initial="2.70w|3.06" current="2.86|3.08"/>
     2292<Version initial="2.70w|3.06" current="2.87|3.08"/>
    22932293<Content>
    22942294<NumberedItem>
    2295 <Text id="st-1a">In a browser, visit the Greenstone demo collection and have a ook at it. Browse to one of the documents. This collection is based on HTML files, but they appear structured in the collection. This is because these HTML files were tagged by hand into sections.</Text>
     2295<Text id="st-1a">In a browser, visit the Greenstone demo collection and have a look at it. Browse to one of the documents. This collection is based on HTML files, but they appear structured in the collection. This is because these HTML files were tagged by hand into sections.</Text>
    22962296</NumberedItem>
    22972297<NumberedItem>
     
    23652365<Text id="0411">Downloading files from the web</Text>
    23662366</Title>
    2367 <Version initial="2.60|3.06" current="2.86|3.08"/>
     2367<Version initial="2.60|3.06" current="2.87|3.08"/>
    23682368<Content>
    23692369<Comment>
     
    24102410</Title>
    24112411<Prerequisite id="downloading_from_internet"/>
    2412 <Version initial="2.60|3.06" current="2.86|3.08"/>
     2412<Version initial="2.60|3.06" current="2.87|3.08"/>
    24132413<Content>
    24142414<NumberedItem>
     
    24592459</Title>
    24602460<SampleFiles folder="marc"/>
    2461 <Version initial="2.60|3.06" current="2.86|3.08"/>
     2461<Version initial="2.60|3.06" current="2.87|3.08"/>
    24622462<Content>
    24632463<Comment>
     
    27312731</Title>
    27322732<SampleFiles folder="isis"/>
    2733 <Version initial="2.70w|3.06" current="2.86|3.08"/>
     2733<Version initial="2.70w|3.06" current="2.87|3.08"/>
    27342734<Content>
    27352735<Comment>
     
    28502850</Title>
    28512851<SampleFiles folder="custom"/>
    2852 <Version initial="2.70" current="2.86"/>
     2852<Version initial="2.70" current="2.87"/>
    28532853<Content>
    28542854<Text id="mf-2">The appearance of all pages produced by Greenstone is governed by macro files, which reside in the folder <Path>Greenstone &rarr; macros</Path>, and images and CSS stylesheets reside in <Path>Greenstone &rarr; web &rarr; style</Path>.</Text>
     
    29422942<Text id="mf-73-1">Changing the colour of the page title and page text</Text>
    29432943</Heading>
    2944 <Text id="mf-17">In the previous exercises we changed a single collection. Now we change all the pages in our Greenstone installation by modifying style and macro files outside the Librarian Interface. First, we format the page so that some other parts are blue. Preview any collection after each change to make sure that it has worked properly. On Windows, macro file changes require a restart of the Greenstone local library server. Stylesheet changes may require a forced reload in the web browser.</Text>
     2944<Text id="mf-17">In the previous exercises we changed a single collection. Now we change all the pages in our Greenstone installation by modifying style and macro files outside the Librarian Interface. First, we format the page so that some other parts are blue. Preview any collection after each change to make sure that it has worked properly. On Windows, macro file changes may require a restart of the Greenstone local library server. Stylesheet changes may require a forced reload in the web browser.</Text>
    29452945<Comment>
    29462946<Text id="mf-17-1">Note, use any collection <b>except</b> the reports collection to preview the following changes. Because the reports collection has been modified to use its own custom stylesheet, changes to the main stylesheet won't have any effect on it.</Text>
     
    29662966</Bullet>
    29672967</BulletList>
    2968 <Text id="mf-27b">Preview the collection. You might want to reload the page. Now text in the page body is a light green color (teal), and the font of the collection title has changed from black to blue.</Text>
     2968<Text id="mf-27b">Preview the collection. You may need to force the browser to reload the page to see the changes in effect, or else may need to restart the Greenstone server. Now text in the page body is a light green color (teal), and the font of the collection title has changed from black to blue.</Text>
    29692969</NumberedItem>
    29702970<comment>(If a collection title image is used, you won't see the change on the collection title.)</comment>
     
    30103010</NumberedItem>
    30113011<NumberedItem>
    3012 <Text id="mf-15">Preview the home page in a web browser. On Windows, restart the Greenstone library server. On unix systems, You may need to reload pages in order to see the changes take effect, as the browser may at first display cached versions of pages you'd already visited earlier. The header of the home page, and the background of every page of each collection (except <i>reports</i>, which uses a custom _cssheader_ macro) should now use the new graphics, and the green box background images are no longer present on the collection pages.</Text>
     3012<Text id="mf-15">Preview the home page in a web browser. On Windows, if forcing the browser to reload the pages does not show the changes in effect, restart the Greenstone library server before reloading the pages in the browser. On unix systems, you may need to reload pages in order to see the changes take effect, as the browser may at first display cached versions of pages you'd already visited earlier. The header of the home page, and the background of every page of each collection (except <i>reports</i>, which uses a custom _cssheader_ macro) should now use the new graphics, and the green box background images are no longer present on the collection pages.</Text>
    30133013</NumberedItem>
    30143014<Heading>
     
    30293029</NumberedItem>
    30303030<NumberedItem>
    3031 <Text id="mf-47">Preview the newly structured home page in a web browser. (On Windows, restart the Greenstone library server.) Look at the file macros/yourhome.dm in a text editor to see how these changes are expressed.</Text>
     3031<Text id="mf-47">Preview the newly structured home page in a web browser. (On Windows, force reload the browser or else restart the Greenstone library server before reloading the pages in the browser.) Look at the file macros/yourhome.dm in a text editor to see how these changes are expressed.</Text>
    30323032</NumberedItem>
    30333033<NumberedItem>
     
    32793279</Title>
    32803280<SampleFiles folder="beatles"/>
    3281 <Version initial="2.60|3.06" current="2.86|3.08"/>
     3281<Version initial="2.60|3.06" current="2.87|3.08"/>
    32823282<Content>
    32833283<NumberedItem>
     
    33333333<Prerequisite id="multimedia_collection_explore"/>
    33343334<SampleFiles folder="beatles"/>
    3335 <Version initial="2.60|3.06" current="2.86|3.08"/>
     3335<Version initial="2.60|3.06" current="2.87|3.08"/>
    33363336<Content>
    33373337<Comment>
     
    38653865</Title>
    38663866<SampleFiles folder="niupepa"/>
    3867 <Version initial="2.60|3.06" current="2.86|3.08"/>
     3867<Version initial="2.60|3.06" current="2.87|3.08"/>
    38683868<Content>
    38693869<Comment>
     
    42054205<SampleFiles folder="niupepa"/>
    42064206<Prerequisite id="scanned_image_collection"/>
    4207 <Version initial="2.70|3.06" current="2.86|3.08"/>
     4207<Version initial="2.70|3.06" current="2.87|3.08"/>
    42084208<Content>
    42094209<Comment>
     
    43364336</Title>
    43374337<SampleFiles folder="oai"/>
    4338 <Version initial="2.60|3.06" current="2.86|3.08"/>
     4338<Version initial="2.60|3.06" current="2.87|3.08"/>
    43394339<Content>
    43404340<Comment>
     
    45264526</Title>
    45274527<Prerequisite id="simple_image_collection"/>
    4528 <Version initial="2.85|3.06" current="2.86|3.08"/>
     4528<Version initial="2.85|3.06" current="2.87|3.08"/>
    45294529<Content>
    45304530<Comment>
     
    45534553<NumberedItem>
    45544554<MajorVersion number="2">
    4555 <Text id="oaiserver-9">You are now ready to visit your oaiserver home page to check that it's all looking good. Start up the Greenstone Server by going to Windows <Path>Start &rarr; All Programs &rarr; Greenstone 2.86 &rarr; Greenstone Server</Path>.</Text>
     4555<Text id="oaiserver-9">You are now ready to visit your oaiserver home page to check that it's all looking good. Start up the Greenstone Server by going to Windows <Path>Start &rarr; All Programs &rarr; Greenstone 2.87 &rarr; Greenstone Server</Path>.</Text>
    45564556</MajorVersion>
    45574557<MajorVersion number="3">
     
    46624662</Title>
    46634663<Prerequisite id="GS_OAI_server"/>
    4664 <Version initial="2.60|3.06" current="2.86|3.08"/>
     4664<Version initial="2.60|3.06" current="2.87|3.08"/>
    46654665<Content>
    46664666<Comment>
     
    47214721</NumberedItem>
    47224722<NumberedItem>
    4723 <Text id="0740">Before you start, you must set up your Greenstone environment in the terminal. In the DOS window, move to the home directory where you installed Greenstone. This is accomplished by something like:</Text>
     4723<Text id="0740">Before you start, you must set up your Greenstone environment in the terminal. In the DOS window or terminal, move to the home directory where you installed Greenstone. This is accomplished by something like:</Text>
    47244724<Command>cd C:\Program Files\Greenstone</Command>
    47254725</NumberedItem>
     
    47824782<Text id="0750">Use METS as Greenstone's Internal Representation</Text>
    47834783</Title>
    4784 <Version initial="2.60" current="2.86"/>
     4784<Version initial="2.60" current="2.87"/>
    47854785<Content>
    47864786<NumberedItem>
     
    48124812</Title>
    48134813<SampleFiles folder="dspace"/>
    4814 <Version initial="2.60" current="2.86"/>
     4814<Version initial="2.60" current="2.87"/>
    48154815<Content>
    48164816<NumberedItem>
     
    49414941</Title>
    49424942<Prerequisite id="dspace_to_greenstone"/>
    4943 <Version initial="2.60|3.06" current="2.86|3.08"/>
     4943<Version initial="2.60|3.06" current="2.87|3.08"/>
    49444944<Content>
    49454945<Comment>
     
    49924992<Text id="gems-1">Editing metadata sets</Text>
    49934993</Title>
    4994 <Version initial="2.70w|3.06" current="2.86|3.08"/>
     4994<Version initial="2.70w|3.06" current="2.87|3.08"/>
    49954995<Content>
    49964996<Text id="gems-2">GEMS (Greenstone Editor for Metadata Sets) can be used to modify existing metadata sets or create new ones. GEMS is launched from the Librarian Interface when you want to create a new metadata set, or edit an existing one. In this exercise, we run GEMS outside of the Librarian Interface.</Text>
     
    50005000<NumberedItem>
    50015001<Text id="gems-4">Start the Greenstone Editor for Metadata Sets (GEMS)</Text>
    5002 <Text id="gems-5"><MajorVersion number="2"><Menu>Start &rarr; All Programs &rarr; Greenstone-2.86 &rarr; Metadata Set Editor (GEMS)</Menu></MajorVersion><MajorVersion number="3"><Menu>Start &rarr; All Programs &rarr; Greenstone-3.08 &rarr; Greenstone Editor for Metadata Sets (GEMS)</Menu></MajorVersion></Text>
     5002<Text id="gems-5"><MajorVersion number="2"><Menu>Start &rarr; All Programs &rarr; Greenstone-2.87 &rarr; Metadata Set Editor (GEMS)</Menu></MajorVersion><MajorVersion number="3"><Menu>Start &rarr; All Programs &rarr; Greenstone-3.08 &rarr; Greenstone Editor for Metadata Sets (GEMS)</Menu></MajorVersion></Text>
    50035003<Text id="gems-5a">(If you're on Linux, use a terminal to run the <Command>gli/gems.sh</Command> start-up script.) </Text>
    50045004</NumberedItem>
     
    50345034</Title>
    50355035<MajorVersion number="2"><SampleFiles folder="demo"/></MajorVersion>
    5036 <Version initial="2.70w|3.06" current="2.86|3.08"/>
     5036<Version initial="2.70w|3.06" current="2.87|3.08"/>
    50375037<Content>
    50385038<Text id="indexers-2">Greenstone supports three indexers <b>MG</b>, <b>MGPP</b> and <b>Lucene</b>. </Text>
     
    52145214<SampleFiles folder="demo_NewFiles"/>
    52155215<Prerequisite id="indexers"/>
    5216 <Version initial="2.71" current="2.86"/>
     5216<Version initial="2.71" current="2.87"/>
    52175217<Content>
    52185218<Text id="depositor-2">Collections built with the <i>Lucene</i> indexer support incremental addition, updates, and deletion of documents and metadata. By default, the <b>import</b> and <b>build</b> processes delete old index files in the <b>index</b> directory and intermediate files in the <b>archives</b> directory. With incremental building, the <b>import</b> and <b>build</b> process will keep the old files and only process the new or modified ones.</Text>
     
    52265226<Text id="depositor-7">Enabling <AutoText key="coredm::_depositor:textdepositor_"/></Text>
    52275227</Heading>
    5228 <Text id="depositor-8">For Windows users, first make sure that you are using a Web Server (e.g. Apache) instead of the Local Library Server. The binary installation of Greenstone will install Apache, but by default the Local Library Server will be used. To switch to using Apache, <AutoText text="rename"/> the <Path>GSDLHOME &rarr; server.exe</Path> file to something else. Then re-run the Greenstone Server, from the <Path>Start &rarr; Greenstone Server</Path> menu followed by pressing its <b>Enter Library</b> button.</Text>
     5228<Text id="depositor-8">For Windows users, first make sure that you are using a Web Server (e.g. Apache) instead of the Local Library Server. The binary installation of Greenstone will install Apache, but by default the Local Library Server will be used. To switch to using Apache, <AutoText text="rename"/> the <Path>GSDLHOME &rarr; server.exe</Path> file to something else. Then re-run the Greenstone Server, from the <Path>Start &rarr; Greenstone Server</Path> menu if on Windows, followed by pressing its <b>Enter Library</b> button. (On unix systems, run <Format>./gs2-server.sh</Format> from Greenstone 2's installed location to start up the Greenstone server.)</Text>
    52295229<Text id="depositor-access">Note: You might need to set permissions for the <Path>GSDLHOME &rarr; tmp</Path> and <Path>GSDLHOME &rarr; collect</Path> or <Path>GSDLHOME &rarr; collect &rarr; your_accessible_collection</Path> directory.</Text>
    52305230<Text id="depositor-enable">In Greenstone, <AutoText key="coredm::_depositor:textdepositor_"/> is disabled by default. To enable it, edit the file <Path>GSDLHOME &rarr; etc &rarr; main.cfg</Path>. Look for the "depositor" line, and change <i>disabled</i> to <i>enabled</i>. Then save and close the file.</Text>
     
    52685268<Text id="depositor-meta3">In the <AutoText key="coredm::_Global:textSubject_"/> field, type: </Text>
    52695269<Format>Communication, Information and Documentation|Records and Archives Management Programme (RAMP) of  UNESCO, Archive Management</Format>
    5270 <Text id="depositor-meta4">In <AutoText key="coredm::_Global:textKeyword_"/> field, type: </Text>
     5270<Text id="depositor-meta4">In the <AutoText key="coredm::_Global:textKeyword_"/> field, type: </Text>
    52715271<Format>manage records and archives</Format>
    52725272<Text id="depositor-meta5">Finally in the <AutoText key="coredm::_Global:textLanguage_"/> field, type: <Format>English</Format></Text>
     
    52765276</NumberedItem>
    52775277<NumberedItem>
    5278 <Text id="depositor-15">Click the <AutoText key="auxdm::_depositor:textbild_"/> button and wait for the process to finish. You will see the <AutoText key="auxdm::_wizard:textbildsuc_"/> message if the collection has been built successfully or error messages if something has gone wrong. </Text>
     5278<Text id="depositor-15">Click the <AutoText key="auxdm::_depositor:textbild_"/> button and wait for the process to finish. You will see the <i><AutoText key="auxdm::_wizard:textbildsuc_"/></i> message if the collection has been built successfully, or error messages if something has gone wrong. </Text>
    52795279</NumberedItem>
    52805280<NumberedItem>
Note: See TracChangeset for help on using the changeset viewer.