Changeset 29247


Ignore:
Timestamp:
2014-09-03T18:09:03+12:00 (10 years ago)
Author:
ak19
Message:

Updating the tutorial file for the upcoming GS3 release

File:
1 edited

Legend:

Unmodified
Added
Removed

  • documentation/trunk/tutorials/xml-source/tutorial_en.xml

    r28945 r29247  
    88<TutorialList>
    99<Title>
    10 <Text id="0001">Greenstone tutorial exercises (2013)</Text>
     10<Text id="0001">Greenstone tutorial exercises (2014)</Text>
    1111</Title>
    1212<MajorVersion number="2"><Version current="2.86"/></MajorVersion>
    … …  
    755755<NumberedItem>
    756756<Text id="0386a">To change the text that is displayed for the index<MajorVersion number="2"> (<AutoText key="coredm::_Global:labelDescription_" type="italics"/>)</MajorVersion><MajorVersion number="3"> (<AutoText text="Descriptions" type="italics"/>)</MajorVersion>, go to the <AutoText key="glidict::GUI.Format"/> panel back in the Librarian Interface. Select <AutoText key="glidict::CDM.GUI.SearchMetadata"/> from the left-hand list. This panel allows you to change the text that is displayed on the search form. <MajorVersion number="2">Change</MajorVersion><MajorVersion number="3">Set</MajorVersion> the <AutoText key="glidict::CDM.SearchMetadataManager.Component_Name"/> for the "dc.Description" index to "image descriptions" (or other suitable text). Go back to the browser and reload the search page. Your new text will appear in the search form. </Text>
     757<MajorVersion number="2"><Text id="0386a">To change the text that is displayed for the index (<AutoText key="coredm::_Global:labelDescription_" type="italics"/>), go to the <AutoText key="glidict::GUI.Format"/> panel back in the Librarian Interface. Select <AutoText key="glidict::CDM.GUI.SearchMetadata"/> from the left-hand list. This panel allows you to change the text that is displayed on the search form. Change the <AutoText key="glidict::CDM.SearchMetadataManager.Component_Name"/> for the "dc.Description" index to "image descriptions" (or other suitable text). Go back to the browser and reload the search page. Your new text will appear in the search form.</Text></MajorVersion>
    757758<Comment>
    758759<Text id="0386b">Note that if you use text instead of macros in the search metadata display text, you will need to do any translations yourself.</Text>
    … …  
    11251126<Text id="fw-21-3">The format statement as it is above will now display the Greenstone link, the link to the original, then the Title as before. Since it's defined for <b>documentNode</b>s, it will display all the Authors (Creators), and the source document for documents. Preview the <AutoText key="gs3::metadata_names::Creator.buttonname" type="italics"/> list and make sure that all authors are displayed for documents.</Text>
    11261127<Text id="fw-21a-3">The additional line <Format>&lt;gsf:metadata name=&quot;dc.Creator&quot; /&gt;</Format> displays all the Creator metadata for the document, separated by a comma (<AutoText text=", " type="quoted"/>). All the metadata values for dc.Creator will be returned by default. If you wish to retrieve only the <i>first</i>, <i>last</i> or <i>n</i>th value for a metadata, you would use the <i>pos</i> attribute. For example, <Format>&lt;gsf:metadata name=&quot;dc.Creator&quot; pos=&quot;first&quot;/&gt;</Format> (or alternatively, <Format>&lt;gsf:metadata name=&quot;dc.Creator&quot; pos=&quot;1&quot;/&gt;</Format>) displays only the first author. </Text>
    1127 <Text id="fw-21b-3">In sectioned documents, you can allow users to browse and search on the section level. In this case, you may want to request metadata for the <i>parent</i>, <i>ancestors</i>, or <i>root</i> (i.e. document) of the current section. For instance, is you want to display the title of the section's parent you can use <Format>&lt;gsf:metadata name=&quot;Title&quot; select=&quot;parent&quot;/&gt;</Format>.</Text> 
     1128<Text id="fw-21b-3">In sectioned documents, you can allow users to browse and search on the section level. In this case, you may want to request metadata for the <i>parent</i>, <i>ancestors</i>, or <i>root</i> (i.e. document) of the current section. For instance, if you want to display the title of the section's parent you can use <Format>&lt;gsf:metadata name=&quot;Title&quot; select=&quot;parent&quot;/&gt;</Format>.</Text> 
    11281129</NumberedItem>
    11291130<NumberedItem>
    … …  
    11881189<Content>
    11891190<Comment>
    1190 <Text id="pdfbox-ext-1">By default the PDFPlugin can process PDF versions 1.4 and older. The PDFBox extension for Greenstone allows text from more recent PDF files to be extracted. The extension uses <b>PDFBox</b>, an open-source PDF conversion tool. This tutorial will cover how to install the PDFBox extension for Greenstone and how to switch on its functionality in the Greenstone Librarian Interface to process text from newer versions of PDF.</Text>
    1191 </Comment>
     1191<Text id="pdfbox-ext-1">By default the PDFPlugin can process PDF versions 1.4 and older. The PDFBox extension for Greenstone<MajorVersion number="3"> is included in a Greenstone 3 binary and</MajorVersion> allows text from more recent PDF files to be extracted. The extension uses <b>PDFBox</b>, an open-source PDF conversion tool. This tutorial will cover<MajorVersion number="2"> how to install the PDFBox extension for Greenstone and</MajorVersion> how to switch on its functionality in the Greenstone Librarian Interface to process text from newer versions of PDF.</Text>
     1192</Comment>
     1193<MajorVersion number="2">
    11921194<Heading>Obtaining and installing the PDFBox extension for Greenstone</Heading>
    11931195<NumberedItem>
    … …  
    12031205<Text id="pdfbox-ext-6">All going well, you will have a folder called <Format>pdf-box</Format> inside your Greenstone's <Format>ext</Format> folder.</Text>
    12041206</NumberedItem>
     1207</MajorVersion>
    12051208<Heading>Turning on the PDFBox extension functionality in GLI</Heading>
    12061209<NumberedItem>
    … …  
    15751578</Heading>
    15761579<NumberedItem>
    1577 <Text id="assoc-files-8">In <AutoText key="glidict::CDM.GUI.Plugins"/>, select the <AutoText text="WordPlugin"/> and press the <AutoText key="glidict::CDM.PlugInManager.Configure" type="button"/> button.In the resulting popup, scroll down to find the <Format>associate_ext</Format> option, and set this option to <AutoText text="pdf" type="italics"/>. Now, for Word documents, Greenstone will look for documents with the exact same name but the PDF file extension. These PDF's will not be processed separately; instead, they will be associated with their equivalent Word documents. (Alternatively, you could make the PDF document the primary document, by setting the <Format>associate_ext</Format> option in the <AutoText text="PDFPlugin"/> to <AutoText text="doc" type="italics"/>.)</Text>
     1580<Text id="assoc-files-8">In <AutoText key="glidict::CDM.GUI.Plugins"/>, select the <AutoText text="WordPlugin"/> and press the <AutoText key="glidict::CDM.PlugInManager.Configure" type="button"/> button.In the resulting popup, scroll down to find the <Format>associate_ext</Format> option, and set this option to <AutoText text="pdf" type="italics"/>. Now, for Word documents, Greenstone will look for documents with the exact same name but the PDF file extension. These PDFs will not be processed separately; instead, they will be associated with their equivalent Word documents. (Alternatively, you could make the PDF document the primary document, by setting the <Format>associate_ext</Format> option in the <AutoText text="PDFPlugin"/> to <AutoText text="doc" type="italics"/>.)</Text>
    15781581</NumberedItem>
    15791582<NumberedItem>
    … …  
    15851588<NumberedItem>
    15861589<Text id="assoc-files-15">Greenstone has internally associated the PDF version with the Word version of the document. However, with the default format statement, the end-user will have no idea that the PDF version exists. The collection built at this point (with default settings) only gives the user the choice of viewing either the Word version or the Greenstone-generated HTML version of the document. They are not given the option to view the PDF version.</Text>
    1587 <Text id="assoc-files-16">To allow users to view the PDF version of the document,<MajorVersion number="2">change the default VList statement from this:</MajorVersion><MajorVersion number="3"> edit the <AutoText text="documentNode"/> template of the <AutoText text="Browse" /> to reference the <Format>equivDocIcon</Format> with a link to the PDF document <Format>equivDocLink</Format>.</MajorVersion></Text>
     1590<Text id="assoc-files-16">To allow users to view the PDF version of the document,<MajorVersion number="2">change the default VList statement from this:</MajorVersion><MajorVersion number="3"> edit the <AutoText text="documentNode"/> template of the <AutoText text="Browse" /> to reference the <Format>equivDocIcon</Format> with a link to the PDF document <Format>equivDocLink</Format> as follows.</MajorVersion></Text>
    15881591<MajorVersion number="2">
    15891592<Format>
    … …  
    16981701<br />
    16991702</MajorVersion>
     1703<Text id="assoc-files-24a">Preview the collection.</Text>
    17001704<Text id="assoc-files-24">Note: When Greenstone encounters a file that matches the provided <Format>associate_ext</Format> value (<Format>pdf</Format> in our case), it sets the metadata value <AutoText text="ex.equivDocIcon"/> for that document to be the macro <i>_iconXXX_</i>, where <i>XXX</i> is whatever the filename extension is (so <AutoText text="_iconpdf_" type="italics"/> in our case). As long as there is an existing macro defined for that combination of the word <i>icon</i> and the filename extension, then a suitable icon will be displayed when the document appears in a VList. For <i>pdf</i> the displayed icon will be <img src="../tutorial_files/ipdf.gif"/>.</Text>
    17011705</NumberedItem>
    … …  
    18411845<NumberedItem>
    18421846<Text id="0460"><b>Build</b> the collection again, <b>preview</b> it, and try out the new <MajorVersion number="2"><AutoText key="coredm::_Global:labelPhrase_"/></MajorVersion><MajorVersion number="3"><AutoText key="gs3::PhindPhraseBrowse::PhindApplet.name" /></MajorVersion> option in the navigation bar. An interesting PHIND search term for this collection is <AutoText text="king" type="quoted"/>. Note that even though it is called a phrase browser, only single terms can be used as the starting point for browsing.</Text>
     1847<Comment>
     1848<Text id="0460a">The Phind phrase browser is a Java applet. To be able to view applets in a browser, you will need a JRE installed and, from Java 7 onwards, will need to additionally add your Greenstone digital library home URL (http://localhost:8383 by default) to the Exception Site List via the Security tab of your Java Control Panel. We have found that installing web browsers before installing a JRE allows browsers to find your JRE and run applets. If you're installing browsers after the JRE has already been installed, then your browser should prompt you to install the JRE again when trying to view Java applets. For further information see <Link>http://java.com/en/download/help/enable_browser.xml</Link> on how to enable Java in a web browser and <Link>http://www.java.com/en/download/help/javaconsole.xml</Link> to locate the Java Control Panel for your operating system.</Text>
     1849</Comment>
    18431850</NumberedItem>
    18441851<Heading>
    … …  
    18861893</Comment>
    18871894<NumberedItem>
    1888 <Text id="0463">Switch to the <AutoText key="glidict::GUI.Create"/> panel, choose <AutoText text="Import Options"/> and view the options that are displayed in the top portion of the screen. Select <AutoText text="maxdocs"/> and set its numeric counter to <AutoText text="3"/>. Now <b>build</b>.</Text>
     1895<Text id="0463">Switch to the <AutoText key="glidict::GUI.Create"/> panel and view the options that are displayed in the top portion of the screen. Select <AutoText text="maxdocs"/> and set its numeric counter to <AutoText text="3"/>. (When in GLI's <AutoText key="glidict::Preferences.Mode.Expert"/> Mode, the <AutoText text="maxdocs"/> option for the import process are located under the <AutoText text="Import Options"/> of the <AutoText key="glidict::GUI.Create"/> panel.) Now <b>build</b>.</Text>
    18891896</NumberedItem>
    18901897<NumberedItem>
    … …  
    22952302</NumberedItem>
    22962303<NumberedItem>
    2297 <Text id="0418">Now click <AutoText key="glidict::Mirroring.Download" type="button"/>. If you have set proxy information in <AutoText key="glidict::Menu.File_Options"/>, a popup will ask for your user name and password. If you're on Windows Vista or later, Windows may show a popup message asking whether you wish to block or unblock the download. In such a case, choose to unblock. Once the download has started, a progress bar appears in the lower half of the panel that reports on how the downloading process is doing.</Text>
     2304<Text id="0418">Now click <AutoText key="glidict::Mirroring.Download" type="button"/>. If you have set proxy information in <AutoText key="glidict::Menu.File_Options"/>, a popup will ask for your user name and password. If you're on Windows Vista or later, Windows may show a popup message asking whether you wish to block or unblock the download. In such a case, choose to unblock. With proxy settings turned on, it may take a short while before GLI starts downloading. Once the download has started, a progress bar appears in the lower half of the panel that reports on how the downloading process is doing.</Text>
    22982305<Comment>
    22992306<Text id="0419">More detailed information can be obtained by clicking <AutoText key="glidict::Mirroring.DownloadJob.Log" type="button"/>. The process can be paused and restarted as needed, or stopped altogether by clicking <AutoText key="glidict::Mirroring.DownloadJob.Close" type="button"/>. Downloading can be a lengthy process involving multiple sites, and so Greenstone allows additional downloads to be queued up. When new URLs are pasted into the <AutoText text="url"/> box and <AutoText key="glidict::Mirroring.Download" type="button"/> clicked, a new progress bar is appended to those already present in the lower half of the panel. When the currently active download item completes, the next is started automatically.</Text>
    … …  
    24042411</NumberedItem>
    24052412<NumberedItem>
    2406 <Text id="0531b">You can specify which search form types are available for a particular collection, and which one is the default, using the <AutoText text="SearchTypes"/> format statement. In the <AutoText key="glidict::GUI.Format"/> panel select <AutoText key="glidict::CDM.GUI.Formats"/> from the left-hand list. Select the <AutoText text="SearchTypes"/> format statement from the list of assigned formats, and set the contents to <MajorVersion number="2"><AutoText text="form"/></MajorVersion><MajorVersion number="3">just <AutoText text="simpleform"/></MajorVersion>. This will make only fielded searching available for this collection.</Text>
     2413<Text id="0531b">You can specify which search form types are available for a particular collection, and which one is the default, using the <AutoText text="SearchTypes"/> format statement. In the <AutoText key="glidict::GUI.Format"/> panel, select <AutoText key="glidict::CDM.GUI.Formats"/> from the left-hand list. Select the <AutoText text="SearchTypes"/> format statement from the list of assigned formats, and set the contents to <MajorVersion number="2"><AutoText text="form"/></MajorVersion><MajorVersion number="3">just <AutoText text="simpleform"/></MajorVersion>. This will make only fielded searching available for this collection.</Text>
    24072414<Comment>
    24082415<MajorVersion number="2"><Text id="0531d">Search type options include <AutoText text="form"/> and <AutoText text="plain"/>. You can specify one or both separated by a comma. If both are specified, the first one is used as the default: this is the one that the user will see when they first enter the collection.</Text></MajorVersion>
    … …  
    30543061</NumberedItem>
    30553062<NumberedItem>
    3056 <Text id="themes-14">Click the <AutoText text="Download theme"/> button. Ensure the Stable version if jQuery is selected. Under <AutoText text="Components"/> uncheck <AutoText text="Toggle All" type="italics"/>, which will uncheck all of the boxes. Under <AutoText text="UI Core"/> check <AutoText text="Core" type="italics"/>, and under <AutoText text="Widgets"/> check <AutoText text="Datepicker" type="italics"/>. At the bottom of the page, under <AutoText text="Theme"/>, <AutoText text="Custom Theme" type="italics"/> should be selected. For <AutoText text="Theme Folder Name:"/>, enter <AutoText text="TutorialTheme" type="italics"/>. Leave <AutoText text="CSS Scope"/> blank. Click <AutoText text="Download"/>. In the pop-up window, select <AutoText text="Save File"/> and click <AutoText text="OK"/> to download the zip file.</Text>
     3063<Text id="themes-14">Click the <AutoText text="Download theme"/> button. Ensure the Stable version of jQuery is selected. Under <AutoText text="Components"/> uncheck <AutoText text="Toggle All" type="italics"/>, which will uncheck all of the boxes. Under <AutoText text="UI Core"/> check <AutoText text="Core" type="italics"/>, and under <AutoText text="Widgets"/> check <AutoText text="Datepicker" type="italics"/>. At the bottom of the page, under <AutoText text="Theme"/>, <AutoText text="Custom Theme" type="italics"/> should be selected. (If there's an option to provide a <AutoText text="Theme Folder Name"/>, enter <AutoText text="TutorialTheme" type="italics"/>.) Leave <AutoText text="CSS Scope"/> blank. Click <AutoText text="Download"/>. In the pop-up window, select <AutoText text="Save File"/> and click <AutoText text="OK"/> to download the zip file.</Text>
    30573064</NumberedItem>
    30583065<NumberedItem>
    30593066<Text id="themes-15">Go to the folder where the zip file was downloaded, and unzip the folder (on Windows, right-click, select <AutoText text="Extract All..."/> and click <AutoText text="Extract"/>).</Text>
    3060 <Text id="themes-16">The extracted folder should be named <AutoText text="jquery-ui-1.10.2.custom" type="italics"/>, or something similar, and should contain three folders (css, development-bundle, js) and an html file (index.html). In the <AutoText text="css"/> folder, there is a folder called <AutoText text="TutorialTheme"/>. Copy this entire folder into <Path>Greenstone3 &rarr; web &rarr; interfaces &rarr; default &rarr;  style &rarr; themes</Path>.</Text>
     3067<Text id="themes-16">The extracted folder will be called <AutoText text="jquery-ui-1.11.1.custom" type="italics"/>, or something similar. Rename it to <AutoText text="TutorialTheme"/>. It should contain css files, an index.html file, a couple of js files and 2 subfolders (called images and external). We largely only need the folder's structure, the css files (particularly jquery-ui.theme.min.css) and the images sufolder, but it's easiest just to copy the entire folder into <Path>Greenstone3 &rarr; web &rarr; interfaces &rarr; default &rarr;  style &rarr; themes</Path>.</Text>
     3068<!--<Text id="themes-16">The extracted folder should be named <AutoText text="jquery-ui-1.10.2.custom" type="italics"/>, or something similar, and should contain three folders (css, development-bundle, js) and an html file (index.html). In the <AutoText text="css"/> folder, there is a folder called <AutoText text="TutorialTheme"/>. Copy this entire folder into <Path>Greenstone3 &rarr; web &rarr; interfaces &rarr; default &rarr;  style &rarr; themes</Path>.</Text>-->
    30613069</NumberedItem>
    30623070<NumberedItem>
    … …  
    30723080                <Tab n="4"/>{title:&quot;Greenstone Custom 2&quot;, name:&quot;custom-theme2&quot;, icon:&quot;theme_90_mint_choco.png&quot;, url:&quot;interfaces/&quot; + gs.xsltParams.interface_name + &quot;/style/themes/alt_theme_2/jquery-ui-1.8.16.custom.css&quot;},<br/>
    30733081                <Tab n="4"/>{title:&quot;Greenstone Custom 3&quot;, name:&quot;custom-theme3&quot;, icon:&quot;theme_90_trontastic.png&quot;, url:&quot;interfaces/&quot; + gs.xsltParams.interface_name + &quot;<br/>/style/themes/alt_theme_3/jquery-ui-1.8.16.custom.css&quot;}<highlight>,     <br/>
    3074                 <Tab n="4"/>{title:&quot;Tutorial Theme&quot;, name:&quot;TutorialTheme&quot;, icon:&quot;TutorialTheme.png&quot;, url:&quot;interfaces/&quot; + gs.xsltParams.interface_name + &quot;/style/themes/TutorialTheme/jquery-ui-1.10.2.custom.css&quot;}</highlight><br/>
     3082                <Tab n="4"/>{title:&quot;Tutorial Theme&quot;, name:&quot;TutorialTheme&quot;, icon:&quot;TutorialTheme.png&quot;, url:&quot;interfaces/&quot; + gs.xsltParams.interface_name + &quot;/style/themes/TutorialTheme/jquery-ui.theme.min.css&quot;}</highlight><br/>
    30753083            <Tab n="3"/>]<br/>
    30763084        <Tab n="2"/>});<br/>
    … …  
    30813089</NumberedItem>
    30823090<NumberedItem>
    3083 <Text id="themes-18">Return to the Library homepage. If not still logged in, login again. Go to the <AutoText key="gs3::interface_default::pref_b"/> page and click on the drop-down menu for <AutoText key="gs3::interface_default::pref.theme"/>. (If the <AutoText key="gs3::interface_default::pref.theme"/> option has disappeared, ensure that you copied the highlighted section in its entirety into the correct place in <AutoText text="pref.xsl"/>, especially that you did not miss the initial comma.) The fifth item in the list should now be "Tutorial Theme". (It will not have a calendar icon like the other themes, because the image referenced in the above statement - TutorialTheme.png - does not exist. To create an icon to match the theme, see below.) Select Tutorial Theme, and click <AutoText key="gs3::interface_default::pref.set_prefs"/>. All of your Greenstone collections will be in this new, custom theme.</Text>
     3091<Text id="themes-18">Return to the Library homepage. If not still logged in, login again. Go to the <AutoText key="gs3::interface_default::pref_b"/> page and click on the drop-down menu for <AutoText key="gs3::interface_default::pref.theme"/>. (If the <AutoText key="gs3::interface_default::pref.theme"/> option has disappeared, ensure that you copied the highlighted section in its entirety into the correct place in <AutoText text="pref.xsl"/>, and check especially that you did not miss the initial comma.) The fifth item in the list should now be "Tutorial Theme". It will not have a calendar icon like the other themes, because the image referenced in the above statement - TutorialTheme.png - does not exist. We'll create an icon to match the theme below. For now, select Tutorial Theme, and click <AutoText key="gs3::interface_default::pref.set_prefs"/>. All of your Greenstone collections will be in this new, custom theme.</Text>
    30843092</NumberedItem>
    30853093<Comment>
    … …  
    30873095</Comment>
    30883096<NumberedItem>
    3089 <Text id="themes-21">Return to the folder extracted from the zip file downloaded from jQuery (<AutoText text="jquery-ui-1.10.2.custom"/> or something similar). Open <AutoText text="index.html" type="italics"/> in a web browser. Scroll down so that the Datepicker calendar is completely visible on your screen, and take a screen shot. (On Windows, this is done by pressing the print screen - <AutoText text="PrtScn"/> - button.) </Text>
     3097<Text id="themes-21">Return to the <AutoText text="TutorialTheme"/> folder (in <Path>Greenstone3 &rarr; web &rarr; interfaces &rarr; default &rarr;  style &rarr; themes</Path>). Open <AutoText text="index.html" type="italics"/> in a web browser. Scroll down so that the Datepicker calendar is completely visible on your screen, and take a screen shot. (On Windows, this is done by pressing the print screen - <AutoText text="PrtScn"/> - button.) </Text>
    30903098</NumberedItem>
    30913099<NumberedItem>
    … …  
    30933101</NumberedItem>
    30943102<NumberedItem>
    3095 <Text id="themes-23">Return to the <AutoText key="gs3::interface_default::pref_b"/> page, and the Tutorial Theme in the <AutoText key="gs3::interface_default::pref.theme"/> drop-down menu will now have a corresonding calendar icon.</Text>
     3103<Text id="themes-23">Return to the <AutoText key="gs3::interface_default::pref_b"/> page, and the Tutorial Theme in the <AutoText key="gs3::interface_default::pref.theme"/> drop-down menu will now have a corresponding calendar icon.</Text>
    30963104</NumberedItem>
    30973105</Content></Tutorial>
    … …  
    31483156</NumberedItem>
    31493157<NumberedItem>
    3150 <Text id="customize-04">Click the <AutoText text="Download theme"/> button. Ensure the Stable version of jQuery is selected. Under <AutoText text="Components"/> uncheck <AutoText text="Toggle All" type="italics"/>, which will uncheck all of the boxes. Under <AutoText text="UI Core"/> check <AutoText text="Core" type="italics"/>, and under <AutoText text="Widgets"/> check <AutoText text="Datepicker" type="italics"/>. At the bottom of the page, under <AutoText text="Theme"/>, <AutoText text="Custom Theme" type="italics"/> should be selected. For <AutoText text="Theme Folder Name:"/>, enter <AutoText text="CollectionTheme" type="italics"/>. Leave <AutoText text="CSS Scope"/> blank. Click <AutoText text="Download"/>. In the pop-up window, select <AutoText text="Save File"/> and click <AutoText text="OK"/> to download the zip file.</Text>
     3158<Text id="customize-04">Click the <AutoText text="Download theme"/> button. Ensure the Stable version of jQuery is selected. Under <AutoText text="Components"/> uncheck <AutoText text="Toggle All" type="italics"/>, which will uncheck all of the boxes. Under <AutoText text="UI Core"/> check <AutoText text="Core" type="italics"/>, and under <AutoText text="Widgets"/> check <AutoText text="Datepicker" type="italics"/>. At the bottom of the page, under <AutoText text="Theme"/>, <AutoText text="Custom Theme" type="italics"/> should be selected. (If there's an option to provide a <AutoText text="Theme Folder Name"/>, enter <AutoText text="CollectionTheme" type="italics"/>.) Leave <AutoText text="CSS Scope"/> blank. Click <AutoText text="Download"/>. In the pop-up window, select <AutoText text="Save File"/> and click <AutoText text="OK"/> to download the zip file.</Text>
    31513159</NumberedItem>
    31523160<NumberedItem>
    31533161<Text id="customize-05">Go to the folder where the zip file was downloaded, and unzip the folder (on Windows, right-click, select <AutoText text="Extract All..."/> and click <AutoText text="Extract"/>).</Text>
    3154 <Text id="customie-06">The extracted folder should be named <AutoText text="jquery-ui-1.10.2.custom" type="italics"/>, or something similar, and should contain three folders (css, development-bundle, js) and an html file (index.html). In the <AutoText text="css"/> folder, there is a folder called <AutoText text="CollectionTheme"/>. Copy this entire folder into <Path>Greenstone3 &rarr; web &rarr; sites &rarr; localsite &rarr; collect &rarr; backdrop &rarr; style</Path>.</Text>
     3162<Text id="customie-06">The extracted folder will be called <AutoText text="jquery-ui-1.11.1.custom" type="italics"/>, or something similar. Rename it to <AutoText text="CollectionTheme"/>. It should contain css files, an index.html file, a couple of js files and 2 subfolders (called images and external). Copy the entire folder into <Path>Greenstone3 &rarr; web &rarr; sites &rarr; localsite &rarr; collect &rarr; backdrop &rarr; style</Path>.</Text>
     3163<!--<Text id="customie-06">The extracted folder should be named <AutoText text="jquery-ui-1.10.2.custom" type="italics"/>, or something similar, and should contain three folders (css, development-bundle, js) and an html file (index.html). In the <AutoText text="css"/> folder, there is a folder called <AutoText text="CollectionTheme"/>. Copy this entire folder into <Path>Greenstone3 &rarr; web &rarr; sites &rarr; localsite &rarr; collect &rarr; backdrop &rarr; style</Path>.</Text>-->
    31553164</NumberedItem>
    31563165<Heading>
    … …  
    31673176<Tab n="2"/>&lt;xsl:value-of select=&quot;/page/pageResponse/collection/metadataList/metadata[@name='httpPath']&quot;/&gt;<br/>
    31683177<Tab n="1"/>&lt;/xsl:variable&gt;<br/>
    3169 <Tab n="1"/>&lt;link href=&quot;{$httpCollection}/style/CollectionTheme/jquery-ui-1.10.2.custom.css&quot; rel=&quot;stylesheet&quot; type=&quot;text/css&quot; /&gt;<br/>
     3178<Tab n="1"/>&lt;link href=&quot;{$httpCollection}/style/CollectionTheme/jquery-ui.theme.css&quot; rel=&quot;stylesheet&quot; type=&quot;text/css&quot; /&gt;<br/>
    31703179&lt;/xsl:template&gt;<br/>
    31713180</Format>
     3181<Text id="customize-08a">You could also make it refer to <AutoText text="jquery-ui.theme.min.css"/> instead, which is another version of the same css style file, one with a reduced file size.</Text>
    31723182</NumberedItem>
    31733183<NumberedItem>
    … …  
    31993209<Text id="0543">Put <Path>advbeat_large</Path> in there.<MajorVersion number="3"> Then go into the <Path>advbeat_large</Path> folder and delete its <Path>index</Path> subfolder.</MajorVersion></Text>
    32003210</NumberedItem>
     3211<MajorVersion number="3">
     3212<NumberedItem>
     3213<Text id="0543a">Next, go into the <Path>advbeat_large</Path> folder's <Path>etc</Path> subfolder and rename the Greenstone 2 specific <AutoText text="collect.cfg" /> file there to <AutoText text="collect.cfg.bak" />. Doing so will allow GLI to detect only the Greenstone 3 collection configuration file, <AutoText text="collectionConfig.xml" />, enabling GLI to rebuild the collection based on that.</Text>
     3214</NumberedItem>
     3215</MajorVersion>
    32013216<MajorVersion number="2">
    32023217<NumberedItem>
    … …  
    33503365</Bullet>
    33513366<Bullet>
    3352 <Text id="0582">Ensure that the <AutoText text="browse"/> format feature is selected, and make the changes that are highlighted below to its <AutoText text="documentNode"/> template. </Text>
     3367<Text id="0582">Ensure that the <AutoText text="browse"/> format feature is selected, and make the changes highlighted below to its <AutoText text="documentNode"/> template. </Text>
    33533368<Text id="0582a">Change:</Text>
    33543369<Format>
    … …  
    37443759</BulletList>
    37453760</NumberedItem>
     3761<!-- No collage browser yet in GS2. In GS3 can try implementing it with javascript instead of applets -->
     3762<MajorVersion number="2">
    37463763<Heading>
    37473764<Text id="0671">Adding an image collage browser</Text>
    … …  
    37533770<Text id="0673">Now change to the <AutoText key="glidict::GUI.Create"/> panel and <b>build</b> and <b>preview</b> the collection. Try out the <AutoText text="collage"/> browsing classifier. You can click on any image during the collage display and the image will be opened up.</Text>
    37543771</NumberedItem>
     3772</MajorVersion>
    37553773</Content>
    37563774</Tutorial>
    … …  
    44104428<Text id="0731">Format statements are processed by the runtime system, so the collection does not need to be rebuilt for these changes to take effect. Click <AutoText key="glidict::CreatePane.Preview_Collection" type="button"/> to see the changes.</Text>
    44114429</NumberedItem>
    4412 <Comment>
     4430<!--<Comment>
    44134431<Text id="0732">To expedite building, this collection contains fewer source documents than the pre-built version supplied with the Greenstone installation. However, after these modifications, its functionality is the same.</Text>
    4414 </Comment>
     4432</Comment>-->
    44154433</Content>
    44164434</Tutorial>
    … …  
    44884506<Text id="oaiserver-22">Greenstone 3's OAI implementation uses the OAI standard for Dublin Core, <AutoText text="oai_dc" type="italics"/>, metadata format. By default, it maps all Dublin Core metadata you may have assigned to your collections into <AutoText text="oai_dc" type="italics"/>. This default mapping is specified in the <Path>web\WEB-INF\classes\OAIConfig.xml</Path> file. If all (or most) of your collections will be using a different metadata format, you can edit the OAIConfig.xml file's <Format>mappingList</Format> section to create mappings from the metadata fields you're using to those in <AutoText text="oai_dc" type="italics"/>. You can also specify mappings at a collection-level, overriding the mappings in OAIConfig.xml for that collection. So if a collection specifies metadata for a different metadata set format from the default mappings in OAIConfig.xml, adjust the collection's <Path>web\sites\localsite\collect\&lt;collection-name&gt;\etc\collectionConfig.xml</Path> file to tell Greenstone how to map the metadata fields of your chosen metadata set format into the <AutoText text="oai_dc" type="italics"/> Dublin Core metadata set supported by the Greenstone OAI server.</Text>
    44894507<Text id="oaiserver-23">For instance, look in the <b>demo</b> collection's collectionConfig.xml file (<Path>web\sites\localsite\collect\lucene-jdbm-demo\etc\collectionConfig.xml</Path>) and scroll down to the definition for the <Format>OAIPMH</Format> ServiceRack. Look in its <Format>mappingList</Format> which will explain and provide examples for how to specify such oai mappings from the <AutoText text="DLS" type="italics"/> metadata format that the <b>demo</b> collection uses, to the Dublin Core (<AutoText text="oai_dc" type="italics"/>) metadata used by Greenstone's OAI server. Its <AutoText key="metadata::dls.Organisation"/> metadata is mapped to <AutoText text="oai_dc.publisher"/> using the following line in the collectionConfig.xml configuration file (note the use of case):</Text>
    4490 <Format>&lt;mapping&gt;dc:publisher,dls.Organization&lt;/mapping&gt;</Format>
     4508<Format>&lt;element name=&quot;dc:publisher&quot;&gt;<br />
     4509<Tab n="1"/>&lt;mapping elements=&quot;dls.Organization&quot; /&gt;<br />
     4510&lt;/element&gt;
     4511</Format><!--OLD WAY: <Format>&lt;mapping&gt;dc:publisher,dls.Organization&lt;/mapping&gt;</Format>-->
    44914512<Text id="oaiserver-24">Because the <AutoText text="backdrop"/> collection uses DC metadata, no mapping is required, as the default mappings from DC metadata to <AutoText text="oai_dc" type="italics"/> are already specified in OAIConfig.xml. (The <AutoText text="demo"/> collection has its DC metadata set's title, subject and language fields explicitly mapped to the oai_dc metadata set, although oai mappings are not necessary if the metadata set is already Dublin Core, dc.)</Text>
    44924513</MajorVersion>
    … …  
    45714592</Format>
    45724593<Text id="gli-oai-5">Make sure that you can generally access this URL from your browser.</Text>
     4594<Text id="gli-oai-5a">Visit the library home page, as this will load the greenstone collections, so that any associated files like images or pdf documents become accessible for download. (Without visiting the library home page, the collections would not be loaded and the images from the Simple Images collection, that we will be downloading below alongside the oai files, will not be available for download.)</Text>
    45734595</NumberedItem>
    45744596<NumberedItem>
    … …  
    45764598</NumberedItem>
    45774599<NumberedItem>
    4578 <Text id="gli-oai-7">If at this stage you were to press the <AutoText key="glidict::Download.ServerInformation" type="button" /> (in the central row of buttons), a dialog will pop up with basic details about the OAI server. At the end, it will diplay the names of the sets available via that OAI Server. <MajorVersion number="3">A <Format>setSpec</Format> and a <Format>setName</Format> property will be defined for each available set. </MajorVersion>In our example, <AutoText text="backdrop" type="italics"/> (the Simple Image collection) would be listed as one of the setNames<MajorVersion number="3"> with its <Format>setSpec</Format> as <Format>localsite:backdrop</Format></MajorVersion>. Press the <AutoText text="close" type="button" /> to close the <AutoText key="glidict::Download.ServerInformation"/> dialog.</Text>
    4579 </NumberedItem>
    4580 <NumberedItem>
    4581 <Text id="gli-oai-8">Tick the <AutoText key="perlmodules::OAIDownload.metadata_prefix_disp"/> checkbox as well as the <AutoText key="perlmodules::OAIDownload.set_disp"/> checkbox. For the latter, type <MajorVersion number="2"><AutoText text="backdrop" type="italics"/> for the <AutoText text="set"/> name</MajorVersion><MajorVersion number="3">the setSpec value of <AutoText text="localsite:backdrop" type="italics"/></MajorVersion>. Then tick <AutoText key="perlmodules::OAIDownload.get_doc_disp"/>. Also tick <AutoText key="perlmodules::OAIDownload.get_doc_exts_disp"/> and include <AutoText text="jpg" type="italics"/> in the list of comma separated values for it so that it becomes</Text>
     4600<Text id="gli-oai-7">If at this stage you were to press the <AutoText key="glidict::Download.ServerInformation" type="button" /> (in the central row of buttons), a dialog will pop up with basic details about the OAI server. At the end, it will diplay the names of the sets available via that OAI Server. <MajorVersion number="3">A <Format>setSpec</Format> and a <Format>setName</Format> property will be defined for each available set. </MajorVersion>In our example, <AutoText text="backdrop" type="italics"/> (the Simple Image collection) would be listed as one of the setNames<MajorVersion number="3"> with its <Format>setSpec</Format> as <Format>backdrop</Format></MajorVersion>. Press the <AutoText text="close" type="button" /> to close the <AutoText key="glidict::Download.ServerInformation"/> dialog.</Text>
     4601<!--setSpec: <Format>localsite:backdrop</Format>-->
     4602</NumberedItem>
     4603<NumberedItem>
     4604<Text id="gli-oai-8">Tick the <AutoText key="perlmodules::OAIDownload.metadata_prefix_disp"/> checkbox as well as the <AutoText key="perlmodules::OAIDownload.set_disp"/> checkbox. For the latter, type <MajorVersion number="2"><AutoText text="backdrop" type="italics"/> for the <AutoText text="set"/> name</MajorVersion><MajorVersion number="3">the setSpec value of <AutoText text="backdrop" type="italics"/></MajorVersion>. Then tick <AutoText key="perlmodules::OAIDownload.get_doc_disp"/>. Also tick <AutoText key="perlmodules::OAIDownload.get_doc_exts_disp"/> and include <AutoText text="jpg" type="italics"/> in the list of comma separated values for it so that it becomes
     4605<!--<AutoText text="localsite:backdrop" type="italics"/>--></Text>
    45824606<Format>jpg,doc,pdf,ppt</Format>
    45834607<Text id="gli-oai-9">Next, tick <AutoText key="perlmodules::OAIDownload.max_records_disp"/> and set it to 10. There will be 9 images in the collection, so we don't really need to set the Max records value, but this is a helpful feature that you can use when downloading from an OAI server.</Text>
    … …  
    46024626</NumberedItem>
    46034627<NumberedItem>
    4604 <Text id="0739">Open a DOS window to access the command-line prompt. This facility should be located somewhere within your <Menu>Start &rarr; Programs</Menu> menu, but details vary between different Windows systems. If you cannot locate it, select <Menu>Start &rarr; Run</Menu> and enter <i>cmd</i> in the popup window that appears.</Text>
     4628<Text id="0739">Open a DOS window to access the command-line prompt. This facility should be located somewhere within your <Menu>Start &rarr; Programs</Menu> menu, but details vary between different Windows systems. If you cannot locate it, select <Menu>Start &rarr; Run</Menu>, enter <AutoText text="cmd" type="italics"/> in the popup window that appears and hit <AutoText text="Enter" type="italics"/>.</Text>
    46054629</NumberedItem>
    46064630<NumberedItem>
    … …  
    46294653<Format>
    46304654<MajorVersion number="2">perl -S downloadfrom.pl -download_mode OAI -url http://&lt;hostname:portnumber&gt;/greenstone/cgi-bin/oaiserver.cgi -set backdrop -max_records 5</MajorVersion>
    4631 <MajorVersion number="3">perl -S downloadfrom.pl -download_mode OAI -url http://&lt;hostname:portnumber&gt;/greenstone3/oaiserver -set localsite:backdrop -max_records 5</MajorVersion>
     4655<MajorVersion number="3">perl -S downloadfrom.pl -download_mode OAI -url http://&lt;hostname:portnumber&gt;/greenstone3/oaiserver -set backdrop -max_records 5</MajorVersion>
     4656<!--<MajorVersion number="3">perl -S downloadfrom.pl -download_mode OAI -url http://&lt;hostname:portnumber&gt;/greenstone3/oaiserver -set localsite:backdrop -max_records 5</MajorVersion>-->
    46324657</Format>
    46334658<Text id="0747">The OAI records will be downloaded into the folder where the downloadfrom.pl script is run from. To change this, use the <Format>-cache_dir <i>full-path-to-folder</i></Format> option and set its value to the full path of the destination folder you choose. (If you wanted to download the documents along with the records, then you would additionally pass in the <Format>-get_doc</Format> flag to the above command as well as the <Format>-get_doc_exts</Format> flag followed by a comma-separated list of file extensions like "jpg,pdf".)</Text>
     4659<Format>
     4660<MajorVersion number="2">perl -S downloadfrom.pl -download_mode OAI -url http://&lt;hostname:portnumber&gt;/greenstone/cgi-bin/oaiserver.cgi -set backdrop -max_records 5 -get_doc -get_doc_exts "jpg,pdf"</MajorVersion>
     4661<MajorVersion number="3">perl -S downloadfrom.pl -download_mode OAI -url http://&lt;hostname:portnumber&gt;/greenstone3/oaiserver -set backdrop -max_records 5 -get_doc -get_doc_exts "jpg,pdf"</MajorVersion>
     4662</Format>
    46344663</NumberedItem>
    46354664<Comment><Text id="0748">You can import the downloaded documents into a new Greenstone collection and build them in the usual manner.</Text></Comment>
    … …  
    46444673<Text id="gli-oai-15">Open GLI, locate files you downloaded over OAI and drag and drop these into a new Greenstone collection called <AutoText text="OAI Collection" />.<MajorVersion number="2"> Because there are <Format>*.oai</Format> files among those downloaded, GLI will offer to add the <AutoText text="OAIPlugin"/>. <!--You may wish to go to the <AutoText key="glidict::GUI.Design"/> panel and remove the <AutoText text="EmbeddedMetadataPlugin"/> from the list of <AutoText key="glidict::CDM.GUI.Plugins"/> to speed up building.--></MajorVersion></Text>
    46454674</NumberedItem>
    4646 <!--<NumberedItem>
    4647 <Text id="gli-oai-15a">Go the <AutoText key="glidict::GUI.Design"/> panel, and configure the <AutoText text="OAIPlugin"/>'s <AutoText text="document_field"/> option to <AutoText key="metadata::ex.dc.Identifier"/>.</Text>
    4648 </NumberedItem>-->
     4675<NumberedItem>
     4676<Text id="gli-oai-15a">Go to the <AutoText key="glidict::GUI.Design"/> panel, and configure the <AutoText text="OAIPlugin"/> by ticking its <AutoText text="no_cover_image"/> option. Generally, Greenstone will look for any images that have an identical name to the primary document being processed and will associate the image with the document as its cover image. Because the OAI files and the image documents downloaded over OAI have matching names, each image would get treated as the cover image for their associated OAI file. We don't want that behaviour here, so we turn on the <AutoText text="no_cover_image"/> option. This allows the OAIPlugin to associate the metadata of each OAI file with its associated image, just as intended.</Text>
     4677<Text id="gli-oai-15b">Note that this time, we don't configure the <AutoText text="OAIPlugin"/>'s <AutoText text="document_field"/> option to <AutoText key="metadata::ex.dc.Identifier"/>, because the OAI files that have been downloaded over OAI have the associated image's document identifier stored in the <AutoText key="metadata::ex.gi.Sourcedoc"/> metadata field. You can see this if you open up any of the downloaded OAI files in a text editor. The (ex.)gi.Sourcedoc field is consulted by default when the Greenstone building process tries to identify what source document to attach the metadata in each OAI file to.</Text>
     4678<!--<Text id="gli-oai-15a">Go to the <AutoText key="glidict::GUI.Design"/> panel, and configure the <AutoText text="OAIPlugin"/>'s <AutoText text="document_field"/> option to <AutoText key="metadata::ex.dc.Identifier"/>.</Text>-->
     4679</NumberedItem>
    46494680<NumberedItem>
    46504681<Text id="gli-oai-16">Switch to the <AutoText key="glidict::GUI.Create"/> panel and press the <b>build</b> button. During this stage, the <AutoText text="OAIPlugin"/> will extract the metadata in the <AutoText text="oai" type="italics"/> files and attach them to the associated <AutoText text="jpg" type="italics"/> files of the downloaded <b>backdrop</b> collection. You can see this once the collection has been built by switching to the <AutoText key="glidict::GUI.Enrich"/> panel and clicking on an oai file, as no metadata is set for such files. However, if you then click on a jpg file and scroll down, there will be metadata names that start with <Format>ex.dc</Format>. This refers to Greenstone-extracted Dublin Core metadata. <AutoText key="metadata::ex.dc.Description"/> and <AutoText key="metadata::ex.dc.Title"/> will be set to the values you had assigned the images in the tutorial <b>A Simple Image Collection</b>. Greenstone will have added additional <Format>ex.dc</Format> metadata in the form of <AutoText key="metadata::ex.dc.Identifier"/>, which is the source URL for this image.</Text>
    … …  
    47014732</NumberedItem>
    47024733<NumberedItem>
    4703 <Text id="0768">In the <AutoText key="glidict::GUI.Gather"/> panel, locate the folder <Path>sample_files &rarr; dspace</Path>. It contains five example items exported from a DSpace institutional repository. Copy them into your collection by dragging them over to the right-hand side of the panel. Cancel out any dialog offering to add plugins.</Text>
     4734<Text id="0768">In the <AutoText key="glidict::GUI.Gather"/> panel, locate the folder <Path>sample_files &rarr; dspace</Path>. It contains five example items exported from a DSpace institutional repository. Copy them into your collection by dragging them over to the right-hand side of the panel. Cancel out of any dialog offering to add plugins.</Text>
    47044735</NumberedItem>
    47054736<NumberedItem>
    … …  
    52285259</NumberedItem>
    52295260<Heading>
    5230 <Text id="hp-08">Adding list of collections</Text>
     5261<Text id="hp-08">Adding the list of collections</Text>
    52315262</Heading>
    52325263<NumberedItem>
Note: See TracChangeset for help on using the changeset viewer.