Changeset 30753

Show
Ignore:
Timestamp:
24.08.2016 21:33:13 (3 years ago)
Author:
ak19
Message:

Further tutorial commits for upcoming GS3.08 release.

Files:
1 modified

Legend:

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

    r30743 r30753  
    820820  Greenstone has a map view, based on the Google Maps API, that can make use of this location metadata.  The map view can be controlled to appear in different parts of the interface: as part of a collection's search results page when browsing the collection, and/or when viewing a document.  For this view to be operational in a Greenstone, it is necessary for the collection to index the GPS metadata.</Text> 
    821821<NumberedItem> 
    822 <Text id="images-gps-11">In the <b>Search Indexes</b> section of the <b>Design</b> panel, press the <b>New Index...</b> button. Scroll down and tick the box for <b>ex.LatShort</b> and press <b>Add Index</b> to create an index on. In like manner, create an index on <b>ex.Latitude</b>. Then another on <b>ex.LngShort</b>. And finally one on <b>ex.Longitude</b>.</Text>  
     822<Text id="images-gps-11">In the <b>Search Indexes</b> section of the <b>Design</b> panel, press the <b>New Index...</b> button. Scroll down and tick the box for <b>ex.LatShort</b> and press <b>Add Index</b> to create an index on it. In like manner, create an index on <b>ex.Latitude</b>. Then another on <b>ex.LngShort</b>. And finally one on <b>ex.Longitude</b>.</Text>  
    823823</NumberedItem> 
    824824<NumberedItem> 
     
    837837<Text id="images-gps-16"> 
    838838  By adding the <Format>&lt;gsf:option name="mapEnabled" value="true" /&gt;</Format> statement 
    839   to the <b>browser</b> format feature, all of the classifiers built will have the map 
     839  to the <b>browse</b> format feature, all of the classifiers built will have the map 
    840840  view enabled.  It is also possible to activate the map view on individual classifiers, 
    841841  and on the search results page by adding the <i>mapEnabled</i> statement to the <i>search</i> 
     
    946946</NumberedItem> 
    947947<MajorVersion number="3"><NumberedItem> 
    948 Next, go to the <AutoText key="glidict::GUI.Format"/> panel, and select the <AutoText key="glidict::CDM.GUI.SearchMetadata"/> section to the left. On the right, set the display text value for <b>Index: dc.Creator</b> to <Format>creators</Format>. 
     948Next, go to the <AutoText key="glidict::GUI.Format"/> panel, and select the <AutoText key="glidict::CDM.GUI.SearchMetadata"/> section to the left. On the right, set the display text value for <b>Index: dc.Creator</b> to <Format>creators</Format> 
    949949</NumberedItem></MajorVersion> 
    950950<NumberedItem> 
     
    10711071<MajorVersion number="3"> 
    10721072<NumberedItem> 
    1073 <Text id="fw-11-3">For collections with documents that undergo a conversion process during importing (e.g. Word, PDF, PowerPoint documents, but not text, HTML documents), the original file is stored in the collection along with the converted version. The default <AutoText text="Browse" /> format statement links to both versions, but the format statement for <AutoText text="Search"/> links only to the converted version of the original file:</Text> 
     1073<Text id="fw-11-3">For collections with documents that undergo a conversion process during importing (e.g. Word, PDF, PowerPoint documents, but not text, HTML documents), the original file is stored in the collection along with the converted version. The default <AutoText text="Browse" /> format statement links to both versions, but the format statement for <AutoText text="Search"/> links only to the converted version of the original file. That is, this format statement:</Text> 
    10741074<Format>&lt;gsf:link type=&quot;document&quot;&gt;<br/> 
    10751075        <Tab n="1"/>&lt;gsf:icon type=&quot;document&quot;/&gt;<br/> 
     
    12711271</NumberedItem> 
    12721272<NumberedItem> 
    1273 <Text id="pdfbox-ext-11">Now that you've installed the PDFBox extension, this will be available as an option in the plugin's configuration dialog. To turn on the PDFBox extension, go to the <AutoText key="glidict::GUI.Design"/> panel, select <AutoText key="glidict::CDM.GUI.Plugins"/> from the left, and on the right double click the <AutoText text="PDFPlugin"/> (alternatively, select this plugin and click the <AutoText key="glidict::CDM.PlugInManager.Configure" type="button"/> below) to open the dialog to configure this plugin. In the <AutoText key="glidict::CDM.PlugInManager.Configure"/> dialog, scroll down to the section <AutoText text="AutoLoadConverters"/> and select the checkbox next to the <AutoText text="pdfbox_conversion"/> option. Click <AutoText key="glidict::General.OK"/> to close the dialog, switch to the <AutoText key="glidict::GUI.Create"/> panel and build your collection. This time, the PDF files will be processed by PDFBox which will extract their text.</Text> 
     1273<Text id="pdfbox-ext-11"><MajorVersion number="2">Now that you've installed the PDFBox extension</MajorVersion><MajorVersion number="3">Since the PDFBox extension (which works with the PDFPlugin) now comes installed with Greenstone 3</MajorVersion>, this will be available as an option in the plugin's configuration dialog. To turn on the PDFBox extension, go to the <AutoText key="glidict::GUI.Design"/> panel, select <AutoText key="glidict::CDM.GUI.Plugins"/> from the left, and on the right double click the <AutoText text="PDFPlugin"/> (alternatively, select this plugin and click the <AutoText key="glidict::CDM.PlugInManager.Configure" type="button"/> below) to open the dialog to configure this plugin. In the <AutoText key="glidict::CDM.PlugInManager.Configure"/> dialog, scroll down to the section <AutoText text="AutoLoadConverters"/> and select the checkbox next to the <AutoText text="pdfbox_conversion"/> option. Click <AutoText key="glidict::General.OK"/> to close the dialog, switch to the <AutoText key="glidict::GUI.Create"/> panel and build your collection. This time, the PDF files will be processed by PDFBox which will extract their text.</Text> 
    12741274<Text id="pdfbox-ext-12">Try this feature out on a collection of recent PDF files, by configuring its PDFPlugin with the <AutoText text="pdfbox_conversion"/> option turned on.</Text> 
    12751275</NumberedItem> 
     
    13121312<Text id="ep-7"><b>Build</b> and <b>preview</b> the collection. View the text versions of some of the PDF documents. <MajorVersion number="2">Note that these are now split into a series of pages, and a "go to page" box is provided.  
    13131313</MajorVersion> 
    1314 <MajorVersion number="3">Note that these are now split into a series of pages, and a table of contents is provided to the right. 
     1314<MajorVersion number="3">Note that these are now split into a series of pages, and a table of contents is provided to the right. Clicking on a page in the table of contents will scroll to that page. The other way of navigating is on the left, where individual pages are listed vertically by page number and clicking the "plus" box next to a page will expand its contents. 
    13151315</MajorVersion> 
    13161316<MajorVersion number="2">The format is still a bit ugly though, and</MajorVersion><MajorVersion number="3">Note that</MajorVersion> pdf05-notext.pdf is still not processed.</Text> 
     
    19941994<Text id="0469">This displays something that looks like this: </Text> 
    19951995<Indent> 
    1996 <table><tr><td><img width='15' height='20' src="../tutorial_files/itext.gif"/></td><td width='408' valign='top'>A discussion of question five from Tudor Quiz: Henry VIII <br/><i>(quizstuff.html)</i></td></tr></table> 
     1996<table><tr><td><img width='15' height='20' src="../tutorial_files/itext.gif"/></td><td width='508' valign='top'>A discussion of question five from Tudor Quiz: Henry VIII <br/><i>(quizstuff.html)</i></td></tr></table> 
    19971997</Indent> 
    19981998<Text id="0472">for a particular document whose <i>Title</i> metadata is <AutoText text="A discussion of question five from Tudor Quiz: Henry VIII"/> and whose <i>Source</i> metadata is <AutoText text="quizstuff.html"/>.</Text> 
     
    22162216<NumberedItem> 
    22172217<Text id="0490"><b>Preview</b> the collection. Documents in the search results list will be displayed like this:</Text> 
    2218 <table><tr><td><img width='15' height='20' src="../tutorial_files/itext.gif" /></td><td width='408' valign='top'>A discussion of question five from Tudor Quiz: Henry VIII <br/> 
     2218<table><tr><td><img width='15' height='20' src="../tutorial_files/itext.gif" /></td><td width='508' valign='top'>A discussion of question five from Tudor Quiz: Henry VIII <br/> 
    22192219Tudor period|Others</td></tr></table> 
    22202220<Text id="0493">(The vertical bar appears because this <AutoText key="metadata::dc.Subject"/> metadata is hierarchical metadata. Unfortunately there is no easy way to get at individual components of the hierarchy. For most metadata, such as title and author, this isn't a problem.)</Text> 
     
    23722372</NumberedItem> 
    23732373<NumberedItem> 
    2374 <Text id="0414">In a web browser, visit <Link>http://englishhistory.net</Link>, follow the link to <i>Tudor England</i>. You should be at the URL</Text> 
     2374<Text id="0414">In a web browser, visit <Link>http://englishhistory.net</Link>, follow the link to <i>The Tudors</i>. You should be at the URL</Text> 
    23752375<Link>http://englishhistory.net/tudor/</Link>  
    23762376<Text id="0415">This is where we started the downloading process to obtain the files you have been using for the <b>tudor</b> collection. You could do the same thing by copying this URL from the web browser, pasting it into the <AutoText key="glidict::GUI.Download"/> panel, and clicking the <AutoText key="glidict::Mirroring.Download" type="button"/> button. However, several megabytes will be downloaded, which might strain your network resources&mdash;or your patience! For a faster exercise we focus on a smaller section of the site. </Text> 
     
    36313631</NumberedItem> 
    36323632<NumberedItem> 
    3633 <Text id="0632"><b>Build</b> the collection and <b>preview</b> it. Unfortunately the MIDI files don't appear as Audio under the <i>browse</i> button. That's because they haven't been assigned <AutoText key="metadata::dc.Format"/> metadata.</Text> 
     3633<Text id="0632"><b>Build</b> the collection and <b>preview</b> it. Unfortunately, the MIDI files don't appear as Audio under the <i>browse</i> button. That's because they haven't been assigned <AutoText key="metadata::dc.Format"/> metadata.</Text> 
    36343634<BulletList> 
    36353635<Bullet> 
     
    45084508</Format> 
    45094509</MajorVersion> 
    4510 <Text id="0730">This format statement alters how the document view is presented. It includes a screen-sized version of the image that hyperlinks back to the original larger version available on the web (unfortunately, the original versions of the images in this sample collection are no longer available on the web). Factual information extracted from the image, such as width, height and type, is also displayed.<MajorVersion number="3"> It uses XSLT to construct the hyperlink which makes use of the greenstone metadata containing the link to the original image.</MajorVersion></Text> 
     4510<Text id="0730">This format statement alters how the document view is presented. It includes a screen-sized version of the image that hyperlinks back to the original larger version available on the web. (Unfortunately, the original versions of the images in this sample collection are no longer available on the web.) Factual information extracted from the image, such as width, height and type, is also displayed.<MajorVersion number="3"> It uses XSLT to construct the hyperlink which makes use of the greenstone metadata containing the link to the original image.</MajorVersion></Text> 
    45114511</NumberedItem> 
    45124512<NumberedItem> 
     
    47144714</NumberedItem> 
    47154715<NumberedItem> 
    4716 <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> 
     4716<Text id="0739">If you're on Windows, 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> 
     4717<Text id="0739a">If you're on Linux or Mac, open a terminal.</Text> 
    47174718</NumberedItem> 
    47184719<NumberedItem> 
     
    49464947</Heading> 
    49474948<NumberedItem> 
    4948 <Text id="0790a">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 and you are running <AutoText text="Windows XP"/>, select <Menu>Start &rarr; Run</Menu> and enter <Command>cmd</Command> in the popup window that appears. In either <AutoText text="Windows Vista"/> or <AutoText text="Windows 7"/>, click the Start button and type <Command>cmd</Command> in the search box at the bottom of the Start menu.</Text> 
     4949<Text id="0790a">If you're on Windows, 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 and you are running <AutoText text="Windows XP"/>, select <Menu>Start &rarr; Run</Menu> and enter <Command>cmd</Command> in the popup window that appears. In either <AutoText text="Windows Vista"/> or <AutoText text="Windows 7"/>, click the Start button and type <Command>cmd</Command> in the search box at the bottom of the Start menu.</Text> 
     4950<Text id="0790aa">If you're on a Unix system or on a Mac, open a terminal.</Text> 
    49494951</NumberedItem> 
    49504952<NumberedItem>