Changeset 25792 for documentation

Show
Ignore:
Timestamp:
14.06.2012 18:03:23 (7 years ago)
Author:
ak19
Message:

Updating for GS3: the first half (upto point 3) of the tutorial Formatting the Word and PDF collection

Files:
1 modified

Legend:

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

    r25790 r25792  
    845845<Text id="fw-2a">Tidying up the default format statement</Text> 
    846846</Heading> 
     847<MajorVersion number="2"> 
    847848<NumberedItem> 
    848849<Text id="fw-3a">In this part of the exercise, we make the format statement simpler without changing the resulting display.</Text> 
     
    871872<Text id="fw-10">Preview the collection to make sure the display hasn't changed. You shouldn't notice any difference when looking at search results, classifiers etc. </Text> 
    872873</NumberedItem> 
     874</MajorVersion> 
     875<MajorVersion number="3"> 
     876<NumberedItem> 
     877<Text id="fw-3a-3">In this part of the exercise, we make the format statement simpler without changing the resulting display.</Text> 
     878<Text id="fw-3-3">Greenstone's default format statement is complex because it is designed to produce something reasonable under almost any conditions, and also because for practical reasons it needs to be backwards compatible with legacy collections. For this collection, we don't need all of the complexity.</Text> 
     879<Text id="fw-3a-1-3">Make sure that the <AutoText key="coredm::_Global:labelBrowse_"/> format statement is selected in the list of formats.</Text> 
     880<Text id="fw-4-3">An excerpt from the default <AutoText key="coredm::_Global:labelBrowse_"/> format statement for <b>documentNode</b> looks like the following:</Text> 
     881<Format> 
     882    &lt;td valign=&quot;top&quot;&gt;<br/> 
     883      <Tab n="1"/>&lt;gsf:link type=&quot;source&quot;&gt;<br/> 
     884        <Tab n="2"/><highlight>&lt;gsf:choose-metadata&gt;</highlight><br/> 
     885          <Tab n="3"/><highlight>&lt;gsf:metadata name=&quot;thumbicon&quot;/&gt;</highlight><br/> 
     886          <Tab n="3"/>&lt;gsf:metadata name=&quot;srcicon&quot;/&gt;<br/> 
     887        <Tab n="2"/><highlight>&lt;/gsf:choose-metadata&gt;</highlight><br/> 
     888      <Tab n="1"/>&lt;/gsf:link&gt;<br/> 
     889    &lt;/td&gt;<br/> 
     890</Format> 
     891<Text id="fw-5-3">This format statement is the default used for the <b>documentNode</b> vertical lists under classifiers.</Text> 
     892<Format>&lt;gsf:choose-metadata&gt;<br/> 
     893          <Tab n="1"/>&lt;gsf:metadata name=&quot;thumbicon&quot;/&gt;<br/> 
     894          <Tab n="1"/>&lt;gsf:metadata name=&quot;srcicon&quot;/&gt;<br/> 
     895        &lt;/gsf:choose-metadata&gt;<br/> 
     896</Format> 
     897<Text id="fw-6-3">chooses <i>ex.thumbicon</i> metadata if it's there, otherwise chooses <i>ex.srcicon</i> metadata. If neither are present, nothing is displayed. For this collection there is no <i>ex.thumbicon</i> metadata so the choice is not needed.</Text> 
     898<Text id="fw-7-3">Replace the above with</Text> 
     899<Format> 
     900    &lt;td valign=&quot;top&quot;&gt;<br/> 
     901      <Tab n="1"/>&lt;gsf:link type=&quot;source&quot;&gt;<br/> 
     902          <Tab n="2"/>&lt;gsf:metadata name=&quot;srcicon&quot;/&gt;<br/> 
     903      <Tab n="1"/>&lt;/gsf:link&gt;<br/> 
     904    &lt;/td&gt;<br/> 
     905</Format> 
     906<Text id="fw-8-3">There is no <i>exp.Title</i> metadata, so remove that element from the following</Text> 
     907<Format>&lt;gsf:choose-metadata&gt;<br/> 
     908          <Tab n="1"/>&lt;gsf:metadata name=&quot;dc.Title&quot;/&gt;<br/> 
     909          <Tab n="1"/><highlight>&lt;gsf:metadata name=&quot;exp.Title&quot;/&gt;</highlight><br/> 
     910          <Tab n="1"/>&lt;gsf:metadata name=&quot;ex.dc.Title&quot;/&gt;<br/> 
     911          <Tab n="1"/>&lt;gsf:metadata name=&quot;Title&quot;/&gt;<br/> 
     912          <Tab n="1"/>&lt;gsf:default&gt;Untitled&lt;/gsf:default&gt;<br/> 
     913        &lt;/gsf:choose-metadata&gt;<br/> 
     914</Format> 
     915<Text id="fw-10-3">Preview the collection to make sure the display hasn't changed. You shouldn't notice any difference when looking at search results, classifiers etc.</Text> 
     916</NumberedItem> 
     917</MajorVersion> 
    873918<Heading> 
    874919<Text id="fw-10a">Linking to Greenstone version or original version of documents</Text> 
    875920</Heading> 
     921<MajorVersion number="2"> 
    876922<NumberedItem> 
    877923<Text id="fw-11">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="VList"/> format statement links to both versions:</Text> 
     
    881927<Text id="fw-13b">Storing and displaying the original allows users to see the correct format, but requires the user to have the relevant program installed. It also increases the size of the collection. The Greenstone version can be viewed in a browser, but may not look as nice.</Text> 
    882928</NumberedItem> 
     929</MajorVersion> 
     930<MajorVersion number="3"> 
     931<NumberedItem> 
     932<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 key="coredm::_Global:labelBrowse_"/> format statement links to both versions, but the format statement for <AutoText key="coredm::_Global:labelSearch_"/> links only to the converted version of the original file:</Text> 
     933<Format>&lt;gsf:link type=&quot;document&quot;&gt;<br/> 
     934        <Tab n="1"/>&lt;gsf:icon type=&quot;document&quot;/&gt;<br/> 
     935      &lt;/gsf:link&gt;</Format> 
     936<Text id="fw-12-3">links to the Greenstone HTML version, while</Text> 
     937<Format>&lt;gsf:link type=&quot;source&quot;&gt;<br/>    
     938          <Tab n="1"/>&lt;gsf:metadata name=&quot;srcicon&quot;/&gt;<br/> 
     939      &lt;/gsf:link&gt;<br/> 
     940</Format> 
     941<Text id="fw-12a-3">links to the original.</Text>  
     942<Text id="fw-13-3">Choose <AutoText key="coredm::_Global:labelSearch_"/> in <AutoText key="glidict::CDM.GUI.Formats"/>. Experiment with removing either of the two links from the format statement.</Text> 
     943<Text id="fw-13a-3">To see the results of your changes, preview the collection and do a search. You are making changes to <b>documentNode</b>s under <AutoText text="Search"/>, which means the changes will only apply to search results.</Text> 
     944<Text id="fw-13b-3">Storing and displaying the original allows users to see the correct format, but requires the user to have the relevant program installed. It also increases the size of the collection. The Greenstone version can be viewed in a browser, but may not look as nice.</Text> 
     945</NumberedItem> 
     946</MajorVersion> 
    883947<Heading> 
    884948<Text id="fw-14a">Making bookshelves show how many items they contain</Text>