Changeset 24617 for documentation

Show
Ignore:
Timestamp:
21.09.2011 15:46:53 (8 years ago)
Author:
ak19
Message:

Changes made after testing out the tutorials 2.85 on Linux.

Files:
1 modified

Legend:

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

    r24559 r24617  
    15441544</NumberedItem> 
    15451545<NumberedItem> 
    1546 <Text id="0414">In a web browser, visit <Link>http://englishhistory.net</Link>, follow the link to <i>Tudor England</i>, and click &lt;<b>Enter</b>&gt;. You should be at the URL</Text> 
     1546<Text id="0414">In a web browser, visit <Link>http://englishhistory.net</Link>, follow the link to <i>Tudor England</i>. You should be at the URL</Text> 
    15471547<Link>http://englishhistory.net/tudor.html</Link>  
    15481548<Text id="0415">This is where we started the downloading process to obtain the files you have been using for the <b>tudor</b> collection. You could do the same thing by copying this URL from the web browser, pasting it into the <AutoText key="glidict::GUI.Download"/> panel, and clicking the <AutoText key="glidict::Mirroring.Download" type="button"/> button. However, several megabytes will be downloaded, which might strain your network resources&mdash;or your patience! For a faster exercise we focus on a smaller section of the site. </Text> 
     
    17871787</NumberedItem> 
    17881788<NumberedItem> 
    1789 <Text id="is-10">In the <AutoText key="glidict::CDM.GUI.Classifiers"/> section, remove the existing (useless) classifiers for <AutoText text="dc.Title;ex.Title"/> and <AutoText text="ex.Source"/>, and add a new <AutoText text="List"/> for <AutoText text="ex.Photographer"/>.</Text> 
     1789<Text id="is-10">In the <AutoText key="glidict::CDM.GUI.Classifiers"/> section of the <AutoText key="glidict::GUI.Design"/> panel, remove the existing (useless) classifiers for <AutoText text="dc.Title;ex.Title"/> and <AutoText text="ex.Source"/>, and add a new <AutoText text="List"/> for <AutoText text="ex.Photographer"/>.</Text> 
    17901790</NumberedItem> 
    17911791<NumberedItem> 
     
    19331933<Format> 
    19341934body {<br/> 
    1935   background: #ffffff;<br/> 
     1935  background-color: #ffffff;<br/> 
    19361936} 
    19371937</Format> 
     
    19881988<Text id="mf-43">Make your own Greenstone home page</Text> 
    19891989</Heading> 
    1990 <Text id="mf-44">You can make radical changes to a page by changing the macro file completely. For example, here we use a alternative to the home page which we have prepared for you in advance and included in your Greenstone installation.</Text> 
     1990<Text id="mf-44">You can make radical changes to a page by changing the macro file completely. For example, here we use an alternative to the home page which we have prepared for you in advance and included in your Greenstone installation.</Text> 
    19911991<NumberedItem> 
    19921992<Text id="mf-45">Open the file <Path>Greenstone &rarr; etc &rarr; main.cfg</Path> in a text editor. Locate the <AutoText text="macrofiles" type="italics"/> list:</Text> 
     
    20142014</Heading> 
    20152015<NumberedItem> 
    2016 <Text id="mf-64">In the step 10 of this exercise we replaced the default background (<AutoText text="chalk.gif"/>) and header (<AutoText text="gsdlhead.gif"/>) images with new ones. To do this we needed to change the image names in the macro files. How did we know which images we were replacing and which macro files to edit? This exercise shows you how to find out.</Text> 
     2016<Text id="mf-64">In step 10 of this exercise we replaced the default background (<AutoText text="chalk.gif"/>) and header (<AutoText text="gsdlhead.gif"/>) images with new ones. To do this we needed to change the image names in the macro files. How did we know which images we were replacing and which macro files to edit? This exercise shows you how to find out.</Text> 
    20172017</NumberedItem> 
    20182018<NumberedItem> 
     
    20272027<Text id="mf-69">To search the macro files for <i><AutoText text="gsdlhead.gif" /></i> type</Text> 
    20282028<Command>findstr /s /m /C:"gsdlhead.gif" "C:\Program Files\Greenstone\macros\*.dm"</Command> 
    2029 <Text id="mf-70"><AutoText text="*.dm"/> means all files ending in <AutoText text=".dm"/> (while <AutoText text="/s"/> tells it to search within subfolders and <AutoText text="/m"/> lists the files that matched). A list of all macro files will be displayed, along with any matches. You will see that <Path>home.dm</Path> and <Path>exported_home.dm</Path> both contain <AutoText text="gsdlhead.gif"/>. <Path>home.dm</Path> is the one you want to edit&mdash;<Path>exported_home.dm</Path> is used for the home page when you export a collection to CD-ROM.</Text> 
     2029<Text id="mf-70"><AutoText text="*.dm"/> means all files ending in <AutoText text=".dm"/> (while <AutoText text="/s"/> tells it to search within subfolders and <AutoText text="/m"/> lists the files that matched). A list of all applicable macro files will be displayed, along with any matches. You will see that <Path>home.dm</Path> and <Path>exported_home.dm</Path> both contain <AutoText text="gsdlhead.gif"/>. <Path>home.dm</Path> is the one you want to edit&mdash;<Path>exported_home.dm</Path> is used for the home page when you export a collection to CD-ROM. On Linux systems, the equivalent command to run in a terminal would be:</Text> 
     2030<Command>fgrep -rl "gsdlhead.gif" /full/path/to/your/greenstone/macros/.</Command> 
    20302031<Text id="mf-71">Do the same thing for <i><AutoText text="chalk.gif" /></i>:</Text> 
    20312032<Command>findstr /s /m /C:"chalk.gif" "C:\Program Files\Greenstone\macros\*.dm"</Command> 
     
    20532054</NumberedItem> 
    20542055<NumberedItem> 
    2055 <Text id="0544">On Windows, if the Greenstone Digital Library Local Library Server is already running, re-start it by clicking the world icon on the task bar and then pressing <i>Restart Library</i>. On Linux and Mac, just do a forced reload/refresh of the web browser (eg. by pressing Shift and the refresh button in Firefox to do a forced reload). If the Local Library Server hasn't been started yet, start it up by selecting <i>Greenstone Digital Library</i> from the <i>Start</i> menu on Windows, or run <Path>./gs-server.sh</Path> on Linux and Mac.</Text> 
     2056<Text id="0544">On Windows, if the Greenstone Digital Library Local Library Server is already running, re-start it by clicking the world icon on the task bar and then pressing <i>Restart Library</i>. On Linux and Mac, just do a forced reload/refresh of the web browser (eg. by pressing Shift and the refresh button in Firefox to do a forced reload). If the Local Library Server hasn't been started yet, start it up first by selecting <i>Greenstone Digital Library</i> from the <i>Start</i> menu on Windows, or run <Path>./gs-server.sh</Path> on Linux and Mac.</Text> 
    20562057</NumberedItem> 
    20572058<NumberedItem> 
     
    21332134</Bullet> 
    21342135<Bullet> 
    2135 <Text id="0574">Add a <AutoText text="List"/> classifier and click the <AutoText text="bookshelf_type"/> and select <AutoText text="always"/> in the drop-down list. Select <AutoText key="metadata::dc.Format"/> as the <AutoText text="metadata"/> field and specify "browse" as the <AutoText text="buttonname"/>. Click the <AutoText text="partition_type_within_level"/> check box and choose <AutoText text="none"/> from the drop-down list. Click the <AutoText text="sort_leaf_nodes_using"/> checkbox, and select <AutoText key="metadata::ex.Title"/> in the drop-down list: this will make the classifier display documents in alphabetical order of title.</Text> 
     2136<Text id="0574">Add a <AutoText text="List"/> classifier and select <AutoText key="metadata::dc.Format"/> as the <AutoText text="metadata"/> field. Click the <AutoText text="bookshelf_type"/> and select <AutoText text="always"/> in the drop-down list. Click the <AutoText text="partition_type_within_level"/> check box and choose <AutoText text="none"/> from the drop-down list. Click the <AutoText text="sort_leaf_nodes_using"/> checkbox, and select <AutoText key="metadata::ex.Title"/> in the drop-down list: this will make the classifier display documents in alphabetical order of title. Specify <AutoText text="browse"/> as the <AutoText text="buttonname"/>.</Text> 
    21362137</Bullet> 
    21372138</BulletList> 
     
    24152416</NumberedItem> 
    24162417<NumberedItem> 
    2417 <Text id="0673">Now change to the <AutoText key="glidict::GUI.Create"/> panel and <b>build</b> and <b>preview</b> the collection.</Text> 
     2418<Text id="0673">Now change to the <AutoText key="glidict::GUI.Create"/> panel and <b>build</b> and <b>preview</b> the collection. Try out the <AutoText text="collage"/> browsing classifier. You can click on any image during the collage display and the image will be opened up.</Text> 
    24182419</NumberedItem> 
    24192420</Content> 
     
    27852786</Comment> 
    27862787<NumberedItem> 
    2787 <Text id="oai-plugin-option">You 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="dc.Resource Identifier"/> from the drop-down list. Click <AutoText key="glidict::General.OK" type="button"/>. Move the <AutoText text="OAIPlugin"/> above the <AutoText text="EmbeddedMetadataPlugin"/>.</Text> 
     2788<Text id="oai-plugin-option">Move the <AutoText text="OAIPlugin"/> above the <AutoText text="EmbeddedMetadataPlugin"/>. Next, 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="dc.Resource Identifier"/> from the drop-down list. Click <AutoText key="glidict::General.OK" type="button"/>.</Text> 
    27882789</NumberedItem> 
    27892790<NumberedItem> 
     
    28012802</NumberedItem> 
    28022803<NumberedItem> 
    2803 <Text id="0714">Add an <AutoText text="AZCompactList" /> classifier based on <AutoText key="metadata::ex.dc.Subject"/> metadata. Configure it with "subjects" as the <AutoText text="buttonname"/>.</Text> 
     2804<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> 
    28042805</NumberedItem> 
    28052806<NumberedItem> 
     
    28082809</NumberedItem> 
    28092810<NumberedItem> 
    2810 <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_".</Text>  
     2811<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>  
    28112812</NumberedItem> 
    28122813<NumberedItem> 
     
    30173018</NumberedItem> 
    30183019<NumberedItem> 
    3019 <Text id="0779">Go back to the <AutoText key="glidict::GUI.Design"/> panel, select <AutoText key="glidict::CDM.GUI.Classifiers"/>. Select the <AutoText key="metadata::ex.Source"/> <AutoText text="List" /> classifier and click <AutoText key="glidict::CDM.ClassifierManager.Configure" type="button"/>. Change the <AutoText text="metadata"/> option to <AutoText key="metadata::ex.dc.Contributor"/>. Activate the <AutoText text="bookshelf_type"/> option and set its value to <AutoText text="always"/>. If not already active, activate the <AutoText text="partition_type_within_level"/> option. Then set it to <AutoText text="none"/>. Finally, activate <AutoText text="buttonname"/> and set this to "contributors". Click <AutoText key="glidict::General.OK" type="button"/> to close the dialog.</Text> 
     3020<Text id="0779">Go back to the <AutoText key="glidict::GUI.Design"/> panel, select <AutoText key="glidict::CDM.GUI.Classifiers"/>. Select the <AutoText key="metadata::ex.Source"/> <AutoText text="List" /> classifier and click <AutoText key="glidict::CDM.ClassifierManager.Configure" type="button"/>. Change the <AutoText text="metadata"/> option to <AutoText key="metadata::ex.dc.Contributor"/>. Activate the <AutoText text="bookshelf_type"/> option and set its value to <AutoText text="always"/>. If not already active, activate the <AutoText text="partition_type_within_level"/> option. Then set it to <AutoText text="none"/>. Finally, activate <AutoText text="buttonname"/> and set this to <AutoText text="contributors"/>. Click <AutoText key="glidict::General.OK" type="button"/> to close the dialog.</Text> 
    30203021</NumberedItem> 
    30213022<NumberedItem> 
     
    31183119</NumberedItem> 
    31193120<NumberedItem> 
    3120 <Text id="gems-9">The new metadata set will be displayed. The left hand side list the elements (and sub-elements, if any) for the set, and the right hand side displays the set or element attributes. Since the new set was based on the Development Library Subset metadata set, it already contains all the elements from that set.</Text> 
     3121<Text id="gems-9">The new metadata set will be displayed. The left hand side lists the elements (and sub-elements, if any) for the set, and the right hand side displays the set or element attributes. Since the new set was based on the Development Library Subset metadata set, it already contains all the elements from that set.</Text> 
    31213122</NumberedItem> 
    31223123<Heading> 
     
    31793180</NumberedItem> 
    31803181<NumberedItem> 
    3181 <Text id="lucene-3">Please note that stopwords are used by default with Lucene indexer, so searching for words like <i>the</i> will match 0 documents. There is also a message on the search page saying that such words are too common and were ignored.</Text> 
     3182<Text id="lucene-3">Please note that stopwords are used by default with Lucene indexer, so searching for words like <i>the</i> will match 0 documents. This is explained in a message on the search page, which states that such words are too common and were ignored.</Text> 
    31823183</NumberedItem> 
    31833184<Heading> 
     
    32833284</NumberedItem> 
    32843285<NumberedItem> 
    3285 <Text id="depositor-user3">Let's modify the groups for the demo user. This user was added for the authentication demonstration collection to allow restricted access to some of the documents. If this user doesn't exist for you, create a new user by clicking on the <AutoText key="auxdm::_status:textaddusers_"/> link under the <AutoText key="auxdm::_status:textusermanage_"/> section on the left. Give it the name "demo" and password "demo".</Text> 
     3286<Text id="depositor-user3">Let's modify the groups for the demo user. This user was added for the authentication demonstration collection to allow restricted access to some of the documents. If this user doesn't exist for you, create a new user by clicking on the <AutoText key="auxdm::_status:textaddusers_"/> link under the <AutoText key="auxdm::_status:textusermanage_"/> section on the left. Give it the name "demo" and password "demo". Click <AutoText text="submit"/>.</Text> 
    32863287</NumberedItem> 
    32873288<NumberedItem> 
     
    32903291<NumberedItem> 
    32913292<Text id="depositor-user5">At the end of each user entry there are two links: <AutoText key="auxdm::_userslistusers:textedituser_"/> and <AutoText key="auxdm::_userslistusers:textdeleteuser_"/>. Click <AutoText key="auxdm::_userslistusers:textedituser_"/> on the <AutoText text="demo"/> user account, and you will be shown more detailed information about the demo user. Add <AutoText text="demoluce-collection-editor"/> at the end of the <AutoText key="auxdm::_userslistusers:textgroups_"/> line, using a comma to separate group entries, so that the <AutoText key="auxdm::_userslistusers:textgroups_"/> field now contains:  
    3292 <Format>demo, demoluce-collection-editor.</Format> (Note, if your collection shortname is not demoluce, then replace demoluce with the appropriate name in ***-collection-editor.)</Text> 
     3293<Format>demo,demoluce-collection-editor.</Format> (Note, if your collection shortname is not demoluce, then replace demoluce with the appropriate name in ***-collection-editor.)</Text> 
    32933294</NumberedItem> 
    32943295<NumberedItem> 
     
    33343335</NumberedItem> 
    33353336<NumberedItem> 
    3336 <Text id="depositor-20">Go to the Greenstone's home page and click <AutoText key="coredm::_depositor:textdepositor_"/> button. Select <b>Demo Lucene</b> from the list and log in.</Text> 
     3337<Text id="depositor-20">Go to the Greenstone's home page and click <AutoText key="coredm::_depositor:textdepositor_"/> button. Select <b>Demo Lucene</b> from the list and log in if asked to do so again.</Text> 
    33373338</NumberedItem> 
    33383339<NumberedItem>