Changeset 27113 for documentation/trunk

Show
Ignore:
Timestamp:
25.03.2013 07:54:08 (7 years ago)
Author:
jlwhisler
Message:

Changes for tutorials through simple image collection. Added |3.05 to Version’s current attribute. Added correct file path for Greenstone 3 in Simple HTML tutorial. Included section on internal/external links, since it’s applicable to GS3 as well as GS2. Added AutoText? for GS3 to correspond with GS2’s coredm keys – so tutorials for GS3 can be generated properly from a Greenstone 3 installation.

Files:
1 modified

Legend:

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

    r26219 r27113  
    498498</Title> 
    499499<SampleFiles folder="simple_html"/> 
    500 <Version initial="2.60" current="2.85"/> 
     500<Version initial="2.60" current="2.85|3.05"/> 
    501501<Content> 
    502502<Comment> 
     
    508508<NumberedItem> 
    509509<Text id="0255">Start the Greenstone Librarian Interface:</Text> 
     510  <MajorVersion number="2"> 
    510511<Menu> 
    511512<Text id="0255a">Start &rarr; All Programs &rarr; Greenstone-2.85 &rarr; Librarian Interface (GLI)</Text> 
    512 </Menu>  
    513 <Comment> 
    514 <Text id="0255b">If you are using Windows Vista or Windows 7 and have installed Greenstone into the default location (i.e. C:\Program Files\Greenstone) a User Account Control dialog may appear as you try to start the Greenstone Librarian Interface, click &lt;<b>Yes</b>&gt; to continue.</Text> 
     513</Menu> 
     514  </MajorVersion> 
     515  <MajorVersion number="3"> 
     516    <Menu> 
     517      <Text id="0255c">Start &rarr; All Programs &rarr; Greenstone-3.05 &rarr; Greenstone Librarian Interface (GLI)</Text> 
     518    </Menu> 
     519  </MajorVersion> 
     520<Comment> 
     521<Text id="0255b">If you are using Windows Vista or Windows 7 and have installed Greenstone into the default location (i.e. C:\Program Files\Greenstone) a User Account Control dialog may appear as you try to start the Greenstone Librarian Interface, click &lt;<b>Yes</b>&gt; to continue. </Text> 
    515522<Text id="0256">After a short pause a startup screen appears, and then after a slightly longer pause the main Greenstone Librarian Interface appears. (A command prompt is also opened in the background.)</Text> 
    516523</Comment> 
     
    574581<Text id="0274">Close the collection by clicking <Menu><AutoText key="glidict::Menu.File"/> &rarr; <AutoText key="glidict::Menu.File_Close"/></Menu>. This automatically saves the collection to disk.</Text> 
    575582</NumberedItem> 
    576 <MajorVersion number="2"> 
     583 
    577584<Heading> 
    578585<Text id="0275">Viewing the internal links and external links</Text> 
     
    580587<NumberedItem> 
    581588<Text id="0275a">Hyperlinks in a Greenstone collection work like this: If the link is to a document that is also in the collection, clicking it takes you to that document in the collection. If the link is to a document that is <i>not</i> in the collection, clicking it takes you to that document on the web.</Text> 
    582 <Text id="0257b">Go back to the web browser and click the <Path>titles</Path>  link near the top of the page. Open the file <Path>boleyn.html</Path> and look for the link to <Path>Katharine of Aragon</Path> (in the 5th paragraph of the <Path>Biography</Path> section). This links to a document inside the collection--<Path>aragon.html</Path>. View this document by clicking the link. For an external link, click <Path>letters written by Anne</Path> (in the <Path>Primary Sources</Path> section). This takes you out on to the web. If you want a warning message to be displayed first, you can open <Path>Greenstone &rarr; etc &rarr; main.cfg</Path> file and uncomment the line <Format>cgiarg shortname=el argdefault=prompt</Format> (remove the # at the start of a line to uncomment it). Note, that if you are already browsing a collection, then you will need to go back to the home page and re-enter the collection to see this take effect (due to caching of the el argument).</Text> 
    583 </NumberedItem> 
    584 </MajorVersion> 
     589<Text id="0257b">Go back to the web browser and click the <Path>titles</Path>  link near the top of the page. Open the file <Path>boleyn.html</Path> and look for the link to <Path>Katharine of Aragon</Path> (in the 5th paragraph of the <Path>Biography</Path> section). This links to a document inside the collection--<Path>aragon.html</Path>. View this document by clicking the link. For an external link, return to <Path>boleyn.html</Path> and click <Path>letters written by Anne</Path> (in the <Path>Primary Sources</Path> section). This takes you out on to the web. </Text> 
     590  <MajorVersion number="2"> 
     591  <Text id="0257c">If you want a warning message to be displayed first, you can open <Path>Greenstone &rarr; etc &rarr; main.cfg</Path> file and uncomment the line <Format>cgiarg shortname=el argdefault=prompt</Format> (remove the # at the start of a line to uncomment it). Note, that if you are already browsing a collection, then you will need to go back to the home page and re-enter the collection to see this take effect (due to caching of the el argument).</Text> 
     592  </MajorVersion> 
     593</NumberedItem> 
     594 
    585595<Heading>  
    586596<Text id="0277">Setting up a shortcut in the Librarian interface</Text> 
     
    596606</Title> 
    597607<SampleFiles folder="images"/> 
    598 <Version initial="2.60" current="2.85"/> 
     608<Version initial="2.60" current="2.85|3.05"/> 
    599609<Content> 
    600610<NumberedItem> 
     
    615625</NumberedItem> 
    616626<NumberedItem> 
    617 <Text id="0344">Click on <AutoText key="coredm::_Global:labelBrowse_"/> in the navigation bar to view a list of the photos ordered by filename and presented as a thumbnail accompanied by some basic data about the image. The structure of this collection is the same as <b>Simple image collection</b>, but the content is different.</Text> 
     627<Text id="0344">Click on <MajorVersion number="2"><AutoText key="coredm::_Global:labelBrowse_"/></MajorVersion><MajorVersion number="3"><AutoText text="Browse" /></MajorVersion> in the navigation bar to view a list of the photos ordered by filename and presented as a thumbnail accompanied by some basic data about the image. The structure of this collection is the same as <b>Simple image collection</b>, but the content is different.</Text> 
    618628</NumberedItem> 
    619629<NumberedItem> 
     
    680690</NumberedItem> 
    681691<NumberedItem> 
    682 <Text id="0362b">Preview the collection by clicking the <AutoText key="glidict::CreatePane.Preview_Collection" type="button"/> button. When you click on <AutoText key="coredm::_Global:labelBrowse_"/> in the navigation bar the presentation has changed to "Title: Bear" and so on. Each image's description should appear beside the thumbnail, following the title.</Text> 
     692<Text id="0362b">Preview the collection by clicking the <AutoText key="glidict::CreatePane.Preview_Collection" type="button"/> button. When you click on <MajorVersion number="2"><AutoText key="coredm::_Global:labelBrowse_"/></MajorVersion><MajorVersion number="3"><AutoText text="Browse" /></MajorVersion> in the navigation bar the presentation has changed to "Title: Bear" and so on. Each image's description should appear beside the thumbnail, following the title.</Text> 
    683693</NumberedItem> 
    684694<Comment> 
     
    710720</NumberedItem> 
    711721<NumberedItem> 
    712 <Text id="0382a"><b>Build</b> the collection, and <b>preview</b> it. Choose the new <AutoText key="coredm::_Global:labelDescription_"/> link that appears in the navigation bar.</Text> 
     722<Text id="0382a"><b>Build</b> the collection, and <b>preview</b> it. Choose the new <MajorVersion number="2"><AutoText key="coredm::_Global:labelDescription_"/></MajorVersion><MajorVersion number="3"><AutoText text="Descriptions" type="italics"/></MajorVersion> link that appears in the navigation bar.</Text> 
    713723</NumberedItem> 
    714724<Comment> 
     
    722732</NumberedItem> 
    723733<NumberedItem> 
    724 <Text id="0386">Switch to the <AutoText key="glidict::GUI.Create"/> panel, <b>build</b> the collection, then <b>preview</b> it. There is now a <AutoText key="coredm::_Global:labelSearch_"/> button in the navigation bar. As an example, search for the term "bear" in the<MajorVersion number="2"> <AutoText key="coredm::_Global:labelDescription_" type="italics"/></MajorVersion><MajorVersion number="3"> <AutoText text="dc.Description" type="italics"/></MajorVersion> index (which is the only index at this point).</Text> 
    725 </NumberedItem> 
    726 <NumberedItem> 
    727 <Text id="0386a">To change the text that is displayed for the index<MajorVersion number="2"> (<AutoText key="coredm::_Global:labelDescription_" 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. 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> 
     734<MajorVersion number="2"> 
     735<Text id="0386-1">Switch to the <AutoText key="glidict::GUI.Create"/> panel, <b>build</b> the collection, then <b>preview</b> it. There is now a <AutoText key="coredm::_Global:labelSearch_"/> button in the navigation bar. As an example, search for the term "bear" in the <AutoText key="coredm::_Global:labelDescription_" type="italics"/> index (which is the only index at this point).</Text> 
     736</MajorVersion> 
     737<MajorVersion number="3"> 
     738<Text id="0386-2">Switch to the <AutoText key="glidict::GUI.Create"/> panel, <b>build</b> the collection, then <b>preview</b> it. There is now a <AutoText text="Search"/> button in the navigation bar. As an example, search for the term "bear" in the <AutoText text="dc.Description" type="italics"/> index (which is the only index at this point).</Text> 
     739</MajorVersion> 
     740</NumberedItem> 
     741<NumberedItem> 
     742<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. 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> 
    728743<Comment> 
    729744<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>