source: trunk/gsdl-documentation/tutorials/xml-source/tutorial_en.xml@ 11642

<?xml version="1.0"?>
<!DOCTYPE TutorialList [
     <!ENTITY nbsp "&#160;">
     <!ENTITY rarr "&#8594;">
     <!ENTITY mdash "&#8212;">
]>
<TutorialList>
<Title>
<Text id="0001">Greenstone tutorial exercises (March 2006)</Text>
</Title>
<SupplementaryText>
<Text id="title">Greenstone tutorial exercise</Text>
<Text id="prereq">Prerequisite:</Text>
<Text id="sample">Sample files:</Text>
<Text id="original">Devised for Greenstone version:</Text>
<Text id="current">Modified for Greenstone version:</Text>
<Text id="index">Back to index</Text>
<Text id="wiki">Back to wiki</Text>
<Text id="print">Print version</Text>
</SupplementaryText>
<Comment>
<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&amp;package_id=152231">sourceforge</Link>.</Text>
</Comment>
<Comment>
<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>
</Comment>
<Tutorial id="unaids_cdrom">
<Title>
<Text id="0082">Working with a pre-packaged collection (UNAIDS)</Text>
</Title>
<Version initial="UNAIDS 2.0 CD-ROM" current="UNAIDS 2.0 CD-ROM"/>
<Content>
<Comment>
<Text id="0083">You will need the Greenstone UNAIDS CD-ROM</Text>
</Comment>
<Heading>
<Text id="0084">Installing a pre-packaged Greenstone collection</Text>
</Heading>
<NumberedItem>
<Text id="0085">On inserting the <b>UNAIDS CD-ROM</b>, for many computers installation will begin automatically. If not, "auto-run"&mdash;a configurable setting under Windows&mdash;is disabled on your computer and you need to double-click <i>setup.exe</i> on the CD-ROM.</Text>
<Menu>
<Text id="0086">My Computer &rarr; UNAIDS20 &rarr; setup.exe</Text>
</Menu>
</NumberedItem>
<NumberedItem>
<Text id="0089">The InstallShield Wizard begins to install the UNAIDS pre-packaged collection. Select the English language.</Text>
</NumberedItem>
<NumberedItem>
<Text id="0090">Click the <b>&lt;next&gt;</b> button.</Text>
</NumberedItem>
<NumberedItem>
<Text id="0091">Choose <b>Run from CD-ROM (standard) </b>as the setup type. This is the default and is already selected. Then click <b>&lt;next&gt;</b>.</Text>
</NumberedItem>
<NumberedItem>
<Text id="0092">Click <b>&lt;next&gt; </b>again to install the UNAIDS collection in the default folder, which is <b>C:\Program Files\UNAIDS Library 2.0 [CD-ROM]</b>.</Text>
<Comment>
<Text id="0093">Installation Wizard copies the required files from CD-ROM to disk</Text>
</Comment>
</NumberedItem>
<NumberedItem>
<Text id="0094">Click <b>&lt;OK</b>&gt; to confirm completion of UNAIDS collection (twice).</Text>
<Comment>
<Text id="0095">InstallShield quits&mdash;the UNAIDS Library is installed.</Text>
</Comment>
</NumberedItem>
<Comment>
<Text id="0097">CD-ROMs like this one that contain pre-packaged Greenstone collections do not include the full Greenstone software. Instead they embody a mini version of Greenstone that allows you to view the collection but not to build new ones.</Text>
</Comment>
<Heading>
<Text id="0098">Browsing around a Greenstone collection</Text>
</Heading>
<NumberedItem>
<Text id="0099">Launch the prebuilt library by clicking:</Text>
<Menu>
<Text id="0100">Start &rarr; All Programs &rarr; UNAIDS Library 2.0 [CD-ROM] &rarr; UNAIDS Library 2.0 (Standard Version).</Text>
</Menu>
<Comment>
<Text id="0104">To access Greenstone through the Local Library Server, it is sometimes necessary to turn off the proxy settings of the browser. Greenstone normally detects this and pops up a window alerting you to the problem.</Text>
</Comment>
</NumberedItem>
<NumberedItem>
<Text id="0105">Click <b>&lt;Enter Library&gt; </b>in the dialog box and your browser (typically Internet Explorer by default) will display the Greenstone home page.</Text>
</NumberedItem>
<NumberedItem>
<Text id="0106">Within the web browser, click <b>titles a-z</b> (in the centre of the navigation bar near the top of the page).</Text>
</NumberedItem>
<NumberedItem>
<Text id="0107">Access the <b>first book</b> in the list of titles by clicking the <b>book icon</b> next to the title:</Text>
<Text id="0108"><i>About UNAIDS</i>.</Text>
</NumberedItem>
<NumberedItem>
<Text id="0109">Use the scroll bar to view the full length of the page.</Text>
</NumberedItem>
<NumberedItem>
<Text id="0110">In the table of contents near the top, click the <b>page icon </b>next to the heading <i>Guiding principles of UNAIDS</i> to view this section.</Text>
</NumberedItem>
<NumberedItem>
<Text id="0111">Click the <b>page icon</b> next to the heading <i>Global and local impact</i> to view the next section.</Text>
</NumberedItem>
<Comment>
<Text id="0112">This style of interaction can be continued to further expand and contract folders and switch to a different section.</Text>
</Comment>
<NumberedItem>
<Text id="0113">To fully expand the contents of this introduction chapter, click <b>Expand Document or Chapter</b> in the upper left portion of the page, under the picture of the document's front cover.</Text>
</NumberedItem>
<NumberedItem>
<Text id="0114">You can return to the currently selected page of document titles by clicking the <b>book icon</b> next to the title of the book at the top of the table of contents (this signifies closing the book). You also get to the document titles using <b>titles a-z</b> in the navigation bar, in this case to the titles beginning with A-D.</Text>
<Comment>
<Text id="0115">If the table of contents is open at the top level&mdash;showing all the chapters&mdash;then clicking <b>Expand Document or Chapter</b> expands the full document. For long documents, which take some time to load in, Greenstone seeks confirmation for this action: clicking 'continue' loads the full document.</Text>
</Comment>
</NumberedItem>
<NumberedItem>
<Text id="0116">Browse around and peruse some other documents in the collection.</Text>
</NumberedItem>
<Heading>
<Text id="0117">Searching within a Greenstone collection</Text>
</Heading>
<NumberedItem>
<Text id="0118">Access the search page by clicking <b>search</b> in the navigation bar.</Text>
</NumberedItem>
<NumberedItem>
<Text id="0119">In the query box under <b>Search for chapters in any language which contain some of the words</b>,<b></b> enter the term <b>gender</b> then click <b>&lt;Begin Search&gt;</b>.</Text>
<Comment>
<Text id="0120">After a short pause, the web browser loads a fresh page showing the results of the search.</Text>
</Comment>
</NumberedItem>
<NumberedItem>
<Text id="0121">Click the <b>page icon</b> for the <b>first matching document</b> in the result set (</Text>
<Text id="0122"><i>Five Year Implementation Review of the Vienna Declaration and Programme of Action</i>) to view the document. Because the search was at the chapter level, you are taken directly to the matching chapter within the document.</Text>
</NumberedItem>
<NumberedItem>
<Text id="0123">Experiment further with searching, and with the interface in general. For example, there is a detailed <b>Help</b> page. It contains a <b>Preferences</b> section through which you can control some search settings.</Text>
<Comment>
<Text id="0124">The Preferences options in the UNAIDS collection are intentionally minimalist. Most collections have a separate Preferences button that offers more features.</Text>
</Comment>
<Comment>
<Text id="0125">The home page of the UNAIDS library collection cycles through a sequence of front cover images, updated every 5 seconds or so. Clicking a particular image takes you directly to that document.</Text>
</Comment>
</NumberedItem>
<Heading>
<Text id="0126">Leaving the Greenstone digital library</Text>
</Heading>
<NumberedItem>
<Text id="0127">There are two ways of leaving Greenstone:</Text>
<NumberedItem>
<Text id="0128">Exit from the Greenstone Software server. Click on the <b>Greenstone Software</b> in the task bar, then choose <b>Exit</b> from the <b>Browser Selection and Settings</b> menu (or click on the exit hotspot, the red cross at the top right). The Greenstone Software exits, but your web browser continues to run.</Text>
</NumberedItem>
<NumberedItem>
<Text id="0129">Exit from your web browser. Leave your web browser in the usual way. The Greenstone server detects when you exit from the browser and generates a popup window that asks whether to close down the server as well. (The reason is that other people may be using Greenstone over the network, and should not be rudely terminated.)</Text>
</NumberedItem>
</NumberedItem>
<Heading>
<Text id="0130">Exercise: Use the UNAIDS collection to answer these questions</Text>
</Heading>
<BulletList>
<Bullet>
<Question>
<Text id="0131">How many publications are there in the collection?</Text>
</Question>
<Answer>900</Answer>
</Bullet>
<Bullet>
<Question>
<Text id="0132">How many documents are there that mention <i>Australia</i> in the title?</Text>
</Question>
<Answer>15</Answer>
</Bullet>
<Bullet>
<Question>
<Text id="0133">How many top-level subject categories are there?</Text>
</Question>
<Answer>21</Answer>
</Bullet>
<Bullet>
<Question>
<Text id="0134">What does AAVP stand for?</Text>
</Question>
<Answer>African Aids Vaccination Programme</Answer>
</Bullet>
<Bullet>
<Question>
<Text id="0136">What does AIDS stand for?</Text>
</Question>
<Answer>Acquired Immuno-Deficiency Syndrome
<Text id="0138">(Search for "AIDS stands for")</Text>
</Answer>
</Bullet>
<Bullet>
<Question>
<Text id="0139">Considering lower case variants only, how many times does the word "condom" appear in the collection? <br/>How many times for "condoms"?</Text>
</Question>
<Answer>6789<br/> 5243</Answer>
</Bullet>
<Bullet>
<Question>
<Text id="0140">If case sensitivity does not matter, how many times does the word "condom" appear in the collection? <br/>How many times for "condoms"?</Text>
</Question>
<Answer>7905<br/> 5571</Answer>
</Bullet>
<Bullet>
<Question>
<Text id="0141">If word endings are ignored, how many times does "condom" and variants such as "condoms" appear in the collection?</Text>
</Question>
<Answer>13477</Answer>
</Bullet>
<Bullet>
<Question>
<Text id="0142">How many <i>chapters</i> contain some variations of the word "condom"? <br/>Does this make it a useful search term?</Text>
</Question>
<Answer>
<Text id="0143">2413 chapters. <br/>  No, since there are only 900 documents</Text>
</Answer>
</Bullet>
<Bullet>
<Question>
<Text id="0144">What year saw the first reported case of AIDS in New Zealand?</Text>
</Question>
<Answer>1983</Answer>
</Bullet>
</BulletList>
</Content>
</Tutorial>
<Tutorial id="IITE_cdrom">
<Title>
<Text id="0145">Working with a pre-packaged collection (Digital Libraries in Education)</Text>
</Title>
<Version initial="IITE Digital Libraries in Education CD-ROM" current="IITE Digital Libraries in Education CD-ROM"/>
<Content>
<Comment>
<Text id="0146">You will need the Greenstone <i>Digital Libraries in Education</i> CD-ROM</Text>
</Comment>
<Heading>
<Text id="0147">Installing a pre-packaged collection</Text>
</Heading>
<NumberedItem>
<Text id="0148">Insert your CD-ROM for the course <i>Digital libraries in education</i> into a Windows computer. If the installation process does not start up straightaway (because the AutoPlay feature is disabled on your computer), navigate to your CD-ROM/DVD drive (normally D:), open the folder <i>prebuilt</i>, and double click on <b>Setup.exe</b>.</Text>
</NumberedItem>
<NumberedItem>
<Text id="0149">During installation you are offered a choice of folder to install in: we recommend the default, which is <i>C:\GSDL</i>.</Text>
</NumberedItem>
<NumberedItem>
<Text id="0150">You are also presented with the option to run Greenstone from the CD-ROM or to copy the entire CD-ROM. We recommend the latter: please check the box that says <b>Install all collection files</b>. It will take at least a couple of minutes to copy the files across.</Text>
</NumberedItem>
<NumberedItem>
<Text id="0151">Finally, the installer offers to install the Netscape browser for you. Do <i>not</i> request this except in the unlikely event that you do not already have a web browser on your computer.</Text>
</NumberedItem>
<Comment>
<Text id="0152">CD-ROMs like this one that contain pre-packaged Greenstone collections do not include the full Greenstone software. Instead they embody a mini version of Greenstone that allows you to view the collection but not to build new ones.</Text>
</Comment>
<Heading>
<Text id="0153">Browsing around a Greenstone collection</Text>
</Heading>
<NumberedItem>
<Text id="0154">To run Greenstone, open the Windows Start menu, Programs, and select <i>Greenstone</i>, then the submenu item<i> Digital Libraries in Education</i>: then &lt;<b><i>Enter Library</i></b>&gt;.</Text>
</NumberedItem>
<NumberedItem>
<Text id="0155">Click the Digital libraries in Education collection's icon. This takes you to the collection's home page, often called the "about" page.</Text>
<Comment>
<Text id="0156">The home page contains an access bar with buttons called search, contents, authors a-z, modules, and acronyms. This access bar is the key to finding information in any Greenstone collection.</Text>
</Comment>
</NumberedItem>
<NumberedItem>
<Text id="0157">Click &lt;<b>authors a-z</b>&gt;. A list of bookshelf icons appears. Click the one called Marchionini, G. to see the two course readings by Gary Marchionini.</Text>
</NumberedItem>
<NumberedItem>
<Text id="0158">One of these items is a PDF file and the other is an HTML file. Click them both in turn to open up the documents.</Text>
</NumberedItem>
<NumberedItem>
<Text id="0159">Click the &lt;<b>contents</b>&gt; button in the access bar. This shows two bookshelves, one for this Study Guide and the other for the Course Readings. Choose one and look at what it contains.</Text>
</NumberedItem>
<NumberedItem>
<Text id="0160">Clicking a bookshelf that is open closes it. Close the bookshelf you have just opened and then choose the other one and examine its contents.</Text>
</NumberedItem>
<NumberedItem>
<Text id="0161">Click &lt;<b>acronyms</b>&gt; in the access bar and find the meaning of the acronym "LOM".</Text>
</NumberedItem>
<NumberedItem>
<Text id="0162">Click &lt;<b>search</b>&gt; and search for the word "LOM". Check out the difference between searching text and searching titles (use the pull-down box on the search page).</Text>
</NumberedItem>
<NumberedItem>
<Text id="0163">Click the collection icon <b>Digital Libraries in Education</b> at the top left. This takes you back to the collection's <b>about</b> page.</Text>
<Text id="0164">Beneath the access bar on the collection's about page is a search box (just the same as the one that appears on the search page), a description of the collection under the heading <b>About this collection</b>, and instructions on how to find information in this collection.</Text>
<Text id="0165">Above the access bar is the collection's icon, saying <b>Digital Libraries in Education</b>. On the right is an icon saying <b>about</b>, above which are three buttons, <b>home</b>, <b>help</b>, and <b>preferences</b>.</Text>
</NumberedItem>
<NumberedItem>
<Text id="0166">Click &lt;<b>home</b>&gt;. This returns you to the Greenstone home page.</Text>
</NumberedItem>
<NumberedItem>
<Text id="0167">Return to the collection (by clicking its icon), and click &lt;<b>help</b>&gt;. This gives more information about how to access the collection.</Text>
</NumberedItem>
<NumberedItem>
<Text id="0168">Click &lt;<b>preferences</b>&gt;. This takes you to a page where you can change some of the settings.</Text>
</NumberedItem>
<NumberedItem>
<Text id="0169">Now explore the collection by navigating freely around it. Click liberally: all images that appear on the screen are clickable. If you hold the mouse stationary over an image, most browsers will soon pop up a brief "mouse-over" message that tells you what will happen if you click. Experiment! Choose common words like "the" or "and" to search for&mdash;that should evoke some response, and nothing will break. (Note: unlike many search systems, Greenstone indexes all words, including these ones.)</Text>
</NumberedItem>
<Heading>
<Text id="0170">Exercise: Read the Help page; then answer these questions</Text>
</Heading>
<BulletList>
<Bullet>
<Text id="0171">What does this collection contain?</Text>
</Bullet>
<Bullet>
<Text id="0172">Name five ways to navigate to a target document in this collection.</Text>
</Bullet>
<Bullet>
<Text id="0173">How many documents in the collection are written by Erik Duval?</Text>
</Bullet>
<Bullet>
<Text id="0174">Compare the number of times the words "he" and "she" appear in the collection.</Text>
</Bullet>
<Bullet>
<Text id="0175">How many times does the word "metadata" appear in titles? In the text itself?</Text>
</Bullet>
<Bullet>
<Text id="0176">What's the difference between a <i>some</i> and an <i>all</i> search?</Text>
</Bullet>
<Bullet>
<Text id="0177">What does "MODS" stand for?</Text>
</Bullet>
<Bullet>
<Text id="0178">How do you switch the interface from English to Russian? Does it stay in Russian when you go to the Greenstone home page?</Text>
</Bullet>
<Bullet>
<Text id="0179">Find a search term that yields different results depending on whether you have <i>ignore word endings</i> or <i>whole word must match</i> set on the Preferences page.</Text>
</Bullet>
<Bullet>
<Text id="0180">What's the difference between Graphical and Textual interface format (on the Preferences page)?</Text>
</Bullet>
</BulletList>
<Heading>
<Text id="0181">Exercise: Use the How to build a digital library collection to answer these questions.</Text>
</Heading>
<BulletList>
<Bullet>
<Text id="0182">How many sentences contain the word education?</Text>
</Bullet>
<Bullet>
<Text id="0183">What story from the School Journal collection is featured in the book?</Text>
</Bullet>
<Bullet>
<Text id="0184">How many acronyms used in the book begin with the word Standard?</Text>
</Bullet>
<Bullet>
<Text id="0185">What does tapu mean?</Text>
</Bullet>
<Bullet>
<Text id="0186">How many times does the word library appear? The word libraries?</Text>
</Bullet>
<Bullet>
<Text id="0187">How many times does Library appear with an initial capital letter?</Text>
</Bullet>
<Bullet>
<Text id="0188">How many times does some derivative of the word form appear?</Text>
</Bullet>
<Bullet>
<Text id="0189">Name an English poem that was probably written in about 1000 A.D.</Text>
</Bullet>
<Bullet>
<Text id="0190">Who is Alan Kay?</Text>
</Bullet>
<Bullet>
<Text id="0191">On what page is the first mention of some aspect of Chinese culture?</Text>
</Bullet>
</BulletList>
<Comment>
<Text id="0192">Most of these questions would be rather difficult to answer from the printed book.</Text>
</Comment>
</Content>
</Tutorial>
<Tutorial id="install_greenstone">
<Title>
<Text id="0193">Installing Greenstone</Text>
</Title>
<Version initial="2.60" current="2.70"/>
<Content>
<Heading>
<Text id="0194">Installing Greenstone on a Windows system</Text>
</Heading>
<Text id="0195">There are various ways of getting Greenstone:</Text>
<NumberedItem>
<Text id="0196">From a UNESCO CD-ROM (version 2.70) (or FAO IMARK CD-ROM, but this is an earlier version 2.51)</Text>
<Text id="0197">These CD-ROMs contain the <b>Greenstone software</b>, plus <b>documented example collections</b>, four <b>language interfaces</b> (English French Spanish Russian), the <b>Export to CD-ROM</b> package, the <b>ImageMagick</b> graphics package, the <b>Java runtime environment</b>, and an <b>installer</b> that installs all of these.</Text>
</NumberedItem>
<NumberedItem>
<Text id="0198">From the IITE Digital Libraries in Education CD-ROM, or a Greenstone workshop CD-ROM</Text>
<Comment>
<Text id="0199">In addition to all the above software, these CD-ROMs contain the tutorial exercises and a set of <b>sample files</b> to be used for these exercises.</Text>
<Text id="0199a">CD-ROMs with Greenstone version 2.62 or earlier also include the <b>Greenstone Language Pack</b>, which gives reader's interfaces in many languages (currently about 40). This has its own installer which you have to invoke separately, after you have installed Greenstone.</Text>
<Text id="0199b">CD-ROMs with version 2.70 or later now come with reader's interfaces in all available languages. Textual images have been removed from the interface; they are now done using CSS (Cascading Style Sheets). The Greenstone Language Pack is no longer needed. Instead, these CD-ROMs come with the <b>Classic Interface Pack</b>, which contains the old text images for use with a backwards compatibility macro file.</Text>
</Comment>
<Comment>
<Text id="0200">All these CD-ROMs contain the full Greenstone software, which allows you to view collections and build new ones. They are not the same as CD-ROMs that contain a pre-packaged Greenstone collection, which only allow you to view that collection.</Text>
</Comment>
</NumberedItem>
<NumberedItem>
<Text id="0201">From <Link>http://www.greenstone.org</Link></Text>
<Text id="0202">Most people download the Windows distribution from <Link>http://www.greenstone.org</Link>, which contains the latest version of Greenstone. There are several optional modules that must be downloaded separately (to avoid a single massive download): <b>documented example collections</b>, the <b>Export to CD-ROM</b> package, the <b>Language Pack</b> (Greenstone 2.62 and earlier) and <b>Classic Interface Pack</b> (Greenstone 2.63 and later). There is also the set of <b>sample files</b> used in these exercises. (To reduce the download size the documented example collections are distributed in unbuilt form and need to be built.)</Text>
<Text id="0203">You need <b>Java</b> to run Greenstone. You might already have it; otherwise download it from <Link>http://java.sun.com</Link>. To work with image collections, you need <b>ImageMagick</b> (from <Link>http://www.imagemagick.org</Link>). </Text>
</NumberedItem>
<Text id="0204">Most Greenstone CD-ROMs start the installation process as soon as they are inserted into the drive, assuming that the AutoPlay feature is enabled on your computer. If installation does not begin by itself, locate the file <i>setup.exe</i> and double click it to start the installation process. (On the IMARK CD-ROM this file resides in the folder <Path>software_tools &rarr; Greenstone</Path>). If you download Greenstone over the web, what you get is the installer&mdash;just double-click it.</Text>
<Text id="0206"><b>If Greenstone has been installed on your computer before, you should completely remove the old version before installing a new one</b>. (However, you need not remove any pre-packaged collections that you may have installed.) To do this, see <TutorialRef id="update_greenstone_installation"/>.</Text>
<Text id="0207">Here is what you need to do to install Greenstone. Older versions of the installer follow much the same sequence but use slightly different wording.</Text>
<BulletList>
<Bullet>
<Text id="0208">Select the language for this installation. We choose <b>English</b></Text>
</Bullet>
<Bullet>
<Text id="0209">Welcome to the InstallShield Wizard for the Greenstone Digital Library Software. Click &lt;<b>Next</b>&gt;</Text>
</Bullet>
<Bullet>
<Text id="0210">License Agreement. Accept the agreement and then click &lt;<b>Next</b>&gt;</Text>
</Bullet>
<Bullet>
<Text id="0211">Choose location to install Greenstone. Leave at the default and click &lt;<b>Next</b>&gt;</Text>
</Bullet>
<Bullet>
<Text id="0212">Setup Type. Leave at the default (Local Library) and click &lt;<b>Next</b>&gt;</Text>
</Bullet>
<Bullet>
<Text id="0213">(For older installers you must now select collections. Leave at the default, Documented Example Collections, and click &lt;<b>Next</b>&gt;)</Text>
</Bullet>
<Bullet>
<Text id="0214">Set admin password. Choose a suitable password and click &lt;<b>Next</b>&gt; (If your computer will not be serving collections online, the password doesn't matter)</Text>
</Bullet>
<Bullet>
<Text id="0215">Click &lt;<b>Install</b>&gt; to complete the installation</Text>
</Bullet>
<Bullet>
<Text id="0216">Files are copied across</Text>
</Bullet>
<Bullet>
<Text id="0217">Installation is complete. If you are installing from a CD-ROM, the installer will offer to install ImageMagick (see below), and Java, if necessary.</Text>
</Bullet>
</BulletList>
<Text id="0218">To invoke the Greenstone Reader's interface, go to the <i>Greenstone Digital Library Software</i> item under <i>Programs</i> on the Windows <i>Start</i> menu and select <i>Greenstone Digital Library</i>. To invoke the Librarian interface, go to the same item and select <i>Greenstone Librarian Interface</i>.</Text>
<Heading>
<Text id="0219">Installing ImageMagick on a Windows system</Text>
</Heading>
<Text id="0220">Once Greenstone has been installed, you should ensure that ImageMagick is installed on your computer if you wish to build any image collections. If you are installing from a Greenstone CD-ROM, you will be asked whether you want to install ImageMagick: say <b>Yes</b>. If you are not, you will need to download ImageMagick (from <Link>http://www.imagemagick.org</Link>). To install this program you must have Windows "Administrator" privileges. (If you do not have Windows Administrator privileges, the ImageMagick installer will give a cryptic error complaining that it failed to set a particular Windows registry value. If this happens you can continue your work with Greenstone, but you will not be able to build collections of images.)</Text>
<Text id="0221"> The remaining steps are straightforward, and, as before, we recommend the default settings. Here is what you need to do.</Text>
<BulletList>
<Bullet>
<Text id="0222">"This will install ImageMagick 5.5.7 Q8. Do you wish to continue?" <b>Yes</b></Text>
</Bullet>
<Bullet>
<Text id="0223">"Welcome to the ImageMagick Setup Wizard Click &lt;<b>Next</b>&gt;</Text>
</Bullet>
<Bullet>
<Text id="0224">"Information: Please read the following ..." Click &lt;<b>Next</b>&gt;</Text>
</Bullet>
<Bullet>
<Text id="0225">"Select Destination Directory ..." Leave at default and click &lt;<b>Next</b>&gt;</Text>
</Bullet>
<Bullet>
<Text id="0226">"Select Start Menu Folder ..." Leave at default and click &lt;<b>Next</b>&gt;</Text>
</Bullet>
<Bullet>
<Text id="0227">"Select Additional Tasks ..." Leave at default and click &lt;<b>Next</b>&gt;</Text>
</Bullet>
<Bullet>
<Text id="0228">"Ready to Install". Click &lt;<b>Install</b>&gt;</Text>
</Bullet>
<Bullet>
<Text id="0229">Files are copied across</Text>
</Bullet>
<Bullet>
<Text id="0230">"You have now installed ..." Click &lt;<b>Next</b>&gt;</Text>
</Bullet>
<Bullet>
<Text id="0231">"Setup has finished ...". Deselect "View index.html" and click &lt;<b>Finish</b>&gt;.</Text>
</Bullet>
</BulletList>
</Content>
</Tutorial>
<Tutorial id="update_greenstone_installation">
<Title>
<Text id="0232">Updating a Greenstone installation</Text>
</Title>
<Prerequisite id="install_greenstone"/>
<Version initial="2.60" current="2.70"/>
<Content>
<Comment>
<Text id="0233">These tutorial exercises assume that you are using Greenstone 2.60 or above.</Text>
</Comment>
<Comment>
<Text id="0234">Before updating to a new version of Greenstone, ensure that the computer is not running the Greenstone Librarian Interface or the Greenstone local library server. Normally, quitting your web browser, or quitting the Librarian Interface, also quits the server.</Text>
</Comment>
<Heading>
<Text id="0235">Removing Greenstone from a Windows system</Text>
</Heading>
<Comment>
<Text id="0236">Completely remove the existing version before you install a new version of Greenstone.</Text>
</Comment>
<NumberedItem>
<Text id="0237">Ensure that you are not running Greenstone.</Text>
</NumberedItem>
<NumberedItem>
<Text id="0238">Remove the old version by going to the Windows Control Panel (from the <i>Settings</i> item on the <i>Start</i> menu). Click <b>Add or Remove Programs</b>, select <b>Greenstone Digital Library Software</b>, and <b>Remove</b> it. (To do this you may need Windows "Administrator" privileges.)</Text>
</NumberedItem>
<NumberedItem>
<Text id="0239">At the end of this procedure you will be asked whether you would like all your Greenstone collections to be removed: you should probably say <i>No</i> if you wish to preserve your work.</Text>
</NumberedItem>
<Comment>
<Text id="0240">Occasionally, problems are encountered if older Greenstone installations are not fully removed. To clean up your system, move your Greenstone collect folder, which contains all your collections, to the desktop. Then check for the folder C:\Program Files\gsdl or C:\Program Files\Greenstone, which is where Greenstone is usually installed, and remove it completely if it exists.</Text>
</Comment>
<Heading>
<Text id="0241">Reinstalling Greenstone on a Windows system</Text>
</Heading>
<NumberedItem>
<Text id="0242">The reinstallation procedure is exactly the same as the original installation procedure, described in <TutorialRef id="install_greenstone"/>. If you already have ImageMagick, you do not need to install it again.</Text>
</NumberedItem>
<Comment>
<Text id="0243">There have been some superficial changes to the installation procedure in moving to Greenstone Version 2.60, because it uses a different installer program.</Text>
</Comment>
<Comment>
<Text id="0244">There is another important difference that you should be aware of: Versions 2.60 and above are installed in the folder Program Files\Greenstone, whereas prior versions were placed in the folder Program Files\gsdl (these are both default locations that you could have changed during installation.) When upgrading to Version 2.60, if you want to save existing collections you must explicitly move the contents of your collect folder from the old place to the new one. Future Greenstone versions will be installed in the new place, Program Files\Greenstone, so this problem will not happen again.</Text>
</Comment>
<Heading>
<Text id="0245">Amalgamating different Greenstone collections</Text>
</Heading>
<NumberedItem>
<Text id="0246">If you have previously installed the Greenstone Digital Library software in a non-standard place, you should amalgamate your collections by moving them from the <i>collect</i> folder in the old place into the folder <i>Program Files\Greenstone\collect</i>.</Text>
</NumberedItem>
<NumberedItem>
<Text id="0247">If you have installed collections from pre-packaged Greenstone CD-ROMs, they reside in a different place: <i>C:\GSDL\collect</i>. To amalgamate these with your main Greenstone installation, move them into the folder <i>Program Files\Greenstone\collect</i>. The mini version of Greenstone that is associated with the pre-packaged collections is no longer necessary. To uninstall it, select <i>Uninstall</i> on the Greenstone menu of the Windows <i>Start</i> menu.</Text>
</NumberedItem>
<Heading>
<Text id="0248">Installing the Greenstone language pack (2.62 and earlier)</Text>
</Heading>
<Comment>
<Text id="0249">If you go to the Preferences page of any Greenstone collection, and look at the <b>Interface language</b> menu, you will probably find that only English, Spanish, French and Russian interfaces are installed.</Text>
</Comment>
<NumberedItem>
<Text id="0250">Locate the Greenstone Language Pack (glp-x.xx.exe/glp-x.xx-linux.bin/gli-x.xx-macOSx.command). This may be on the CD-ROM from which you installed Greenstone, or you may have to download it from <Link>http://www.greenstone.org</Link>. </Text>
</NumberedItem>
<NumberedItem>
<Text id="0251">Run the executable file (double click it on Windows); this will start the installer. Accept all the defaults</Text>
</NumberedItem>
<NumberedItem>
<Text id="0252f">Restart the Greenstone Digital Library and look at the interface language menu again. Now you should see about 40 different languages.</Text>
</NumberedItem>
<Heading>
<Text id="0252z">Enabling other languages (2.63 and later)</Text>
</Heading>
<Comment>
<Text id="0252y">If you have downloaded Greenstone from the web, then all the laguanges will be enabled by default. However, if you have installed Greenstone from a UNESCO CD-ROM, then only English, French, Spanish and Russian will be enabled.</Text>
</Comment>
<NumberedItem>
<Text id="0252x">To enable a new language, edit the file <Path>greenstone &rarr;etc &rarr;main.cfg</Path>. Look for the appropriate <AutoText text="Language" type="quoted"/> line, and uncomment it (i.e. remove the # from the start). Check that the required encoding is also enabled.</Text>
<Text id="0252w">For example, suppose that we want to enable Turkish. The <AutoText text="Language" type="quoted"/> line for Turkish looks like:</Text>
<Format>#Language shortname=tr longname=Turkish default_encoding=windows-1254</Format>
<Text id="0252v">To enable it, we remove the #, i.e. make it look like:</Text>
<Format>Language shortname=tr longname=Turkish default_encoding=windows-1254</Format>
<Text id="0252p">The default encoding for Turkish is windows-1254. So we look for the windows-1254 Encoding line:</Text>
<Format>Encoding shortname=windows-1254 "longname=Turkish (Windows-1254)" map=win1254.ump</Format>
<Text id="0252u">This is already enabled (no # at the start) so we don't need to do anything else.</Text>
</NumberedItem>
<Heading>
<Text id="0252a">Installing the Classic Interface Pack (2.63 and later)</Text>
</Heading>
<Comment>
<Text id="0252b">Greenstone now comes with all languages enabled. 
The generated HTML uses text + CSS rather than images for navigation bar, 
home, help, preferences buttons etc. The classic interface pack is not needed if you want to use Greenstone in another language. It is only needed if you want to revert back to the old style HTML with text images. This may be useful if you have customized your Greenstone, or if you require compatibility with Netscape 4.</Text>
</Comment>
<NumberedItem>
<Text id="0252c">Locate the Classic Interface Pack (gcip-x.xx.zip). This may be on the CD-ROM from which you installed Greenstone, or you may have to download it from <Link>http://www.greenstone.org</Link>. </Text>
</NumberedItem>
<NumberedItem>
<Text id="0252d">The classic interface pack is a zip file containing the old text images, such as classifier buttons. Unzip the zip file into the images directory of your Greenstone installation.</Text>
</NumberedItem>
<NumberedItem>
<Text id="1252e">Enable the use of the old-style macros by editing <Path>greenstone &rarr; etc &rarr; main.cfg</Path>: replace <AutoText text="nav_css.dm" type="quoted"/> with <AutoText text="nav_ns4.dm" type="quoted"/> in the <AutoText text="macrofiles" type="quoted"/> list.</Text>
</NumberedItem>
<NumberedItem>
<Text id="0252">Restart the Greenstone Digital Library. It should now be using the old text images.</Text>
</NumberedItem>
</Content>
</Tutorial>
<Tutorial id="small_html_collection">
<Title>
<Text id="0253">Building a small collection of HTML files</Text>
</Title>
<SampleFiles folder="hobbits"/>
<Version initial="2.60" current="2.70"/>
<Content>
<Comment>
<Text id="0254">You will need some HTML files, such as those in the <Path>hobbits</Path> folder in <Path>sample_files</Path>.</Text>
</Comment>
<NumberedItem>
<Text id="0255">Start the Greenstone Librarian Interface:</Text>
<Menu>
<Text id="0255a">Start &rarr; All Programs &rarr; Greenstone Digital Library Software v2.70 &rarr; Greenstone Librarian Interface</Text>
</Menu> 
<Comment>
<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>
</Comment>
</NumberedItem>
<NumberedItem>
<Text id="0257">Start a new collection within the Librarian Interface:</Text>
<Menu><AutoText key="glidict::Menu.File"/> &rarr; <AutoText key="glidict::Menu.File_New"/></Menu>
</NumberedItem>
<NumberedItem>
<Text id="0260">You will create a collection based on a few HTML web pages that describe some Hobbits in <i>Lord of the Rings</i>.</Text>
<Text id="0261">A window pops up. Fill it out with appropriate values&mdash;for example,</Text>
<Indent>
<Text id="0261a">Collection Title: About Hobbits<br/></Text>
<Text id="0261b">Description of Content: A collection about hobbits.</Text>
</Indent>
<Text id="0262">Leave the setting for <AutoText key="glidict::NewCollectionPrompt.Base_Collection"/> at its default: <AutoText key="glidict::NewCollectionPrompt.NewCollection"/>, and click <AutoText key="glidict::General.OK" type="button"/>.</Text>
</NumberedItem>
<NumberedItem>
<Text id="0263">Another window pops up, from which you select the metadata set (or sets) to use. This is discussed in other exercises. For now, select <b>Dublin Core Metadata Element Set Version 1.1</b> followed by <AutoText key="glidict::General.OK" type="button"/>.</Text>
<Comment>
<Text id="0263a">If this is the first time you have opened a collection in the Librarian Interface, two popup progress bars will appear, to show progress while loading plugins and classifiers.</Text>
</Comment>
</NumberedItem>
<NumberedItem>
<Text id="0264">Next you must gather together the files that will constitute the collection. A suitable set has been prepared ahead of time in <Path>sample_files</Path> in the folder <Path>hobbits</Path>. Using the left-hand side of the Librarian Interface's <AutoText key="glidict::GUI.Gather"/> panel, interactively navigate to the <Path>sample_files</Path> folder.</Text>
</NumberedItem>
<NumberedItem>
<Text id="0265">Now drag the <Path>hobbits</Path> folder from the left-hand side and drop it on the right. The progress bar at the bottom shows some activity. Gradually, duplicates of all the files will appear in the collection panel.</Text>
<Comment>
<Text id="0266">You can inspect the files that have been copied by double-clicking on the folder in the right-hand side.</Text>
</Comment>
</NumberedItem>
<NumberedItem>
<Text id="0267">Since this is our first collection, we won't complicate matters by manually assigning metadata or altering the collection's design. Instead we rely on default behaviour. So pass directly to the <AutoText key="glidict::GUI.Create"/> panel by clicking its tab.</Text>
</NumberedItem>
<NumberedItem>
<Text id="0268">To start building the collection, click the <AutoText key="glidict::CreatePane.Build_Collection" type="button"/> button.</Text>
</NumberedItem>
<NumberedItem>
<Text id="0269">Once the collection has built successfully, a window pops up to confirm this. Click <AutoText key="glidict::General.OK" type="button"/>.</Text>
</NumberedItem>
<NumberedItem>
<Text id="0270">Click the <AutoText key="glidict::CreatePane.Preview_Collection" type="button"/> button to look at the end result. This loads the relevant page into your web browser (starting it up if necessary). Look around the collection and learn about Hobbits!</Text>
</NumberedItem>
<NumberedItem>
<Text id="0271">Back in the Librarian Interface, click the <AutoText key="glidict::GUI.Enrich"/> tab to view the metadata associated with the documents in the collection.</Text>
</NumberedItem>
<NumberedItem>
<Text id="0272">Presently there is no manually assigned metadata, but the act of building the collection has extracted metadata from the documents. Double click the <Path>hobbits</Path> folder to expand its content. Then single-click <Path>bilbo.html</Path> to display all its metadata in the right-hand side of the panel. The initial fields, starting <AutoText text="dc." type="quoted"/>, are empty. These are Dublin Core metadata fields (we asked you to include this metadata set when the collection was initially formed) for manually entered data.</Text>
</NumberedItem>
<NumberedItem>
<Text id="0273">Use the scroll bar on the extreme right to view the bottom part of the list. There you will see fields starting <AutoText text="ex." type="quoted"/> that express the extracted metadata: for example <AutoText key="metadata::ex.Title"/>, based on the text within the HTML Title tags, and <AutoText key="metadata::ex.Language"/>, the document's language (represented using the ISO standard 2-letter mnemonic) which Greenstone determines by analysing the document's text.</Text>
</NumberedItem>
<NumberedItem>
<Text id="0274">Close the collection by clicking <Menu><AutoText key="glidict::Menu.File"/> &rarr; <AutoText key="glidict::Menu.File_Close"/></Menu>. This automatically saves the collection to disk.</Text>
</NumberedItem>
<Heading>
<Text id="0277">Setting up a shortcut in the Librarian interface</Text>
</Heading>
<NumberedItem>
<Text id="0278">To set up a shortcut to the source files, in the <AutoText key="glidict::GUI.Gather"/> panel navigate to the folder in your local file space that contains the files you want to use&mdash;in our case, the <Path>sample_files</Path> folder. Select this folder and then right-click it. Follow the instructions to set up a shortcut. Close all the folders in the file tree and you will see the shortcut to your source files in the left-hand pane of the <AutoText key="glidict::GUI.Gather"/> panel.</Text>
</NumberedItem>
</Content>
</Tutorial>
<Tutorial id="word_PDF_collection">
<Title>
<Text id="0279">A collection of Word and PDF files</Text>
</Title>
<SampleFiles folder="Word_and_PDF"/>
<Version initial="2.60" current="2.70"/>
<Content>
<Comment>
<Text id="0280">You will need some source files like those in the <Path>sample_files &rarr; Word_and_PDF</Path> folder.</Text>
</Comment>
<NumberedItem>
<Text id="0281">Start a new collection called <b>reports</b>, fill out appropriate fields for it, and choose Dublin Core as the metadata set.</Text>
</NumberedItem>
<NumberedItem>
<Text id="0282">Copy the 12 files from <Path>sample_files &rarr; Word_and_PDF &rarr; Documents</Path> into the collection. You can select multiple files by clicking on the first one and shift-clicking on the last one, and drag them all across together. (This is the normal technique of multiple selection.)</Text>
</NumberedItem>
<NumberedItem>
<Text id="0287">Switch to the <AutoText key="glidict::GUI.Create"/> panel, and <b>build</b> and <b>preview</b> the collection.</Text>
</NumberedItem>
<NumberedItem>
<Text id="0288">Again, this collection contains no manually assigned metadata. All the information that appears&mdash;title and filename&mdash;is extracted automatically from the documents themselves. Because of this the quality of some of the title metadata is suspect.</Text>
</NumberedItem>
<NumberedItem>
<Text id="0289">Back in the Librarian Interface, click the <AutoText key="glidict::GUI.Enrich"/> tab to view the automatically extracted metadata. You will need to scroll down to see the extracted metadata, which begins with <AutoText text="ex." type="quoted"/>. The PostScript documents (<Path>cluster.ps</Path> and <Path>langmodl.ps</Path> do not have extracted titles: what appears in the <i>titles a-z</i> list is just the first few characters of the document).</Text>
</NumberedItem>
<Heading>
<Text id="0290">Manually adding metadata to documents in a collection</Text>
</Heading>
<NumberedItem>
<Text id="0291">In the <AutoText key="glidict::GUI.Enrich"/> panel, manually add Dublin Core <AutoText key="metadata::dc.Title"/> metadata to one of these documents. Select <Path>word03.doc</Path> and double-click to open it. Copy the title of this document (<AutoText text="Greenstone: A comprehensive open-source digital library software system" type="quoted"/>) and return to the Librarian Interface. Scroll up or down in the metadata table until you can see <AutoText key="metadata::dc.Title"/>. Click in the value box, paste in the metadata and press <b>Enter</b>. </Text>
</NumberedItem>
<NumberedItem>
<Text id="0292">Now add <AutoText key="metadata::dc.Creator"/> information for the same document. You can add more than one value for the same field: when you press <b>Enter</b> in a metadata value field, a new empty field of the same type will be generated.</Text>
</NumberedItem>
<NumberedItem>
<Text id="0292a">Close the document when you have finished copying metadata from it. External programs opened when viewing documents must be closed before building the collection, otherwise errors can occur.</Text>
</NumberedItem>
<NumberedItem>
<Text id="0293">Next add title and creator metadata for a few of the other documents.</Text>
</NumberedItem>
<Comment>
<Text id="0294">If you build and preview your collection at this point, you will find that nothing has changed. You need to alter the collection design to use the new Dublin Core metadata instead of the original extracted metadata.</Text>
</Comment>
<Heading>
<Text id="0295">Collection design; branding a collection with an image</Text>
</Heading>
<NumberedItem>
<Text id="0296">Change to the <AutoText key="glidict::GUI.Design"/> panel, which is split into several sections. The first section <AutoText key="glidict::CDM.GUI.General"/> appears. This allows you to modify the values you provided when defining the collection, if desired. You can also brand the collection using a suitable image.</Text>
</NumberedItem>
<NumberedItem>
<Text id="0297">Click on the <AutoText key="glidict::General.Browse" type="button"/> button associated with <AutoText key="glidict::CDM.General.Icon_Collection"/>, and browse to the image <Path>sample_files &rarr; Word_and_PDF &rarr; wrdpdf.gif</Path> on your computer. When you select this image, Greenstone automatically generates an appropriate URL for the image. <b>Preview</b> the collection.</Text>
</NumberedItem>
<NumberedItem>
<Text id="0301">If you are on the web, you can easily make your own Greenstone-style icon by going to</Text>
<Link>http://www.greenstone.org/make-images.html</Link>
<Text id="0302">and following the instructions there.</Text>
</NumberedItem>
<Heading>
<Text id="0303">Document plugins</Text>
</Heading>
<NumberedItem>
<Text id="0304">Now look at the <AutoText key="glidict::CDM.GUI.Plugins"/> section, by clicking on this in the list to the left. Here you can add, configure or remove plugins to be used in the collection. There is no need to remove any plugins, but it will speed up processing a little. In this case we have only Word, PDF, RTF, and PostScript documents, and can remove the ZIPPlug, TEXTPlug, HTMLPlug, EMAILPlug, ImagePlug, ISISPlug and NULPlug plugins. To delete a plugin, select it and click <AutoText key="glidict::CDM.PlugInManager.Remove" type="button"/>. GAPlug is required for any type of source collection and should not be removed. </Text>
</NumberedItem>
<Heading>
<Text id="0305">Search types and fielded searching</Text>
</Heading>
<NumberedItem>
<Text id="0306">Go to the <AutoText key="glidict::CDM.GUI.SearchTypes"/> section. This specifies what kind of search interface and what search indexes will be provided for the collection. Let's add a form search option. Click <AutoText key="glidict::CDM.SearchTypeManager.Enable"/>; this allows form searching to be added to the collection.</Text>
</NumberedItem>
<NumberedItem>
<Text id="0307">To include "form search" as well as the default "plain search", pull down the <AutoText key="glidict::CDM.SearchTypeManager.SearchType_Selection"/> menu and select <AutoText text="form"/>; then click <AutoText key="glidict::CDM.SearchTypeManager.Add" type="button"/>.</Text>
<Text id="0308">Plain search will be the default search type as it is first in the list.</Text>
</NumberedItem>
<Heading>
<Text id="0309">Search indexes</Text>
</Heading>
<NumberedItem>
<Text id="0310">The next step in the <AutoText key="glidict::GUI.Design"/> panel is <AutoText key="glidict::CDM.GUI.Indexes"/>. These specify what parts of the collection are searchable (e.g. searching by title and author). Delete the <AutoText key="metadata::ex.Title"/> and <AutoText key="metadata::ex.Source"/> indexes, which are not particularly useful, by selecting them one at a time and clicking <AutoText key="glidict::CDM.IndexManager.Remove_Index" type="button"/>. Only the <i>text</i> index remains.</Text>
</NumberedItem>
<NumberedItem>
<Text id="0311">Now add a Title index based on <AutoText key="metadata::dc.Title"/> by providing an <b>Index Name</b> (e.g. "Document Title") and selecting <AutoText key="metadata::dc.Title"/> from the <b>Index Source</b> box. Then click <AutoText key="glidict::CDM.IndexManager.Add_Index" type="button"/>.</Text>
</NumberedItem>
<NumberedItem>
<Text id="0312">You can add indexes based on any metadata. Add an index called "Authors" based on <AutoText key="metadata::dc.Creator"/> metadata.</Text>
</NumberedItem>
<Comment>
<Text id="0313">The next two sections are <AutoText key="glidict::CDM.GUI.Subcollections"/> and <AutoText key="glidict::CDM.GUI.SuperCollection"/>. In this exercise, we will not make any changes to these.</Text>
</Comment>
<Heading>
<Text id="0314">Browsing classifiers</Text>
</Heading>
<NumberedItem>
<Text id="0315">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 classifiers, <i>AZLists</i> based on <AutoText key="metadata::ex.Title"/> and <AutoText key="metadata::ex.Source"/> metadata. Remove both of these by selecting them in turn and clicking <AutoText key="glidict::CDM.ClassifierManager.Remove" type="button"/>.</Text>
</NumberedItem>
<NumberedItem>
<Text id="0316">Now we add an <i>AZList</i> classifier for <AutoText key="metadata::dc.Title"/> metadata. Select <i>AZList</i> from the <AutoText key="glidict::CDM.ClassifierManager.Classifier"/> drop-down list and click <AutoText key="glidict::CDM.ClassifierManager.Add" type="button"/>.</Text>
</NumberedItem>
<NumberedItem>
<Text id="0317">A popup window <AutoText key="glidict::CDM.ArgumentConfiguration.Title"/> appears. Select <AutoText key="metadata::dc.Title"/> from the <AutoText text="metadata"/> drop-down list and click <AutoText key="glidict::General.OK" type="button"/>.</Text>
</NumberedItem>
<NumberedItem>
<Text id="0318">Now add an <AutoText text="AZCompactList"/> classifier. Click <AutoText key="glidict::CDM.ClassifierManager.Add" type="button"/> and configure it to use <AutoText key="metadata::dc.Creator"/> metadata, with button name "Creator". Click <AutoText key="glidict::General.OK" type="button"/>.</Text>
<Comment>
<Text id="0319">The last three sections are <AutoText key="glidict::CDM.GUI.Formats"/>, <AutoText key="glidict::CDM.GUI.Translation"/> and <AutoText key="glidict::CDM.GUI.MetadataSets"/>. In this exercise, we will not make any changes to these.</Text>
</Comment>
</NumberedItem>
<NumberedItem>
<Text id="0320">Switch to the <AutoText key="glidict::GUI.Create"/> panel, and <b>build</b> and <b>preview</b> the collection.</Text>
</NumberedItem>
<NumberedItem>
<Text id="0321">Check that all the facilities work properly. There should be three full-text indexes, called <i>text</i>, <i>Document Title</i>, and <i>Authors</i>. In the <i>titles a-z</i> list should appear all the documents to which you have assigned <AutoText key="metadata::dc.Title"/> metadata (and only those documents). In the <i>authors a-z</i> list should appear 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>
</NumberedItem>
<Comment>
<Text id="0322">At this point you might like to publish the collection on CD-ROM, See <TutorialRef id="export_to_CDROM"/> for how to do this.</Text>
</Comment>
</Content>
</Tutorial>
<Tutorial id="difficult_PDF_collection">
<Title>
<Text id="0323">Difficult PDF documents</Text>
</Title>
<SampleFiles folder="difficult_documents"/>
<Version initial="2.60" current="2.70"/>
<Content>
<NumberedItem>
<Text id="0324">Build a fresh Greenstone collection from the two files in <Path>sample_files &rarr; difficult_documents.</Path> Use the default collection configuration: that is, simply gather the files into a new collection, and build it.</Text>
<Comment>
<Text id="0325">These files are called <Path>No extractable text.pdf</Path> and <Path>Weird characters.pdf</Path>&mdash;their names hint at the problems they will cause!</Text>
</Comment>
</NumberedItem>
<NumberedItem>
<Text id="0326">Now preview the collection. The titles and filenames lists show only one of the documents. When you click the "text" icon to look at the text extracted from that document, it's garbage. During the building process this message appeared: "One document was processed and included in the collection; one was rejected."</Text>
</NumberedItem>
<Heading>
<Text id="0333">Modes in the Librarian Interface</Text>
</Heading>
<Comment>
<Text id="0334">The Librarian Interface can operate in different modes. So far, you have been using the default mode, called <AutoText key="glidict::Preferences.Mode.Librarian"/>. </Text>
</Comment>
<NumberedItem>
<Text id="0335">Use the <AutoText key="glidict::Menu.File_Options"/> item on the <AutoText key="glidict::Menu.File"/> menu to switch to <AutoText key="glidict::Preferences.Mode.Expert"/> mode and then build the collection again. The <AutoText key="glidict::GUI.Create"/> panel looks different in <AutoText key="glidict::Preferences.Mode.Expert"/> mode because it gives more options: locate the <AutoText key="glidict::CreatePane.Build_Collection" type="button"/> button, near the bottom of the window, and click it. Now a message appears saying that the file could not be processed, and why.</Text>
</NumberedItem>
<NumberedItem>
<Text id="0336">We recommend that you switch back to <AutoText key="glidict::Preferences.Mode.Librarian"/> mode for subsequent exercises, to avoid confusion.</Text>
</NumberedItem>
<Heading>
<Text id="0336a">Improved PDF Conversion with Ghostscript</Text>
</Heading>
<Comment>
<Text id="0336b">If you have Ghostscript installed, then you can use a new method of handling these difficult PDF documents. Ghostscript is a program that can convert Postscript and PDF files to other formats. You can download it from <Link>http://www.cs.wisc.edu/~ghost/</Link> (follow the link to the current stable release).</Text>
</Comment>
<NumberedItem>
<Text id="0327">Greenstone can convert PDF files into a series of images with a corresponding file that details how they are composed into the complete document (called an <AutoText text="item" type="quoted"/> file). For this part of the exercise, ImageMagick also needs to be installed (see <TutorialRef id="install_greenstone"/>).</Text>
</NumberedItem>
<NumberedItem>
<Text id="0328">In the <AutoText key="glidict::CDM.GUI.Plugins"/> list in the <AutoText key="glidict::GUI.Design"/> panel, double-click <AutoText text="PDFPlug"/> to pop up a window that shows its settings, and set the <AutoText text="convert_to"/> option to <AutoText text="pagedimg_gif"/>.</Text>
</NumberedItem>
<NumberedItem>
<Text id="0329"><b>Build</b> the collection and <b>preview</b> it. Both PDF documents have been processed and divided into pages, but each page displays <AutoText key="perlmodules::BasPlug.dummy_text" type="quoted"/> because when converting PDF documents to images, no text is extracted.</Text>
</NumberedItem>
<NumberedItem>
<Text id="0330">In order to view the documents properly we need to modify a format statement. In the <AutoText key="glidict::CDM.GUI.Formats"/> section on the <AutoText key="glidict::GUI.Design"/> panel, select the <AutoText text="DocumentText"/> format statement. Replace <Format>[Text]</Format> with <Format>[srcicon]</Format> and click <AutoText key="glidict::CDM.FormatManager.Replace" type="button"/>.</Text>
</NumberedItem>
<NumberedItem>
<Text id="0332"><b>Preview</b> the collection from the <AutoText key="glidict::GUI.Create"/> panel. (There is no need to build it). Images from the documents are now displayed instead of the extracted text. Both <Path>No extractable text.pdf</Path> and <Path>Weird characters.pdf</Path> display nicely now. </Text>
</NumberedItem>
</Content>
</Tutorial>
<Tutorial id="simple_image_collection">
<Title>
<Text id="0337">A simple image collection</Text>
</Title>
<SampleFiles folder="images"/>
<Version initial="2.60" current="2.70"/>
<Content>
<NumberedItem>
<Text id="0338">Start a new collection (<Menu><AutoText key="glidict::Menu.File"/> &rarr; <AutoText key="glidict::Menu.File_New"/></Menu>) called <b>backdrop</b>. Fill out the fields with appropriate information. For <AutoText key="glidict::NewCollectionPrompt.Base_Collection"/>, select the item <b>Simple image collection (image-e)</b> from the pull-down menu.</Text>
<Comment>
<Text id="0340">Greenstone does not ask you to choose a metadata set because the new collection inherits whatever is used by the base collection.</Text>
</Comment>
</NumberedItem>
<NumberedItem>
<Text id="0341">Copy the images provided in <Path>sample_files &rarr; images</Path> into your newly-formed collection.</Text>
</NumberedItem>
<NumberedItem>
<Text id="0342">Change to the <AutoText key="glidict::GUI.Create"/> panel and <b>build</b> the collection.</Text>
</NumberedItem>
<NumberedItem>
<Text id="0343"><b>Preview</b> the result.</Text>
</NumberedItem>
<NumberedItem>
<Text id="0344">Click <AutoText key="coredm::_Global:labelBrwse_"/> 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>
</NumberedItem>
<NumberedItem>
<Text id="0345">Change to the <AutoText key="glidict::GUI.Enrich"/> panel and view the extracted metadata for <Path>Ascent.jpg</Path>.</Text>
</NumberedItem>
<Comment>
<Text id="0346">We now add our own metadata and use it to give users a new way to browse the collection. We use the Dublin Core metadata set.</Text>
</Comment>
<Heading>
<Text id="0347">Adding a metadata set to the collection</Text>
</Heading>
<NumberedItem>
<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 <AutoText key="glidict::GUI.Design"/> panel of the Librarian Interface and click <AutoText key="glidict::CDM.GUI.MetadataSets"/> in the list on the left (the last one). Then click  <AutoText key="glidict::CDM.MetadataSetManager.Add" type="button"/> (lower left button).</Text>
</NumberedItem>
<NumberedItem>
<Text id="0349">In the window that pops up, select <AutoText text="dublin.mds"/> and click <AutoText key="glidict::CDM.MetadataSetManager.Chooser.Add" type="button"/>.</Text>
</NumberedItem>
<Heading>
<Text id="0350">Adding Title metadata</Text>
</Heading>
<NumberedItem>
<Text id="0351">Now switch to the <AutoText key="glidict::GUI.Enrich"/> panel by clicking this tab. The metadata for each file now shows the Dublin core <AutoText text="dc."/> fields as well as the extracted <AutoText text="ex."/> fields.</Text>
</NumberedItem>
<NumberedItem>
<Text id="0352">We work with just the first three files (<Path>Ascent.jpg</Path>, <Path>Autumn.jpg</Path> and <Path>Azul.jpg</Path>) to get a flavour of what is possible. First, set each file's <AutoText key="metadata::dc.Title"/> field to be the same as its filename but without the filename extension.</Text>
</NumberedItem>
<NumberedItem>
<Text id="0353">Click on <Path>Ascent.jpg</Path> so its metadata fields are available, then click on its <AutoText key="metadata::dc.Title"/> field on the right-hand side. Type in <b>Ascent</b>, and click <b>Enter</b>.</Text>
</NumberedItem>
<Comment>
<Text id="0354">The <AutoText key="glidict::EnrichPane.ExistingValues" args="..."/> box will become more useful when more entries have been added.</Text>
</Comment>
<NumberedItem>
<Text id="0355">Repeat the process for <b>Autumn.jpg</b> and <b>Azul.jpg</b>.</Text>
</NumberedItem>
<Comment>
<Text id="0356">Now we customize the collection's appearance. Building or previewing the collection at this point won't reveal anything new. That's because we haven't changed the design of the collection to take advantage of the new metadata.</Text>
</Comment>
<Heading>
<Text id="0357">Change Format Features to display new metadata</Text>
</Heading>
<NumberedItem>
<Text id="0358">Go to the <AutoText key="glidict::GUI.Design"/> panel and select <AutoText key="glidict::CDM.GUI.Formats"/> from the left-hand list. Leave the feature selection controls at their default values, so that <AutoText key="glidict::CDM.FormatManager.Feature"/> remains blank and <AutoText text="VList" /> is selected as the <AutoText key="glidict::CDM.FormatManager.Part"/>. In the <AutoText key="glidict::CDM.FormatManager.Editor"/>, edit the text as follows:</Text>
<Indent>
<Text id="0359">Change "_ImageName_:" to "Title:" <br/> Change "[Image]" to "[dc.Title]"</Text>
</Indent>
<Comment>
<Text id="0360">Metadata names are case-sensitive in Greenstone: it is important that you capitalize "Title" (and don't capitalize "dc").</Text>
</Comment>
</NumberedItem>
<NumberedItem>
<Text id="0361">Next click <AutoText key="glidict::CDM.FormatManager.Replace" type="button"/>. The first of the above changes alters the fragment of text that appears to the right of the thumbnail image, the second alters the item of metadata that follows it.</Text>
</NumberedItem>
<NumberedItem>
<Text id="0362">Go to the <AutoText key="glidict::GUI.Create"/> panel and click <AutoText key="glidict::CreatePane.Build_Collection" type="button"/>. Now <b>preview</b> the collection. When you click on <AutoText key="coredm::_Global:labelBrwse_"/> in the navigation bar the presentation has changed to "Title: Ascent" and so on.</Text>
</NumberedItem>
<Comment>
<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>
</Comment>
<Comment>
<Text id="0364">For some design parameters the collection must be rebuilt before the effect of changes can be seen. However, changes to format statements take place immediately and you can see the result straightaway by clicking <b>reload</b> (or <b>refresh</b>) in the web browser.</Text>
</Comment>
<Heading>
<Text id="0365">Changing the size of image thumbnails</Text>
</Heading>
<NumberedItem>
<Text id="0366">Thumbnail images are created by the <AutoText text="ImagePlug"/> plug-in, so we need to access its configuration settings. To do this, switch to the <AutoText key="glidict::GUI.Design"/> panel and select <AutoText key="glidict::CDM.GUI.Plugins"/> from the list on the left. Double-click <AutoText text="plugin ImagePlug"/> to pop up a window that shows its settings. (Alternatively, select <AutoText text="plugin ImagePlug"/> with a single click and then click <AutoText key="glidict::CDM.PlugInManager.Configure" type="button"/> further down the screen). Currently all options are off, so standard defaults are used. Select <AutoText text="thumbnailsize"/>, set it to <AutoText text="50"/>, and click <AutoText key="glidict::General.OK" type="button"/>.</Text>
</NumberedItem>
<NumberedItem>
<Text id="0367"><b>Build</b> and <b>preview</b> the collection.</Text>
</NumberedItem>
<NumberedItem>
<Text id="0368">Once you have seen the result of the change, return to the <AutoText key="glidict::GUI.Design"/> panel, select the configuration options for <AutoText text="ImagePlug"/>, and switch the <AutoText text="thumbnailsize"/> option off so that the thumbnail reverts to its normal size when the collection is re-built.</Text>
</NumberedItem>
<Comment>
<Text id="0369">Now add metadata that describes the photos in the collection. Again, for illustration, we focus on the first three images (<Path>Ascent.jpg</Path>, <Path>Autumn.jpg</Path> and <Path>Azul.jpg</Path>).</Text>
</Comment>
<Heading>
<Text id="0370">Adding Description metadata</Text>
</Heading>
<NumberedItem>
<Text id="0371">Switch to the <AutoText key="glidict::GUI.Enrich"/> panel and select <Path>Ascent.jpg</Path>. We'll store our description in the <AutoText key="metadata::dc.Description"/> metadata element, so select it now in the right-hand panel.</Text>
</NumberedItem>
<Comment>
<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>
</Comment>
<NumberedItem>
<Text id="0373">Back in the Librarian Interface enter the text <b>Moon rising over mountain landscape</b> as the <AutoText key="metadata::dc.Description"/> field's value and click <b>Enter</b> to have it added.</Text>
</NumberedItem>
<NumberedItem>
<Text id="0374">Repeat this process for <Path>Autumn.jpg</Path> and <Path>Azul.jpg</Path>, adding a suitable description for each.</Text>
</NumberedItem>
<NumberedItem>
<Text id="0375">Build the collection again, to incorporate the new metadata.</Text>
</NumberedItem>
<NumberedItem>
<Text id="0376">Now update the format statement to use the new <AutoText key="metadata::dc.Description"/> metadata. Switch back to the <AutoText key="glidict::CDM.GUI.Formats"/> section of the <AutoText key="glidict::GUI.Design"/> panel, and ensure the <AutoText key="glidict::CDM.FormatManager.Feature"/> box is blank, and <AutoText text="VList" /> is selected in the <AutoText key="glidict::CDM.FormatManager.Part"/> box. In the <AutoText key="glidict::CDM.FormatManager.Editor"/>, place your cursor after the text that says</Text>
<Format>[dc.Title]&lt;br&gt;</Format> 
</NumberedItem>
<NumberedItem>
<Text id="0377">and add the following text:</Text>
<Format>Description: [dc.Description]&lt;br&gt;</Format> 
</NumberedItem>
<NumberedItem>
<Text id="0378">Then click <AutoText key="glidict::CDM.FormatManager.Replace" type="button"/>.</Text>
</NumberedItem>
<NumberedItem>
<Text id="0379"><b>Preview</b> the result (you don't need to build the collection as was done in step 22 to incorporate the metadata, because changes to format statements take effect immediately). Each image's description should appear beside the thumbnail, following the title.</Text>
</NumberedItem>
<Heading>
<Text id="0380">Adding a browsing classifier based on Description metadata</Text>
</Heading>
<NumberedItem>
<Text id="0381">Switch to the <AutoText key="glidict::GUI.Design"/> panel and select <AutoText key="glidict::CDM.GUI.Classifiers"/> from the left-hand list. Set the menu item for <AutoText key="glidict::CDM.ClassifierManager.Classifier"/> to <AutoText text="AZList" />; then click <AutoText key="glidict::CDM.ClassifierManager.Add" type="button"/>.</Text>
</NumberedItem>
<NumberedItem>
<Text id="0382">A window pops up to control the classifier's options. Set the menu item for metadata to <AutoText key="metadata::dc.Description"/> and click <AutoText key="glidict::General.OK" type="button"/>. Now switch to the <AutoText key="glidict::GUI.Create"/> panel, <b>build</b> the collection, and <b>preview</b> it. Choose the new <b>descriptions</b> link that appears in the navigation bar.</Text>
</NumberedItem>
<Comment>
<Text id="0383">Only three items are shown, because only items with the relevant metadata (dc.Description in this case) appear in the list. The original browse list includes all photos in the collection because it is based on <AutoText key="metadata::ex.Image"/>, extracted metadata that reflects an image's filename, which is set for all images in the collection.</Text>
</Comment>
<Heading>
<Text id="0384">Creating a searchable index based on Description metadata</Text>
</Heading>
<NumberedItem>
<Text id="0385">Switch to the <AutoText key="glidict::GUI.Design"/> panel and select <AutoText key="glidict::CDM.GUI.Indexes"/> from the left-hand list. Enter the text "descriptions" as the <AutoText key="glidict::CDM.IndexManager.Index_Name"/>, select <AutoText key="metadata::dc.Description"/> and click <AutoText key="glidict::CDM.IndexManager.Add_Index" type="button"/>.</Text>
</NumberedItem>
<NumberedItem>
<Text id="0386">Switch to the <AutoText key="glidict::GUI.Create"/> 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>
</NumberedItem>
</Content>
</Tutorial>
<Tutorial id="large_html_collection">
<Title>
<Text id="0387">A large collection of HTML files&mdash;Tudor</Text>
</Title>
<SampleFiles folder="tudor"/>
<Version initial="2.60" current="2.70"/>
<Content>
<NumberedItem>
<Text id="0388">Invoke the Greenstone Librarian Interface (from the Windows <i>Start</i> menu) and start a new collection called <b>tudor</b> (use the <AutoText key="glidict::Menu.File"/> menu). Fill out the pop-up dialog with appropriate values and leave <b>Dublin Core</b>, which is selected by default, as the metadata set.</Text>
</NumberedItem>
<NumberedItem>
<Text id="0389">In the <AutoText key="glidict::GUI.Gather"/> panel, open the <Path>tudor</Path> folder in <Path>sample_files</Path>.</Text>
</NumberedItem>
<NumberedItem>
<Text id="0390">Drag <Path>englishhistory.net</Path> from the left-hand side to the right to include it in your <b>tudor</b> collection.</Text>
</NumberedItem>
<NumberedItem>
<Text id="0391">Switch to the <AutoText key="glidict::GUI.Create"/> panel and click <AutoText key="glidict::CreatePane.Build_Collection" type="button"/>.</Text>
</NumberedItem>
<NumberedItem>
<Text id="0392">When building has finished, <b>preview</b> the collection.</Text>
</NumberedItem>
<NumberedItem>
<Text id="0393">The browsing facilities in this collection (<i>titles a-z</i> and <i>filenames</i>) are based entirely on extracted metadata. Return to the Librarian Interface and examine the metadata that has been extracted for some of the files.</Text>
</NumberedItem>
<Comment>
<Text id="0394">You've probably noticed that the collection contains a few stray image files, as well as the HTML documents. This is a mistake. The issue is that many of the HTML documents include images, and although Greenstone attempts to determine which images belong to HTML pages and only considers other images for inclusion in the collection, in this case it hasn't been completely successful. (This is because the web site from which these files were downloaded occasionally departs from the usual convention of hierarchical structuring.)</Text>
</Comment>
<NumberedItem>
<Text id="0395">Switch to the <AutoText key="glidict::GUI.Design"/> panel and select the <AutoText key="glidict::CDM.GUI.Plugins"/> section. Beside <AutoText text="plugin HTMLPlug"/> you will see <AutoText text="-smart_block"/>. This is the option that attempts to identify images in the HTML pages and block them from inclusion&mdash;in this case, it's not smart enough! Select the <AutoText text="plugin HTMLPlug"/> line and click <AutoText key="glidict::CDM.PlugInManager.Configure" type="button"/>. A popup window appears. Scroll down the page to locate the <AutoText text="smart_block"/> option and switch it off. Click <AutoText key="glidict::General.OK" type="button"/>.</Text>
</NumberedItem>
<NumberedItem>
<Text id="0396">Switch to the <AutoText key="glidict::GUI.Create"/> panel and <b>build</b> and <b>preview</b> the collection. The collection is exactly as before except that these stray images are suppressed. What is happening is that plug-ins operate as a pipeline: files are passed to each one in turn until one is found that can process it. By default (i.e. without <AutoText text="smart_block"/>) the HTML plug-in blocks <i>all</i> images, which is appropriate for this collection.</Text>
</NumberedItem>
<Heading>
<Text id="0397">Looking at different views of the files in the Gather and Enrich panels</Text>
</Heading>
<NumberedItem>
<Text id="0398">Switch to the <AutoText key="glidict::GUI.Gather"/> panel and in the right-hand side open <Path>englishhistory.net &rarr; tudor</Path>.</Text>
</NumberedItem>
<NumberedItem>
<Text id="0400">Change the <AutoText key="glidict::Filter.Filter_Tree"/> menu for the right-hand side from <AutoText key="glidict::Filter.All_Files"/> to <AutoText key="glidict::Filter.0"/>. Notice the files displayed above are filtered accordingly, to show only files of this type.</Text>
</NumberedItem>
<NumberedItem>
<Text id="0401">Change the <AutoText key="glidict::Filter.Filter_Tree"/> menu to <AutoText key="glidict::Filter.3"/>. Again, the files shown above alter.</Text>
</NumberedItem>
<NumberedItem>
<Text id="0402">Now return the <AutoText key="glidict::Filter.Filter_Tree"/> setting back to <AutoText key="glidict::Filter.All_Files"/>, otherwise you may get confused later. Remember, if the <AutoText key="glidict::GUI.Gather"/> or <AutoText key="glidict::GUI.Enrich"/> panels do not seem to be showing all your files, this could be the problem.</Text>
</NumberedItem>
</Content>

</Tutorial>
<Tutorial id="export_to_CDROM">
<Title>
<Text id="0403">Exporting a collection to CD-ROM/DVD</Text>
</Title>
<Prerequisite id="large_html_collection"/>
<Version initial="2.60" current="2.70"/>
<Content>
<Comment>
<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>
</Comment>
<NumberedItem>
<Text id="0405">Launch the Greenstone Librarian Interface if it is not already running.</Text>
</NumberedItem>
<NumberedItem>
<Text id="0406">Choose <Menu><AutoText key="glidict::Menu.File"/> &rarr; <AutoText key="glidict::Menu.File_CDimage"/></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 <AutoText text="collections" type="quoted"/> is used. Do so now, entering <AutoText text="Tudor collection" type="quoted"/> in the field for <AutoText key="glidict::WriteCDImagePrompt.CD_Name"/>; then click <AutoText key="glidict::WriteCDImagePrompt.Export" type="button"/>.</Text>
<Text id="0408">The necessary files for export are written to:</Text>
<Path>Greenstone &rarr; tmp &rarr; exported_Tudorcollection</Path>
<Comment>
<Text id="0408b">Note, if you didn't specify a name for the CD-ROM, then the folder name will be <Path>exported_collections</Path> instead of <Path>exported_Tudorcollections</Path>.</Text>
</Comment>
<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 <Path>exported_Tudorcollection</Path> into the folder that represents the disk.</Text>
<Comment>
<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>
</Comment>
</NumberedItem>
</Content>
</Tutorial>
<Tutorial id="downloading_from_internet">
<Title>
<Text id="0411">Downloading files from the web</Text>
</Title>
<Prerequisite id="large_html_collection"/>
<Version initial="2.60" current="2.70"/>
<Content>
<Comment>
<Text id="0412">The Greenstone Librarian Interface's Download panel allows you to download individual files, parts of websites, and indeed whole websites, from the web.</Text>
</Comment>
<NumberedItem>
<Text id="0413">Start a new collection called <b>webtudor</b>, and base it on the <b>tudor</b> collection.</Text>
</NumberedItem>
<NumberedItem>
<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>
<Link>http://englishhistory.net/tudor/contents.html</Link> 
<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.</Text>
</NumberedItem>
<NumberedItem>
<Text id="0416">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. In the <AutoText key="glidict::GUI.Download"/> panel, enter this URL</Text>
<Link>http://englishhistory.net/tudor/citizens/</Link> 
<Text id="0417">into the <AutoText key="glidict::Mirroring.Source_URL"/> box. There are several options that govern how the download process proceeds. To copy the <i>citizens</i> section of the website, select <AutoText key="glidict::Mirroring.Higher_Directories"/>. If you don't do this (or if you miss out the terminating "/"), the downloading process will follow links to other areas of the <i>englishhistory.net</i> website and grab those as well. Set <AutoText key="glidict::Mirroring.Download_Depth"/> to <AutoText key="glidict::Mirroring.Download_Depth.Unlimited"/>&mdash;we want to follow as many links as necessary to download all the pages.</Text>
</NumberedItem>
<NumberedItem>
<Text id="0418">Now click <AutoText key="glidict::Mirroring.Download" type="button"/>. A progress bar appears in the lower half of the panel that reports on how the downloading process is doing.</Text>
<Comment>
<Text id="0419">More detailed information can be obtained by clicking <AutoText key="glidict::Mirroring.DownloadJob.Log" type="button"/>. The process can be paused and restarted as needed, or stopped altogether by clicking <AutoText key="glidict::Mirroring.DownloadJob.Close" type="button"/>. Downloading can be a lengthy process involving multiple sites, and so Greenstone allows additional downloads to be queued up. When new URLs are pasted into the <AutoText key="glidict::Mirroring.Source_URL"/> box and <AutoText key="glidict::Mirroring.Download" type="button"/> clicked, a new progress bar is appended to those already present in the lower half of the panel. When the currently active download item completes, the next is started automatically.</Text>
</Comment>
</NumberedItem>
<NumberedItem>
<Text id="0420">Downloaded files are stored in a top-level folder called <AutoText key="glidict::Tree.DownloadedFiles"/> that appears on the left-hand side of the <AutoText key="glidict::GUI.Gather"/> panel. You may not need all the downloaded files, and you choose which you want by dragging selected files from this folder over into the collection area on the right-hand side, just like we have done before when selecting data from the <Path>sample_files</Path> folder. In this example we will include everything that has been downloaded.</Text>
<Text id="0421">Select the <Path>englishhistory.net</Path> folder within <AutoText key="glidict::Tree.DownloadedFiles"/> and drag it across into the collection area.</Text>
</NumberedItem>
<NumberedItem>
<Text id="0422">Switch to the <AutoText key="glidict::GUI.Create"/> panel to <b>build</b> and <b>preview</b> the collection. It is smaller than the previous collection because we included only the <i>citizens</i> files. However, these now represent the latest versions of the documents.</Text>
</NumberedItem>
</Content>
</Tutorial>
<Tutorial id="web_linking">
<Title>
<Text id="0423">Pointing to documents on the web</Text>
</Title>
<Prerequisite id="downloading_from_internet"/>
<Version initial="2.60" current="2.70"/>
<Content>
<NumberedItem>
<Text id="0424">Open up your <b>webtudor</b> collection, and in the <AutoText key="glidict::GUI.Gather"/> panel inspect the files you dragged into it. The first folder is <Path>englishhistory.net</Path>, which opens up to reveal <Path>tudor</Path>, and so on. The files represent a complete sweep of the pages (and supporting images) that constitute the <i>Tudor citizens</i> section of the <i>englishhistory.net</i> web site. They were downloaded from the web in a way that preserved the structure of the original site. This allows any page's original URL to be reconstructed from the folder hierarchy.</Text>
</NumberedItem>
<NumberedItem>
<Text id="0425">In the <AutoText key="glidict::GUI.Design"/> panel, select the <AutoText key="glidict::CDM.GUI.Plugins"/> section, then select the <AutoText text="plugin HTMLPlug"/> line and click <AutoText key="glidict::CDM.PlugInManager.Configure" type="button"/>. A popup window appears. Locate the <AutoText text="file_is_url"/> option (about halfway down the first block of items) and switch it on. Click <AutoText key="glidict::General.OK" type="button"/>.</Text>
<Text id="0426">Setting this option to the <AutoText text="HTMLPlug"/> means that Greenstone sets an additional piece of metadata for each document called <AutoText text="URL"/>, which gives its original URL.</Text>
<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 <Path>tudor</Path> folder, because this will set <AutoText text="URL"/> metadata to something like</Text>
<Indent>
http://tudor/citizens/...
</Indent> 
<Text id="0428">rather than</Text>
<Indent>
http://englishhistory.net/tudor/citizens/...
</Indent> 
<Text id="0429">If you have copied over a subfolder previously, delete it and make a fresh copy. Drag the folder in the right-hand side of the <AutoText key="glidict::GUI.Gather"/> panel on to the trash can in the lower right corner. Then obtain a fresh copy of the files by dragging across the <Path>englishhistory.net</Path> folder from the <AutoText key="glidict::Tree.DownloadedFiles"/> folder on the left-hand side.</Text>
</NumberedItem>
<NumberedItem>
<Text id="0430">To make use of the new URL metadata, the icon link must be changed to serve up the original URL rather than the copy stored in the digital library. Go to the <AutoText key="glidict::GUI.Design"/> panel, select the <AutoText key="glidict::CDM.GUI.Formats"/> section and edit the <AutoText text="VList" /> format statement by replacing</Text>
<Format>[link][icon][/link]</Format>
<Text id="0431">with</Text>
<Format>[weblink][webicon][/weblink]</Format>
<Text id="0432">Click <AutoText key="glidict::CDM.FormatManager.Replace" type="button"/> to commit the change.</Text>
</NumberedItem>
<NumberedItem>
<Text id="0433">Switch to the <AutoText key="glidict::GUI.Create"/> panel and <b>build</b> and <b>preview</b> the collection. The collection behaves exactly as before, except that when you click a document icon your web browser retrieves the original document from the web (assuming it is still there by the time you do this exercise!). If you are working offline you will be unable to retrieve the document.</Text>
</NumberedItem>
</Content>
</Tutorial>
<Tutorial id="enhanced_html_collection">
<Title>
<Text id="0434">Enhanced collection of HTML files</Text>
</Title>
<Prerequisite id="large_html_collection"/>
<Version initial="2.60" current="2.70"/>
<Content>
<Comment>
<Text id="0435">We return to the Tudor collection and add metadata that expresses a subject hierarchy. Then we build a classifier that exploits it by allowing readers to browse the documents about Monarchs, Relatives, Citizens, and Others separately.</Text>
</Comment>
<Heading>
<Text id="0437">Adding hierarchically-structured metadata and a Hierarchy classifier</Text>
</Heading>
<NumberedItem>
<Text id="0438">Open up your <b>tudor</b> collection (the original version, not the <b>webtudor</b> version), switch to the <AutoText key="glidict::GUI.Enrich"/> panel and select the <Path>monarchs</Path> folder (a subfolder of <Path>tudor</Path>). Set its <b>dc.Subject and Keywords</b> metadata to <b>Tudor period|Monarchs</b>. (For brevity, we refer to this metadata element in future simply as <b>dc.Subject</b>.) The vertical bar ("|") is a hierarchy marker. Selecting a <i>folder</i> and adding metadata has the effect of setting this metadata value for all files contained in this folder, its subfolders, and so on. A popup alerts you to this fact.</Text>
</NumberedItem>
<NumberedItem>
<Text id="0439">Repeat for the <Path>relative</Path> and <Path>citizens</Path> folders, setting their <AutoText key="metadata::dc.Subject"/> metadata to <b>Tudor period|Relatives</b> and <b>Tudor period|Citizens</b> respectively. Note that the hierarchy appears in the <AutoText key="glidict::EnrichPane.ExistingValues" args="dc.Subject and Keywords"/> area.</Text>
</NumberedItem>
<NumberedItem>
<Text id="0440">Finally, select all remaining files&mdash;the ones that are not in the <Path>monarchs</Path>, <Path>relative</Path>, and <Path>citizens</Path> folders&mdash;by selecting the first and shift-clicking the last. Set their <AutoText key="metadata::dc.Subject"/> metadata to <b>Tudor period|Others</b>: this is done in a single operation (there is a short delay before it completes).</Text>
</NumberedItem>
<NumberedItem>
<Text id="0441">Switch to the <AutoText key="glidict::GUI.Design"/> panel and select <AutoText key="glidict::CDM.GUI.Classifiers"/> from the left-hand list. Set the menu item for <AutoText key="glidict::CDM.ClassifierManager.Classifier"/> to <AutoText text="Hierarchy"/>; then click <AutoText key="glidict::CDM.ClassifierManager.Add" type="button"/>.</Text>
</NumberedItem>
<NumberedItem>
<Text id="0442">A window pops up to control the classifier's options. Change the <b>metadata</b> to <AutoText key="metadata::dc.Subject"/> and then click <AutoText key="glidict::General.OK" type="button"/>.</Text>
</NumberedItem>
<NumberedItem>
<Text id="0443">For tidiness' sake, <b>remove</b> the <b>classifier</b> for <b>Source</b> metadata (included by default) from the list of currently assigned classifiers, because this adds little to the collection.</Text>
</NumberedItem>
<NumberedItem>
<Text id="0444">Now switch to the <AutoText key="glidict::GUI.Create"/> panel, <b>build</b> the collection, and <b>preview</b> it. Choose the new <AutoText key="coredm::_Global:labelSubject_"/> link that appears in the navigation bar, and click the bookshelves to navigate around the four-entry hierarchy that you have created.</Text>
</NumberedItem>
<Comment>
<Text id="0445">Next we partition the full-text index into four separate pieces. To do this we first define four subcollections obtained by "filtering" the documents according to a criterion based on their <AutoText key="metadata::dc.Subject"/> metadata. Then an index is assigned to each subcollection.</Text>
</Comment>
<Heading>
<Text id="0446">Partitioning the full-text index based on metadata values</Text>
</Heading>
<NumberedItem>
<Text id="0447">Switch to the <AutoText key="glidict::GUI.Design"/> panel, and click <AutoText key="glidict::CDM.GUI.Subcollections"/>. This feature is disabled because you are operating in <AutoText key="glidict::Preferences.Mode.Librarian"/> mode (this is indicated in the title bar at the top of the window).</Text>
</NumberedItem>
<NumberedItem>
<Text id="0448">Switch to <AutoText key="glidict::Preferences.Mode.Systems"/> mode by going to <AutoText key="glidict::Menu.File_Options"/> (on the <AutoText key="glidict::Menu.File"/> menu) and clicking <AutoText key="glidict::Preferences.Mode" type="button"/>. Read about the other modes too. Note that the mode appears in the title bar.</Text>
</NumberedItem>
<NumberedItem>
<Text id="0449">Return to the <AutoText key="glidict::CDM.GUI.Subcollections"/> section of the <AutoText key="glidict::GUI.Design"/> panel. Ensure that the <AutoText key="glidict::CDM.SubcollectionManager.Subcollection_Controls"/> tab is selected (the default). Define a subcollection filter with name <b>monarchs</b> that matches against <b>dc.Subject and Keywords,</b> and type <b>Monarchs</b> as the regular expression to match with. Click <AutoText key="glidict::CDM.SubcollectionManager.Add" type="button"/>. This filter includes any file whose <AutoText key="metadata::dc.Subject"/> metadata contains the word <i>Monarchs</i>.</Text>
</NumberedItem>
<NumberedItem>
<Text id="0450">Define another filter, <b>relatives</b>, which matches <AutoText key="metadata::dc.Subject"/> against the word <b>Relatives</b>.<b></b> Define a third and fourth, <b>citizens</b> and <b>others</b>, which matches it against the words <b>Citizens</b> and <b>Others</b> respectively.</Text>
</NumberedItem>
<NumberedItem>
<Text id="0451">Having defined the subcollections, we partition the index into corresponding parts. Click the <AutoText key="glidict::CDM.SubcollectionManager.Subindex_Controls"/> tab. Select the first subcollection and give it the name <b>citizens</b>; click <AutoText key="glidict::CDM.SubcollectionIndexManager.Add_Subindex" type="button"/>. Repeat for the other three subcollections, naming their partitions <b>monarchs</b>, <b>others</b> and <b>relatives</b>. <b>Build</b> and <b>preview</b> the collection.</Text>
</NumberedItem>
<NumberedItem>
<Text id="0452">The search page includes a pulldown menu that allows you to select one of these partitions for searching. For example, try searching the <i>relatives</i> partition for <i>mary</i> and then search the <i>monarchs</i> partition for the same thing.</Text>
</NumberedItem>
<NumberedItem>
<Text id="0453">To allow users to search the collection as a whole as well as each subcollection individually, return to the <AutoText key="glidict::CDM.GUI.Subcollections"/> section of the <AutoText key="glidict::GUI.Design"/> panel and select the <AutoText key="glidict::CDM.SubcollectionManager.Subindex_Controls"/> tab.<b></b> Type <b>all</b> into the <AutoText key="glidict::CDM.SubcollectionIndexManager.PartitionName"/> and select all four subcollections by checking their boxes.</Text>
</NumberedItem>
<NumberedItem>
<Text id="0454">To ensure that the <i>all</i> index appears first in the list on the reader's web page, use the <AutoText key="glidict::CDM.Move.Move_Up" type="button"/> button to get it to the top of the list here in the <AutoText key="glidict::GUI.Design"/> panel. Then <b>build</b> and <b>preview</b> the collection.</Text>
</NumberedItem>
<NumberedItem>
<Text id="0455">Search for a common term (like <i>the</i>) in all five index partitions, and check that the numbers of words (not documents) add up.</Text>
</NumberedItem>
<NumberedItem>
<Text id="0456">Return to <AutoText key="glidict::Preferences.Mode.Librarian"/> mode, using <AutoText key="glidict::Menu.File_Options"/> (on the <AutoText key="glidict::Menu.File"/> menu).</Text>
</NumberedItem>
<Heading>
<Text id="0457">Adding a hierarchical phrase index (PHIND)</Text>
</Heading>
<NumberedItem>
<Text id="0458">Switch to the <AutoText key="glidict::GUI.Design"/> panel and choose the <AutoText key="glidict::CDM.GUI.Classifiers"/> item from the left-hand list.</Text>
</NumberedItem>
<NumberedItem>
<Text id="0459">Choose <AutoText text="Phind"/> from the <AutoText key="glidict::CDM.ClassifierManager.Classifier"/> menu. Click <AutoText key="glidict::CDM.ClassifierManager.Add" type="button"/>. 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 <AutoText key="glidict::General.OK" type="button"/>.</Text>
</NumberedItem>
<NumberedItem>
<Text id="0460"><b>Build</b> the collection again, <b>preview</b> it, and try out the new <AutoText key="coredm::_Global:labelphrases_"/> option in the navigation bar. An interesting PHIND search term for this collection is <AutoText text="king" type="quoted"/>.</Text>
</NumberedItem>
<Comment>
<Text id="0461">Finally we look at how the building process can be controlled. Developing a new collection usually involves numerous cycles of building, previewing, adjusting some enrich and design features, and so on. While prototyping, it is best to temporarily reduce the number of documents in the collection. This can be accomplished through the <AutoText text="maxdocs"/>  parameter to the building process.</Text>
</Comment>
<Heading>
<Text id="0462">Controlling the building process</Text>
</Heading>
<NumberedItem>
<Text id="0463">Switch to the <AutoText key="glidict::GUI.Create"/> panel and view the options that are displayed in the top portion of the screen. Select <AutoText text="maxdocs"/> and set its numeric counter to <AutoText text="3"/>. Now <b>build</b>.</Text>
</NumberedItem>
<NumberedItem>
<Text id="0464">Preview the newly rebuilt collection's <AutoText key="coredm::_Global:labelTitle_"/> page. Previously this listed more than a dozen pages per letter of the alphabet, but now there are just three&mdash;the first three files encountered by the building process.</Text>
</NumberedItem>
<NumberedItem>
<Text id="0464a">Go back to the <AutoText key="glidict::GUI.Create"/> panel and turn off the <AutoText text="maxdocs"/> option. <b>Rebuild</b> the collection so that all the documents are included.</Text>
</NumberedItem>
</Content>
</Tutorial>
<Tutorial id="format_and_macros">
<Title>
<Text id="0465">Learning about formats and macros</Text>
</Title>
<Prerequisite id="large_html_collection"/>
<Version initial="2.60" current="2.70"/>
<Content>
<Comment>
<Text id="0466">Format statements and macro files allow you to customize the appearance of Greenstone collections. They are very powerful, but complex and hard to learn. This tutorial exercise gives an introduction to the facilities they provide.</Text>
</Comment>
<Heading>
<Text id="0467">Experimenting with format statements</Text>
</Heading>
<NumberedItem>
<Text id="0468">Open up your <b>tudor</b> collection, go to the <AutoText key="glidict::GUI.Design"/> panel (by clicking on its tab) and select <AutoText key="glidict::CDM.GUI.Formats"/> from the left-hand list. Leave the editing controls at their default value, so that <AutoText key="glidict::CDM.FormatManager.Feature"/> remains blank and <AutoText text="VList"/> is selected as the <AutoText key="glidict::CDM.FormatManager.Part"/>. The text in the <AutoText key="glidict::CDM.FormatManager.Editor"/> box reads as follows:</Text>
<Format>
&lt;td valign=top&gt;[link][icon][/link]&lt;/td&gt;<br/>
&lt;td valign=top&gt;[ex.srclink]{Or}{[ex.thumbicon],[ex.srcicon]} [ex./srclink]&lt;/td&gt;<br/>
&lt;td valign=top&gt;[highlight]<br/>
{Or}{[dls.Title],[dc.Title],[ex.Title],Untitled}<br/>
[/highlight]{If}{[ex.Source],&lt;br&gt;&lt;i&gt;([ex.Source])&lt;/i&gt;}&lt;/td&gt;
</Format> 
<Text id="0469">This displays something that looks like this: </Text>
<Indent>
<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>
</Indent>
<Text id="0472">for a particular document whose <i>Title</i> metadata is <AutoText text="A discussion of question five from Tudor Quiz: Henry VIII"/> and whose <i>Source</i> metadata is <AutoText text="quizstuff.html"/>.</Text>
<Text id="0473">This format appears in the search results list, in the <AutoText key="coredm::_Global:labelTitle_"/> list, and also when you get down to individual documents in the <AutoText key="coredm::_Global:labelTitle_"/> hierarchy. This is Greenstone's default format statement.</Text>
</NumberedItem>
<Comment>
<Text id="0474">Greenstone's default format statement is complex&mdash;even baroque&mdash;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.</Text>
</Comment>
<NumberedItem>
<Text id="0475">Delete the contents of the <AutoText key="glidict::CDM.FormatManager.Editor"/> box and replace it with this simpler version:</Text>
<Format>
&lt;td&gt;[link][icon][/link]&lt;/td&gt; <br/>
&lt;td&gt;[ex.Title]&lt;br&gt;<br/>
&nbsp;&nbsp;&nbsp;&nbsp;&lt;i&gt;([ex.Source])&lt;/i&gt;<br/>
&lt;/td&gt;
</Format>
<Text id="0475a">Remember to click <AutoText key="glidict::CDM.FormatManager.Replace" type="button"/>.</Text> 
<Text id="0476"><b>Preview</b> the result (you don't need to build the collection, because changes to format statements take effect immediately). Look at some search results and at the <AutoText key="coredm::_Global:labelTitle_"/> list. They are just the same as before! Under most circumstances this far simpler format statement is entirely equivalent to Greenstone's more complex default. </Text>
<Comment>
<Text id="0478">But there's a problem. Beside the bookshelves in the <AutoText key="coredm::_Global:labelSubject_"/> browser, beneath the subject appears a mysterious "()". What is printed on these bookshelf nodes is governed by the same format statement, and though bookshelf nodes of the hierarchy have associated <i>Title</i> metadata&mdash;their title is the name of the metadata value associated with that bookshelf&mdash;they do not have <AutoText key="metadata::ex.Source"/> metadata, so it comes out blank.</Text>
</Comment>
</NumberedItem>
<NumberedItem>
<Text id="0482">In the <AutoText key="glidict::CDM.GUI.Formats"/> section of the <AutoText key="glidict::GUI.Design"/> panel, the <AutoText key="glidict::CDM.FormatManager.Feature"/> menu (just above <AutoText key="glidict::CDM.FormatManager.Part"/> menu) is blank. That implies that the same format is used for the search results, titles, and all nodes in the subject hierarchy&mdash;including internal nodes (that is, bookshelves). The <AutoText key="glidict::CDM.FormatManager.Feature"/> menu can be used to restrict a format statement to a specific one of these lists; when it's blank, the <AutoText text="VList" /> specification applies throughout. We will override this format statement for the hierarchical <i>subject</i> classifier. In the <AutoText key="glidict::CDM.FormatManager.Feature"/> menu, scroll down to the item that says</Text>
<Indent>
CL2: Hierarchy -metadata dc.Subject and Keywords
</Indent> 
<Text id="0483">and select it. This is the format statement that affects the second classifier (i.e., "CL2"), which is a <AutoText text="Hierarchy"/> classifier based on <b>dc.Subject and Keywords</b> metadata.</Text>
<Text id="0484">Edit the <AutoText key="glidict::CDM.FormatManager.Editor"/> box below to read</Text>
<Format>
&lt;td&gt;[link][icon][/link]&lt;/td&gt;<br/>
&lt;td&gt;[ex.Title]&lt;/td&gt;
</Format> 
<Text id="0485">and click <AutoText key="glidict::CDM.FormatManager.Add" type="button"/>.</Text>
</NumberedItem>
<NumberedItem>
<Text id="0486">Now go to the <AutoText key="glidict::GUI.Create"/> panel and click <AutoText key="glidict::CreatePane.Preview_Collection" type="button"/>. 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 <AutoText key="metadata::ex.Source"/> 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>
</NumberedItem>
<NumberedItem>
<Text id="0487">Let's change the search results format so that <i>dc.Subject and Keywords</i> metadata is displayed here instead of the filename. In the <AutoText key="glidict::CDM.FormatManager.Feature"/> menu (under <AutoText key="glidict::CDM.GUI.Formats"/> on the <AutoText key="glidict::GUI.Design"/> panel), scroll down to the item <AutoText text="Search"/> and select it. Change the <AutoText key="glidict::CDM.FormatManager.Editor"/> box below to read</Text>
<Format>
&lt;td&gt;[link][icon][/link]&lt;/td&gt;<br/>
&lt;td&gt;[ex.Title]&lt;br&gt;<br/> 
&nbsp;&nbsp;&nbsp;&nbsp;[dc.Subject]<br/> 
&lt;/td&gt;<br/>
</Format> 
<Text id="0488">and click <AutoText key="glidict::CDM.FormatManager.Add" type="button"/>.</Text>
</NumberedItem>
<NumberedItem>
<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 <AutoText key="glidict::CDM.FormatManager.Variable"/> dropdown menu&mdash;the one that says <AutoText text="[Text]"/>. Make it say <b>[dc.Subject]</b> and click <AutoText key="glidict::CDM.FormatManager.Insert" type="button"/> to insert this into the <AutoText key="glidict::CDM.FormatManager.Editor"/>. This menu shows many of the things that you can put in square brackets in the format statement.</Text>
</NumberedItem>
<NumberedItem>
<Text id="0490">Now go to the <AutoText key="glidict::GUI.Create"/> panel and click <AutoText key="glidict::CreatePane.Preview_Collection" type="button"/>. Documents in the search results list will be displayed like this:</Text>
<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/>
Tudor period|Others</td></tr></table>
<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>
</NumberedItem>
<NumberedItem>
<Text id="0494">Finally, let's return to the <i>subjects</i> hierarchy and learn how to do different things to the bookshelves and to the documents themselves. In the <AutoText key="glidict::CDM.FormatManager.Feature"/> menu, re-select the item</Text>
<Indent>
CL2: Hierarchy -metadata dc.Subject and Keywords
</Indent> 
<Text id="0495">Edit the <AutoText key="glidict::CDM.FormatManager.Editor"/> box below to read</Text>
<Format>
&lt;td&gt;[link][icon][/link]&lt;/td&gt;<br/>
&lt;td&gt;{If}{[numleafdocs],&lt;b&gt;Bookshelf title:&lt;/b&gt; [ex.Title],<br/>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&lt;b&gt;Title:&lt;/b&gt; [ex.Title]}<br/> 
&lt;/td&gt;
</Format> 
<Text id="0496">and click <AutoText key="glidict::CDM.FormatManager.Replace" type="button"/>. Again, you can insert the items in square brackets by selecting them from the <AutoText key="glidict::CDM.FormatManager.Variable"/> dropdown box (don't forget to click <AutoText key="glidict::CDM.FormatManager.Insert" type="button"/>).</Text>
<Comment>
<Text id="0497">The <AutoText text="If"/> statement tests the value of the variable <AutoText text="numleafdocs"/>. This variable is only set for internal nodes of the hierarchy, i.e. bookshelves, and gives the number of documents below that node. If it is set we take the first branch, otherwise we take the second. Commas are used to separate the branches. The curly brackets serve to indicate that the <AutoText text="If"/> is special&mdash;otherwise the word <AutoText text="If" type="quoted"/> itself would be output.</Text>
</Comment>
</NumberedItem>
<NumberedItem>
<Text id="0498">Go to the <AutoText key="glidict::GUI.Create"/> panel, click <AutoText key="glidict::CreatePane.Preview_Collection" type="button"/>, and examine the subject hierarchy again to see the effect of your changes.</Text>
</NumberedItem>
<Heading>
<Text id="0499">Collection-specific macros</Text>
</Heading>
<Comment>
<Text id="0500">The appearance of all pages produced by Greenstone is governed by macro files, which reside in the folder <Path>Greenstone &rarr; macros</Path>. The garish example collection is a version of the demo collection with bizarre layout and coloring. Now we apply the same bizarre layout and coloring to the tudor collection.</Text>
</Comment>
<NumberedItem>
<Text id="0505">Go to the folder <Path>Greenstone &rarr; collect &rarr; garish &rarr; macros</Path>. Copy the file <Path>extra.dm</Path>. Now go to your collection folder <Path>Greenstone &rarr; collect &rarr; tudor</Path> and create a new folder in there called <Path>macros</Path>. Paste <Path>extra.dm</Path> into that new folder. The overall effect is that you have created a new file <Path>Greenstone &rarr; collect &rarr; tudor &rarr; macros &rarr; extra.dm</Path>.</Text>
</NumberedItem>
<NumberedItem>
<Text id="0505a">This macro file uses a CSS style file and some images which you will also need to copy from the garish collection. Go to the folder <Path>Greenstone &rarr; collect &rarr; garish &rarr; images</Path>. Select the three files <Path>style.css</Path>, <Path>horzline.gif</Path> and <Path>bg_blue.gif</Path>. <b>Copy</b> these files and paste them into the <Path>Greenstone &rarr; collect &rarr; tudor &rarr; images</Path> folder.</Text>
</NumberedItem>
<NumberedItem>
<Text id="0507">Go to the <AutoText key="glidict::GUI.Create"/> panel and click <AutoText key="glidict::CreatePane.Preview_Collection" type="button"/>. The content of your collection remains the same, but its appearance has changed completely&mdash;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>
</NumberedItem>
<Heading>
<Text id="0512">General macros</Text>
</Heading>
<Comment>
<Text id="0513">You can also use macros to completely change the appearance of your Greenstone site. Like the above exercise, what follows is just a lead-in to illustrate what is possible and show you where to look to achieve different kinds of effects.</Text>
</Comment>
<NumberedItem>
<Text id="0514">Exit from the Librarian Interface, since it is concerned with individual collections and we are now dealing with the site as a whole.</Text>
</NumberedItem>
<NumberedItem>
<Text id="0515">Go to the folder <Path>Greenstone &rarr; etc</Path> and edit the file called <Path>main.cfg</Path>. This is Greenstone's main configuration file, and contains a list of the macros that will be loaded in on startup. One of them, <Path>home.dm</Path>, dictates how the Greenstone home page will look, which is specified in the file <Path>Greenstone &rarr; macros &rarr; home.dm</Path>. This <Path>macros</Path> folder contains an alternative version, called <Path>yourhome.dm</Path>, which is not currently being used. To use it instead, in <Path>main.cfg</Path> change the string <AutoText text="home.dm" type="quoted"/> to <AutoText text="yourhome.dm" type="quoted"/>.</Text>
</NumberedItem>
<NumberedItem>
<Text id="0516">Now restart Greenstone (just the Greenstone Digital Library will do, rather than the Greenstone Librarian Interface). You will find that the appearance of the home page has changed completely.</Text>
</NumberedItem>
<NumberedItem>
<Text id="0517">Instead of substituting <AutoText text="yourhome.dm" type="quoted"/> for <AutoText text="home.dm" type="quoted"/> in the file <Path>main.cfg</Path>, you could have simply edited <Path>home.dm</Path> and left <Path>main.cfg</Path> as it is. However, we wanted to preserve <Path>home.dm</Path> so that you could revert to your original Greenstone home page! Do this now by editing <Path>main.cfg</Path> and changing the string <AutoText text="yourhome.dm" type="quoted"/> back to <AutoText text="home.dm" type="quoted"/>. You will need to re-start Greenstone for this to take effect.</Text>
</NumberedItem>
<Comment>
<Text id="0518">To learn more about macros, read <i>Customizing the Greenstone User Interface</i>, an illustrated guide to customizing the user interface, by Allison Zhang of the Washington Research Library Consortium, available at <Link>http://www.wrlc.org/dcpc/UserInterface/interface.htm</Link>.</Text>
</Comment>
</Content>
</Tutorial>
<Tutorial id="bibliography_collection">
<Title>
<Text id="0520">A bibliographic collection</Text>
</Title>
<SampleFiles folder="marc"/>
<Version initial="2.60" current="2.70"/>
<Content>
<NumberedItem>
<Text id="0521">Start a new collection called <b>Beatles Bibliography</b>. Enter the requested information and make it a <b>New Collection</b>. There is no need to include any metadata sets because the metadata extracted from the MARC records will appear as extracted metadata. Deselect the <b>Dublin Core</b> metadata set, and click <AutoText key="glidict::General.OK" type="button"/>.</Text>
<Text id="0521a">A <AutoText key="glidict::NoMetadataSetsSelected.Title"/> warning message will pop-up, alerting you to the fact that you won't be able to manually assign metadata to the collection. In this collection, all the metadata will come from the MARC file; click <AutoText key="glidict::General.OK" type="button"/> to continue. (If you don't want to see this popup again, tick the <AutoText key="glidict::WarningDialog.Dont_Show_Again"/> checkbox.)</Text>
</NumberedItem>
<NumberedItem>
<Text id="0522">In the <AutoText key="glidict::GUI.Gather"/> panel, open the <Path>marc</Path> folder, drag <Path>locbeatles50.marc</Path> into the right-hand pane and drop it there. A popup window asks whether you want to add <AutoText text="MARCPlug" /> to the collection to process this file. Click <AutoText key="glidict::CDM.PlugInManager.Add" type="button"/>, because this plugin will be needed to process the MARC records.</Text>
</NumberedItem>
<NumberedItem>
<Text id="0523">Remove the plugins <AutoText text="TextPlug" /> to <AutoText text="NULPlug" /> by selecting each one in the <AutoText key="glidict::CDM.PlugInManager.Assigned"/> list and clicking <AutoText key="glidict::CDM.PlugInManager.Remove" type="button"/> (<AutoText text="ZIPPlug" />, <AutoText text="GAPlug" /> and <AutoText text="MARCPlug" /> 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>
</NumberedItem>
<NumberedItem>
<Text id="0524">Now select <AutoText key="glidict::CDM.GUI.Classifiers"/> within the <AutoText key="glidict::GUI.Design"/> panel and <b>remove</b> the default classifier for <b>Source</b> metadata. In this collection all records are from the same file, so <b>Source</b> metadata, which is set to the filename, is not particularly interesting.</Text>
</NumberedItem>
<NumberedItem>
<Text id="0525">Switch to the <AutoText key="glidict::GUI.Create"/> panel, <b>build</b> the collection, and <b>preview</b> it. Browse through the <b>titles a-z</b> and view a record or two. Try searching&mdash;for example, find items that include <AutoText text="George Martin"/>.</Text>
</NumberedItem>
<NumberedItem>
<Text id="0526">Add an <AutoText text="AZCompactList" /> classifier for the <b>Subject</b> metadata. Select this item from the relevant menu of the <AutoText key="glidict::CDM.GUI.Classifiers"/> section of the <AutoText key="glidict::GUI.Design"/> panel and click <AutoText key="glidict::CDM.ClassifierManager.Add" type="button"/>. In the popup window, select <AutoText key="metadata::ex.Subject"/> as the metadata item.</Text>
<Comment>
<Text id="0527"><AutoText text="AZCompactList" /> is like <AutoText text="AZList"/>, 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>
</Comment>
</NumberedItem>
<NumberedItem>
<Text id="0528"><b>Build</b> the collection and <b>preview</b> the result.</Text>
</NumberedItem>
<NumberedItem>
<Text id="0529">Make each bookshelf node show how many entries it contains by appending this to the <AutoText key="glidict::CDM.GUI.Formats"/> for the <AutoText text="VList" /> format statement in the <AutoText key="glidict::GUI.Design"/> panel:</Text>
<Format>{If}{[numleafdocs],&lt;td&gt;&lt;i&gt;([numleafdocs])&lt;/i&gt;&lt;/td&gt;}</Format> 
</NumberedItem>
<NumberedItem>
<Text id="0530">Click <AutoText key="glidict::CDM.FormatManager.Replace" type="button"/>, switch to the <AutoText key="glidict::GUI.Create"/> panel, and click <AutoText key="glidict::CreatePane.Preview_Collection" type="button"/> (no need to build the collection again).</Text>
</NumberedItem>
<Heading>
<Text id="0531">Adding fielded searching</Text>
</Heading>
<NumberedItem>
<Text id="0532">In the <AutoText key="glidict::GUI.Design"/> panel select <AutoText key="glidict::CDM.GUI.SearchTypes"/> from the left-hand list and activate the <AutoText key="glidict::CDM.SearchTypeManager.Enable"/> option.</Text>
</NumberedItem>
<NumberedItem>
<Text id="0532a">Add form searching to the collection by selecting <AutoText text="form"/> in the <AutoText key="glidict::CDM.SearchTypeManager.SearchType_Selection"/> menu and clicking <AutoText key="glidict::CDM.SearchTypeManager.Add" type="button"/>. Remove plain searching by selecting <AutoText text="plain"/> in the <AutoText key="glidict::CDM.SearchTypeManager.Assigned"/> list, and clicking <AutoText key="glidict::CDM.SearchTypeManager.Remove" type="button"/>.</Text>
</NumberedItem>
<NumberedItem>
<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 <AutoText key="coredm::_Global:labelSearch_"/> in the navigation bar. Note that the <AutoText key="coredm::_Global:linktextPREFERENCES_"/> page has changed to control the advanced searching options.</Text>
</NumberedItem>
<Comment>
<Text id="0534">To finish off the collection, brand it with an image that will be used to represent the collection on the Greenstone page, and appear at the top of each page of the collection</Text>
</Comment>
<Heading>
<Text id="0535">Branding a collection with an image</Text>
</Heading>
<NumberedItem>
<Text id="0536">From the <AutoText key="glidict::CDM.GUI.General"/> section of the <AutoText key="glidict::GUI.Design"/> panel, click the <AutoText key="glidict::General.Browse" type="button"/> button next to the label <AutoText key="glidict::CDM.General.Icon_Collection"/> and use the resulting popup file browser to access the folder <Path>sample_files &rarr; marc</Path>. Select <Path>beatles_logo.jpg</Path> and click &lt;<b>Open</b>&gt;.</Text>
<Comment>
<Text id="0537">Greenstone copies the image into your collection area, so the collection will still work when the CD-ROM is removed from the drive.</Text>
</Comment>
</NumberedItem>
<NumberedItem>
<Text id="0538">Repeat this process for the <AutoText key="glidict::CDM.General.Icon_Collection_Small"/>, selecting the same image.</Text>
</NumberedItem>
<NumberedItem>
<Text id="0539">Now <b>build</b> the collection and <b>preview</b> it.</Text>
</NumberedItem>
</Content>
</Tutorial>
<Tutorial id="multimedia_collection_explore">
<Title>
<Text id="0540">Looking at a multimedia collection</Text>
</Title>
<SampleFiles folder="beatles"/>
<Version initial="2.60" current="2.70"/>
<Content>
<NumberedItem>
<Text id="0541">Copy the entire folder</Text>
<Path>sample_files &rarr; beatles &rarr; advbeat_large</Path> 
<Text id="0542">(with all its contents) into your Greenstone <Path>collect</Path> folder. If you have installed Greenstone in the usual place, this is</Text>
<Path>
<Text id="0542a"><Path>My Computer &rarr; Local Disk (C:) &rarr; Program Files &rarr; Greenstone &rarr; collect</Path></Text>
</Path> 
<Text id="0543">Put <Path>advbeat_large</Path> in there.</Text>
</NumberedItem>
<NumberedItem>
<Text id="0544">If the Greenstone Digital Library Local Library Server is already running, re-start it by clicking the CD icon on the task bar and then pressing <i>Restart Library</i>. If not, start it up by selecting <i>Greenstone Digital Library</i> from the <i>Start</i> menu.</Text>
</NumberedItem>
<NumberedItem>
<Text id="0545">Explore the Beatles collection. Note how the <AutoText key="coredm::_Global:labelBrowse_"/> button divides the material into seven different types. Within each category, the documents have appropriate icons. Some documents have an audio icon: when you click these you hear the music (assuming your computer is set up with appropriate player software). Others have an image thumbnail: when you click these you see the images.</Text>
</NumberedItem>
<NumberedItem>
<Text id="0546">Look at the <AutoText key="coredm::_Global:labelTitle_"/> browser. Each title has a bookshelf that may include several related items. For example, <AutoText text="Hey Jude"/> has a cover image, MP3 audio and MIDI versions, lyrics, and a discography item.</Text>
</NumberedItem>
<NumberedItem>
<Text id="0547">Observe the low quality of the metadata. For example, the four items under <AutoText text="A Hard Day's Night"/> (under <AutoText text="H" type="qupted"/> in the <AutoText key="coredm::_Global:labelTitle_"/> 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&mdash;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>
</NumberedItem>
<NumberedItem>
<Text id="0548">In the Windows file browser, take a look at the files that makes up the collection, in the</Text>
<Path>sample_files &rarr; beatles &rarr; advbeat_large &rarr; import</Path> 
<Text id="0549">folder. What a mess! There are over 450 files under seven top-level sub-folders. Organization is minimal, reflecting the different times and ways the files were gathered. For example, <Path>html_lyrics</Path> and <Path>discography</Path> are excerpts of web sites, and <Path>cover_images</Path> contains album covers in JPEG format. For each type, drill down through the hierarchy and look at a sample document.</Text>
</NumberedItem>
</Content>
</Tutorial>
<Tutorial id="multimedia_collection_build">
<Title>
<Text id="0550">Building a multimedia collection</Text>
</Title>
<Prerequisite id="multimedia_collection_explore"/>
<SampleFiles folder="beatles"/>
<Version initial="2.60" current="2.70"/>
<Content>
<Comment>
<Text id="0551">We will proceed to reconstruct from scratch the Beatles collection that you have just looked at. We develop the collection using a small subset of the material, purely to speed up the repeated rebuilding that is involved.</Text>
</Comment>
<NumberedItem>
<Text id="0552">Start a new collection (<Menu><AutoText key="glidict::Menu.File"/> &rarr; <AutoText key="glidict::Menu.File_New"/></Menu>) called <b>small_beatles</b>, basing it on the default "New Collection." (Basing it on the existing Advanced Beatles collection would make your life far easier, but we want you to learn how to build it from scratch!) Fill out the fields with appropriate information. Use the Dublin Core metadata set (set by default).</Text>
</NumberedItem>
<NumberedItem>
<Text id="0554">Copy the files provided in</Text>
<Path>sample_files &rarr; beatles &rarr; advbeat_small</Path> 
<Text id="0555">into your new collection. Do this by opening up <Path>advbeat_small</Path>, selecting the eight items within it (from <Path>cover_images</Path> to <Path>beatles_midi.zip</Path>), and dragging them across. Because some of these files are in MP3 and MARC formats you will be asked whether to include <AutoText text="MP3Plug" /> and <AutoText text="MARCPlug" /> in your collection. Click <AutoText key="glidict::CDM.PlugInManager.Add" type="button"/>.</Text>
</NumberedItem>
<NumberedItem>
<Text id="0556">Change to the <AutoText key="glidict::GUI.Enrich"/> panel and browse around the files. There is no metadata&mdash;yet. Recall that you can double-click files to view them.</Text>
<Text id="0557">(There are no MIDI files in the collection: these require more advanced customisation because there is no MIDI plugin. We will deal with them later.)</Text>
</NumberedItem>
<NumberedItem>
<Text id="0558">Change to the <AutoText key="glidict::GUI.Create"/> panel and <b>build</b> the collection.</Text>
</NumberedItem>
<NumberedItem>
<Text id="0559"><b>Preview</b> the result.</Text>
</NumberedItem>
<Heading>
<Text id="0560">Manually correcting metadata</Text>
</Heading>
<NumberedItem>
<Text id="0561">You might want to correct some of the metadata&mdash;for example, the atrocious misspelling in the titles "MAGICAL MISTERY TOUR." These documents are in the discography section, with filenames that contain the same misspelling. Locate one of them in the <AutoText key="glidict::GUI.Enrich"/> panel. Notice that the extracted metadata element <AutoText key="metadata::ex.Title"/> is now filled in, and misspelt. You cannot correct this element, for it is extracted from the file and will be re-extracted every time the collection is re-built.</Text>
</NumberedItem>
<NumberedItem>
<Text id="0562">Instead, add <AutoText key="metadata::dc.Title"/> metadata for these two files: "Magical Mystery Tour." Change to the <AutoText key="glidict::GUI.Enrich"/> panel, open the discography folder and drill down to the individual files. Set the <AutoText key="metadata::dc.Title"/> value for the two offending items.</Text>
</NumberedItem>
<Comment>
<Text id="0563">Now there's a twist. The <AutoText key="metadata::dc.Title"/> metadata won't appear in titles a-z because the classifier has been instructed to use <AutoText key="metadata::ex.Title"/>. But changing the classifier to use <AutoText key="metadata::dc.Title"/> would miss out all the extracted titles! Fortunately, there's a way of dealing with this by specifying a list of metadata names in the classifier.</Text>
</Comment>
<NumberedItem>
<Text id="0564">Change to the <AutoText key="glidict::GUI.Design"/> panel and select the <AutoText key="glidict::CDM.GUI.Classifiers"/> section. Double-click the <AutoText key="metadata::ex.Title"/> classifier (the first one) to edit its configuration settings.</Text>
<BulletList>
<Bullet>
<Text id="0565">Type <Format><AutoText key="metadata::dc.Title" type="plain"/>,</Format> before the <Format><AutoText key="metadata::ex.Title" type="plain"/></Format> in the metadata box&mdash;i.e. make it read</Text>
<Format>
<AutoText key="metadata::dc.Title" type="plain"/>,<AutoText key="metadata::ex.Title" type="plain"/>
</Format> 
<Text id="0565a">and click <AutoText key="glidict::General.OK" type="button"/>.</Text>
</Bullet>
</BulletList>
<Text id="0566"><b>Build</b> the collection again, and <b>preview</b> it.</Text>
<Text id="0567">Extracted metadata is unreliable. But it is very cheap! On the other hand, manually assigned metadata is reliable, but expensive. The previous section of this exercise has shown how to aim for the best of both worlds by using extracted metadata but correcting it when it is wrong. While this may not satisfy the professional librarian, it could provide a useful compromise for the music teacher who wants to get their collection together with a minimum of effort.</Text>
</NumberedItem>
<Heading>
<Text id="0568">Browsing by media type</Text>
</Heading>
<NumberedItem>
<Text id="0569">First let's remove the <AutoText text="AZList" /> classifier for filenames, which isn't very useful, and replace it with a browsing structure that groups documents by category (discography, lyrics, audio etc.). Categories are defined by manually assigned metadata.</Text>
<BulletList>
<Bullet>
<Text id="0570">Change to the <AutoText key="glidict::GUI.Enrich"/> panel, select the folder <Path>cover_images</Path> and set its <AutoText key="metadata::dc.Format"/> metadata value to "Images". Setting this value at the folder level means that all files within the folder inherit it.</Text>
</Bullet>
<Bullet>
<Text id="0571">Repeat the process. Assign "Discography" to the <Path>discography</Path> folder, "Lyrics" to <Path>html_lyrics</Path>, "MARC" to <Path>marc</Path>, "Audio" to <Path>mp3</Path>, "Tablature" to <Path>tablature_txt</Path>, and "Supplementary" to <Path>wordpdf</Path>.</Text>
</Bullet>
<Bullet>
<Text id="0572">Switch to the <AutoText key="glidict::GUI.Design"/> panel and select the <AutoText key="glidict::CDM.GUI.Classifiers"/> section.</Text>
</Bullet>
<Bullet>
<Text id="0573">Delete the <AutoText key="metadata::ex.Source"/> classifier (the second one).</Text>
</Bullet>
<Bullet>
<Text id="0574">Add an <AutoText text="AZCompactList" /> classifier. Select <AutoText key="metadata::dc.Format"/> as the <AutoText text="metadata"/> field and specify "browse" as the <AutoText text="buttonname"/>. Click the <AutoText text="sort"/> checkbox, and specify "Title" in the adjacent text box: this will make the classifier display documents in alphabetical order of title.</Text>
</Bullet>
</BulletList>
<Text id="0575"><b>Build</b> the collection again and <b>preview</b> it.</Text>
</NumberedItem>
<Heading>
<Text id="0579">Suppressing dummy text</Text>
</Heading>
<NumberedItem>
<Text id="0580">Alongside the Audio files there is an MP3 icon, which plays the audio when you click it, and also a text document that contains some dummy text. This isn't supposed to be seen, but to suppress it you have to fiddle with a format statement.</Text>
<BulletList>
<Bullet>
<Text id="0581">Change to the <AutoText key="glidict::GUI.Design"/> panel and select the <AutoText key="glidict::CDM.GUI.Formats"/> section.</Text>
</Bullet>
<Bullet>
<Text id="0582">Ensure that <AutoText text="VList" /> 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>
<Format>
&lt;td valign=top&gt;<highlight>[link][icon][/link]</highlight>&lt;/td&gt;<br/> 
<highlight>&lt;td valign=top&gt;[ex.srclink]{Or}{[ex.thumbicon],[ex.srcicon]}[ex./srclink]&lt;/td&gt; </highlight><br/>
&lt;td valign=top&gt;[highlight]<br/>
{Or}{[dls.Title],[dc.Title],[Title],Untitled} <br/>
[/highlight]{If}{[ex.Source],&lt;br&gt;&lt;i&gt;([ex.Source])&lt;/i&gt;}&lt;/td&gt;
</Format> 
<Text id="0583">to this:</Text>
<Format>
&lt;td valign=top&gt;<br/>
<highlight>{If}{[dc.Format] eq 'Audio', </highlight><br/>
<highlight>&nbsp;&nbsp;[srclink][srcicon][/srclink], </highlight><br/>
<highlight>&nbsp;&nbsp;[link][icon][/link]}</highlight>&lt;/td&gt; <br/>
&lt;td valign=top&gt;[highlight] {Or}{[dls.Title],[dc.Title],[Title],Untitled} [/highlight]{If}{[ex.Source],&lt;br&gt;&lt;i&gt;([ex.Source])&lt;/i&gt;}&lt;/td&gt;
</Format> 
</Bullet>
<Bullet>
<Text id="0584">Then click <AutoText key="glidict::CDM.FormatManager.Replace" type="button"/>.</Text>
</Bullet>
</BulletList>
<Text id="0585">To make this easier for you we have prepared a plain text file that contains the new text. In WordPad open the following file:</Text>
<Path>sample_files &rarr; beatles &rarr; format_tweaks &rarr; audio_tweak.txt</Path> 
<Text id="0586">(Be sure to use WordPad rather than Notepad, because Notepad does not display the line breaks correctly.) Place it in the copy buffer by highlighting the text in WordPad and selecting <Menu>Edit &rarr; Copy</Menu>. Now move back to the Librarian Interface, highlight all the text that makes up the current VList format statement, and use <Menu><AutoText key="glidict::Menu.Edit"/> &rarr; <AutoText key="glidict::Menu.Edit_Paste"/></Menu> to transform the old statement to the new one. Remember to press <AutoText key="glidict::CDM.FormatManager.Replace" type="button"/> when finished.</Text>
<Text id="0589"><b>Preview</b> the result. You may need to click the browser's &lt;<b>Reload</b>&gt; button to force it to re-load the page.</Text>
</NumberedItem>
<NumberedItem>
<Text id="0593">While we're at it, let's remove the source filename from where it appears after each document.</Text>
<BulletList>
<Bullet>
<Text id="0594">In the <AutoText text="VList"/> format feature, delete the text that is highlighted below:</Text>
<Format>
&lt;td valign=top&gt;<br/>
{If}{[dc.Format] eq 'Audio',<br/> 
&nbsp;&nbsp;[srclink][srcicon][/srclink],<br/>
&nbsp;&nbsp;[link][icon][/link]}&lt;/td&gt; <br/>
&lt;td valign=top&gt;[highlight] {Or}{[dls.Title],[dc.Title],[Title],Untitled} [/highlight]<highlight>{If}{[ex.Source],&lt;br&gt;&lt;i&gt;([ex.Source])&lt;/i&gt;}</highlight>&lt;/td&gt;</Format> 
</Bullet>
</BulletList>
<Text id="0595">Don't forget to click <AutoText key="glidict::CDM.FormatManager.Replace" type="button"/> after all this work! <b>Preview</b> the result (you don't need to build the collection.)</Text>
</NumberedItem>
<Heading>
<Text id="0596">Using <AutoText text="AZCompactList"/> rather than <AutoText text="AZList"/></Text>
</Heading>
<NumberedItem>
<Text id="0597">There are sometimes several documents with the same title. For example, <AutoText text="All My Loving" type="italics"/> appears both as lyrics and tablature (under <AutoText text="ALL MY LOVING" type="italics"/>). The <AutoText key="coredm::_Global:labelTitle_"/> browser might be improved by grouping these together under a bookshelf icon. This is a job for an <AutoText text="AZCompactList" />.</Text>
<BulletList>
<Bullet>
<Text id="0598">Change to the <AutoText key="glidict::GUI.Design"/> panel and select the <AutoText key="glidict::CDM.GUI.Classifiers"/> section.</Text>
</Bullet>
<Bullet>
<Text id="0599">Remove the <AutoText key="metadata::ex.Title"/> classifier (at the top)</Text>
</Bullet>
<Bullet>
<Text id="0600">Add an <AutoText text="AZCompactList" /> classifier, and enter <AutoText key="metadata::dc.Title"/><b>,</b><AutoText key="metadata::ex.Title"/> as its metadata.</Text>
</Bullet>
<Bullet>
<Text id="0602">Finish by pressing <AutoText key="glidict::General.OK" type="button"/>.</Text>
</Bullet>
<Bullet>
<Text id="0603">Move the new classifier to the top of the list (<AutoText key="glidict::CDM.Move.Move_Up" type="button"/> button).</Text>
</Bullet>
</BulletList>
<Text id="0604"><b>Build</b> the collection again and <b>preview</b> it. Both items for <AutoText text="All My Loving" type="italics"/> now appear under the same bookshelf. However, many entries haven't been amalgamated because of non-uniform titles: for example <AutoText text="A Hard Day's Night" type="italics"/> appears as four different variants. We will learn below how to amalgamate these.</Text>
</NumberedItem>
<Heading>
<Text id="0605">Making bookshelves show how many items they contain</Text>
</Heading>
<NumberedItem>
<Text id="0606">Make the bookshelves show how many documents they contain by inserting a line in the <AutoText text="VList"/> format statement in the <AutoText key="glidict::CDM.GUI.Formats"/> section of the <AutoText key="glidict::GUI.Design"/> panel:</Text>
<Format>
&lt;td valign=top&gt;<br/> 
{If}{[dc.Format] eq 'Audio',<br/> 
&nbsp;&nbsp;[srclink][srcicon][/srclink],<br/> 
&nbsp;&nbsp;[link][icon][/link]}&lt;/td&gt;<br/> 
<highlight>&lt;td&gt;{If}{[numleafdocs],([numleafdocs])}&lt;/td&gt;</highlight><br/> 
&lt;td valign=top&gt;[highlight] {Or}{[dls.Title],[dc.Title],[Title],Untitled} [/highlight]&lt;/td&gt;</Format> 
<Text id="0607">You will find this text in <Path>format_tweaks &rarr; show_num_docs.txt</Path>, which can be copied and pasted in as before. Don't forget to click <AutoText key="glidict::CDM.FormatManager.Replace" type="button"/>.</Text>
<Text id="0609"><b>Preview</b> the result (you don't need to build the collection.)</Text>
</NumberedItem>
<NumberedItem>
<Text id="0610">Now turn to the images. Dummy documents are displayed here too. First change to the <AutoText key="glidict::GUI.Enrich"/> panel, open the folder <Path>cover_images</Path> and add <AutoText key="metadata::dc.Title"/> metadata, assigning to each of the ten documents the title of the corresponding album. Remember, you can double-click a file to view it.</Text>
</NumberedItem>
<NumberedItem>
<Text id="0611">To suppress the dummy documents, change the <AutoText text="VList" /> format statement in the <AutoText key="glidict::CDM.GUI.Formats"/> section of the <AutoText key="glidict::GUI.Design"/> panel again by adding the two highlighted lines, and the close curly bracket:</Text>
<Format>&lt;td valign=top&gt;<br/> 
{If}{[dc.Format] eq 'Audio',<br/> 
&nbsp;&nbsp;[srclink][srcicon][/srclink],<br/> 
&nbsp;&nbsp;<highlight>{If}{[dc.Format] eq 'Images',</highlight><br/> 
&nbsp;&nbsp;&nbsp;&nbsp;<highlight>[srclink][thumbicon][/srclink],</highlight><br/> 
&nbsp;&nbsp;&nbsp;&nbsp;[link][icon][/link]}<highlight>}</highlight>&lt;/td&gt;<br/> 
&lt;td&gt;{If}{[numleafdocs],([numleafdocs])}&lt;/td&gt;<br/> 
&lt;td valign=top&gt;[highlight] {Or}{[dls.Title],[dc.Title],[Title],Untitled} [/highlight]&lt;/td&gt;</Format> 
</NumberedItem>
<NumberedItem>
<Text id="0612">In the <AutoText key="glidict::CDM.GUI.Classifiers"/> section on the <AutoText key="glidict::GUI.Design"/> panel, add a <AutoText text="Phind"/> classifier. Leave the settings at their defaults: this generates a phrase browsing classifier that sources its phrases from <i>Title</i> and <i>text</i>.</Text>
</NumberedItem>
<NumberedItem>
<Text id="0613">To complete the collection, use the browse button of <AutoText key="glidict::CDM.General.Icon_Collection"/> in the <AutoText key="glidict::CDM.GUI.General"/> section of the <AutoText key="glidict::GUI.Design"/> panel to select the following image:</Text>
<Path>advbeatles_large &rarr; images &rarr; flick4.gif.</Path>
<Text id="0616"><b>Build</b> the collection again and <b>preview</b> it.</Text>
</NumberedItem>
<Comment>
<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>
</Comment>
<Heading>
<Text id="0623">Using <AutoText text="UnknownPlug"/></Text>
</Heading>
<Comment>
<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>
</Comment>
<NumberedItem>
<Text id="0627"><AutoText text="UnknownPlug" /> is a useful generic plugin. It knows nothing about any given format but can be tailored to process particular document types&mdash;like MIDI&mdash;based on their filename extension, and set basic metadata.</Text>
<Text id="0627a">In the <AutoText key="glidict::CDM.GUI.Plugins"/> section of the <AutoText key="glidict::GUI.Design"/> panel:</Text>
<BulletList>
<Bullet>
<Text id="0628">add <AutoText text="UnknownPlug" />;</Text>
</Bullet>
<Bullet>
<Text id="0629">activate its <AutoText text="process_extension"/> field and set it to <AutoText text="mid" type="quoted"/> to make it recognize files with extension <AutoText text=".mid" type="italics"/>;</Text>
</Bullet>
<Bullet>
<Text id="0630">Set <AutoText text="file_format"/> to <AutoText text="MIDI" type="quoted"/> and <AutoText text="mime_type"/> to <AutoText text="audio/midi" type="quoted"/>.</Text>
</Bullet>
</BulletList>
<Text id="0631">In this collection, all MIDI files are contained in the file <Path>beatles_midi.zip</Path>. <AutoText text="ZIPPlug" /> (already in the list of default plugins) is used to unpack the files and pass them down the list of plugins until they reach <AutoText text="UnknownPlug"/>.</Text>
</NumberedItem>
<NumberedItem>
<Text id="0632"><b>Build</b> the collection and <b>preview</b> it. Unfortunately the MIDI files don't appear as Audio under the <i>browse</i> button. That's because they haven't been assigned <AutoText key="metadata::dc.Format"/> metadata.</Text>
<BulletList>
<Bullet>
<Text id="0633">Back in the <AutoText key="glidict::GUI.Enrich"/> panel, click on the file <Path>beatles_midi.zip</Path> and assign its <AutoText key="metadata::dc.Format"/> value to "Audio"&mdash;do this by clicking on "Audio" in the <AutoText key="glidict::EnrichPane.ExistingValues" args="dc.Format"/> list. All files extracted from the Zip file inherit its settings.</Text>
</Bullet>
</BulletList>
</NumberedItem>
<Heading>
<Text id="0634">Cleaning up a title browser using regular expressions</Text>
</Heading>
<Comment>
<Text id="0618a">We now clean up the <AutoText key="coredm::_Global:labelTitle_"/> browser.</Text>
</Comment>
<Comment>
<Text id="0621">To do this we must put the Librarian Interface into a different mode. The interface supports four levels of user: <AutoText key="glidict::Preferences.Mode.Assistant"/>, who can add documents and metadata to collections, and create new ones whose structure mirrors that of existing collections; <AutoText key="glidict::Preferences.Mode.Assistant"/>, who can, in addition, design new collections, but cannot use specialist IT features (e.g. regular expressions); <AutoText key="glidict::Preferences.Mode.Systems"/>, who can use all design features, but cannot perform troubleshooting tasks (e.g. interpreting debugging output from Perl programs); and <AutoText key="glidict::Preferences.Mode.Expert"/>, who can perform all functions.</Text>
</Comment>
<Comment>
<Text id="0622">So far you have mostly been operating in <AutoText key="glidict::Preferences.Mode.Librarian"/> mode. We switch to <AutoText key="glidict::Preferences.Mode.Systems"/> mode for the next exercise.</Text>
</Comment>
<NumberedItem>
<Text id="0624">To switch modes, click <Menu><AutoText key="glidict::Menu.File"/> &rarr; <AutoText key="glidict::Menu.File_Options"/> &rarr; <AutoText key="glidict::Preferences.Mode"/></Menu> and change to <AutoText key="glidict::Preferences.Mode.Systems"/>. 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>
</NumberedItem>
<NumberedItem>
<Text id="0635">Next we return to our <AutoText key="coredm::_Global:labelTitle_"/> 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 <AutoText text="ANTHOLOGY 1" type="quoted"/>, <AutoText text="ANTHOLOGY 2" type="quoted"/> and <AutoText text="ANTHOLOGY 3" type="quoted"/> the same for grouping purposes. To achieve this:</Text>
<BulletList>
<Bullet>
<Text id="0636">Go to the Title <AutoText text="AZCompactList" /> under <AutoText key="glidict::CDM.GUI.Classifiers"/> on the <AutoText key="glidict::GUI.Design"/> panel;</Text>
</Bullet>
<Bullet>
<Text id="0637">Activate <AutoText text="removesuffix"/> and set it to:</Text>
<Format>(?i)(\\s+\\d+)|(\\s+[[:punct:]].*)</Format> 
</Bullet>
</BulletList>
<Text id="0638"><b>Build</b> the collection and <b>preview</b> the result. Observe how many more times similar titles have been amalgamated under the same bookshelf. Test your understanding of regular expressions by trying to rationalize the amalgamations. (Note: <AutoText text="[[:punct:]]" type="italics"/> stands for any punctuation character.) The icons beside the Word and PDF documents are not the correct ones, but that will be fixed in the next format statement.</Text>
</NumberedItem>
<Comment>
<Text id="0639">The previous exercise was done in <AutoText key="glidict::Preferences.Mode.Systems"/> mode because it requires the use of regular expressions, something librarians are not normally trained in.</Text>
</Comment>
<Comment>
<Text id="0640">One powerful use of regular expressions in the exercise was to clean up the <AutoText key="coredm::_Global:labelTitle_"/> browser. Perhaps the best way of doing this would be to have proper title metadata. The metadata extracted from HTML files is messy and inconsistent, and this was reflected in the original titles a-z browser. Defining proper title metadata would be simple but rather laborious. Instead, we have opted to use regular expressions in the <AutoText text="AZCompactList"/> classifier to clean up the title metadata. This is difficult to understand, and a bit fiddly to do, but if you can cope with its idiosyncrasies it provides a quick way to clean up the extracted metadata and avoid having to enter a large amount of metadata.</Text>
</Comment>
<Heading>
<Text id="0643">Using non-standard macro files</Text>
</Heading>
<Comment>
<Text id="0644">To put finishing touches to our collection, we add some decorative features</Text>
</Comment>
<NumberedItem>
<Text id="0645">Using your Windows file browser outside Greenstone, locate the folder</Text>
<Path>sample_files &rarr; beatles &rarr; advbeat_large</Path> 
</NumberedItem>
<NumberedItem>
<Text id="0646">Copy the <Path>images</Path> and <Path>macros</Path> folders located there into your collection's top-level folder. (It's OK to overwrite the existing <Path>images</Path> folder: the image in it is included in the folder being copied.) The <Path>images</Path> folder includes some useful icons, and the <Path>macros</Path> folder defines some macro names that use these images. To see the macro definitions, take a look by using a text editor to open the file <Path>extra.dm</Path> in the <Path>macros</Path> folder.</Text>
</NumberedItem>
<Heading>
<Text id="0647">Using different icons for different media types</Text>
</Heading>
<NumberedItem>
<Text id="0648">Re-Edit your <AutoText text="VList" /> format statement to be the following (in <AutoText key="glidict::CDM.GUI.Formats"/> on the <AutoText key="glidict::GUI.Design"/> panel)</Text>
<Format><highlight>&lt;td valign=top&gt;</highlight><br/> 
&nbsp;&nbsp;<highlight>{If}{[numleafdocs],[link][icon][/link]}</highlight><br/> 
&nbsp;&nbsp;<highlight>{If}{[dc.Format] eq 'Lyrics',[link]_iconlyrics_[/link]}</highlight><br/> 
&nbsp;&nbsp;<highlight>{If}{[dc.Format] eq 'Discography',[link]_icondisc_[/link]}</highlight><br/> 
&nbsp;&nbsp;<highlight>{If}{[dc.Format] eq 'Tablature',[link]_icontab_[/link]}</highlight><br/> 
&nbsp;&nbsp;<highlight>{If}{[dc.Format] eq 'MARC',[link]_iconmarc_[/link]}</highlight><br/> 
&nbsp;&nbsp;<highlight>{If}{[dc.Format] eq 'Images',[srclink][thumbicon][/srclink]}</highlight><br/> 
&nbsp;&nbsp;<highlight>{If}{[dc.Format] eq 'Supplementary',[srclink][srcicon][/srclink]}</highlight><br/> 
&nbsp;&nbsp;<highlight>{If}{[dc.Format] eq 'Audio',[srclink]{If}{[FileFormat] eq 'MIDI',_iconmidi_,_iconmp3_}[/srclink]}</highlight><br/> 
<highlight>&lt;/td&gt;</highlight><br/> 
&lt;td&gt;<br/> 
{If}{[numleafdocs],([numleafdocs])}<br/> 
&lt;/td&gt;<br/> 
&lt;td valign=top&gt;<br/> 
[highlight]<br/> 
{Or}{[dc.Title],[Title],Untitled}<br/> 
[/highlight]<br/> 
&lt;/td&gt;</Format> 
</NumberedItem>
<NumberedItem>
<Text id="0649">The complete statement is in the file <Path>format_tweaks &rarr; multi_icons.txt</Path>.</Text>
</NumberedItem>
<NumberedItem>
<Text id="0651"><b>Preview</b> your collection as before. Now different icons are used for discography, lyrics, tablature, and MARC metadata. Even MP3 and MIDI audio file types are distinguished. If you let the mouse hover over one of these images a "tool tip" appears explaining what file type the icon represents in the current interface language (note: <Path>extra.dm</Path> only defines English and French).</Text>
</NumberedItem>
<Heading>
<Text id="0652">Changing the collection's background image</Text>
</Heading>
<NumberedItem>
<Text id="0653">Open your collection's <Path>macros</Path> folder and locate the <Path>extra.dm</Path> file within it. <b>Right-click</b> on it. If prompted, select <b>WordPad</b> as the application to open it with.</Text>
</NumberedItem>
<NumberedItem>
<Text id="0654">The file content is fairly brief, specifying only what needs to be overridden from the default behaviour for this collection. In WordPad, near the top of the file you should see:</Text>
<Format>
_collectionspecificstyle_ {<br/>
&lt;style&gt;<br/>
body.bgimage \{ background-image: url("_httpcimages_/beat_margin.gif");  \}<br/>
\#page \{ margin-left: 120px; \}<br/>
&lt;/style&gt;<br/>
}
</Format>
<Text id="0655">Use copy and paste on these lines to make this part of the file look like:</Text>
<Format>
# Original statements<br/>
#_collectionspecificstyle_ {<br/>
#&lt;style&gt;<br/>
#body.bgimage \{ background-image: url("_httpcimages_/beat_margin.gif");  \}<br/>
#\#page \{ margin-left: 120px; \} <br/>
#&lt;/style&gt;<br/>
#}<br/>
<br/>
_collectionspecificstyle_ {<br/>
&lt;style&gt;<br/>
body.bgimage \{ background-image: url("_httpcimages_/tile.jpg");  \}<br/>
&lt;/style&gt;<br/>
}
</Format>
<Text id="0656">A hash (#) at the start of line signals a comment, and Greenstone ignores the following text. We use this to comment out the original statements and replace them with modified lines. It is useful to retain the original version in case we need to restore the original lines at a later date. These lines relate to the background image used. The new image <Path>tile.jpg</Path> was also in the <Path>images</Path> folder that was copied across previously.</Text>
</NumberedItem>
<NumberedItem>
<Text id="0657">Within <b>WordPad</b>, save <i>extra.dm</i>.</Text>
</NumberedItem>
<NumberedItem>
<Text id="0658"><b>Preview</b> the collection's home page. The page background is now the new graphic.</Text>
<Text id="0659">Other features can be altered by editing the macro files&mdash;for example, the headers and footers used on each page, and the highlighting style used for search terms (specify a different colour, use bold etc.).</Text>
</NumberedItem>
<NumberedItem>
<Text id="0660">If you want to you can reverse the most recent change you made by commenting out the new lines added (add #) and uncommenting the original lines (delete # character). Remember to save the file. To undo all the customized changes made, delete the content of the <Path>macros</Path> and <Path>images</Path> folders.</Text>
</NumberedItem>
<Heading>
<Text id="0661">Building a full-size version of the collection</Text>
</Heading>
<NumberedItem>
<Text id="0662">To finish, let's now build a larger version of the collection. To do this:</Text>
<BulletList>
<Bullet>
<Text id="0663">Close the current collection (<Menu><AutoText key="glidict::Menu.File"/> &rarr; <AutoText key="glidict::Menu.File_Close"/></Menu>).</Text>
</Bullet>
<Bullet>
<Text id="0664">Start a new collection called <i>advbeat</i> (<Menu><AutoText key="glidict::Menu.File"/> &rarr; <AutoText key="glidict::Menu.File_New"/></Menu>).</Text>
</Bullet>
<Bullet>
<Text id="0665">Base this new collection on <i>small_beatles</i>.</Text>
</Bullet>
<Bullet>
<Text id="0666">Copy the content of <Path>sample_files &rarr; beatles &rarr; advbeat_large &rarr; import</Path> into this newly formed collection. Since there are considerably more files in this set of documents the copy will take longer.</Text>
</Bullet>
<Bullet>
<Text id="0670"><b>Build</b> the collection and preview the result. (If you want the collection to have an icon, you will have to add it from the <AutoText key="glidict::GUI.Design"/> panel.)</Text>
</Bullet>
</BulletList>
</NumberedItem>
<Heading>
<Text id="0671">Adding an image collage browser</Text>
</Heading>
<NumberedItem>
<Text id="0672">Switch to the <AutoText key="glidict::GUI.Design"/> panel and select the <AutoText key="glidict::CDM.GUI.Classifiers"/> section. Pull down the <AutoText key="glidict::CDM.ClassifierManager.Classifier"/> menu and select <AutoText text="Collage"/>. Click <AutoText key="glidict::CDM.ClassifierManager.Add" type="button"/>. There is no need to customize the options, so click <AutoText key="glidict::General.OK" type="button"/> at the bottom of the resulting popup.</Text>
</NumberedItem>
<NumberedItem>
<Text id="0673">Now change to the <AutoText key="glidict::GUI.Create"/> panel and <b>build</b> and <b>preview</b> the collection.</Text>
</NumberedItem>
</Content>
</Tutorial>
<Tutorial id="scanned_image_collection">
<Title>
<Text id="0674">Scanned image collection</Text>
</Title>
<SampleFiles folder="niupepa"/>
<Version initial="2.60" current="2.70"/>
<Content>
<Comment>
<Text id="0675">Here we build a small replica of Niupepa, the Maori Newspaper collection, using five newspapers taken from two newspaper series. It allows full text searching and browsing by title and date. When a newspaper is viewed, a preview image and its corresponding plain text are presented side by side, with a goto page navigation feature at the top of the page.</Text>
</Comment>
<Comment>
<Text id="0676">The collection involves a mixture of plug-ins, classifiers, and format statements. The bulk of the work is done by <AutoText text="PagedImgPlug"/>, a plug-in designed precisely for the kind of data we have in this example. For each document, an <AutoText text="item" type="quoted"/> file is prepared that specifies a list of image files that constitute the document, tagged with their page number and (optionally) accompanied by a text file containing the machine-readable version of the image, which is used for full text searching. Three newspapers in our collection (all from the series <AutoText text="Te Whetu o Te Tau" type="quoted"/>) have text representations, and two (from <AutoText text="Te Waka o Te Iwi" type="quoted"/>) have images only. Item files can also specify metadata. In our example the newspaper series is recorded as <AutoText key="metadata::ex.Title"/> and its date of publication as <AutoText key="metadata::ex.Date"/>. This metadata is extracted as part of the building process.</Text>
</Comment>
<NumberedItem>
<Text id="0677">Start a new collection called <b>Paged Images</b> and fill out the fields with appropriate information: it is a collection sourced from an excerpt of Niupepa documents; the only metadata used is document title and date, and these are extracted from the <AutoText text="item" type="quoted"/> files included in the source documents so no metadata set need be stipulated.</Text>
</NumberedItem>
<NumberedItem>
<Text id="0678">In the <AutoText key="glidict::CDM.GUI.Plugins"/> section on the <AutoText key="glidict::GUI.Design"/> panel, add <AutoText text="PagedImgPlug" />. Switch on its <AutoText text="screenview"/> 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 <AutoText text="screenview"/> option generates smaller screen-resolution images of each page when the collection is built.</Text>
</NumberedItem>
<NumberedItem>
<Text id="0679">In the <AutoText key="glidict::GUI.Gather"/> panel, open the <Path>niupepa &rarr; sample_items</Path> folder in <Path>sample_files</Path> and drag it into your collection on the right-hand side.</Text>
</NumberedItem>
<NumberedItem>
<Text id="0680">Some of the files you have just dragged in are text files that contain the text extracted from page images. We want these to be processed by <AutoText text="PagedImgPlug" />, not <AutoText text="TEXTPlug" />. Switch to the <AutoText key="glidict::GUI.Design"/> panel and delete <AutoText text="TEXTPlug" />. While you are at it, you could tidy things up by deleting <AutoText text="HTMLPlug" />, <AutoText text="EMAILPlug" />, <AutoText text="PDFPlug" />, <AutoText text="RTFPlug" />, <AutoText text="WordPlug" />, <AutoText text="PSPlug" />, <AutoText text="ISISPlug" /> and <AutoText text="NULPlug" /> as well, since they will not be used.</Text>
</NumberedItem>
<NumberedItem>
<Text id="0681">Now go to the <AutoText key="glidict::GUI.Create"/> panel, <b>build</b> the collection and <b>preview</b> the result. Search for <AutoText text="waka" type="quoted"/> and view one of the titles listed (all three appear as <AutoText text="Te Whetu o Te Tau" type="italics"/>). Browse by <AutoText key="coredm::_Global:labelTitle_"/> and view one of the <AutoText text="Te Waka o Te Iwi" type="italics"/> titles.</Text>
</NumberedItem>
<Comment>
<Text id="0682">This collection was built with Greenstone's default settings. You can locate items of interest, but the information is less clearly and attractively presented than in the full Niupepa collection.</Text>
</Comment>
<Heading>
<Text id="0683">Grouping documents by series title and displaying dates within each group</Text>
</Heading>
<Comment>
<Text id="0684">Under titles a-z documents from the same series are repeated without any distinguishing features such as date. It would be better to group them by series title and display dates within each group. This can be accomplished using an <AutoText text="AZCompactList"/> classifier rather than <AutoText text="AZList"/>, and tuning the <AutoText text="VList"/> format statement.</Text>
</Comment>
<NumberedItem>
<Text id="0685">In the <AutoText key="glidict::GUI.Design"/> panel, under the <AutoText key="glidict::CDM.GUI.Classifiers"/> section, delete the <AutoText text="AZList" /> classifiers for <AutoText key="metadata::ex.Source"/> and <AutoText key="metadata::ex.Title"/>.</Text>
</NumberedItem>
<NumberedItem>
<Text id="0686">Now add an <AutoText text="AZCompactList" /> classifier, setting its <AutoText text="metadata"/> option to <AutoText key="metadata::ex.Title"/>, and add a <AutoText text="DateList" /> classifier, setting its <AutoText text="metadata"/> option to <AutoText key="metadata::ex.Date"/>.</Text>
</NumberedItem>
<NumberedItem>
<Text id="0687"><b>Modify</b> the format statement for <AutoText text="VList" />. Find the part of the default statement that says</Text>
<Format>{If}{[ex.Source],&lt;br&gt;&lt;i&gt;([ex.Source])&lt;/i&gt;}</Format> 
<Text id="0689">and change it to</Text>
<Format>{If}{[ex.Date],: [ex.Date]}</Format> 
<Text id="0690">This has the effect of displaying the extracted date information, if present.</Text>
</NumberedItem>
<NumberedItem>
<Text id="0691">At the end of this format statement, where is says:</Text>
<Format>&lt;/td&gt;</Format> 
<Text id="0692">append</Text>
<Format>{If}{[numleafdocs],&lt;td&gt;([numleafdocs] items)&lt;/td&gt;}</Format> 
<Text id="0692a">and click <AutoText key="glidict::CDM.FormatManager.Replace" type="button"/>.</Text>
<Comment>
<Text id="0693">As a consequence of using the <AutoText text="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 <AutoText text="numleafdocs"/> metadata.</Text>
</Comment>
</NumberedItem>
<Heading>
<Text id="0694">Suppressing dummy text</Text>
</Heading>
<Comment>
<Text id="0695">When you reach a newspaper, only its associated text is displayed. When either of the <AutoText text="Te Waka o Te Iwi"/> newspapers is accessed, the document view presents the message <AutoText key="perlmodules::BasPlug.dummy_text" type="quoted"/>. No scanned image information (screen-view resolution or otherwise) is shown, even though it has been computed and stored with the document. This can be fixed by a format statement that modifies the default behaviour for <AutoText text="DocumentText"/>.</Text>
</Comment>
<NumberedItem>
<Text id="0696">Staying within the <AutoText key="glidict::CDM.GUI.Formats"/> section of the <AutoText key="glidict::GUI.Design"/> panel, under <AutoText key="glidict::CDM.FormatManager.Feature"/> select <AutoText text="DocumentText"/>. The default format string displays the document's plain text, which, if there is none, is set to <AutoText key="perlmodules::BasPlug.dummy_text" type="quoted"/>. Change this to:</Text>
<Format>
&lt;center&gt;<br/>  
&nbsp;&nbsp;&lt;table width=_pagewidth_&gt;<br/>  
&nbsp;&nbsp;&nbsp;&nbsp;&lt;tr&gt;<br/>  
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&lt;td valign=top&gt;[srclink][screenicon][/srclink]&lt;/td&gt;<br/>  
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&lt;td&gt;[Text]&lt;/td&gt;<br/>  
&nbsp;&nbsp;&nbsp;&nbsp;&lt;/tr&gt;<br/>  
&nbsp;&nbsp;&lt;/table&gt;<br/> 
&lt;/center&gt;
</Format>
<Text id="0696a">and click <AutoText key="glidict::CDM.FormatManager.Replace" type="button"/>.</Text>
<Text id="0697">(available as <Path>niupepa &rarr; doc_tweak.txt</Path>)</Text>
<Comment>
<Text id="0698">Including <Format>[screenicon]</Format> has the effect of embedding the screen-sized image generated by switching the screenview option on in <AutoText text="PagedImgPlug"/>. It is hyperlinked to the original image by the construct <Format>[srclink]...[/srclink]</Format>.</Text>
</Comment>
</NumberedItem>
<NumberedItem>
<Text id="0699">Switch to the <AutoText key="glidict::GUI.Create"/> panel<b>;</b> <b>build</b> and <b>preview</b> the revised collection.</Text>
</NumberedItem>
<NumberedItem>
<Text id="0700">If you like, add a logo and change the background as you have done before. You will find a suitable image in the file <Path>niupepa &rarr; images</Path>, that is activated through <Path>macros &rarr; extra.dm</Path>.</Text>
</NumberedItem>
<Comment>
<Text id="0701">In the collection you have just built, newspapers are grouped by series title, and dates are supplied alongside each one to distinguish it from others in the same series. Users can browse chronologically by date, and when a newspaper page is viewed a preview image is shown on the left that displays the original high-resolution version when clicked, accompanied on the right by the plain-text version of that newspaper (if available).</Text>
</Comment>
</Content>
</Tutorial>
<Tutorial id="OAI_collection">
<Title>
<Text id="0702">Open Archives Initiative (OAI) collection</Text>
</Title>
<SampleFiles folder="oai"/>
<Version initial="2.60" current="2.70"/>
<Content>
<Comment>
<Text id="0703">This exercise explores service-level interoperability using the Open Archive Initiative Protocol for Metadata Harvesting (OAI-PMH). So that you can do this on a stand-alone computer, we do not actually connect to the external server that is acting as the data provider. Instead we have provided an appropriate set of files that take the form of XML records produced by the OAI-PMH protocol.</Text>
</Comment>
<Comment>
<Text id="0704">One of Greenstone's documented example collections is sourced over OAI. This exercise takes you through the steps necessary to reconstruct it. (Note: this example is a collection of images: you will not be able to build it unless ImageMagick is installed on your computer.) You may wish to take a look at the documented example collection OAI demo now to see what this exercise will build.</Text>
</Comment>
<NumberedItem>
<Text id="0705">Start a new collection called <b>OAI Service Provider</b>. Fill out the fields with appropriate information. You can leave the default metadata set as Dublin Core, although we do not make use of it.</Text>
</NumberedItem>
<NumberedItem>
<Text id="0706">In the <AutoText key="glidict::GUI.Gather"/> panel, navigate to the <Path>sample_small</Path> folder in <Path>sample_files &rarr; oai</Path>. Drag this folder into the collection and drop it there.</Text>
</NumberedItem>
<NumberedItem>
<Text id="0707">During the copy operation, a popup window appears asking whether to add <AutoText text="OAIPlug" /> to the list of plug-ins used in the collection, because the Librarian Interface has not found an existing plug-in that can handle this file type. Press the <AutoText key="glidict::CDM.PlugInManager.QuickAdd" type="button"/> button to include it.</Text>
</NumberedItem>
<Comment>
<Text id="0708">When files are copied across like this, the Librarian Interface studies each one and uses its filename extension to check whether the collection contains a corresponding plug-in. No plug-in in the list is capable of processing the OAI file records that are copied across (they have the file extension .oai), so the Librarian Interface prompts you to add the appropriate plug-in.</Text>
</Comment>
<Comment>
<Text id="0709">Sometimes there is more than one plug-in that could process a file&mdash;for example, the .xml extension is used for many different XML formats. The popup window, therefore, offers a choice of all possible plug-ins that matched. It is normally easy to determine the correct choice. If you wish, you can ignore the prompt (click <AutoText key="glidict::CDM.PlugInManager.Ignore" type="button"/>), because plug-ins can be added later, in the <AutoText key="glidict::CDM.GUI.Plugins"/> section of the <AutoText key="glidict::GUI.Design"/> panel.</Text>
</Comment>
<NumberedItem>
<Text id="0710">You need to configure the Image plug-in. In the <AutoText key="glidict::GUI.Design"/> panel, select the <AutoText key="glidict::CDM.GUI.Plugins"/> section, then select the <AutoText text="plugin ImagePlug"/> line and click <AutoText key="glidict::CDM.PlugInManager.Configure" type="button"/>. In the resulting popup window locate the <AutoText text="screenviewsize"/> option, switch it on, and type the number <AutoText text="300"/> in the box beside it to create a screen-view image of 300 pixels. Click <AutoText key="glidict::General.OK" type="button"/>.</Text>
</NumberedItem>
<NumberedItem>
<Text id="0711">Now switch to the <AutoText key="glidict::GUI.Create"/> panel and <b>build</b> and <b>preview</b> the collection.</Text>
</NumberedItem>
<Comment>
<Text id="0712">Like other collections we have built by relying on Greenstone defaults, the end result is passable but can be improved. The next steps refine the collection using the metadata harvested by OAI-PMH into the .oai files.</Text>
</Comment>
<NumberedItem>
<Text id="0713">In the <AutoText key="glidict::CDM.GUI.Classifiers"/> section of the <AutoText key="glidict::GUI.Design"/> panel, delete the two <AutoText text="AZList" /> classifiers (<AutoText key="metadata::ex.Title"/> and <AutoText key="metadata::ex.Source"/>).</Text>
</NumberedItem>
<NumberedItem>
<Text id="0714">Add an <AutoText text="AZCompactList" /> classifier based on <AutoText key="metadata::ex.Subject"/> metadata.</Text>
</NumberedItem>
<NumberedItem>
<Text id="0715">Now add an <AutoText text="AZCompactList" /> classifier based on <AutoText key="metadata::ex.Description"/> metadata. In its configuration panel set <AutoText text="mincompact"/> to  <AutoText text="1"/>, <AutoText text="maxcompact"/> to <AutoText text="10"/> and <AutoText text="buttonname"/> to <AutoText text="Captions"/>.</Text>
</NumberedItem>
<NumberedItem>
<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 called "captions" based on <AutoText key="metadata::ex.Description"/> metadata.</Text>
</NumberedItem>
<NumberedItem>
<Text id="0717"><b>Build</b> collection and <b>preview</b> it.</Text>
</NumberedItem>
<Heading>
<Text id="0718">Tweaking the presentation with format statements</Text>
</Heading>
<NumberedItem>
<Text id="0719">In the <AutoText key="glidict::GUI.Design"/> panel, select <AutoText key="glidict::CDM.GUI.Formats"/>. First replace the <AutoText text="VList" /> format statement with this:</Text>
<Format>
&lt;td&gt;<br/> 
&nbsp;&nbsp;{If}{[numleafdocs],[link][icon][/link],[link][thumbicon][/link]}<br/> 
&lt;/td&gt;<br/> 
&lt;td valign=middle&gt;<br/> 
&nbsp;&nbsp;{If}{[numleafdocs],[Title],&lt;i&gt;[Description]&lt;/i&gt;}<br/> 
&lt;/td&gt;
</Format> 
<Text id="0720">You will find this text in the file <Path>vlist_tweak.txt</Path> in the <Path>oai &rarr;format_tweaks</Path> folder of <Path>sample_files</Path>. Remember to press <AutoText key="glidict::CDM.FormatManager.Replace" type="button"/> when finished</Text>
<Comment>
<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. Greenstone's default is to use extracted metadata, so <Format>[Description]</Format> is the same as <Format>[ex.Description]</Format>.</Text>
</Comment>
</NumberedItem>
<NumberedItem>
<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>
<Format>&lt;h3&gt;[Subject]&lt;/h3&gt;</Format> 
<Comment>
<Text id="0723">The document heading appears above the detach and no highlighting 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>sample_small &rarr; oai &rarr; JCDLPICS &rarr; srcdocs</Path> and check its <AutoText key="metadata::ex.Filename"/> and <AutoText key="metadata::ex.Title"/> metadata. The above format statement displays <AutoText key="metadata::ex.Subject"/> metadata instead.</Text>
</Comment>
</NumberedItem>
<NumberedItem>
<Text id="0727">Finally, you will have noticed that where the document itself should appear, you see only <AutoText key="perlmodules::BasPlug.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>
<Format>&lt;center&gt;&lt;table width=_pagewidth_ border=1&gt;<br/> 
&lt;tr&gt;&lt;td colspan=2 align=center&gt;<br/> 
&lt;a href=[OrigURL]&gt;[screenicon]&lt;/a&gt;&lt;/td&gt;&lt;/tr&gt;<br/> 
&lt;tr&gt;&lt;td&gt;Caption:&lt;/td&gt;&lt;td&gt; &lt;i&gt;[Description]&lt;/i&gt; &lt;br&gt;<br/> 
(&lt;a href=[OrigURL]&gt;original [ImageWidth]x[ImageHeight] [ImageType] available&lt;/a&gt;)<br/> 
&lt;/td&gt;&lt;/tr&gt;<br/> 
&lt;tr&gt;&lt;td&gt;Subject:&lt;/td&gt;&lt;td&gt; [Subject]&lt;/td&gt;&lt;/tr&gt;<br/> 
&lt;tr&gt;&lt;td&gt;Publisher:&lt;/td&gt;&lt;td&gt; [Publisher]&lt;/td&gt;&lt;/tr&gt;<br/> 
&lt;tr&gt;&lt;td&gt;Rights:&lt;td&gt; [Rights]&lt;/td&gt;&lt;/tr&gt;<br/> 
&lt;/table&gt;&lt;/center&gt;</Format> 
<Text id="0727a">Click <AutoText key="glidict::CDM.FormatManager.Replace" type="button"/>.</Text>
<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>
</NumberedItem>
<NumberedItem>
<Text id="0731">Format statements are processed by the runtime system, so the collection does not need to be rebuilt for these changes to take effect. Switch to the <AutoText key="glidict::GUI.Design"/> panel and press <AutoText key="glidict::CreatePane.Preview_Collection" type="button"/> to see the changes.</Text>
</NumberedItem>
<Comment>
<Text id="0732">To expedite building, this collection contains fewer source documents than the pre-built version supplied with the Greenstone installation. However, after these modifications, its functionality is the same.</Text>
</Comment>
</Content>
</Tutorial>
<Tutorial id="OAI_downloading">
<Title>
<Text id="0733">Downloading over OAI</Text>
</Title>
<Prerequisite id="OAI_collection"/>
<Version initial="2.60" current="2.70"/>
<Content>
<Comment>
<Text id="0734">The previous exercise did not obtain the data from an external OAI-PMH server. This missing step is accomplished by running a command-line program. To do this, your computer must have a direct connection to the Internet&mdash;being behind a firewall may interfere with the ability to download the information.</Text>
</Comment>
<NumberedItem>
<Text id="0735"><b>Save</b> your collection. Note its directory name, which should be <i>oaiservi</i> (it appears in the title bar of the Librarian Interface), and <b>quit</b> the Librarian Interface.</Text>
</NumberedItem>
<NumberedItem>
<Text id="0736">In a text editor (e.g. WordPad), open the collection's configuration file, which is in <Path>Greenstone &rarr; collect &rarr; oaiservi &rarr; etc &rarr; collect.cfg</Path>. Add the following line (all on one line):</Text>
<Command>acquire OAI -src rocky.dlib.vt.edu/~jcdlpix/cgi-bin/OAI1.1/jcdlpix.pl -getdoc</Command>
<Text id="0737">Although the position of this line is not critical, we recommend that you place it near the beginning of the file, after the public and creator lines but before the index line. Save the file and quit the editor.</Text>
</NumberedItem>
<NumberedItem>
<Text id="0738">Delete the contents of the collection's <Path>import</Path> folder. This contains the canned version of the collection files, put there during the previous exercise. Now we want to witness the data arriving anew from the external OAI server.</Text>
</NumberedItem>
<NumberedItem>
<Text id="0739">Open a DOS window to access the command-line prompt. This facility should be located somewhere within your <Menu>Start &rarr; Programs</Menu> menu, but details vary between different Windows systems. If you cannot locate it, select <Menu>Start &rarr; Run</Menu> and enter <i>cmd</i> in the popup window that appears.</Text>
</NumberedItem>
<NumberedItem>
<Text id="0742">In the DOS window, move to the home directory where you installed Greenstone. This is accomplished by something like:</Text>
<Command>cd C:\Program Files\Greenstone</Command> 
</NumberedItem>
<NumberedItem>
<Text id="0743">Type:</Text>
<Command>setup.bat</Command> 
<Text id="0744">to set up the ability to run Greenstone command-line programs.</Text>
</NumberedItem>
<NumberedItem>
<Text id="0745">Change directory into the folder containing the OAI Services Provider collection you built in the last exercise.</Text>
<Command>cd collect\oaiservi</Command> 
<Comment>
<Text id="0746">Even though the collection name used capital letters the directory generated by the Librarian Interface is all lowercase.</Text>
</Comment>
</NumberedItem>
<NumberedItem>
<Text id="0747">Run:</Text>
 <Command>perl -S importfrom.pl oaiservi</Command>
<Comment>
<Text id="0748">Greenstone will immediately set to work and generate a stream of diagnostic output. The importfrom.pl program connects to the OAI data provider specified in collection configuration file (it does this for each "acquire" line in the file) and exports all the records on that site.</Text>
</Comment>
</NumberedItem>
<NumberedItem>
<Text id="0749">The downloaded files are saved in the collection's import folder. Once the command is finished, everything is in place and the collection is ready to be built. Confirm you have successfully acquired the OAI records by rebuilding the collection.</Text>
</NumberedItem>
</Content>
</Tutorial>
<Tutorial id="METS_export">
<Title>
<Text id="0750">Use METS as Greenstone's Internal Representation</Text>
</Title>
<Prerequisite id="large_html_collection"/>
<Version initial="2.60" current="2.70"/>
<Content>
<NumberedItem>
<Text id="0751">In the Greenstone Librarian Interface, open the <b>Tudor</b> collection.</Text>
</NumberedItem>
<Comment>
<Text id="0752">To be able to substitute <AutoText text="METSPlug"/> for <AutoText text="GAPlug"/> you need to be in <AutoText key="glidict::Preferences.Mode.Expert"/> mode.</Text>
</Comment>
<NumberedItem>
<Text id="0753">Click <Menu><AutoText key="glidict::Menu.File"/> &rarr; <AutoText key="glidict::Menu.File_Options"/> &rarr; <AutoText key="glidict::Preferences.Mode"/></Menu> and change to <AutoText key="glidict::Preferences.Mode.Expert"/> mode.</Text>
</NumberedItem>
<NumberedItem>
<Text id="0756">Switch to the <AutoText key="glidict::GUI.Design"/> panel select <AutoText key="glidict::CDM.GUI.Plugins"/>. Remove <AutoText text="GAPlug"/> from the list of plug-ins and add <AutoText text="METSPlug" />, with the default configuration options.</Text>
</NumberedItem>
<NumberedItem>
<Text id="0757">Now change to the <AutoText key="glidict::GUI.Create"/> panel, locate the options for the import process and set <AutoText text="saveas"/> to <AutoText text="METS"/>. Import options are not available unless you are in <AutoText key="glidict::Preferences.Mode.Expert"/> mode.</Text>
</NumberedItem>
<NumberedItem>
<Text id="0758">Rebuild the collection.</Text>
</NumberedItem>
<NumberedItem>
<Text id="0759">In your Windows file browser, locate the <Path>archives</Path> folder for the Tudor collection. For each document in the collection, Greenstone has generated two files: <Path>docmets.xml</Path>, the core METS description, and <Path>doctxt.xml</Path>, a supporting file. (Note: unless you are connected to the Internet you will be unable to view <Path>doctxt.xml</Path> in your web browser, because it refers to a remote resource.) Depending on the source documents there may be additional files, such as the images used within a web page. One of MET's many features is the ability to reference information in external XML files. Greenstone uses this to tie the content of the document, which is stored in the external XML file <Path>doctxt.xml</Path>, to its hierarchical structure, which is described in the core METS file <Path>docmets.xml</Path>.</Text>
</NumberedItem>
</Content>
</Tutorial>
<Tutorial id="dspace_to_greenstone">
<Title>
<Text id="0760">Moving a collection from DSpace to Greenstone</Text>
</Title>
<SampleFiles folder="dspace"/>
<Version initial="2.60" current="2.70"/>
<Content>
<NumberedItem>
<Text id="0761">First, change to <AutoText key="glidict::Preferences.Mode.Systems"/> (or <AutoText key="glidict::Preferences.Mode.Expert"/>) mode (using <Menu><AutoText key="glidict::Menu.File"/> &rarr; <AutoText key="glidict::Menu.File_Options"/></Menu>), because you will need to change the order of plug-ins in the <AutoText key="glidict::GUI.Design"/> panel.</Text>
</NumberedItem>
<NumberedItem>
<Text id="0763">Start a <b>new collection</b> called <b>StoneD</b> and fill out its fields appropriately. Leave the metadata set at Dublin Core, the default.</Text>
</NumberedItem>
<NumberedItem>
<Text id="0764">Switch to the <AutoText key="glidict::GUI.Design"/> panel and select the <AutoText key="glidict::CDM.GUI.Plugins"/> section on the left-hand side. <b>Remove</b> <AutoText text="TEXTPlug" />, <AutoText text="HTMLPlug" /> and <AutoText text="EMAILPlug" />. Strictly speaking we do not need to remove these, however it reduces clutter.</Text>
</NumberedItem>
<NumberedItem>
<Text id="0765">Now add <AutoText text="DSpacePlug" />. Leave the plugin options at their defaults and press <AutoText key="glidict::General.OK" type="button"/>.</Text>
</NumberedItem>
<NumberedItem>
<Text id="0766">Using the up and down arrows, <b>Move</b> the position of <AutoText text="DSpacePlug" /> to above <AutoText text="GAPlug" /> and below <AutoText text="ZIPPlug" />.</Text>
</NumberedItem>
<NumberedItem>
<Text id="0767">Now add <AutoText text="MP3Plug" />, with the default configuration options. Its position in the plug-in pipeline need not be changed.</Text>
</NumberedItem>
<NumberedItem>
<Text id="0768">In the <AutoText key="glidict::GUI.Gather"/> panel, locate the folder <Path>sample_files &rarr; dspace &rarr; exported_docs</Path>. It contains five example items exported from a DSpace institutional repository. Copy them into your collection by dragging them over to the right-hand side of the panel.</Text>
</NumberedItem>
<NumberedItem>
<Text id="0769"><b>Build</b> the collection and <b>preview</b> it to see the basic defaults exhibited by a DSpace collection.</Text>
</NumberedItem>
<Comment>
<Text id="0770">If you browse by titles a-z, you will find 7 documents listed, though only 5 items were exported from DSpace. Two of the original items had alternative forms in their directory folder. DSpace plug-in options control what happens in such situations: the default is to treat them as separate Greenstone documents.</Text>
</Comment>
<Comment>
<Text id="0771">Below we use a plug-in option (<AutoText text="first_inorder_ext"/>) to fuse the alternative forms together. This option has the effect of treating documents with the same filename but different extensions as a single entity within a collection. One of the files is viewed as the primary document&mdash;it is indexed, and metadata is extracted from it if possible&mdash;while the others are handled as "associated files."</Text>
</Comment>
<Comment>
<Text id="0772">The <AutoText text="first_inorder_ext"/> option takes as its argument a list of file extensions (separated by commas): the first one in the list that matches becomes the primary document.</Text>
</Comment>
<NumberedItem>
<Text id="0773">Select <AutoText text="DSpacePlug" /> and click <AutoText key="glidict::CDM.PlugInManager.Configure" type="button"/>. Switch on its configuration option <AutoText text="first_inorder_ext"/>. Set its value to <AutoText text="pdf,doc,mp3" type="quoted"/> in the popup window that appears and press <AutoText key="glidict::General.OK" type="button"/>.</Text>
</NumberedItem>
<NumberedItem>
<Text id="0774"><b>Build</b> and <b>preview</b> the collection.</Text>
</NumberedItem>
<Comment>
<Text id="0775">There are now only 5 documents, because only one version of each document has been included&mdash;the primary version.</Text>
</Comment>
<Comment>
<Text id="0776">The DSpace exported files contain Dublin Core metadata for title and author (amongst other things).</Text>
</Comment>
<Heading>
<Text id="0777">Adding indexing and browsing capabilities to match DSpace's</Text>
</Heading>
<NumberedItem>
<Text id="0778">In the <AutoText key="glidict::GUI.Design"/> panel, select <AutoText key="glidict::CDM.GUI.Indexes"/>. Delete the <AutoText key="metadata::ex.Title"/> and <AutoText key="metadata::ex.Source"/> indexes, and add one for <AutoText key="metadata::dc.Title"/> called "titles" and another for <AutoText key="metadata::dc.Contributor"/> called "authors".</Text>
</NumberedItem>
<NumberedItem>
<Text id="0779">Staying within the <AutoText key="glidict::GUI.Design"/> panel, select <AutoText key="glidict::CDM.GUI.Classifiers"/> and <b>delete</b> both <AutoText text="AZList" /> classifiers (<AutoText key="metadata::ex.Title"/> and <AutoText key="metadata::ex.Source"/>). Add an <AutoText text="AZList" /> classifier for <AutoText key="metadata::dc.Title"/> and an <AutoText text="AZCompactList" /> classifier for <AutoText key="metadata::dc.Contributor"/>.</Text>
</NumberedItem>
<NumberedItem>
<Text id="0780">Now select the <AutoText key="glidict::CDM.GUI.Formats"/> section of the <AutoText key="glidict::GUI.Design"/> panel and replace the <AutoText text="VList" /> format statement with this:</Text>
<Format>
&lt;td valign=top&gt;[link][icon][/link]&lt;/td&gt;<br/>
&lt;td valign=top&gt;<br/>
&nbsp;&nbsp;[srclink][srcicon][/srclink]<br/>
&lt;/td&gt;<br/>
&lt;td valign=top&gt;<br/>
&nbsp;&nbsp;[highlight]{Or}{[dc.Title],[ex.Title],Untitled}[/highlight]<br/>
&nbsp;&nbsp;{If}{[ex.Source],&lt;br&gt;&lt;i&gt;([ex.Source])&lt;/i&gt;}<br/>
&nbsp;&nbsp;{If}{[equivlink],&lt;br&gt;Also available as:[equivlink]}<br/>
&lt;/td&gt; 
</Format>
<Text id="0781">You will find this text in the file <Path>format_tweak.txt</Path> in the <Path>dspace</Path> folder of <Path>sample_files</Path>, and you can copy and paste this. Remember to press <AutoText key="glidict::CDM.FormatManager.Replace" type="button"/> when finished.</Text>
</NumberedItem>
<NumberedItem>
<Text id="0782">Also, let's add a format statement for the classifier based on <AutoText key="metadata::dc.Contributor"/> metadata. In the <AutoText key="glidict::CDM.FormatManager.Feature"/> menu (under <AutoText key="glidict::CDM.GUI.Formats"/> on the  <AutoText key="glidict::GUI.Design"/> panel), select the item that says:</Text>
<Indent>
CL2: AZCompactList -metadata <AutoText key="metadata::dc.Contributor"/>
</Indent> 
</NumberedItem>
<NumberedItem>
<Text id="0783">Leave <AutoText text="VList" /> as the <AutoText key="glidict::CDM.FormatManager.Part"/> and edit the text in the <AutoText key="glidict::CDM.FormatManager.Editor"/> box so that it looks like:</Text>
<Format>
&lt;td valign=top&gt;[link][icon][/link]&lt;/td&gt;<br/> 
&lt;td valign=top&gt;<br/>  
&nbsp;&nbsp;[srclink][srcicon][/srclink]<br/> 
&lt;/td&gt;<br/> 
&lt;td valign=top&gt;<br/> 
&nbsp;&nbsp;[highlight]<br/>  
&nbsp;&nbsp;&nbsp;&nbsp;{If}{[numleafdocs],([numleafdocs]) [ex.Title],[dc.Title]}<br/> 
&nbsp;&nbsp;[/highlight]<br/>
&nbsp;&nbsp;{If}{[ex.Source],&lt;br&gt;&lt;i&gt;([ex.Source])&lt;/i&gt;}<br/>
&nbsp;&nbsp;{If}{[equivlink],&lt;br&gt;Also available as:[equivlink]}<br/>
&lt;/td&gt;
</Format>
<Text id="0784">and click <AutoText key="glidict::CDM.FormatManager.Add" type="button"/>. This will display the number of documents for each bookshelf in the authors classifier.</Text>
<Text id="0785">You will find this text in the file <Path>format_contributor.txt</Path> in the <Path>dspace</Path> folder of <Path>sample_files</Path>, and you can copy and paste this.</Text>
</NumberedItem>
<NumberedItem>
<Text id="0786"><b>Build</b> collection once again and <b>preview</b> it.</Text>
</NumberedItem>
<Comment>
<Text id="0787">There are still only 5 documents, but against some of the entries&mdash;for example, <AutoText text="Interview with Bob Dylan" type="quoted"/>&mdash;appears the line <AutoText text="Also available as:" type="quoted"/> followed by icons that link to the alternative representations.</Text>
</Comment>
</Content>
</Tutorial>
<Tutorial id="greenstone_to_dspace">
<Title>
<Text id="0788">Moving a collection from Greenstone to DSpace</Text>
</Title>
<Prerequisite id="dspace_to_greenstone"/>
<Version initial="2.60" current="2.70"/>
<Content>
<Comment>
<Text id="0789">In this exercise you export a Greenstone collection in a form suitable for DSpace. It is possible to do this from the Librarian Interface's <AutoText key="glidict::Menu.File"/> menu, which contains an item called <AutoText key="glidict::Menu.File_ExportAs"/>, that allows you to export collections in different forms. However, to gain a deeper understanding of Greenstone, we perform the work by invoking a program from the Windows command-line prompt. This requires some technical skill; if you are not used to working in the command-line environment we recommend that you skip this exercise.</Text>
</Comment>
<Heading>
<Text id="0790">Using Greenstone from the command line</Text>
</Heading>
<NumberedItem>
<Text id="0790a">Open a DOS window to access the command-line prompt. This facility should be located somewhere within your <Menu>Start &rarr; Programs</Menu> menu, but details vary between different Windows systems. If you cannot locate it, select <Menu>Start &rarr; Run</Menu> and enter <Command>cmd</Command> in the popup window that appears.</Text>
</NumberedItem>
<NumberedItem>
<Text id="0790b">In the DOS window, move to the home directory where you installed Greenstone. This is accomplished by something like:</Text>
<Command>cd C:\Program Files\Greenstone</Command> 
</NumberedItem>
<NumberedItem>
<Text id="0790c">Type:</Text>
<Command>setup.bat</Command> 
<Text id="0790d">to set up the ability to run Greenstone command-line programs.</Text>
</NumberedItem>
<NumberedItem>
<Text id="0790e">Change directory into the folder containing the StoneD collection you built in the last exercise.</Text>
<Command>cd collect\stoned</Command> 
</NumberedItem>
<NumberedItem>
<Text id="0792">Run the following command to export the collection using the DSpace import/export format:</Text>
<Command>perl -S export.pl -saveas DSpace -removeold stoned</Command> 
</NumberedItem>
<Comment>
<Text id="0793">Exporting in Greenstone is an additive process. If you ran the <Command>export.pl</Command> command once again, the new files exported would be added&mdash;with different folder names&mdash;to those already in the export folder. For the kind of explorations we are conducting we might re-run the command several times. The <Command>-removeold</Command> option deletes files that have previously been exported.</Text>
</Comment>
<NumberedItem>
<Text id="0794">This command has created a new subfolder, <Path>collect &rarr; stoned &rarr; export</Path>. Use the file browser to explore it. In it are the files needed to ingest this set of documents into DSpace.</Text>
</NumberedItem>
<Comment>
<Text id="0795">You could equally well run the <Command>export.pl</Command> command on a different Greenstone collection and transfer the output to a DSpace installation by using DSpace's batch-import facility.</Text>
</Comment>
</Content>
</Tutorial>
</TutorialList>