Changeset 11406
- Timestamp:
- 2006-03-17T18:11:00+13:00 (18 years ago)
- File:
-
- 1 edited
Legend:
- Unmodified
- Added
- Removed
-
trunk/gsdl-documentation/tutorials/xml-source/tutorial_en.xml
r11401 r11406 1240 1240 <Text id="0469">This displays something that looks like this: </Text> 1241 1241 <Indent> 1242 <table><tr><td><img width='15' height='20' src="tutorial_ images/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>1242 <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> 1243 1243 </Indent> 1244 1244 <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> … … 1289 1289 </NumberedItem> 1290 1290 <NumberedItem> 1291 <Text id="0489">To insert the <b>[dc.Subject]</b>, position the cursor at the appropriate point and investigate the <b>Variables</b> dropdown menu below--the one that says <b>[Text]</b>. Make it say <b>[dc.Subject]</b> and click <b>Insert </b>to insert this into the <b>HTML Format String</b>. This menu shows all the things that you can put in square brackets in the format statement. The only exception is <b>[Text]</b>, which gives the full text of the document, and can only be used when <b>DocumentText</b> is the <b>Affected Component</b>.</Text>1291 <Text id="0489">To insert the <b>[dc.Subject]</b>, position the cursor at the appropriate point and either type it in, or use the <b>Variables</b> dropdown menu--the one that says <b>[Text]</b>. Make it say <b>[dc.Subject]</b> and click <b>Insert </b>to insert this into the <b>HTML Format String</b>. This menu shows all the things that you can put in square brackets in the format statement. The only exception is <b>[Text]</b>, which gives the full text of the document, and can only be used when <b>DocumentText</b> is the <b>Affected Component</b>.</Text> 1292 1292 </NumberedItem> 1293 1293 <NumberedItem> 1294 1294 <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 <table><tr><td><img width='15' height='20' src="tutorial_ images/itext.gif" /></td><td width='408' valign='top'>A discussion of question five from Tudor Quiz: Henry VIII <br/>1295 <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/> 1296 1296 Tudor period|Others</td></tr></table> 1297 1297 <Text id="0493">(The vertical bar appears because this <i>dc.Subject and Keywords</i> metadata is hierarchical metadata. Unfortunately there is no way to get at individual components of the hierarchy. For most metadata, such as title and author, this isn't a problem.)</Text> … … 1372 1372 </NumberedItem> 1373 1373 <NumberedItem> 1374 <Text id="0523">Remove the plugins <b>TextPlug</b> to <b>NULPlug</b> (<b>ZIPPlug</b>, <b>GAPlug</b> and <b>MARCPlug</b> remain). It is not strictly necessary to remove these redundant plugins, but it is good practice to include only plugins that are needed, to avoid accidentally including stray documents.</Text>1374 <Text id="0523">Remove the plugins <b>TextPlug</b> to <b>NULPlug</b> by selecting each one in the <b>Currently Assigned Plugins</b> list and clicking <b>Remove Plugin</b> (<b>ZIPPlug</b>, <b>GAPlug</b> and <b>MARCPlug</b> remain). It is not strictly necessary to remove these redundant plugins, but it is good practice to include only plugins that are needed, to avoid accidentally including stray documents.</Text> 1375 1375 </NumberedItem> 1376 1376 <NumberedItem> … … 1404 1404 <NumberedItem> 1405 1405 <Text id="0532a">Add form searching to the collection by selecting <b>form</b> in the <b>Search Types</b> menu and clicking <<b>Add Search Type</b>>. Remove plain searching by selecting <b>plain</b> in the <b>Currently Assigned Search Types</b> list, and clicking <<b>Remove Search Type</b>>.</Text> 1406 </NumberedItem> 1406 1407 <NumberedItem> 1407 1408 <Text id="0533"><b>Build</b> the collection once again, and <b>preview</b> the results. Notice that the collection's home page no longer includes a query box. (This is because the search form is too big to fit here nicely.) To search, you have to click <b>search</b> in the navigation bar. Note that the <i>Preferences </i>page has changed to control the advanced searching options.</Text> … … 1511 1512 dc.Title,ex.Title 1512 1513 </Format> 1514 <Text id="0565a">and click <b><OK></b>.</Text> 1513 1515 </Bullet> 1514 1516 </BulletList> … … 1535 1537 </Bullet> 1536 1538 <Bullet> 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>. </Text>1539 <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> 1538 1540 </Bullet> 1539 1541 </BulletList> 1540 1542 <Text id="0575"><b>Build</b> the collection again and <b>preview</b> it.</Text> 1541 1543 </NumberedItem> 1542 <NumberedItem>1543 <Text id="0576">Greenstone has no pre-defined button for "Category", so it appears in the navigation bar as text. It does, however, have a button for <i>browse</i> (it's used in the Beatles collection you looked at in Part I).</Text>1544 <BulletList>1545 <Bullet>1546 <Text id="0577">Go back to the <b>AZCompactList</b> classifier for <b>dc.Format</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. Also, specify "Browse" as the <b>buttonname</b>.</Text>1547 </Bullet>1548 </BulletList>1549 <Text id="0578">You will need to build the collection for this to take effect.</Text>1550 </NumberedItem>1551 1544 <Heading> 1552 1545 <Text id="0579">Suppressing dummy text</Text> … … 1561 1554 <Text id="0582">Ensure that <b>VList</b> is selected, and make the changes that are highlighted below. You need to insert three lines into the first line, and delete the second line.<br/> <br/> Change:</Text> 1562 1555 <Format> 1563 <td valign=top>[link][icon][/link]</td><br/> 1564 <td valign=top><br/> 1565 [ex.srclink]{Or}{[ex.thumbicon],[ex.srcicon]}[ex./srclink]</td> <br/> 1556 <td valign=top><highlight>[link][icon][/link]</highlight></td><br/> 1557 <highlight><td valign=top>[ex.srclink]{Or}{[ex.thumbicon],[ex.srcicon]}[ex./srclink]</td> </highlight><br/> 1566 1558 <td valign=top>[highlight]<br/> 1567 1559 {Or}{[dls.Title],[dc.Title],[Title],Untitled} <br/> … … 1571 1563 <Format> 1572 1564 <td valign=top><br/> 1573 {If}{[dc.Format] eq 'Audio',<br/>1574 [srclink][srcicon][/srclink],<br/>1575 [link][icon][/link]}</td> <br/>1565 <highlight>{If}{[dc.Format] eq 'Audio', </highlight><br/> 1566 <highlight>[srclink][srcicon][/srclink], </highlight><br/> 1567 <highlight>[link][icon][/link]}</highlight></td> <br/> 1576 1568 <td valign=top>[highlight] {Or}{[dls.Title],[dc.Title],[Title],Untitled} [/highlight]{If}{[ex.Source],<br><i>([ex.Source])</i>}</td> 1577 1569 </Format> … … 1597 1589 [srclink][srcicon][/srclink],<br/> 1598 1590 [link][icon][/link]}</td> <br/> 1599 <td valign=top>[highlight] {Or}{[dls.Title],[dc.Title],[Title],Untitled} [/highlight] {If}{[ex.Source],<br><i>([ex.Source])</i>}</td></Format>1591 <td valign=top>[highlight] {Or}{[dls.Title],[dc.Title],[Title],Untitled} [/highlight]<highlight>{If}{[ex.Source],<br><i>([ex.Source])</i>}</highlight></td></Format> 1600 1592 </Bullet> 1601 1593 </BulletList> … … 1633 1625 </Heading> 1634 1626 <NumberedItem> 1635 <Text id="0606">Make the bookshelves show how many documents they contain by inserting a line in the VList format statement in the <b> Design</b> panel:</Text>1627 <Text id="0606">Make the bookshelves show how many documents they contain by inserting a line in the VList format statement in the <b>Format Features</b> section of the <b>Design</b> panel:</Text> 1636 1628 <Format> 1637 1629 <td valign=top><br/> … … 1639 1631 [srclink][srcicon][/srclink],<br/> 1640 1632 [link][icon][/link]}</td><br/> 1641 <td>{If}{[numleafdocs],([numleafdocs])}</td><br/>1633 <highlight><td>{If}{[numleafdocs],([numleafdocs])}</td></highlight><br/> 1642 1634 <td valign=top>[highlight] {Or}{[dls.Title],[dc.Title],[Title],Untitled} [/highlight]</td></Format> 1643 1635 <Text id="0607">You will find this text in <i>format_tweaks</i>--></Text> … … 1653 1645 {If}{[dc.Format] eq 'Audio',<br/> 1654 1646 [srclink][srcicon][/srclink],<br/> 1655 {If}{[dc.Format] eq 'Images',<br/>1656 [srclink][thumbicon][/srclink],<br/>1657 [link][icon][/link]} }</td><br/>1647 <highlight>{If}{[dc.Format] eq 'Images',</highlight><br/> 1648 <highlight>[srclink][thumbicon][/srclink],</highlight><br/> 1649 [link][icon][/link]}<highlight>}</highlight></td><br/> 1658 1650 <td>{If}{[numleafdocs],([numleafdocs])}</td><br/> 1659 1651 <td valign=top>[highlight] {Or}{[dls.Title],[dc.Title],[Title],Untitled} [/highlight]</td></Format> … … 1670 1662 <Text id="0617">Note how we assigned dc.Format metadata to all documents in the collection with a minimum of labour. We did this by capitalizing on the folder structure of the original information. Even though we complained earlier about how messy this folder structure is, you can still take advantage of it when assigning metadata.</Text> 1671 1663 </Comment> 1672 <Comment>1673 <Text id="0618">In the next exercise we incorporate the MIDI files. Greenstone has no MIDI plugin (yet). But that doesn't mean you can't use MIDI files! We also clean up the <i>titles a-z</i> browser.</Text>1674 </Comment>1675 <Comment>1676 <Text id="0621">To do this we must put the Librarian Interface into a different mode. The interface supports four levels of user: Library Assistants, who can add documents and metadata to collections, and create new ones whose structure mirrors that of existing collections; Librarians, who can, in addition, design new collections, but cannot use specialist IT features (e.g. regular expressions); Library Systems Specialists, who can use all design features, but cannot perform troubleshooting tasks (e.g. interpreting debugging output from Perl programs); and Experts, who can perform all functions.</Text>1677 </Comment>1678 <Comment>1679 <Text id="0622">So far you have mostly been operating in Librarian mode. We switch to Library Systems Specialist mode for the next exercise.</Text>1680 </Comment>1681 1664 <Heading> 1682 1665 <Text id="0623">Using UnknownPlug</Text> 1683 1666 </Heading> 1684 < NumberedItem>1685 <Text id="06 24">To switch modes, click <Menu>File-->Preferences-->Mode</Menu> and change to <b>Library Systems Specialist</b>. Note from the description that appears that you need to be able to formulate regular expressions to use this mode fully. That is what we do below.</Text>1686 </ NumberedItem>1667 <Comment> 1668 <Text id="0618">In this section we incorporate the MIDI files. Greenstone has no MIDI plugin (yet). But that doesn't mean you can't use MIDI files! </Text> 1669 </Comment> 1687 1670 <NumberedItem> 1688 1671 <Text id="0627"><b>UnknownPlug</b> is a useful generic plugin. It knows nothing about any given format but can be tailored to process particular document types--like MIDI--based on their filename extension, and set basic metadata.</Text> 1672 <Text id="0627a">In the <b>Document Plugins</b> section of the <b>Design</b> panel:</Text> 1689 1673 <BulletList> 1690 1674 <Bullet> … … 1711 1695 <Text id="0634">Cleaning up a title browser using regular expressions</Text> 1712 1696 </Heading> 1697 <Comment> 1698 <Text id="0618a">We now clean up the <i>titles a-z</i> browser.</Text> 1699 </Comment> 1700 <Comment> 1701 <Text id="0621">To do this we must put the Librarian Interface into a different mode. The interface supports four levels of user: Library Assistants, who can add documents and metadata to collections, and create new ones whose structure mirrors that of existing collections; Librarians, who can, in addition, design new collections, but cannot use specialist IT features (e.g. regular expressions); Library Systems Specialists, who can use all design features, but cannot perform troubleshooting tasks (e.g. interpreting debugging output from Perl programs); and Experts, who can perform all functions.</Text> 1702 </Comment> 1703 <Comment> 1704 <Text id="0622">So far you have mostly been operating in Librarian mode. We switch to Library Systems Specialist mode for the next exercise.</Text> 1705 </Comment> 1706 <NumberedItem> 1707 <Text id="0624">To switch modes, click <Menu>File-->Preferences-->Mode</Menu> and change to <b>Library Systems Specialist</b>. Note from the description that appears that you need to be able to formulate regular expressions to use this mode fully. That is what we do below.</Text> 1708 </NumberedItem> 1713 1709 <NumberedItem> 1714 1710 <Text id="0635">Next we return to our <i>titles a-z</i> browser and clean it up. The aim is to amalgamate variants of titles by stripping away extraneous text. For example, we would like to treat "ANTHOLOGY 1", "ANTHOLOGY 2" and "ANTHOLOGY 3" the same for grouping purposes. To achieve this:</Text> … … 1747 1743 </Heading> 1748 1744 <NumberedItem> 1749 <Text id="0648">Re-Edit your <b>VList</b> format statement to be the following </Text>1750 <Format> <td valign=top><br/>1751 {If}{[numleafdocs],[link][icon][/link]}<br/>1752 {If}{[dc.Format] eq 'Lyrics',[link]_iconlyrics_[/link]}<br/>1753 {If}{[dc.Format] eq 'Discography',[link]_icondisc_[/link]}<br/>1754 {If}{[dc.Format] eq 'Tablature',[link]_icontab_[/link]}<br/>1755 {If}{[dc.Format] eq 'MARC',[link]_iconmarc_[/link]}<br/>1756 {If}{[dc.Format] eq 'Images',[srclink][thumbicon][/srclink]}<br/>1757 {If}{[dc.Format] eq 'Supplementary',[srclink][srcicon][/srclink]}<br/>1758 {If}{[dc.Format] eq 'Audio',[srclink]{If}{[FileFormat] eq 'MIDI',_iconmidi_,_iconmp3_}[/srclink]}<br/>1759 </td><br/>1745 <Text id="0648">Re-Edit your <b>VList</b> format statement to be the following (in <Menu>Design-->Format Features</Menu>)</Text> 1746 <Format><highlight><td valign=top></highlight><br/> 1747 <highlight>{If}{[numleafdocs],[link][icon][/link]}</highlight><br/> 1748 <highlight>{If}{[dc.Format] eq 'Lyrics',[link]_iconlyrics_[/link]}</highlight><br/> 1749 <highlight>{If}{[dc.Format] eq 'Discography',[link]_icondisc_[/link]}</highlight><br/> 1750 <highlight>{If}{[dc.Format] eq 'Tablature',[link]_icontab_[/link]}</highlight><br/> 1751 <highlight>{If}{[dc.Format] eq 'MARC',[link]_iconmarc_[/link]}</highlight><br/> 1752 <highlight>{If}{[dc.Format] eq 'Images',[srclink][thumbicon][/srclink]}</highlight><br/> 1753 <highlight>{If}{[dc.Format] eq 'Supplementary',[srclink][srcicon][/srclink]}</highlight><br/> 1754 <highlight>{If}{[dc.Format] eq 'Audio',[srclink]{If}{[FileFormat] eq 'MIDI',_iconmidi_,_iconmp3_}[/srclink]}</highlight><br/> 1755 <highlight></td></highlight><br/> 1760 1756 <td><br/> 1761 1757 {If}{[numleafdocs],([numleafdocs])}<br/> … … 1866 1862 </NumberedItem> 1867 1863 <NumberedItem> 1868 <Text id="0678"> Add <b>PagedImgPlug</b> and switch on its <b>screenview</b> configuration option by checking the box. The source images we use were scanned at high resolution and are large files for a browser to download. The <i>screenview</i> option generates smaller screen-resolution images of each page when the collection is built.</Text>1864 <Text id="0678">In <Menu>Design-->DocumentPlugins</Menu>, add <b>PagedImgPlug</b>. Switch on its <b>screenview</b> configuration option by checking the box. The source images we use were scanned at high resolution and are large files for a browser to download. The <i>screenview</i> option generates smaller screen-resolution images of each page when the collection is built.</Text> 1869 1865 </NumberedItem> 1870 1866 <NumberedItem> … … 1890 1886 </NumberedItem> 1891 1887 <NumberedItem> 1892 <Text id="0686">Now add <b>AZCompactList</b> for <i>ex.Title</i> and <b>DateList</b> for<i>ex.Date</i>.</Text>1888 <Text id="0686">Now add an <b>AZCompactList</b> classifier, setting its <b>metadata</b> option to <i>ex.Title</i>, and add a <b>DateList</b> classifier, setting its <b>metadata</b> option to <i>ex.Date</i>.</Text> 1893 1889 </NumberedItem> 1894 1890 <NumberedItem> … … 1904 1900 <Text id="0692">append</Text> 1905 1901 <Format>{If}{[numleafdocs],<td>([numleafdocs] items)</td>}</Format> 1902 <Text id="0692a">and click <b><Replace Format></b>.</Text> 1906 1903 <Comment> 1907 1904 <Text id="0693">As a consequence of using the AZCompactList classifier, bookshelf icons appear when titles are browsed. This revised format statement has the effect of specifying in brackets how many items are contained within a bookshelf. It works by exploiting the fact that only bookshelf icons define [numleafdocs] metadata.</Text> … … 1916 1913 <NumberedItem> 1917 1914 <Text id="0696">Staying within the <b>Format Features</b> section of the <b>Design </b>panel, under "Choose Feature" select <b>DocumentText</b>. Its HTML format string is empty, triggering the default behaviour of displaying the document's plain text, or, if there is none, "This document has no text". Change this to:</Text> 1918 <Format><center><br/> <table width=_pagewidth_><br/> <tr><br/> <td valign=top>[srclink][screenicon][/srclink]</td><br/> <td>[Text]</td><br/> </tr><br/> </table><br/> </center></Format> 1915 <Format> 1916 <center><br/> 1917 <table width=_pagewidth_><br/> 1918 <tr><br/> 1919 <td valign=top>[srclink][screenicon][/srclink]</td><br/> 1920 <td>[Text]</td><br/> 1921 </tr><br/> 1922 </table><br/> 1923 </center> 1924 </Format> 1925 <Text id="0692a">and click <b><Replace Format></b>.</Text> 1919 1926 <Text id="0697">(available as niupepa\doc_tweak.txt)</Text> 1920 1927 <Comment> … … 2005 2012 </NumberedItem> 2006 2013 <NumberedItem> 2007 <Text id="0722">Next, select <b>DocumentHeading</b> from the <b>Choose Feature</b> pull-down list and make its format statement (which is currently blank) read</Text>2014 <Text id="0722">Next, select <b>DocumentHeading</b> from the <b>Choose Feature</b> pull-down list and change its format statement to: </Text> 2008 2015 <Format><h3>[Subject]</h3></Format> 2009 2016 <Comment> … … 2012 2019 </NumberedItem> 2013 2020 <NumberedItem> 2014 <Text id="0727">Finally, you will have noticed that where the document itself should appear, you see only <i>This document has no text</i>. To rectify this, select <b>DocumentText</b> in the <b>Choose Feature</b> pull-down list and use the following as its format statement ( which is currently blank) (this text is in <i>doctxt_tweak.txt</i> in the <i>format_tweaks</i> folder mentioned earlier):</Text>2021 <Text id="0727">Finally, you will have noticed that where the document itself should appear, you see only <i>This document has no text</i>. To rectify this, select <b>DocumentText</b> in the <b>Choose Feature</b> pull-down list and use the following as its format statement (this text is in <i>doctxt_tweak.txt</i> in the <i>format_tweaks</i> folder mentioned earlier):</Text> 2015 2022 <Format><center><table width=_pagewidth_ border=1><br/> 2016 2023 <tr><td colspan=2 align=center><br/> … … 2023 2030 <tr><td>Rights:<td> [Rights]</td></tr><br/> 2024 2031 </table></center></Format> 2032 <Text id="0727a">Click <b><Replace Format></b>.</Text> 2025 2033 <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> 2026 2034 </NumberedItem> … … 2102 2110 </NumberedItem> 2103 2111 <NumberedItem> 2104 <Text id="0756">Switch to the <b>Design</b> panel select <b>Document Plugins</b>. Remove <b>GAPlug </b>from the list of plug-ins and add <b>METSPlug</b> .</Text>2112 <Text id="0756">Switch to the <b>Design</b> panel select <b>Document Plugins</b>. Remove <b>GAPlug </b>from the list of plug-ins and add <b>METSPlug</b>, with the default configuration options.</Text> 2105 2113 </NumberedItem> 2106 2114 <NumberedItem> … … 2135 2143 </NumberedItem> 2136 2144 <NumberedItem> 2137 <Text id="0766">Using the up and down arrows, <b>Move</b> the position of <b>DSpacePlug</b> to above <b> PDFPlug</b> and below <b>GAPlug</b>.</Text>2145 <Text id="0766">Using the up and down arrows, <b>Move</b> the position of <b>DSpacePlug</b> to above <b>GAPlug</b> and below <b>ZIPPlug</b>.</Text> 2138 2146 </NumberedItem> 2139 2147 <NumberedItem>
Note:
See TracChangeset
for help on using the changeset viewer.
