Changeset 26073 for documentation

Show
Ignore:
Timestamp:
06.08.2012 17:42:50 (7 years ago)
Author:
ak19
Message:

Further updates were necessary to the last 3 tutorials committed after retesting. And added in references to format statements prepared beforehand for GS3 (and which will be committed to the tutorial sample files hereafter).

Files:
1 modified

Legend:

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

    r26059 r26073  
    20782078</NumberedItem> 
    20792079<NumberedItem> 
    2080 <Text id="0533d"><b>Rebuild</b> the collection and <b>preview</b> the results. Notice the extra field in the <AutoText key="coredm::_query:textinfield_"/> drop-down menus in the search form. You can do quite complicated queries by searching for words in different fields at the same time.</Text> 
     2080<Text id="0533d"><b>Rebuild</b> the collection and <b>preview</b> the results. Notice the extra field in the <MajorVersion number="2"><AutoText key="coredm::_query:textinfield_"/></MajorVersion><MajorVersion number="3"><AutoText text="in field"/></MajorVersion> drop-down menus in the search form. You can do quite complicated queries by searching for words in different fields at the same time.</Text> 
    20812081</NumberedItem> 
    20822082<NumberedItem> 
     
    21182118<MajorVersion number="3"> 
    21192119<Format> 
    2120   &lt;gsf:choose-metadata&gt;<br/> 
    2121     <Tab n="1"/>&lt;gsf:metadata name=&quot;dc.Title&quot;/&gt;<br/> 
    2122     <Tab n="1"/>&lt;gsf:metadata name=&quot;exp.Title&quot;/&gt;<br/> 
    2123     <Tab n="1"/>&lt;gsf:metadata name=&quot;ex.dc.Title&quot;/&gt;<br/> 
    2124     <Tab n="1"/>&lt;gsf:metadata name=&quot;Title&quot;/&gt;<br/> 
    2125     <Tab n="1"/>&lt;gsf:default&gt;Untitled&lt;/gsf:default&gt;<br/> 
    2126   &lt;/gsf:choose-metadata&gt; 
    2127 </Format> 
    2128 The above format statement is found in the <AutoText text="choose-title"/> template defined in the <AutoText text="global"/> format feature, which is included by the <AutoText text="browse"/> format statements. 
     2120&lt;gsf:template name=&quot;choose-title&quot;&gt;<br/> 
     2121  <Tab n="1"/>&lt;gsf:choose-metadata&gt;<br/> 
     2122    <Tab n="2"/>&lt;gsf:metadata name=&quot;dc.Title&quot;/&gt;<br/> 
     2123    <Tab n="2"/>&lt;gsf:metadata name=&quot;exp.Title&quot;/&gt;<br/> 
     2124    <Tab n="2"/>&lt;gsf:metadata name=&quot;ex.dc.Title&quot;/&gt;<br/> 
     2125    <Tab n="2"/>&lt;gsf:metadata name=&quot;Title&quot;/&gt;<br/> 
     2126    <Tab n="2"/>&lt;gsf:default&gt;Untitled&lt;/gsf:default&gt;<br/> 
     2127  <Tab n="1"/>&lt;/gsf:choose-metadata&gt;<br /> 
     2128&lt;/gsf:template&gt; 
     2129</Format> 
     2130The above <AutoText text="choose-title"/> template, defined in the <AutoText text="global"/> format features, is included by the <AutoText text="browse"/> format statements. 
    21292131</MajorVersion> 
    21302132<Text id="0533-11c">Since there is no <AutoText key="metadata::dc.Title"/> metadata and because <AutoText key="metadata::exp.Title"/> comes before <AutoText key="metadata::ex.Title"/>, the exploded titles will be displayed.</Text> 
     
    21372139<Text id="0533-12b">We need to modify the collection design to take note of these changes.</Text> 
    21382140<NumberedItem> 
    2139 <Text id="0533-13">In the <AutoText key="glidict::CDM.GUI.Indexes"/> section, change the Title index to use <AutoText key="metadata::exp.Title"/>: select the Title index in the <AutoText key="glidict::CDM.IndexManager.Indexes"/> list and click <AutoText key="glidict::CDM.IndexManager.Edit_Index" type="button"/>. Deselect <AutoText key="metadata::dc.Title"/>, <AutoText key="metadata::ex.dc.Title"/> and <AutoText key="metadata::ex.Title"/> in the list of metadata, and select <AutoText key="metadata::exp.Title"/>. Click <AutoText key="glidict::CDM.IndexManager.Replace_Index" type="button"/>.</Text> 
     2141<Text id="0533-13">In the <AutoText key="glidict::CDM.GUI.Indexes"/> section, change the Title index to use <AutoText key="metadata::exp.Title"/>: select the Title index in the <AutoText key="glidict::CDM.IndexManager.Indexes"/> list and click <AutoText key="glidict::CDM.IndexManager.Edit_Index" type="button"/>. Deselect <AutoText key="metadata::dc.Title"/> and <AutoText key="metadata::ex.Title"/> in the list of metadata, and select <AutoText key="metadata::exp.Title"/>. Click <AutoText key="glidict::CDM.IndexManager.Replace_Index" type="button"/>.</Text> 
    21402142</NumberedItem> 
    21412143<NumberedItem> 
     
    21492151</NumberedItem> 
    21502152<NumberedItem> 
    2151 <Text id="0533-15">To explicitly use the <AutoText key="metadata::exp.Title"/> metadata, in the <AutoText key="glidict::CDM.GUI.Classifiers"/> section, change the <AutoText text="dc.Title;ex.Title"/> <AutoText text="List"/> to use <AutoText key="metadata::exp.Title"/> metadata. Double click the <AutoText text="dc.Title;ex.Title"/> <AutoText text="List"/> in the <AutoText key="glidict::CDM.ClassifierManager.Assigned"/> list, and change the <AutoText text="metadata"/> option to use <AutoText key="metadata::exp.Title"/>. Click <AutoText key="glidict::General.OK" type="button"/>. Do the same thing for the Subject <AutoText text="AZCompactList"/>, changing <AutoText key="metadata::dc.Subject"/> to <AutoText key="metadata::exp.Subject"/>.</Text> 
     2153<Text id="0533-15">To explicitly use the <AutoText key="metadata::exp.Title"/> metadata, in the <AutoText key="glidict::CDM.GUI.Classifiers"/> section, change the <MajorVersion number="2"><AutoText text="dc.Title;ex.Title"/></MajorVersion><MajorVersion number="3"><AutoText text="dc.Title;Title"/></MajorVersion>&nbsp;<AutoText text="List"/> to use <AutoText key="metadata::exp.Title"/> metadata. Double click the <MajorVersion number="2"><AutoText text="dc.Title;ex.Title"/></MajorVersion><MajorVersion number="3"><AutoText text="dc.Title;Title"/></MajorVersion>&nbsp;<AutoText text="List"/> in the <AutoText key="glidict::CDM.ClassifierManager.Assigned"/> list, and change the <AutoText text="metadata"/> option to use <AutoText key="metadata::exp.Title"/>. Click <AutoText key="glidict::General.OK" type="button"/>. Do the same thing for the Subject <AutoText text="AZCompactList"/>, changing <AutoText key="metadata::dc.Subject"/> to <AutoText key="metadata::exp.Subject"/>.</Text> 
    21522154</NumberedItem> 
    21532155<NumberedItem> 
     
    21552157</NumberedItem> 
    21562158<NumberedItem> 
    2157 <Text id="0533-16">In the <AutoText key="glidict::CDM.GUI.Formats"/> section of the <AutoText key="glidict::GUI.Format"/> panel, select <AutoText text="VList"/> in the list of assigned format statements.</Text> 
     2159<Text id="0533-16"> 
     2160<MajorVersion number="2">In the <AutoText key="glidict::CDM.GUI.Formats"/> section of the <AutoText key="glidict::GUI.Format"/> panel, select <AutoText text="VList"/> in the list of assigned format statements.</MajorVersion> 
     2161<MajorVersion number="3">Switch to the <AutoText key="glidict::CDM.GUI.Formats"/> section of the <AutoText key="glidict::GUI.Format"/> panel to make the following adjustments.</MajorVersion> 
     2162</Text> 
    21582163<BulletList> 
    21592164<Bullet> 
     
    21652170<Format> 
    21662171  &lt;gsf:choose-metadata&gt;<br/> 
    2167     <Tab n="1"/>&lt;gsf:metadata name=&quot;dc.Title&quot;/&gt;<br/> 
     2172    <Tab n="1"/><highlight>&lt;gsf:metadata name=&quot;dc.Title&quot;/&gt;</highlight><br/> 
    21682173    <Tab n="1"/>&lt;gsf:metadata name=&quot;exp.Title&quot;/&gt;<br/> 
    2169     <Tab n="1"/>&lt;gsf:metadata name=&quot;ex.dc.Title&quot;/&gt;<br/> 
     2174    <Tab n="1"/><highlight>&lt;gsf:metadata name=&quot;ex.dc.Title&quot;/&gt;</highlight><br/> 
    21702175    <Tab n="1"/>&lt;gsf:metadata name=&quot;Title&quot;/&gt;<br/> 
    21712176    <Tab n="1"/>&lt;gsf:default&gt;Untitled&lt;/gsf:default&gt;<br/> 
     
    21902195<Text id="0533-16b-3">There are no source or thumb icons, so in the <AutoText text="documentNode"/> and <AutoText text="classifierNode"/> templates of the <AutoText text="browse"/> format feature, remove the occurrences of the following section:</Text> 
    21912196<Format> 
    2192   &lt;gsf:link type=&quot;source&quot;&gt;<br /> 
    2193     <Tab n="1"/>&lt;gsf:choose-metadata&gt;<br /> 
    2194       <Tab n="2"/>&lt;gsf:metadata name=&quot;thumbicon&quot;/&gt;<br /> 
    2195       <Tab n="2"/>&lt;gsf:metadata name=&quot;srcicon&quot;/&gt;<br /> 
    2196     <Tab n="1"/>&lt;/gsf:choose-metadata&gt;<br /> 
    2197   &lt;/gsf:link&gt;<br /> 
     2197&lt;td valign="top"&gt;<br /> 
     2198  <Tab n="1"/>&lt;gsf:link type=&quot;source&quot;&gt;<br /> 
     2199    <Tab n="2"/>&lt;gsf:choose-metadata&gt;<br /> 
     2200      <Tab n="3"/>&lt;gsf:metadata name=&quot;thumbicon&quot;/&gt;<br /> 
     2201      <Tab n="3"/>&lt;gsf:metadata name=&quot;srcicon&quot;/&gt;<br /> 
     2202    <Tab n="2"/>&lt;/gsf:choose-metadata&gt;<br /> 
     2203  <Tab n="1"/>&lt;/gsf:link&gt;<br /> 
     2204&lt;/td&gt; 
    21982205</Format> 
    21992206</MajorVersion> 
     
    22322239</MajorVersion> 
    22332240<MajorVersion number="3"> 
    2234 <Text id="0533-19-3">The record Title will be displayed as part of the default <AutoText text="documentContent"/> format, so we override the <AutoText text="documentHeading"/> format statement (which displays the Title) with one that does not do anything. Go to the <AutoText text="display"/> format feature in the <AutoText key="glidict::CDM.FormatManager.Editor"/> and add the following:</Text> 
     2241<Text id="0533-19-3">The record Title will be displayed as part of the default <AutoText text="documentContent"/> format, so we override the <AutoText text="documentHeading"/> format statement (which displays the Title) with one that does not do anything. Go to the <AutoText text="display"/> format feature in the <AutoText key="glidict::CDM.FormatManager.Editor"/> and add the following just after the <Format>&lt;gsf:option name=&quot;TOC&quot; value=&quot;true&quot;/&gt;</Format>:</Text> 
    22352242<Format>&lt;gsf:template name=&quot;documentHeading&quot;/&gt;</Format> 
    22362243</MajorVersion> 
     
    22382245<NumberedItem> 
    22392246<MajorVersion number="2"> 
    2240 <Text id="0533-20">Next, edit the <AutoText text="DocumentText"/> format statement. Delete the contents and replace it with</Text> 
     2247<Text id="0533-20">Next, edit the <AutoText text="DocumentText"/> format statement. Delete the contents and replace it with the following (which can be copied from <Path>sample_files &rarr; marc &rarr; format_tweaks &rarr; document_text.txt</Path>).</Text> 
    22412248<Format> 
    22422249&lt;table&gt;<br/> 
     
    22482255</MajorVersion> 
    22492256<MajorVersion number="3"> 
    2250 <Text id="0533-20-3">Next, override the default <AutoText text="documentContent"/> behaviour by creating a format statement for this. Still in the <AutoText text="display"/> format features, add:</Text> 
     2257<Text id="0533-20-3">Next, override the default <AutoText text="documentContent"/> behaviour by creating a format statement for this. Still in the <AutoText text="display"/> format features, after the <AutoText text="documentHeading"/>, add the following format statement (which can be copied from <Path>sample_files &rarr; marc &rarr; format_tweaks &rarr; document_content.txt</Path>):</Text> 
    22512258<Format> 
    22522259  &lt;gsf:template name=&quot;documentContent&quot;&gt;<br /> 
     
    23022309</NumberedItem> 
    23032310<NumberedItem> 
    2304 <Text id="is-12"><b>Rebuild</b> and <b>preview</b> the collection. </Text> 
     2311<Text id="is-11"><b>Rebuild</b> and <b>preview</b> the collection. </Text> 
    23052312</NumberedItem> 
    23062313<NumberedItem> 
    23072314<MajorVersion number="2"> 
    2308 <Text id="is-11">In the <AutoText key="glidict::CDM.GUI.Formats"/> section of the <AutoText key="glidict::GUI.Format"/> panel, change the <AutoText text="VList"/> format statement to display <AutoText text="Photographer"/> and <AutoText text="Notes"/> metadata. Change it to look like:</Text> 
     2315<Text id="is-12">In the <AutoText key="glidict::CDM.GUI.Formats"/> section of the <AutoText key="glidict::GUI.Format"/> panel, change the <AutoText text="VList"/> format statement to display <AutoText text="Photographer"/> and <AutoText text="Notes"/> metadata. Change it to look like:</Text> 
    23092316<Format> 
    23102317&lt;td valign=top&gt;[link][icon][/link]&lt;/td&gt;<br/> 
     
    23132320</MajorVersion> 
    23142321<MajorVersion number="3"> 
    2315 <Text id="is-11">In the <AutoText key="glidict::CDM.GUI.Formats"/> section of the <AutoText key="glidict::GUI.Format"/> panel, change the <AutoText text="browse"/> format statement to display <AutoText text="Photographer"/> and <AutoText text="Notes"/> metadata. Change its <AutoText text="documentNode"/> template to look like:</Text> 
     2322<Text id="is-12-3">In the <AutoText key="glidict::CDM.GUI.Formats"/> section of the <AutoText key="glidict::GUI.Format"/> panel, change the <AutoText text="browse"/> format statement to display <AutoText text="Photographer"/> and <AutoText text="Notes"/> metadata. Change its <AutoText text="documentNode"/> template to look like:</Text> 
    23162323<Format> 
    23172324  &lt;gsf:template match=&quot;documentNode&quot;&gt;<br /> 
     
    23292336  &lt;/gsf:template&gt; 
    23302337</Format> 
     2338<Text id="is-12a-3">The above format can be copied from <Path>sample_files &rarr; isis &rarr; format_tweaks &rarr; browse_tweak.txt</Path>. If you want search results to be displayed in a similar manner, make the same changes to the <AutoText text="documentNode"/> template of the <AutoText text="search"/> format features too.</Text> 
    23312339</MajorVersion> 
    23322340</NumberedItem> 
    23332341<MajorVersion number="2"> 
    23342342<NumberedItem> 
    2335 <Text id="is-11a">Make fielded searching the default by changing the <AutoText text="SearchTypes"/> format statement to <AutoText text="form,plain"/> (instead of <AutoText text="plain,form"/>).</Text> 
     2343<Text id="is-12b">Make fielded searching the default by changing the <AutoText text="SearchTypes"/> format statement to <AutoText text="form,plain"/> (instead of <AutoText text="plain,form"/>).</Text> 
    23362344</NumberedItem> 
    23372345</MajorVersion> 
     
    23482356<Text id="is-16">Finally, lets link to the raw record, which is stored as <AutoText text="ISISRawRecord"/> metadata.  
    23492357<MajorVersion number="2">Edit the <AutoText text="DocumentText"/> format statement to look like the following. (This format can be copied from <Path>sample_files &rarr; isis &rarr; format_tweaks &rarr; document_text.txt</Path>.)</MajorVersion> 
    2350 <MajorVersion number="3">Add the following to the <AutoText text="display"/> format statement, to adjust the <AutoText text="documentContent"/>. This now makes use of a predefined Greenstone javascript function to toggle between displaying and hiding the raw record.</MajorVersion></Text> 
     2358<MajorVersion number="3">Add the following to the <AutoText text="display"/> format statement (which can be copied from <Path>sample_files &rarr; isis &rarr; format_tweaks &rarr; document_content.txt</Path>), to adjust the <AutoText text="documentContent"/>. This now makes use of a predefined Greenstone javascript function to toggle between displaying and hiding the raw record.</MajorVersion> 
     2359</Text> 
    23512360<MajorVersion number="2"> 
    23522361<Format> 
     
    33423351</NumberedItem> 
    33433352<NumberedItem> 
    3344 <Text id="0707">During the copy operation, a popup window appears asking whether to add <AutoText text="OAIPlugin" /> to the list of plug-ins used in the collection, because the Librarian Interface has not found an existing plug-in that can handle this file type. Press the <AutoText key="glidict::CDM.PlugInManager.QuickAdd" type="button"/> button to include it.</Text> 
     3353<Text id="0707">During the copy operation, a popup window may appear asking whether to add <AutoText text="OAIPlugin" /> to the list of plug-ins used in the collection, because the Librarian Interface has not found an existing plug-in that can handle this file type. Press the <AutoText key="glidict::CDM.PlugInManager.QuickAdd" type="button"/> button to include it.</Text> 
    33453354<Text id="0707a">The files for this collection consist of a set of images (in <Path>JCDLPICS &rarr; srcdocs</Path>) and a set of OAI records (in <Path>JCDLPICS</Path>) which contain metadata for the images.</Text> 
    33463355</NumberedItem> 
     
    33963405</MajorVersion> 
    33973406<MajorVersion number="3"> 
    3398 <Text id="0719">In the <AutoText key="glidict::GUI.Format"/> panel, select <AutoText key="glidict::CDM.GUI.Formats"/>. First, in the <AutoText text="browse" /> format statement, replace the templates for <AutoText text="documentNode"/> and <AutoText text="classifierNode"/> for <AutoText text="VList"/>s with the following.</Text> 
     3407<Text id="0719">In the <AutoText key="glidict::GUI.Format"/> panel, select <AutoText key="glidict::CDM.GUI.Formats"/>. First, in the <AutoText text="browse" /> format statement, replace the templates for <AutoText text="documentNode"/> and <AutoText text="classifierNode"/> for <AutoText text="VList"/>s with the following (which can be copied from <Path>sample_files &rarr; oai &rarr; format_tweaks &rarr; browse_tweak.txt</Path>).</Text> 
    33993408<Format> 
    34003409  &lt;gsf:template match=&quot;documentNode&quot;&gt;<br /> 
     
    34293438</NumberedItem> 
    34303439<NumberedItem> 
    3431 <Text id="0722">Next, select <MajorVersion number="2"><AutoText text="DocumentHeading"/></MajorVersion><MajorVersion number="3">the <AutoText text="documentHeading"/> in the <AutoText text="display"/> format statement </MajorVersion> from the <AutoText key="glidict::CDM.GUI.Formats"/> list and change its format statement to:</Text> 
     3440<Text id="0722"> 
     3441<MajorVersion number="2">Next, select <AutoText text="DocumentHeading"/> from the <AutoText key="glidict::CDM.GUI.Formats"/> list and change its format statement to:</MajorVersion> 
     3442<MajorVersion number="3">Next, select the <AutoText text="display"/> format statement from the <AutoText key="glidict::CDM.GUI.Formats"/> list and add the following to create a custom <AutoText text="documentHeading"/> format statement:</MajorVersion> 
     3443</Text> 
    34323444<MajorVersion number="2"> 
    34333445<Format>&lt;h3&gt;[ex.dc.Subject]&lt;/h3&gt;</Format>  
     
    34363448<Format> 
    34373449  &lt;gsf:template name=&quot;documentHeading&quot;&gt;<br /> 
    3438     &lt;h3&gt;<br /> 
    3439       &lt;gsf:metadata name=&quot;ex.dc.Subject&quot;/&gt;<br /> 
    3440     &lt;/h3&gt;<br /> 
     3450    <Tab n="1"/>&lt;h3&gt;<br /> 
     3451    <Tab n="2"/>&lt;gsf:metadata name=&quot;ex.dc.Subject&quot;/&gt;<br /> 
     3452    <Tab n="1"/>&lt;/h3&gt;<br /> 
    34413453  &lt;/gsf:template&gt; 
    34423454</Format>  
     
    34613473</MajorVersion> 
    34623474<MajorVersion number="3"> 
    3463 <Text id="0727">Finally, select <AutoText text="display"/> in the <AutoText key="glidict::CDM.GUI.Formats"/> list and use the following as its format statement:</Text> 
     3475<Text id="0727">Still in the <AutoText text="display"/> format in the <AutoText key="glidict::CDM.GUI.Formats"/> list, add the following (which can be copied from <Path>sample_files &rarr; oai &rarr; format_tweaks &rarr; document_content.txt</Path>) to create a custom <AutoText text="documentContent"/> format statement:</Text> 
    34643476<Format> 
    34653477  &lt;gsf:template name=&quot;documentContent&quot;&gt;<br />