Changeset 27122

Show
Ignore:
Timestamp:
25.03.2013 12:25:22 (7 years ago)
Author:
jlwhisler
Message:

Changes to indexers & depositor tutorials. Added |3.05 to Version’s current attribute for indexer tutorial. Added Auto Text for GS3 to correspond with GS2’s coredm keys – so tutorials for GS3 can be generated properly from a Greenstone 3 installation. Fixed demo collection name to match what it’s called in GS3.

Files:
1 modified

Legend:

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

    r27121 r27122  
    44624462</Title> 
    44634463<SampleFiles folder="demo"/> 
    4464 <Version initial="2.70w" current="2.85"/> 
     4464<Version initial="2.70w" current="2.85|3.05"/> 
    44654465<Content> 
    44664466<Text id="indexers-2">Greenstone supports three indexers <b>MG</b>, <b>MGPP</b> and <b>Lucene</b>. </Text> 
     
    44754475</NumberedItem> 
    44764476<NumberedItem> 
    4477 <Text id="indexers-8">In the <AutoText key="glidict::GUI.Gather"/> panel, click <AutoText key="glidict::Tree.World"/> and click <MajorVersion number="2"><b>Greenstone demo (demo)</b></MajorVersion><MajorVersion number="3"><b>Demo Collection (lucene-jdbm-demo)</b></MajorVersion>, it will show the documents in the <b>Greenstone demo</b> collection. Drag all 11 folders underneath <Path>Greenstone demo (demo)</Path> into the new collection.</Text> 
    4478 <Comment> 
    4479 <Text id="demo-collection">If you haven't installed the <b>Greenstone demo (demo)</b> collection yet, you can download the <Path>demo.zip</Path> file from the link above, unzip it and put it into the <Path>collect</Path> folder in your Greenstone installation.</Text> 
     4477<Text id="indexers-8">In the <AutoText key="glidict::GUI.Gather"/> panel, click <AutoText key="glidict::Tree.World"/> and click <MajorVersion number="2"><b>Greenstone demo (demo)</b></MajorVersion><MajorVersion number="3"><Path>localsite &rarr; Demo Collection (lucene-jdbm-demo)</Path></MajorVersion>, it will show the documents in the <b>Greenstone demo</b> collection. Drag all 11 folders in the demo folder into the new collection.</Text> 
     4478<Comment> 
     4479<Text id="demo-collection">If you haven't installed the <MajorVersion number="2"><b>Greenstone demo (demo)</b></MajorVersion><MajorVersion number="3"><b>Demo Collection (lucene-jdbm-demo)</b></MajorVersion> collection yet, you can download the <Path>demo.zip</Path> file from the link above, unzip it and put it into the <Path>collect</Path> folder in your Greenstone installation.</Text> 
    44804480</Comment> 
    44814481</NumberedItem> 
     
    45004500</Heading> 
    45014501<NumberedItem> 
    4502 <Text id="indexers-15">Lucene provides single letter and multiple letter wildcards and range searching. The query syntax could be quite complicated (for more information please see http://lucene.apache.org/java/docs/queryparsersyntax.html). Here we will learn how to use the wildcards while constructing queries.</Text> 
     4502<Text id="indexers-15">Lucene provides single letter and multiple letter wildcards and range searching. The query syntax could be quite complicated (for more information please see <Link>http://lucene.apache.org/java/docs/queryparsersyntax.html</Link>. Here we will learn how to use the wildcards while constructing queries.</Text> 
    45034503</NumberedItem> 
    45044504<NumberedItem> 
     
    45184518</NumberedItem> 
    45194519<NumberedItem> 
    4520 <Text id="indexers-21">In the <AutoText key="glidict::GUI.Gather"/> panel, drag all the 11 folders from <Path><AutoText key="glidict::Tree.World"/> &rarr; Greenstone demo (demo)</Path> into the new collection. </Text> 
     4520<Text id="indexers-21">In the <AutoText key="glidict::GUI.Gather"/> panel, drag all 11 folders from <AutoText key="glidict::Tree.World"/><Path> &rarr; <MajorVersion number="2">Greenstone demo (demo)</MajorVersion><MajorVersion number="3">localsite &rarr; Demo Collection (lucene-jdbm-demo)</MajorVersion></Path> into the new collection. </Text> 
    45214521</NumberedItem> 
    45224522<NumberedItem> 
     
    45574557<MajorVersion number="3"> 
    45584558<NumberedItem> 
    4559 <Text id="indexers-26-3">MGPP supports stemming, casefolding and accentfolding. By default, searching in collections built with MGPP indexer is set to <AutoText key="coredm::_preferences:textnostem_"/> and <AutoText key="coredm::_preferences:textmatchcase_"/>. So searching <i>econom</i> will return 0 documents. Searching for <i>fao</i> will return 0 documents whereas searching for <i>FAO</i> will return &mdash; 89 word counts and 11 matched documents.</Text> 
    4560 <Text id="indexers-26a-3">Go to the <AutoText text="advanced search form"/> page by clicking the <AutoText text="advanced search form"/> button at the top right corner. You can see that <b>stem</b> is off, which means <AutoText key="coredm::_preferences:textwordends_"/> option is set to <AutoText key="coredm::_preferences:textnostem_"/>. And <b>case</b> (folding) is off too, which means the <AutoText key="coredm::_preferences:textcasediffs_"/> option is set to <AutoText key="coredm::_preferences:textmatchcase_"/>.</Text> 
    4561 </NumberedItem> 
    4562 <NumberedItem> 
    4563 <Text id="indexers-27-3">Sometimes we may want to ignore word endings while searching so as to match different variations of the term. Change the <AutoText text="stem"/> option from <AutoText text="off"/> to <AutoText text="on"/>. This will change the search settings from the default, which is that the <AutoText key="coredm::_preferences:textnostem_"/> to <AutoText key="coredm::_preferences:textstem_"/>. Now try searching for <i>econom</i> again, 9 documents are found.</Text> 
    4564 <Text id="indexers-27a-3">Please note that word endings are determined according to the third-party stemming tables incorporated in Greenstone, not by the user. Thus the searches may not do precisely what is expected, especially when cultural variations or dialects are concerned. Besides, not all languages support stemming, only English and French have stemming at the moment.</Text> 
    4565 <Text id="indexers-27b-3">Change the <AutoText text="stem"/> option back to <AutoText text="off"/> (to <AutoText key="coredm::_preferences:textnostem_"/>) to avoid confusion later on.</Text> 
    4566 </NumberedItem> 
    4567 <NumberedItem> 
    4568 <Text id="indexers-28-3">Sometimes we may want to search for the exact term, that is, differentiate the upper cases from lower cases. In the <AutoText text="advanced search form"/> page, the default settings already insist that upper/lower case must match (case stemming is off). If you want to ignore case when searching, switch <AutoText text="case"/> folding to <AutoText text="on"/> (<AutoText key="coredm::_preferences:textignorecase_"/>). Now try searching for <i>fao</i> and <i>FAO</i> respectively this time. Notice the search results are the same for both this time.</Text> 
     4559<Text id="indexers-26-3">MGPP supports stemming, casefolding and accentfolding. By default, searching in collections built with MGPP indexer is set to <AutoText text="whole word must match"/> and <AutoText text="upper/lower case must match"/>. So searching <i>econom</i> will return 0 documents. Searching for <i>fao</i> will return 0 documents, whereas searching for <i>FAO</i> will return 89 word counts and 11 matched documents.</Text> 
     4560<Text id="indexers-26a-3">Go to the <AutoText text="advanced search"/> page by clicking the <AutoText text="advanced search"/> button at the top right corner. You can see that <b>stem</b> is off, which means the <b>word endings</b> option is set to <AutoText text="whole word must match"/>. And <b>case</b> (folding) is off too, which means the <b>case difference</b> option is set to <AutoText text="upper/lower case must match"/>.</Text> 
     4561</NumberedItem> 
     4562<NumberedItem> 
     4563<Text id="indexers-27-3">Sometimes we may want to ignore word endings while searching so as to match different variations of the term. Change the <AutoText text="stem"/> option from <AutoText text="off"/> to <AutoText text="on"/>. This will change the search settings from the default, which is that the <AutoText text="whole word must match"/>, to <AutoText text="ignore word endings"/>. Now try searching for <i>econom</i> again, 9 documents are found.</Text> 
     4564<Text id="indexers-27a-3">Please note that word endings are determined according to the third-party stemming tables incorporated in Greenstone, not by the user. Thus the searches may not do precisely what is expected, especially when cultural variations or dialects are concerned. In addition, not all languages support stemming; only English and French have stemming at the moment.</Text> 
     4565<Text id="indexers-27b-3">Change the <AutoText text="stem"/> option back to <AutoText text="off"/> (<AutoText text="whole word must match"/>) to avoid confusion later on.</Text> 
     4566</NumberedItem> 
     4567<NumberedItem> 
     4568<Text id="indexers-28-3">Sometimes we may want to search for the exact term, that is, differentiate the upper cases from lower cases. In the <AutoText text="advanced search form"/> page, the default settings already insist that upper/lower case must match (case folding is off). If you want to ignore case when searching, switch <AutoText text="case"/> folding to <AutoText text="on"/> (<AutoText text="ignore case differences"/>). Now try searching for <i>fao</i> and <i>FAO</i> respectively. Notice the search results are the same for both this time.</Text> 
    45694569</NumberedItem> 
    45704570</MajorVersion> 
     
    45734573</Heading> 
    45744574<Comment> 
    4575 <Text id="mgpp-1">MGPP has several hotkeys for setting the search modes for a query term. These hotkeys explicitly set the <AutoText key="coredm::_preferences:textwordends_"/> option and the <AutoText key="coredm::_preferences:textcasediffs_"/> option for the query being constructed. <MajorVersion number="3">Use them in the plain <AutoText text="text search"/> or <AutoText text="form search"/>.</MajorVersion></Text> 
    4576 </Comment> 
    4577 <NumberedItem> 
    4578 <Text id="mgpp-2"><b>#s</b> and <b>#u</b> are hotkeys for the <AutoText key="coredm::_preferences:textwordends_"/> option. Appending <b>#s</b> to a query term will specifically enable the <AutoText key="coredm::_preferences:textstem_"/> function. For example, <MajorVersion number="3">click on the <AutoText text="Form search"/> button and </MajorVersion>try searching for <i>econom#s</i>. 9 documents are found, which is the same as in step 17.<MajorVersion number="2"> Remember that we have set it back to <AutoText key="coredm::_preferences:textnostem_"/>. This means using hotkeys will override the current preference settings.</MajorVersion></Text> 
    4579 </NumberedItem> 
    4580 <NumberedItem> 
    4581 <Text id="mgpp-3">Appending <b>#u</b> to a query term will explicitly set the current search to <AutoText key="coredm::_preferences:textnostem_"/>. </Text> 
    4582 <Text id="mgpp-4">Note that using hotkeys will only affect that query term. That is, hotkeys are used per term. For example, if a query expression contains more than one term, some terms can have hotkeys and others not, and the hotkeys can be different for different terms. This provides a fine-grained control of the query, whereas <MajorVersion number="2">changing settings in the <AutoText key="coredm::_Global:linktextPREFERENCES_"/> page will affect the query as a whole</MajorVersion><MajorVersion number="3">changing the controls for a search field in the <AutoText text="advanced search form"/> page will apply to all the query terms in that field</MajorVersion>.</Text> 
    4583 </NumberedItem> 
    4584 <NumberedItem> 
    4585 <Text id="mgpp-5">Hotkeys <b>#i</b> and <b>#c</b> control the case sensitivity. Appending <b>#i</b> to a query term will explicitly set the search to <AutoText key="coredm::_preferences:textignorecase_"/> (i.e. case insensitive).<MajorVersion number="3"> For example, search for <i>fao#i</i> returns 11 documents.</MajorVersion></Text> 
    4586 </NumberedItem> 
    4587 <NumberedItem> 
    4588 <Text id="mgpp-6">In contrast, appending <b>#c</b> will specifically turn off the casefolding, that is, <AutoText key="coredm::_preferences:textmatchcase_"/>.<MajorVersion number="2"> For example, search for <i>fao#c</i> returns 0 documents.</MajorVersion></Text> 
     4575<Text id="mgpp-1">MGPP has several hotkeys for setting the search modes for a query term. These hotkeys explicitly set the <MajorVersion number="2"><AutoText key="coredm::_preferences:textwordends_"/></MajorVersion><MajorVersion number="3"><AutoText text="stem"/></MajorVersion> option and the <MajorVersion number="2"><AutoText key="coredm::_preferences:textcasediffs_"/></MajorVersion><MajorVersion number="3"><AutoText text="case"/></MajorVersion> option for the query being constructed. <MajorVersion number="3">Use them in the plain <AutoText text="text search"/> or <AutoText text="form search"/>.</MajorVersion></Text> 
     4576</Comment> 
     4577<NumberedItem> 
     4578<Text id="mgpp-2"><b>#s</b> and <b>#u</b> are hotkeys for the <MajorVersion number="2"><AutoText key="coredm::_preferences:textwordends_"/></MajorVersion><MajorVersion number="3"><AutoText text="stem"/></MajorVersion> option. Appending <b>#s</b> to a query term will specifically enable the <MajorVersion number="2"><AutoText key="coredm::_preferences:textstem_"/></MajorVersion><MajorVersion number="3"><AutoText text="ignore word endings"/></MajorVersion> function. For example, <MajorVersion number="3">click on the <AutoText text="Form search"/> button and </MajorVersion>try searching for <i>econom#s</i>. 9 documents are found, which is the same as in the previous section.<MajorVersion number="2"> Remember that we have set it back to <AutoText key="coredm::_preferences:textnostem_"/>. This means using hotkeys will override the current preference settings.</MajorVersion></Text> 
     4579</NumberedItem> 
     4580<NumberedItem> 
     4581<Text id="mgpp-3">Appending <b>#u</b> to a query term will explicitly set the current search to <MajorVersion number="2"><AutoText key="coredm::_preferences:textnostem_"/></MajorVersion><MajorVersion number="3"><AutoText text="whole word must match"/></MajorVersion>. </Text> 
     4582<Text id="mgpp-4">Note that using hotkeys will only affect that query term. That is, hotkeys are used per term. For example, if a query expression contains more than one term, some terms can have hotkeys and others not, and the hotkeys can be different for different terms. This provides a fine-grained control of the query, whereas <MajorVersion number="2">changing settings in the <AutoText key="coredm::_Global:linktextPREFERENCES_"/> page will affect the query as a whole</MajorVersion><MajorVersion number="3">changing the controls for a search field on the <AutoText text="advanced search"/> page will apply to all the query terms in that field</MajorVersion>.</Text> 
     4583</NumberedItem> 
     4584<NumberedItem> 
     4585<Text id="mgpp-5">Hotkeys <b>#i</b> and <b>#c</b> control the case sensitivity. Appending <b>#i</b> to a query term will explicitly set the search to <MajorVersion number="2"><AutoText key="coredm::_preferences:textignorecase_"/> (i.e. case insensitive).</MajorVersion><MajorVersion number="3"><AutoText text="ignore case differences"/> (i.e. case insensitive). For example, search for <i>fao#i</i> returns 11 documents.</MajorVersion></Text> 
     4586</NumberedItem> 
     4587<NumberedItem> 
     4588<Text id="mgpp-6">In contrast, appending <b>#c</b> will specifically turn off the casefolding, that is, <MajorVersion number="3"><AutoText text="upper/lower case must match"/>.</MajorVersion><MajorVersion number="2"><AutoText key="coredm::_preferences:textmatchcase_"/>. For example, search for <i>fao#c</i> returns 0 documents.</MajorVersion></Text> 
    45894589</NumberedItem> 
    45904590<NumberedItem> 
     
    45944594<Text id="quickref-1">A quick reference of the search mode hotkeys in MGPP</Text> 
    45954595</Heading> 
     4596<MajorVersion number="2"> 
    45964597<Comment> 
    45974598<Format><AutoText key="coredm::_preferences:textwordends_"/></Format> 
     
    46024603<Format>&nbsp;&nbsp;&nbsp;&nbsp;<b>#c</b>&nbsp;&nbsp;&nbsp;&nbsp;<AutoText key="coredm::_preferences:textmatchcase_"/></Format> 
    46034604</Comment> 
     4605</MajorVersion> 
     4606<MajorVersion number="3"> 
     4607<Comment> 
     4608<Format><AutoText text="Word endings:"/></Format> 
     4609<Format>&nbsp;&nbsp;&nbsp;&nbsp;<b>#s</b>&nbsp;&nbsp;&nbsp;&nbsp;<AutoText text="ignore word endings"/></Format> 
     4610<Format>&nbsp;&nbsp;&nbsp;&nbsp;<b>#u</b>&nbsp;&nbsp;&nbsp;&nbsp;<AutoText text="whole word must match"/></Format> 
     4611<Format><AutoText text="Case differences:"/></Format> 
     4612<Format>&nbsp;&nbsp;&nbsp;&nbsp;<b>#i</b>&nbsp;&nbsp;&nbsp;&nbsp;<AutoText text="ignore case differences"/></Format> 
     4613<Format>&nbsp;&nbsp;&nbsp;&nbsp;<b>#c</b>&nbsp;&nbsp;&nbsp;&nbsp;<AutoText text="upper/lower case must match"/></Format> 
     4614</Comment> 
     4615</MajorVersion> 
    46044616</Content> 
    46054617</Tutorial> 
     4618<MajorVersion number="2"> 
    46064619<Tutorial id="depositor"> 
    46074620<Title> 
     
    46964709</Content> 
    46974710</Tutorial> 
     4711</MajorVersion> 
    46984712</TutorialList>