Changeset 32896 for documentation/trunk


Ignore:
Timestamp:
2019-03-13T20:13:52+13:00 (5 years ago)
Author:
ak19
Message:

Committing the changes for 5 tutorials at a time.

File:
1 edited

Legend:

Unmodified
Added
Removed

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

    r32895 r32896  
    528528  </MajorVersion>
    529529<Comment>
    530 <Text id="0255b">If you are using Windows Vista or Windows 7 and have installed Greenstone into  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>
     530  <Text id="0255b">If you are using Windows Vista or Windows 7 and have installed Greenstone into  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>
     531</Comment>
     532<Comment>
     533  <Text id="0255c"> On Windows 8 and onwards you may see a Windows Firewall message about Java. If you have admin permissions, choose the option "Domain networks, such as a workplace network" then press Allow Access to allow Java to comminicate on the selected networks.</Text>
     534</Comment>
     535<Comment>
    531536<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>
    532537</Comment>
    … …  
    630635</NumberedItem>
    631636<NumberedItem>
    632 <Text id="0341">Copy the images (avoid the README.TXT file) provided in <Path>sample_files &rarr; images</Path> into your newly-formed collection.</Text>
     637<Text id="0341">Copy the images provided in <Path>sample_files &rarr; images</Path> (avoiding the README.TXT file and any folders) into your newly-formed collection.</Text>
    633638</NumberedItem>
    634639<NumberedItem>
    … …  
    734739</NumberedItem>
    735740<NumberedItem>
    736 <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>
     741<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="Description" type="italics"/></MajorVersion> link that appears in the navigation bar.</Text>
    737742</NumberedItem>
    738743<Comment>
    … …  
    754759</NumberedItem>
    755760<NumberedItem>
    756 <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. <MajorVersion number="2">Change</MajorVersion><MajorVersion number="3">Set</MajorVersion> the <AutoText key="glidict::CDM.SearchMetadataManager.Component_Name"/> for the "dc.Description" index to "image descriptions" (or other suitable text). Press the <AutoText key="glidict::CreatePane.Preview_Collection" type="button"/> button. In the browser, visit the collection's search page again. Your new text will appear in the search form. </Text>
     761<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. <MajorVersion number="2">Change</MajorVersion><MajorVersion number="3">Set</MajorVersion> the <AutoText key="glidict::CDM.SearchMetadataManager.Component_Name"/> for the "dc.Description" index to "image descriptions" (or other suitable text). Press the <AutoText key="glidict::CreatePane.Preview_Collection" type="button"/> button. In the browser, you should now see your new text appear for the displayed index name in the search form. </Text>
    757762<MajorVersion number="2"><Text id="0386a">To change the text that is displayed for the index (<AutoText key="coredm::_Global:labelDescription_" type="italics"/>), 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></MajorVersion>
    758763<Comment>
    … …  
    784789</NumberedItem>
    785790<NumberedItem> 
    786   <Text id="images-gps-2">Now select each of the remaining folders of images in turn, and assign the appropriate values for their <b>dc.Title</b>: <i>Musée d'Orsay</i>, <i>Parc de Luxembourg</i> and <i>Panthéon district</i>, respectively.</Text>
    787 </NumberedItem>
    788 <NumberedItem>
    789 <Text id="images-gps-3">Go to the <AutoText key="glidict::GUI.Design"/> panel. In the <b>Browsing Classifiers</b> section, choose <b>AZCompactList</b> from the <AutoText key="glidict::CDM.ClassifierManager.Classifier"/> dropdown box and press <AutoText key="glidict::CDM.ClassifierManager.Add" type="button"/>. In the configuration dialog that appears, set the metadata field to <b>dc.Title</b> and tick the buttonname option and set its value to <Format>locations</Format>. This will create a classifier labelled <Format>locations</Format> that groups all images under Eiffel Tower into one bookshelf and similarly creates bookshelves for the other 3 categories.</Text>
     791  <Text id="images-gps-2">Now select each of the remaining folders of images in turn, and assign the appropriate values for their <b>dc.Title</b>: <i>Musée d'Orsay</i>, <i>Parc de Luxembourg</i> and <i>Panthéon district</i>.</Text>
     792</NumberedItem>
     793<NumberedItem>
     794<Text id="images-gps-3">Go to the <AutoText key="glidict::GUI.Design"/> panel. In the <b>Browsing Classifiers</b> section, choose <b>AZCompactList</b> from the <AutoText key="glidict::CDM.ClassifierManager.Classifier"/> dropdown box and press <AutoText key="glidict::CDM.ClassifierManager.Add" type="button"/>. In the configuration dialog that appears, set the metadata field to <b>dc.Title</b> and tick the buttonname option and set its value to <Format>locations</Format>. This will create a classifier labelled <Format>locations</Format> that groups all images under Eiffel Tower into one bookshelf and similarly creates bookshelves for the other 3 categories. Click <AutoText key="glidict::General.OK" type="button"/> to close the plugin configuration dialog.</Text>
    790795</NumberedItem>
    791796<NumberedItem>
    … …  
    826831</NumberedItem>
    827832<NumberedItem>
    828 <Text id="images-gps-14">To enable the map, go to the <AutoText key="glidict::CDM.FormatManager.Feature"/> section of the <AutoText key="glidict::GUI.Format"/> panel, and select the <b>browse</b> format feature. In the editor below, enter the following format statement <i>above</i> the documentNode template:</Text>
     833<Text id="images-gps-14">To enable the map, go to the <AutoText key="glidict::CDM.GUI.Formats"/> section of the <AutoText key="glidict::GUI.Format"/> panel. Select the <AutoText text="browse" /> format feature in the drop down for <AutoText key="glidict::CDM.FormatManager.Feature"/>. In the editor below it, enter the following format statement <i>above</i> the documentNode template:</Text>
    829834<Format>&lt;gsf:option name="mapEnabled" value="true" /&gt;</Format>
    830835</NumberedItem>
    831836<NumberedItem>
    832 <Text>Also in the <AutoText key="glidict::CDM.FormatManager.Feature"/> section, select the <b>searchType</b> feature. Add <AutoText text="raw"/> to the list of search types.</Text>
    833 </NumberedItem>
    834 <NumberedItem>
    835 <Text id="images-gps-15">In the <AutoText key="glidict::GUI.Format"/> panel press <AutoText key="glidict::CreatePane.Preview_Collection" type="button"/>, and click on the new browsing classifier (<Format>locations</Format>) and then click on a bookshelf icon. The page that opens up shows a Google map, with the locations of the images in the collection pinpointed on it. The map view can also scroll through all the images, locating each place and associated image in turn.</Text>
     837<Text>Also in the <AutoText key="glidict::CDM.FormatManager.Feature"/> section, select the <b>searchType</b> feature. Add <AutoText text="raw"/> to the comma-separated <AutoText text="searchType"/> list.</Text>
     838</NumberedItem>
     839<NumberedItem>
     840<Text id="images-gps-15">In the <AutoText key="glidict::GUI.Format"/> panel press <AutoText key="glidict::CreatePane.Preview_Collection" type="button"/>, and click on the new browsing classifier (<Format>locations</Format>) and then click on a bookshelf icon (not the plus next to each bookshelf icon). The page that opens up shows a Google map, with the locations of the images in the collection pinpointed on it. The map view can also scroll through all the images, locating each place and associated image in turn.</Text>
    836841</NumberedItem>
    837842<Text id="images-gps-16">
    … …  
    848853  <NumberedItem>
    849854    <Text id="images-gps-17">
    850       To activate a map view when viewing the document, go to the <AutoText key="glidict::CDM.FormatManager.Feature"/> section of the <AutoText key="glidict::GUI.Format"/> panel, and select the <b>display</b> format feature. In the editor below, enter the following format statement <i>after</i> the line <Format>&lt;gsf:option name="TOC" value="true" /&gt;</Format>:
     855      To activate a map view when viewing the document, go to the <AutoText key="glidict::CDM.GUI.Formats"/> section of the <AutoText key="glidict::GUI.Format"/> panel, and select the <AutoText text="display"/> format feature in the <AutoText key="glidict::CDM.FormatManager.Feature"/> dropdown. In the editor below, enter the following format statement <i>after</i> the line <Format>&lt;gsf:option name="TOC" value="true" /&gt;</Format>:
    851856    </Text>
    852857    <Format>&lt;gsf:option name="mapEnabled" value="true" /&gt;</Format>
    … …  
    939944</Heading>
    940945<NumberedItem>
    941 <Text id="0315a">The <AutoText key="glidict::CDM.GUI.Classifiers"/> section adds "classifiers," which provide the collection with browsing functions. Go to this section and observe that Greenstone has provided two <i>List</i> classifiers, based on <AutoText text="dc.Title;ex.Title"/> and <AutoText key="metadata::ex.Source"/> metadata. <MajorVersion number="2">These correspond to the <AutoText key="coredm::_Global:labelTitle_" type="italics"/> and <AutoText key="coredm::_Global:labelSource_" type="italics"/> buttons on the collection's access bar.</MajorVersion><MajorVersion number="3">These correspond to the <AutoText key="gs3::metadata_names::Title.buttonname" /> and <AutoText key="gs3::metadata_names::Source.buttonname" /> buttons on the collection's access bar.</MajorVersion> </Text>
     946<Text id="0315a">The <AutoText key="glidict::CDM.GUI.Classifiers"/> section adds "classifiers," which provide the collection with browsing functions. Go to this section and observe that Greenstone has provided two <i>List</i> classifiers, based on <AutoText text="dc.Title;Title"/> and <AutoText key="metadata::ex.Source"/> metadata. <MajorVersion number="2">These correspond to the <AutoText key="coredm::_Global:labelTitle_" type="italics"/> and <AutoText key="coredm::_Global:labelSource_" type="italics"/> buttons on the collection's access bar.</MajorVersion><MajorVersion number="3">These correspond to the <AutoText key="gs3::metadata_names::Title.buttonname" /> and <AutoText key="gs3::metadata_names::Source.buttonname" /> buttons on the collection's access bar.</MajorVersion> </Text>
    942947<Text id="0315a-1">Remove the <AutoText key="metadata::ex.Source"/> classifier by selecting it and clicking <AutoText key="glidict::CDM.ClassifierManager.Remove" type="button"/>.</Text>
    943948</NumberedItem>
    … …  
    946951</NumberedItem>
    947952<NumberedItem>
    948 <Text id="0320">Switch to the <AutoText key="glidict::GUI.Create"/> panel, and <b>build</b> and <b>preview</b> the collection.</Text>
    949 </NumberedItem>
    950 <MajorVersion number="3"><NumberedItem>
    951 Next, go to the <AutoText key="glidict::GUI.Format"/> panel, and select the <AutoText key="glidict::CDM.GUI.SearchMetadata"/> section to the left. On the right, set the display text value for <b>Index: dc.Creator</b> to <Format>creators</Format>
     953<Text id="0320">Switch to the <AutoText key="glidict::GUI.Create"/> panel, and <b>build</b> the collection.</Text>
     954</NumberedItem>
     955<MajorVersion number="3">
     956  <NumberedItem>
     957    <Text id="0320a">
     958    Next, go to the <AutoText key="glidict::GUI.Format"/> panel, and select the <AutoText key="glidict::CDM.GUI.SearchMetadata"/> section to the left. On the right, set the display text value for <b>Index: dc.Creator</b> to</Text>
     959    <Format>creators</Format>
    952960</NumberedItem></MajorVersion>
    953961<NumberedItem>
    954962<MajorVersion number="2">
    955 <Text id="0321-1">Check that all the facilities work properly. There should be three full-text indexes, called <AutoText key="coredm::_Global:texttext_" type="italics"/>, <AutoText key="coredm::_Global:labelTitle_" type="italics"/>, and <AutoText key="coredm::_Global:labelCreator_" type="italics"/>. The <AutoText key="coredm::_Global:labelTitle_" type="italics"/> list should display all the document Titles. The <AutoText key="coredm::_Global:labelCreator_" type="italics"/> list should show one bookshelf for each author you have assigned as <AutoText key="metadata::dc.Creator"/>, and clicking on that bookshelf should take you to all the documents they authored.</Text>
     963<Text id="0321-1">Press the <AutoText key="glidict::CreatePane.Preview_Collection" type="button"/> button. Check that all the facilities work properly. There should be three full-text indexes, called <AutoText key="coredm::_Global:texttext_" type="italics"/>, <AutoText key="coredm::_Global:labelTitle_" type="italics"/>, and <AutoText key="coredm::_Global:labelCreator_" type="italics"/>. The <AutoText key="coredm::_Global:labelTitle_" type="italics"/> list should display all the document Titles. The <AutoText key="coredm::_Global:labelCreator_" type="italics"/> list should show one bookshelf for each author you have assigned as <AutoText key="metadata::dc.Creator"/>, and clicking on that bookshelf should take you to all the documents they authored.</Text>
    956964</MajorVersion>
    957965<MajorVersion number="3">
    958 <Text id="0321-2">Check that all the facilities work properly. There should be three full-text indexes, called <AutoText text="text" type="italics"/>, <AutoText key="gs3::metadata_names::Title.buttonname" type="italics"/>, and <AutoText key="gs3::metadata_names::Creator.buttonname" type="italics"/>. The <AutoText key="gs3::metadata_names::Title.buttonname" type="italics"/> list should display all the document Titles. The <AutoText key="gs3::metadata_names::Creator.buttonname" type="italics"/> list should show one bookshelf for each author you have assigned as <AutoText key="metadata::dc.Creator"/>, and clicking on that bookshelf should take you to all the documents they authored.</Text>
     966<Text id="0321-2">Press the <AutoText key="glidict::CreatePane.Preview_Collection" type="button"/> button. Check that all the facilities work properly. There should be three full-text indexes, called <AutoText text="text" type="italics"/>, <AutoText key="gs3::metadata_names::Title.buttonname" type="italics"/>, and <AutoText key="gs3::metadata_names::Creator.buttonname" type="italics"/>. The <AutoText key="gs3::metadata_names::Title.buttonname" type="italics"/> list should display all the document Titles. The <AutoText key="gs3::metadata_names::Creator.buttonname" type="italics"/> list should show one bookshelf for each author you have assigned as <AutoText key="metadata::dc.Creator"/>, and clicking on that bookshelf should take you to all the documents they authored.</Text>
    959967</MajorVersion>
    960968</NumberedItem>
    … …  
    991999<Text id="fw-3a">In this part of the exercise, we make the format statement simpler without changing the resulting display.</Text>
    9921000<Text id="fw-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>
    993 <Text id="fw-3a-1">Make sure that the <AutoText text="VList"/> format statement is selected in the list of formats.</Text>
     1001<Text id="fw-3a-1">Make sure that the <AutoText text="VList"/> format statement is selected in the list of format features.</Text>
    9941002<Text id="fw-4">The default <AutoText text="VList"/> format statement looks like the following:</Text>
    9951003<Format>
    … …  
    10671075<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>
    10681076<Text id="fw-12"><Format>[link][icon][/link]</Format> links to the Greenstone HTML version, while <Format>[ex.srclink][ex.srcicon][/ex.srclink]</Format> links to the original.</Text>
    1069 <Text id="fw-13">Choose <AutoText text="SearchVList"/> in <AutoText key="glidict::CDM.GUI.Formats"/> by selecting <AutoText text="Search"/> from the <AutoText key="glidict::CDM.FormatManager.Feature"/> drop down list, and <AutoText text="VList"/> from the <AutoText key="glidict::CDM.FormatManager.Part"/> list. Click <AutoText key="glidict::CDM.FormatManager.Add" type="button"/> to add the <AutoText text="SearchVList"/> format statement into the list of assigned formats. Experiment with removing either of the two links from the format statement.</Text>
     1077<Text id="fw-13">Choose <AutoText text="SearchVList"/> in <AutoText key="glidict::CDM.GUI.Formats"/> by selecting <AutoText text="Search"/> from the <AutoText key="glidict::CDM.FormatManager.Feature"/> drop down list, and <AutoText text="VList"/> from the <AutoText key="glidict::CDM.FormatManager.Part"/> list. Click <AutoText key="glidict::CDM.FormatManager.Add" type="button"/> to add the <AutoText text="SearchVList"/> format statement into the list of assigned formats. Experiment with removing and restoring either of the two links from the format statement, previewing the effect of each change.</Text>
    10701078<Text id="fw-13a">To see the results of your changes, preview the collection and do a search. You are making changes to <AutoText text="SearchVList"/>, which means the changes will only apply to search results.</Text>
    10711079<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>
    … …  
    10841092</Format>
    10851093<Text id="fw-12a-3">links to the original.</Text>
    1086 <Text id="fw-13-3">Choose <AutoText text="Search"/> in <AutoText key="glidict::CDM.GUI.Formats"/>. Experiment with removing either of the two links from the format statement.</Text>
     1094<Text id="fw-13-3">Choose <AutoText text="Search"/> in <AutoText key="glidict::CDM.GUI.Formats"/>. Experiment with removing and restoring either of the two links from the format statement, previewing the effect of each change.</Text>
    10871095<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>
    10881096<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>
Note: See TracChangeset for help on using the changeset viewer.