Changeset 11428 for trunk/gsdl-documentation
- Timestamp:
- 2006-03-21T10:34:07+12:00 (18 years ago)
- File:
-
- 1 edited
Legend:
- Unmodified
- Added
- Removed
-
trunk/gsdl-documentation/tutorials/xml-source/tutorial_en.xml
r11409 r11428 5 5 <TutorialList> 6 6 <Title> 7 <Text id="0001">Greenstone tutorial exercises, Version 1 (May 2005)</Text> 8 </Title> 9 <Comment> 10 <Text id="intro">(If you are working from a Greenstone CD-ROM, sample files for these exercises are in the folder <i>sample_files</i>; otherwise they can be downloaded from <Link url="http://sourceforge.net/project/showfiles.php?group_id=12123&package_id=152231">sourceforge</Link>.)</Text> 7 <Text id="0001">Greenstone tutorial exercises (March 2006)</Text> 8 </Title> 9 <Comment> 10 <Text id="intro">If you are working from a Greenstone CD-ROM, sample files for these exercises are in the folder <i>sample_files</i>; otherwise they can be downloaded from <Link url="http://sourceforge.net/project/showfiles.php?group_id=12123&package_id=152231">sourceforge</Link>.</Text> 11 <Text id="intro2">The text sometimes uses Windows terminology, but the exercises work equally well on other systems if you make appropriate changes to the pathnames.</Text> 11 12 </Comment> 12 13 <Tutorial id="unaids_cdrom"> … … 836 837 </NumberedItem> 837 838 <NumberedItem> 838 <Text id="0344">Click <<b>browse></b> in the navigation bar to view a list of the photos ordered by filename and presented as a thumbnail accompanied by some basic data about the image. The structure of this collection is the same as <b>Simple image collection (image-e)</b>, but the content is different.</Text>839 <Text id="0344">Click <i>browse</i> in the navigation bar to view a list of the photos ordered by filename and presented as a thumbnail accompanied by some basic data about the image. The structure of this collection is the same as <b>Simple image collection (image-e)</b>, but the content is different.</Text> 839 840 </NumberedItem> 840 841 <NumberedItem> … … 848 849 </Heading> 849 850 <NumberedItem> 850 <Text id="0348">The collection (image-e) on which <b>backdrop</b> is based uses only extracted metadata. To add another metadata set, go to the <b>Design</b> panel of the Librarian Interface and click <<b>Metadata Sets</b>> in the list on the left (the last one). Then click<b> <Add Metadata Set</b>> (lower left button).</Text>851 <Text id="0348">The collection (image-e) on which <b>backdrop</b> is based uses only extracted metadata. To add another metadata set, go to the <b>Design</b> panel of the Librarian Interface and click <b>Metadata Sets</b> in the list on the left (the last one). Then click <<b>Add Metadata Set...</b>> (lower left button).</Text> 851 852 </NumberedItem> 852 853 <NumberedItem> … … 878 879 </Heading> 879 880 <NumberedItem> 880 <Text id="0358">Go to the <b>Design</b> panel (by clicking on its tab) and select <b>Format Features </b>from the left-hand list. Leave the <b>Editing Controls </b>at their default value, so that <b>Choose Feature </b>remains blank and <b>VList </b>is selected as the <b>Affected Component</b>. In the <b>HTML Format String</b>, edit the text as follows:</Text>881 <Text id="0358">Go to the <b>Design</b> panel and select <b>Format Features</b> from the left-hand list. Leave the feature selection controls at their default values, so that <b>Choose Feature</b> remains blank and <b>VList</b> is selected as the <b>Affected Component</b>. In the <b>HTML Format String</b>, edit the text as follows:</Text> 881 882 <Indent> 882 883 <Text id="0359">Change "_ImageName_:" to "Title:" <br/> Change "[Image]" to "[dc.Title]"</Text> … … 893 894 </NumberedItem> 894 895 <Comment> 895 <Text id="0363"> Because we only assigned metadata to the first three items, after this the title becomes blank because the subsequent items have no dc.Title metadata. To get a full listing, enter all the metadata.</Text>896 <Text id="0363">After the first three items, the Title becomes blank because we have only assigned dc.Title metadata to these first three. To get a full listing, enter all the metadata.</Text> 896 897 </Comment> 897 898 <Comment> … … 902 903 </Heading> 903 904 <NumberedItem> 904 <Text id="0366">Thumbnail images are created by the <i>ImagePlug</i> plug-in, so we need to access its configuration settings. To do this, switch to the <b>Design</b> panel and select <b>Document Plugins</b> from the list on the left. Double-click <b>plugin ImagePlug</b> to pop up a window that shows its settings. (Alternatively, select <b>ImagePlug </b>with a single click and then click <b><Configure Plugin > </b>further down the screen). Currently all options are off, so standard defaults are used. Select <b>thumbnailsize</b>, set it to <b>50</b>, and click <b><OK></b>.</Text>905 <Text id="0366">Thumbnail images are created by the <i>ImagePlug</i> plug-in, so we need to access its configuration settings. To do this, switch to the <b>Design</b> panel and select <b>Document Plugins</b> from the list on the left. Double-click <b>plugin ImagePlug</b> to pop up a window that shows its settings. (Alternatively, select <b>ImagePlug </b>with a single click and then click <b><Configure Plugin...></b> further down the screen). Currently all options are off, so standard defaults are used. Select <b>thumbnailsize</b>, set it to <b>50</b>, and click <b><OK></b>.</Text> 905 906 </NumberedItem> 906 907 <NumberedItem> … … 920 921 </NumberedItem> 921 922 <Comment> 922 <Text id="0372">What description should you enter? To remind yourself of a file's content, the Librarian Interface lets you open files by double-clicking them. It launches the appropriate application based on the filename extension, Word for .doc files, Acrobat for .pdf files and so on. Double-click Ascent.jpg: the image will normally be displayed by Microsoft's Photo Editor (although this depends on how your computer has been set up).</Text>923 <Text id="0372">What description should you enter? To remind yourself of a file's content, the Librarian Interface lets you open files by double-clicking them. It launches the appropriate application based on the filename extension, Word for .doc files, Acrobat for .pdf files and so on. Double-click Ascent.jpg: on Windows, the image will normally be displayed by Microsoft's Photo Editor (although this depends on how your computer has been set up).</Text> 923 924 </Comment> 924 925 <NumberedItem> … … 932 933 </NumberedItem> 933 934 <NumberedItem> 934 <Text id="0376">Now update the format statement to use the new <b>dc.Description </b>metadata. Switch to the <b>Design </b>panel and enter the <b>Format Features </b>section by selecting this from the list of names on the left-hand size and ensure <b>VList</b> is selected. In the <b>HTML Format String</b>, place your cursor after the text that says</Text>935 <Text id="0376">Now update the format statement to use the new <b>dc.Description </b>metadata. Switch back to the <b>Format Features</b> section of the <b>Design </b>panel, and ensure the <b>Choose Feature</b> box is blank, and <b>VList</b> is selected in the <b>Affected Component</b> box. In the <b>HTML Format String</b>, place your cursor after the text that says</Text> 935 936 <Format>[dc.Title]<br></Format> 936 937 </NumberedItem> … … 949 950 </Heading> 950 951 <NumberedItem> 951 <Text id="0381">Switch to the <b>Design</b> panel and select <b>Browsing Classifiers </b>from the left-hand list. Set the menu item for <b>Select classifier to add </b>to <b>AZList</b>; then click <<b>Add Classifier </b>>.</Text>952 <Text id="0381">Switch to the <b>Design</b> panel and select <b>Browsing Classifiers </b>from the left-hand list. Set the menu item for <b>Select classifier to add </b>to <b>AZList</b>; then click <<b>Add Classifier...</b>>.</Text> 952 953 </NumberedItem> 953 954 <NumberedItem> … … 964 965 </NumberedItem> 965 966 <NumberedItem> 966 <Text id="0386">Switch to the <b>Create </b>panel, <b>build </b>the collection, then <b>preview </b>it. As an example, search for the term "mountain" in the <i>descriptions</i> index.</Text>967 <Text id="0386">Switch to the <b>Create</b> panel, <b>build</b> the collection, then <b>preview</b> it. As an example, search for the term "mountain" in the <i>descriptions</i> index (which is the only index at this point).</Text> 967 968 </NumberedItem> 968 969 </Content> … … 997 998 </Comment> 998 999 <NumberedItem> 999 <Text id="0395">Switch to the <b>Design</b> panel and select the <b>Document Plugins</b> section. Beside <b>plugin HTMLPlug</b> you will see <i>-smart_block</i>. This is the option that attempts to identify images in the HTML pages and block them from inclusion--in this case, it's not smart enough! Select the <b>plugin HTMLPlug</b> line and click <<b>Configure Plugin ></b>. A popup window appears. Scroll down the page to locate the <b>smart_block</b> option and switch it off. Click <<b>OK></b>.</Text>1000 <Text id="0395">Switch to the <b>Design</b> panel and select the <b>Document Plugins</b> section. Beside <b>plugin HTMLPlug</b> you will see <i>-smart_block</i>. This is the option that attempts to identify images in the HTML pages and block them from inclusion--in this case, it's not smart enough! Select the <b>plugin HTMLPlug</b> line and click <<b>Configure Plugin...></b>. A popup window appears. Scroll down the page to locate the <b>smart_block</b> option and switch it off. Click <<b>OK></b>.</Text> 1000 1001 </NumberedItem> 1001 1002 <NumberedItem> … … 1022 1023 <Tutorial id="export_to_CDROM"> 1023 1024 <Title> 1024 <Text id="0403">Exporting a collection to CD-ROM </Text>1025 <Text id="0403">Exporting a collection to CD-ROM/DVD</Text> 1025 1026 </Title> 1026 1027 <Prerequisite id="large_html_collection"/> … … 1028 1029 <Content> 1029 1030 <Comment> 1030 <Text id="0404">To publish a collection on CD-ROM , Greenstone's Export to CD-ROM export module must be installed (see <TutorialRef id="install_greenstone"/>).</Text>1031 <Text id="0404">To publish a collection on CD-ROM or DVD, Greenstone's Export to CD-ROM export module must be installed (see <TutorialRef id="install_greenstone"/>).</Text> 1031 1032 </Comment> 1032 1033 <NumberedItem> … … 1034 1035 </NumberedItem> 1035 1036 <NumberedItem> 1036 <Text id="0406">Choose <Menu>File-->Write CD/DVD image </Menu>, and in the popup window select the <b>tudor</b> collection as the collection to export. You can optionally name the CD-ROM; otherwise the default "collections" is used. Do so now, entering "Tudor collection" in the field for <b>CD/DVD name</b>; then click <b><Write CD/DVD image></b>.</Text>1037 <Text id="0406">Choose <Menu>File-->Write CD/DVD image...</Menu>, and in the popup window select the <b>tudor</b> collection as the collection to export. You can optionally name the CD-ROM; otherwise the default "collections" is used. Do so now, entering "Tudor collection" in the field for <b>CD/DVD name</b>; then click <b><Write CD/DVD image></b>.</Text> 1037 1038 <Text id="0408">The necessary files for export are written to:</Text> 1038 1039 <Text id="0408a"><Path>C:\Program Files\Greenstone\tmp\exported_Tudorcollection</Path></Text> 1039 <Text id="0409">You need to use your own computer's software to write these on to CD-ROM. On Windows XPthis ability is built into the operating system: assuming you have a CD-ROM or DVD writer insert a blank disk into the drive and drag the contents of <i>exported_Tudorcollection</i> into the folder that represents the disk.</Text>1040 <Comment> 1041 <Text id="0410">The result will be a self-installing Greenstone CD-ROM, which starts the installation process as soon as it is placed in the drive.</Text>1040 <Text id="0409">You need to use your own computer's software to write these on to CD-ROM. On <i>Windows XP</i> this ability is built into the operating system: assuming you have a CD-ROM or DVD writer insert a blank disk into the drive and drag the contents of <i>exported_Tudorcollection</i> into the folder that represents the disk.</Text> 1041 <Comment> 1042 <Text id="0410">The result will be a self-installing Windows Greenstone CD-ROM or DVD, which starts the installation process as soon as it is placed in the drive.</Text> 1042 1043 </Comment> 1043 1044 </NumberedItem> … … 1093 1094 </NumberedItem> 1094 1095 <NumberedItem> 1095 <Text id="0425">In the <b>Design</b> panel, select the <b>Document Plugins</b> section, then select the <b>plugin HTMLPlug</b> line and click <<b>Configure Plugin ></b>. A popup window appears. Locate the <b>file_is_url</b> option (about halfway down the first block of items) and switch it on. Click <<b>OK></b>.</Text>1096 <Text id="0425">In the <b>Design</b> panel, select the <b>Document Plugins</b> section, then select the <b>plugin HTMLPlug</b> line and click <<b>Configure Plugin...></b>. A popup window appears. Locate the <b>file_is_url</b> option (about halfway down the first block of items) and switch it on. Click <<b>OK></b>.</Text> 1096 1097 <Text id="0426">Setting this option to the HTMLPlug means that Greenstone sets an additional piece of metadata for each document called URL, which gives its original URL.</Text> 1097 1098 <Text id="0427">It is important that the files gathered in the collection start with the web domain name (<i>englishhistory.net</i> in this case). The conversion process will not work if you dragged over a subfolder, for example the <i>tudor</i> folder, because this will set URL metadata to something like</Text> … … 1140 1141 </NumberedItem> 1141 1142 <NumberedItem> 1142 <Text id="0441">Switch to the <b>Design</b> panel and select <b>Browsing Classifiers </b>from the left-hand list. Set the menu item for <b>Select classifier to add </b>to <b>Hierarchy</b>; then click <<b>Add Classifier </b>>.</Text>1143 <Text id="0441">Switch to the <b>Design</b> panel and select <b>Browsing Classifiers </b>from the left-hand list. Set the menu item for <b>Select classifier to add </b>to <b>Hierarchy</b>; then click <<b>Add Classifier...</b>>.</Text> 1143 1144 </NumberedItem> 1144 1145 <NumberedItem> … … 1194 1195 </NumberedItem> 1195 1196 <NumberedItem> 1196 <Text id="0459">Choose <b>Phind</b> from the <b>Select classifier to add</b> menu. Click <<b>Add Classifier ></b>. A window pops asking for configuration options: leave the values at their preset defaults (this will base the phrase index on the full text) and click <b><OK></b>.</Text>1197 <Text id="0459">Choose <b>Phind</b> from the <b>Select classifier to add</b> menu. Click <<b>Add Classifier...</b>>. A window pops asking for configuration options: leave the values at their preset defaults (this will base the phrase index on the full text) and click <b><OK></b>.</Text> 1197 1198 </NumberedItem> 1198 1199 <NumberedItem> … … 1210 1211 <NumberedItem> 1211 1212 <Text id="0464">Preview the newly rebuilt collection's <b>titles a-z</b> page. Previously this listed more than a dozen pages per letter of the alphabet, but now there are just three--the first three files encountered by the building process.</Text> 1213 </NumberedItem> 1214 <NumberedItem> 1215 <Text id="0464a">Go back to the <b>Create</b> panel and turn off the <b>maxdocs</b> option. <b>Rebuild</b> the collection so that all the documents are included.</Text> 1212 1216 </NumberedItem> 1213 1217 </Content> … … 1239 1243 <table><tr><td><img width='15' height='20' src="tutorial_files/itext.gif"/></td><td width='408' valign='top'>A discussion of question five from Tudor Quiz: Henry VIII <br/><i>(quizstuff.html)</i></td></tr></table> 1240 1244 </Indent> 1241 <Text id="0472">for a particular document whose <i>Title</i> metadata is <i>A discussion of question five from Tudor Quiz: Henry VIII</i> and whose <i>Source</i> metadata is <i>quizstuff.html</i> </Text>1242 <Text id="0473"> .This format appears in the search results list, in the <i>titles a-z</i> list, and also when you get down to individual documents in the <i>subjects</i> hierarchy. This is Greenstone's default format statement.</Text>1245 <Text id="0472">for a particular document whose <i>Title</i> metadata is <i>A discussion of question five from Tudor Quiz: Henry VIII</i> and whose <i>Source</i> metadata is <i>quizstuff.html</i>.</Text> 1246 <Text id="0473">This format appears in the search results list, in the <i>titles a-z</i> list, and also when you get down to individual documents in the <i>subjects</i> hierarchy. This is Greenstone's default format statement.</Text> 1243 1247 </NumberedItem> 1244 1248 <Comment> … … 1273 1277 </NumberedItem> 1274 1278 <NumberedItem> 1275 <Text id="0486">Now go to the <b>Create</b> panel and click <<b>Preview </b>>. First, the offending "()" has disappeared from the bookshelves. Second, when you get down to a list of documents in the subject hierarchy, the filename does not appear beside the title, because <i>ex.Source</i> is not specified in the format statement and this format statement applies to all nodes in the <i>subject</i> classifier. Note that the search results and titles lists have not changed: they still display the filename underneath the title.</Text>1279 <Text id="0486">Now go to the <b>Create</b> panel and click <<b>Preview Collection</b>>. First, the offending "()" has disappeared from the bookshelves. Second, when you get down to a list of documents in the subject hierarchy, the filename does not appear beside the title, because <i>ex.Source</i> is not specified in the format statement and this format statement applies to all nodes in the <i>subject</i> classifier. Note that the search results and titles lists have not changed: they still display the filename underneath the title.</Text> 1276 1280 </NumberedItem> 1277 1281 <NumberedItem> … … 1289 1293 </NumberedItem> 1290 1294 <NumberedItem> 1291 <Text id="0490">Now go to the <b>Create</b> panel and click <<b>Preview </b>>. Documents in the search results list will be displayed like this:</Text>1295 <Text id="0490">Now go to the <b>Create</b> panel and click <<b>Preview Collection</b>>. Documents in the search results list will be displayed like this:</Text> 1292 1296 <table><tr><td><img width='15' height='20' src="tutorial_files/itext.gif" /></td><td width='408' valign='top'>A discussion of question five from Tudor Quiz: Henry VIII <br/> 1293 1297 Tudor period|Others</td></tr></table> … … 1312 1316 </NumberedItem> 1313 1317 <NumberedItem> 1314 <Text id="0498">Go to the <b>Create </b>panel, click <<b>Preview </b>>, and examine the subject hierarchy again to see the effect of your changes.</Text>1318 <Text id="0498">Go to the <b>Create </b>panel, click <<b>Preview Collection</b>>, and examine the subject hierarchy again to see the effect of your changes.</Text> 1315 1319 </NumberedItem> 1316 1320 <Heading> … … 1327 1331 </NumberedItem> 1328 1332 <NumberedItem> 1329 <Text id="0507">Go to the <b>Create </b>panel and click <<b>Preview </b>>. The content of your collection remains the same, but its appearance has changed completely--for example, all the pages are pink! To learn about how to control these changes, go to the documented example collection called <i>Garish version of demo collection</i>, and read about it.</Text>1333 <Text id="0507">Go to the <b>Create </b>panel and click <<b>Preview Collection</b>>. The content of your collection remains the same, but its appearance has changed completely--for example, all the pages are pink! To learn about how to control these changes, go to the documented example collection called <i>Garish version of demo collection</i>, and read about it.</Text> 1330 1334 </NumberedItem> 1331 1335 <Heading> … … 1375 1379 </NumberedItem> 1376 1380 <NumberedItem> 1377 <Text id="0526">Add an <b>AZCompactList</b> classifier for the <b>Subject</b> metadata. Select this item from the relevant menu of the <b>Browsing Classifiers </b>section of the <b>Design</b> panel and click <b><Add Classifier ></b>. In the popup window, select <b>ex.Subject </b>as the metadata item.</Text>1381 <Text id="0526">Add an <b>AZCompactList</b> classifier for the <b>Subject</b> metadata. Select this item from the relevant menu of the <b>Browsing Classifiers </b>section of the <b>Design</b> panel and click <b><Add Classifier...></b>. In the popup window, select <b>ex.Subject </b>as the metadata item.</Text> 1378 1382 <Comment> 1379 1383 <Text id="0527"><b>AZCompactList</b> is like <b>AZList,</b> except that terms that appear multiple times in the hierarchy are automatically grouped together and a new node, shown as a bookshelf icon, is formed.</Text> … … 1448 1452 </NumberedItem> 1449 1453 <NumberedItem> 1450 <Text id="0547">Observe the low quality of the metadata. For example, the four items under <i>A H ARD DAY'S NIGHT</i> (under "H" in the <i>titles a-z</i> browser) have different variants as their titles. The collection would have been easier to organize had the metadata been cleaned up manually first, but that would be a big job. Only a tiny amount of metadata was added by hand--fewer than ten items. The original metadata was left untouched and Greenstone facilities used to clean it up automatically. (You will find in <TutorialRef id="multimedia_collection_build"/> that this is possible but tricky.)</Text>1454 <Text id="0547">Observe the low quality of the metadata. For example, the four items under <i>A Hard Day's Night</i> (under "A" in the <i>titles a-z</i> browser) have different variants as their titles. The collection would have been easier to organize had the metadata been cleaned up manually first, but that would be a big job. Only a tiny amount of metadata was added by hand--fewer than ten items. The original metadata was left untouched and Greenstone facilities used to clean it up automatically. (You will find in <TutorialRef id="multimedia_collection_build"/> that this is possible but tricky.)</Text> 1451 1455 </NumberedItem> 1452 1456 <NumberedItem> … … 1531 1535 </Bullet> 1532 1536 <Bullet> 1533 <Text id="0574">Add an <b>AZCompactList</b> classifier. Select <b>dc.Format</b> as the metadata field and specify "Category" as the <b>buttonname</b>. Click the <b>sort</b> checkbox, and leave <b>Title</b>in the adjacent text box: this will make the classifier display documents in alphabetical order of title.</Text>1537 <Text id="0574">Add an <b>AZCompactList</b> classifier. Select <b>dc.Format</b> as the metadata field and specify "Category" as the <b>buttonname</b>. Click the <b>sort</b> checkbox, and specify "Title" in the adjacent text box: this will make the classifier display documents in alphabetical order of title.</Text> 1534 1538 </Bullet> 1535 1539 </BulletList> … … 1829 1833 </Heading> 1830 1834 <NumberedItem> 1831 <Text id="0672">Switch to the <b>Design</b> panel and select the <b>Browsing Classifiers</b> section. Pull down the <b>select classifier to add</b> menu and select <b>Collage</b>. Click <<b>Add Classifier </b>>. There is no need to customize the options, so click <<b>OK</b>> at the bottom of the resulting popup.</Text>1835 <Text id="0672">Switch to the <b>Design</b> panel and select the <b>Browsing Classifiers</b> section. Pull down the <b>select classifier to add</b> menu and select <b>Collage</b>. Click <<b>Add Classifier...</b>>. There is no need to customize the options, so click <<b>OK</b>> at the bottom of the resulting popup.</Text> 1832 1836 </NumberedItem> 1833 1837 <NumberedItem> … … 1960 1964 </Comment> 1961 1965 <NumberedItem> 1962 <Text id="0710">You need to configure the Image plug-in. In the <b>Design</b> panel, select the <b>Document Plugins</b> section, then select the <b>plugin ImagePlug</b> line and click <<b>Configure Plugin ></b>. In the resulting popup window locate the <b>screenviewsize</b> option, switch it on, and type the number 300 in the box beside it to create a screen-view image of 300 pixels. Click <<b>OK></b>.</Text>1966 <Text id="0710">You need to configure the Image plug-in. In the <b>Design</b> panel, select the <b>Document Plugins</b> section, then select the <b>plugin ImagePlug</b> line and click <<b>Configure Plugin...></b>. In the resulting popup window locate the <b>screenviewsize</b> option, switch it on, and type the number 300 in the box beside it to create a screen-view image of 300 pixels. Click <<b>OK></b>.</Text> 1963 1967 </NumberedItem> 1964 1968 <NumberedItem> … … 2155 2159 </Comment> 2156 2160 <NumberedItem> 2157 <Text id="0773">Select <b>DSpacePlug</b> and click <<b>Configure Plugin </b>>. Switch on its configuration option <b>first_inorder_ext</b>. Set its value to <i>pdf,doc,mp3</i> in the popup window that appears and press <b><OK></b>.</Text>2161 <Text id="0773">Select <b>DSpacePlug</b> and click <<b>Configure Plugin...</b>>. Switch on its configuration option <b>first_inorder_ext</b>. Set its value to <i>pdf,doc,mp3</i> in the popup window that appears and press <b><OK></b>.</Text> 2158 2162 </NumberedItem> 2159 2163 <NumberedItem>
Note:
See TracChangeset
for help on using the changeset viewer.