Changeset 26059 for documentation/trunk

Show
Ignore:
Timestamp:
01.08.2012 22:45:17 (7 years ago)
Author:
ak19
Message:

OAI collection tutorial (JCDLPICS) updated for GS3.

Files:
1 modified

Legend:

Unmodified
Added
Removed

  • documentation/trunk/tutorials/xml-source/tutorial_en.xml

    r26058 r26059  
    33523352</Comment> 
    33533353<NumberedItem> 
    3354 <Text id="oai-plugin-option">You will need to specify which document the OAI metadata values should be attached to. In the <AutoText key="glidict::GUI.Design"/> panel, select the <AutoText key="glidict::CDM.GUI.Plugins"/> section, then select the <AutoText text="OAIPlugin"/> and click <AutoText key="glidict::CDM.PlugInManager.Configure" type="button"/>. Locate the <AutoText text="document_field"/> option in the popup window and select <AutoText text="ex.dc.Identifier"/> from the drop-down list. Click <AutoText key="glidict::General.OK" type="button"/>. Finally, move the <AutoText text="OAIPlugin"/> above the <AutoText text="EmbeddedMetadataPlugin"/>.</Text> 
     3354<Text id="oai-plugin-option">You will need to specify which document the OAI metadata values should be attached to. In the <AutoText key="glidict::GUI.Design"/> panel, select the <AutoText key="glidict::CDM.GUI.Plugins"/> section, then select the <AutoText text="OAIPlugin"/> and click <AutoText key="glidict::CDM.PlugInManager.Configure" type="button"/>. Locate the <AutoText text="document_field"/> option in the popup window and type <AutoText text="ex.dc.Identifier"/> (it may not be available in the drop-down list until after building). Click <AutoText key="glidict::General.OK" type="button"/>. <MajorVersion number="2">Finally, you may want to remove the <AutoText text="EmbeddedMetadataPlugin"/> to speed up building (since it's not going to extract metadata relevant to this tutorial anyway).</MajorVersion></Text> 
    33553355</NumberedItem> 
    33563356<NumberedItem> 
    … …  
    33683368</NumberedItem> 
    33693369<NumberedItem> 
    3370 <Text id="0714">Add an <AutoText text="AZCompactList" /> classifier based on <AutoText key="metadata::ex.dc.Subject"/> metadata. Configure it with <AutoText text="subjects"/> as the <AutoText text="buttonname"/>.</Text> 
     3370<Text id="0714">Add an <AutoText text="AZCompactList" /> classifier based on <AutoText key="metadata::ex.dc.Subject"/> metadata. Configure it with <AutoText text="Subjects"/> as the <AutoText text="buttonname"/>.</Text> 
    33713371</NumberedItem> 
    33723372<NumberedItem> 
    … …  
    33753375</NumberedItem> 
    33763376<NumberedItem> 
    3377 <Text id="0716">In the <AutoText key="glidict::CDM.GUI.Indexes"/> section of the <AutoText key="glidict::GUI.Design"/> panel, delete all indexes and add a new one based on <AutoText key="metadata::ex.dc.Description"/> metadata. Set the <AutoText text="Display text"/> for the <AutoText key="metadata::ex.dc.Description"/> index by going to the <AutoText key="glidict::CDM.GUI.SearchMetadata"/> section in the <AutoText key="glidict::GUI.Format"/> panel and changing its label to "_labelDescription_". Using a macro for an index name means that it will display in the correct language (assuming that the macro has been translated). You can check <Path>Greenstone &rarr; macros &rarr; english.dm</Path> to see which macros are available.</Text>  
     3377<Text id="0716">In the <AutoText key="glidict::CDM.GUI.Indexes"/> section of the <AutoText key="glidict::GUI.Design"/> panel, delete all indexes and add a new one based on <AutoText key="metadata::ex.dc.Description"/> metadata. Set the <AutoText text="Display text"/> for the <AutoText key="metadata::ex.dc.Description"/> index by going to the <AutoText key="glidict::CDM.GUI.SearchMetadata"/> section in the <AutoText key="glidict::GUI.Format"/> panel and changing its label to <MajorVersion number="2">"_labelDescription_". Using a macro for an index name means that it will display in the correct language (assuming that the macro has been translated). You can check <Path>Greenstone &rarr; macros &rarr; english.dm</Path> to see which macros are available.</MajorVersion><MajorVersion number="3">"descriptions"</MajorVersion>.</Text>  
    33783378</NumberedItem> 
    33793379<NumberedItem> 
    … …  
    33843384</Heading> 
    33853385<NumberedItem> 
     3386<MajorVersion number="2"> 
    33863387<Text id="0719">In the <AutoText key="glidict::GUI.Format"/> panel, select <AutoText key="glidict::CDM.GUI.Formats"/>. First replace the <AutoText text="VList" /> format statement with the following (which can be copied from the file <Path>vlist_tweak.txt</Path> in the <Path>sample_files &rarr; oai &rarr;format_tweaks</Path> folder).</Text> 
    33873388<Format> 
    … …  
    33903391&lt;/td&gt;<br/>  
    33913392&lt;td valign=middle&gt;<br/>  
    3392 &nbsp;&nbsp;{If}{[numleafdocs],[Title],&lt;i&gt;[dc.Description]&lt;/i&gt;}<br/>  
     3393&nbsp;&nbsp;{If}{[numleafdocs],[Title],&lt;i&gt;[ex.dc.Description]&lt;/i&gt;}<br/>  
    33933394&lt;/td&gt; 
     3395</Format> 
     3396</MajorVersion> 
     3397<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> 
     3399<Format> 
     3400  &lt;gsf:template match=&quot;documentNode&quot;&gt;<br /> 
     3401    <Tab n="1"/>&lt;td valign=&quot;top&quot;&gt;<br /> 
     3402      <Tab n="2"/>&lt;gsf:link type=&quot;document&quot;&gt;<br /> 
     3403        <Tab n="3"/>&lt;gsf:metadata name=&quot;thumbicon&quot;/&gt;<br /> 
     3404      <Tab n="2"/>&lt;/gsf:link&gt;<br /> 
     3405    <Tab n="1"/>&lt;/td&gt;<br /> 
     3406    <Tab n="1"/>&lt;td valign=&quot;middle&quot;&gt;<br /> 
     3407      <Tab n="2"/>&lt;i&gt;<br /> 
     3408        <Tab n="3"/>&lt;gsf:metadata name=&quot;ex.dc.Description&quot;/&gt;<br /> 
     3409      <Tab n="2"/>&lt;/i&gt;<br /> 
     3410    <Tab n="1"/>&lt;/td&gt;<br /> 
     3411  &lt;/gsf:template&gt; 
     3412</Format> 
     3413<Format> 
     3414  &lt;gsf:template match=&quot;classifierNode[@classifierStyle = 'VList']&quot;&gt;<br /> 
     3415    <Tab n="1"/>&lt;td valign=&quot;top&quot;&gt;<br /> 
     3416      <Tab n="2"/>&lt;gsf:link type=&quot;classifier&quot;&gt;<br /> 
     3417        <Tab n="3"/>&lt;gsf:icon type=&quot;classifier&quot;/&gt;<br /> 
     3418      <Tab n="2"/>&lt;/gsf:link&gt;<br /> 
     3419    <Tab n="1"/>&lt;/td&gt;<br /> 
     3420    <Tab n="1"/>&lt;td valign=&quot;top&quot;&gt;<br /> 
     3421      <Tab n="2"/>&lt;xsl:call-template name=&quot;choose-title&quot;/&gt;<br /> 
     3422    <Tab n="1"/>&lt;/td&gt;<br /> 
     3423  &lt;/gsf:template&gt; 
     3424</Format> 
     3425</MajorVersion>  
     3426<Comment> 
     3427<Text id="0721">This format statement customizes the appearance of vertical lists such as the search results and captions lists to show a thumbnail icon followed by Description metadata.</Text> 
     3428</Comment> 
     3429</NumberedItem> 
     3430<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> 
     3432<MajorVersion number="2"> 
     3433<Format>&lt;h3&gt;[ex.dc.Subject]&lt;/h3&gt;</Format>  
     3434</MajorVersion> 
     3435<MajorVersion number="3"> 
     3436<Format> 
     3437  &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 /> 
     3441  &lt;/gsf:template&gt; 
    33943442</Format>  
    3395 <Comment> 
    3396 <Text id="0721">This format statement customizes the appearance of vertical lists such as the search results and captions lists to show a thumbnail icon followed by Description metadata.</Text> 
    3397 </Comment> 
    3398 </NumberedItem> 
    3399 <NumberedItem> 
    3400 <Text id="0722">Next, select <AutoText text="DocumentHeading"/> from the <AutoText key="glidict::CDM.FormatManager.Feature"/> pull-down list and change its format statement to: </Text> 
    3401 <Format>&lt;h3&gt;[ex.dc.Subject]&lt;/h3&gt;</Format>  
    3402 <Comment> 
    3403 <Text id="0723">The document heading appears above the <AutoText key="coredm::_document:textDETACH_" type="italics"/> and <AutoText key="coredm::_document:textNOHIGHLIGHT_" type="italics"/> buttons when you get to a document in the collection. By default <AutoText text="DocumentHeading"/> displays the document's <AutoText key="metadata::ex.Title"/> metadata. In this particular set of OAI exported records, titles are filenames of JPEG images, and the filenames are particularly uninformative (for example, 01dla14). You can see them in the <AutoText key="glidict::GUI.Enrich"/> panel if you select an image in <Path>oai &rarr; JCDLPICS &rarr; srcdocs</Path> and check its <AutoText key="metadata::ex.Source"/> and <AutoText key="metadata::ex.Title"/> metadata. The above format statement displays <AutoText key="metadata::ex.dc.Subject"/> metadata instead.</Text> 
    3404 </Comment> 
    3405 </NumberedItem> 
    3406 <NumberedItem> 
     3443</MajorVersion> 
     3444<Comment> 
     3445<Text id="0723"><MajorVersion number="2">The document heading appears above the <AutoText key="coredm::_document:textDETACH_" type="italics"/> and <AutoText key="coredm::_document:textNOHIGHLIGHT_" type="italics"/> buttons when you get to a document in the collection.</MajorVersion> By default <MajorVersion number="2"><AutoText text="DocumentHeading"/></MajorVersion><MajorVersion number="3"><AutoText text="documentHeading"/></MajorVersion> displays the document's <AutoText key="metadata::ex.Title"/> metadata. In this particular set of OAI exported records, titles are filenames of JPEG images, and the filenames are particularly uninformative (for example, 01dla14). You can see them in the <AutoText key="glidict::GUI.Enrich"/> panel if you select an image in <Path>oai &rarr; JCDLPICS &rarr; srcdocs</Path> and check its <AutoText key="metadata::ex.Source"/> and <AutoText key="metadata::ex.Title"/> metadata. The above format statement displays <AutoText key="metadata::ex.dc.Subject"/> metadata instead.</Text> 
     3446</Comment> 
     3447</NumberedItem> 
     3448<NumberedItem> 
     3449<MajorVersion number="2"> 
    34073450<Text id="0727">Finally, you will have noticed that where the document itself should appear, you see only <AutoText key="perlmodules::BasePlugin.dummy_text" type="quoted"/>. To rectify this, select <AutoText text="DocumentText"/> in the <AutoText key="glidict::CDM.FormatManager.Feature"/> pull-down list and use the following as its format statement (this text is in <Path>doctxt_tweak.txt</Path> in the <Path>format_tweaks</Path> folder mentioned earlier):</Text> 
    34083451<Format>&lt;center&gt;&lt;table width=_pagewidth_ border=1&gt;<br/>  
    … …  
    34143457&nbsp;&nbsp;&lt;tr&gt;&lt;td&gt;Subject:&lt;/td&gt;&lt;td&gt; [ex.dc.Subject]&lt;/td&gt;&lt;/tr&gt;<br/>  
    34153458&nbsp;&nbsp;&lt;tr&gt;&lt;td&gt;Publisher:&lt;/td&gt;&lt;td&gt; [ex.dc.Publisher]&lt;/td&gt;&lt;/tr&gt;<br/>  
    3416 &nbsp;&nbsp;&lt;tr&gt;&lt;td&gt;Rights:&lt;td&gt; [ex.dc.Rights]&lt;/td&gt;&lt;/tr&gt;<br/>  
    3417 &lt;/table&gt;&lt;/center&gt;</Format>  
    3418 <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. Factual information extracted from the image, such as width, height and type, is also displayed.</Text> 
     3459&nbsp;&nbsp;&lt;tr&gt;&lt;td&gt;Rights:&lt;/td&gt;&lt;td&gt; [ex.dc.Rights]&lt;/td&gt;&lt;/tr&gt;<br/>  
     3460&lt;/table&gt;&lt;/center&gt;</Format> 
     3461</MajorVersion> 
     3462<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> 
     3464<Format> 
     3465  &lt;gsf:template name=&quot;documentContent&quot;&gt;<br /> 
     3466    <Tab n="1"/>&lt;table&gt;<br /> 
     3467      <Tab n="2"/>&lt;tr&gt;<br /> 
     3468    <Tab n="3"/>&lt;td colspan=&quot;2&quot; align=&quot;center&quot;&gt;<br /> 
     3469        <Tab n="4"/>&lt;a&gt;&lt;xsl:attribute name=&quot;href&quot;&gt;<br /> 
     3470        <Tab n="5"/>&lt;gsf:metadata name=&quot;ex.dc.OrigURL&quot;/&gt;<br /> 
     3471        <Tab n="5"/>&lt;/xsl:attribute&gt;<br /> 
     3472        <Tab n="5"/>&lt;gsf:metadata name=&quot;screenicon&quot;/&gt;<br /> 
     3473        <Tab n="4"/>&lt;/a&gt;<br /> 
     3474    <Tab n="3"/>&lt;/td&gt;<br /> 
     3475      <Tab n="2"/>&lt;/tr&gt;<br /> 
     3476      <Tab n="2"/>&lt;tr&gt;<br /> 
     3477        <Tab n="3"/>&lt;td&gt;Caption:&lt;/td&gt;<br /> 
     3478        <Tab n="3"/>&lt;td&gt;&lt;i&gt;&lt;gsf:metadata name=&quot;ex.dc.Description&quot;/&gt;&lt;/i&gt;&lt;br/&gt;<br /> 
     3479        <Tab n="3"/>&lt;a&gt;&lt;xsl:attribute name=&quot;href&quot;&gt;&lt;gsf:metadata name=&quot;ex.dc.OrigURL&quot;/&gt;&lt;/xsl:attribute&gt;<br /> 
     3480      <Tab n="4"/>original &lt;gsf:metadata name=&quot;ImageWidth&quot;/&gt;x&lt;gsf:metadata name=&quot;ImageHeight&quot;/&gt; &lt;gsf:metadata name=&quot;ImageType&quot;/&gt; available<br /> 
     3481    <Tab n="3"/>&lt;/a&gt;<br /> 
     3482        <Tab n="3"/>&lt;/td&gt;<br /> 
     3483      <Tab n="2"/>&lt;/tr&gt;<br /> 
     3484      <Tab n="2"/>&lt;tr&gt;<br /> 
     3485        <Tab n="3"/>&lt;td&gt;Subject:&lt;/td&gt;<br /> 
     3486        <Tab n="3"/>&lt;td&gt;&lt;gsf:metadata name=&quot;ex.dc.Subject&quot;/&gt;&lt;/td&gt;<br /> 
     3487      <Tab n="2"/>&lt;/tr&gt;<br /> 
     3488      <Tab n="2"/>&lt;tr&gt;<br /> 
     3489        <Tab n="3"/>&lt;td&gt;Publisher:&lt;/td&gt;<br /> 
     3490        <Tab n="3"/>&lt;td&gt;&lt;gsf:metadata name=&quot;ex.dc.Publisher&quot;/&gt;&lt;/td&gt;<br /> 
     3491      <Tab n="2"/>&lt;/tr&gt;<br /> 
     3492      <Tab n="2"/>&lt;tr&gt;<br /> 
     3493        <Tab n="3"/>&lt;td&gt;Rights:&lt;/td&gt;<br /> 
     3494        <Tab n="3"/>&lt;td&gt;&lt;gsf:metadata name=&quot;ex.dc.Rights&quot;/&gt;&lt;/td&gt;<br /> 
     3495      <Tab n="2"/>&lt;/tr&gt;<br /> 
     3496    <Tab n="1"/>&lt;/table&gt;<br /> 
     3497  &lt;/gsf:template&gt; 
     3498</Format> 
     3499</MajorVersion> 
     3500<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. 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> 
    34193501</NumberedItem> 
    34203502<NumberedItem>