Changeset 8527 for trunk/gli/help/en


Ignore:
Timestamp:
2004-11-12T14:29:22+13:00 (19 years ago)
Author:
mdewsnip
Message:

Reasonably substantially updated the GLI documentation, particularly for new metadata code, deleting collections, and the removal of the metadata set editor. French, Spanish and Russian translations of the new strings will be provided by UNESCO before the CD-ROM is created.

File:
1 edited

Legend:

Unmodified
Added
Removed

  • trunk/gli/help/en/help.xml

    r7653 r8527  
    8989  <Section name="startingoff">
    9090    <Title>Starting Off</Title>
    91 This section covers how to create, save and load a collection.
     91{2.intro}
    9292    <Section name="creatingacollection">
    9393      <Title>Creating a New Collection</Title>
    … …  
    102102          </ContentsItem>
    103103          <ContentsItem>
    104             The collection name
    105           </ContentsItem>
    106           <ContentsItem>
    107             The creator's email
    108           </ContentsItem>
    109           <ContentsItem>
    110104            Default metadata sets
    111105          </ContentsItem>
    … …  
    131125need to, in the design view.
    132126<Break/>
    133 "Title" is the text displayed at the top of your collection's home page.  It can
     127"Collection title" is the text displayed at the top of your collection's home page.  It can
    134128be any length.
    135 <Break/>
    136 "Short Name" is the collection's filename.  It must be unique.
    137 <Break/>
    138 "Author's Email" should be a valid email address.
    139129<Break/>
    140130"Description of content"
    … …  
    225215existing metadata. The process is described in the <Reference target="importingpreviouslyassignedmetadata">Importing Previously Assigned Metadata</Reference> section.
    226216    </Section>
     217    <Section name="deletingcollections">
     218      <Title>{2.4.title}</Title>
     219<ObviousSentence>{2.4.obvious}</ObviousSentence>
     220      <Contents>
     221        <ContentsGroup linkto="simple">
     222          <ContentsItem>
     223            {2.4.contents}
     224          </ContentsItem>
     225        </ContentsGroup>
     226      </Contents>
     227      <Anchor name="simple">Simple Instructions:</Anchor>
     228{2.4.text}
     229    </Section>
    227230  </Section>
    228231
    … …  
    230233 <Section name="downloadingfiles">
    231234    <Title>Downloading Files From the Internet</Title>
    232 This section only
    233 applies when the "Mirror" view is enabled.  If this tab does
    234 not appear, advanced users can enable it by editing the "config.xml" file in
    235 the Librarian Interface installation folder (or, on a multiuser system, in your
    236 home directory's ".gli" folder) to set the value of "workflow.mirror" to
    237 "true". To download web pages you need to install the mirroring tool wget
    238 (version v1.9 recommended) and make it accessible from the Librarian
    239 Interface "install" folder.
    240 <Break/>
    241 After this, you can download (or "mirror") the
    242 files you need. This section explains the Librarian Interface's mirroring
    243 process.
     235{3.intro} This section explains the Librarian Interface's mirroring process.
    244236    <Section name="themirrorview">
    245237      <Title>The Mirror view</Title>
    … …  
    345337(the shape of the pointer changes) and dragging.
    346338<Break/>
    347 Beneath is the Status Area, which describes the state of the Librarian
    348 Interface: how many items are selected and what action is requested.  It
    349 reports on the progress of actions that involve files, which can take some time
    350 to complete. The "Stop" button stops any action that is currently in progress.
     339{4.1.status} The "Stop" button stops any action that is currently in progress.
    351340<Break/>
    352341Two large buttons occupy the lower right corner of the screen. "New Folder", with a picture
    … …  
    362351have special significance.  The Librarian Interface can map such folders to
    363352the first level of the file tree.  To do this, right-click the desired
    364 folder.  Select "Map", and enter a name for the folder.  To remove an item,
    365 right-click the mapped folder and select "Unmap Folder".
     353folder.  Select "Create Shortcut", and enter a name for the folder.  To remove an item,
     354right-click the mapped folder and select "Remove Shortcut".
    366355    </Section>
    367356    <Section name="creatingfolders">
    … …  
    506495          </ContentsItem>
    507496          <ContentsItem>
    508             The MetaEdit Controls
     497            {5.1.controls.short}
    509498          </ContentsItem>
    510499          <ContentsItem>
    … …  
    524513<Break/>
    525514On the left of the "Enrich" view is the Collection Tree. To the right is the Metadata Table, which shows metadata for any selected files or folders in the Collection Tree.  Columns are named in
    526 grey at the top, and can be resized by dragging the separating line.  Clicking
    527 any row transfers its details to the MetaEdit Controls below.  If several files
    528 are selected, black text indicates that the value is common to all of the
     515grey at the top, and can be resized by dragging the separating line. {5.1.controls.1}
     516If several files are selected, black text indicates that the value is common to all of the
    529517selected files, while grey text indicates that it is not.  Black values may be
    530518updated or removed, while grey ones can be removed from those that have it, or
    … …  
    536524folder icon to go immediately to the folder where the metadata is assigned.
    537525<Break/>
    538 The MetaEdit Controls at the lower right appear only when a file is selected
    539 from the tree and a row is selected from the table.  Use them to update, append,
     526{5.1.controls.2} Use them to update, append,
    540527and remove the metadata value.  The value field is for entering or editing the
    541528metadata value.  Beside it is a button labelled "..." which, when clicked,
    … …  
    550537automatically places it into the value field.  Conversely, typing in the text
    551538field selects the Value Tree entry that starts with the characters you have
    552 typed.  Pressing [Enter] auto-completes the typing with the selected value.
    553 <Break/>
    554 Metadata values can be organised into a hierarchy. This is shown in the Value Tree using folders for internal levels. Hierarchical values can be entered using the character "\" to separate the levels.  For
    555 example, "Cards\Red\Diamonds\Seven" might be used in a hierarchy that represents a pack of playing cards. This enables values to be grouped together. Groups can also be assigned as metadata to files.
     539typed.  Pressing [Tab] auto-completes the typing with the selected value.
     540<Break/>
     541Metadata values can be organised into a hierarchy. This is shown in the Value Tree using folders for internal levels. Hierarchical values can be entered using the character "|" to separate the levels.  For
     542example, "Cards|Red|Diamonds|Seven" might be used in a hierarchy that represents a pack of playing cards. This enables values to be grouped together. Groups can also be assigned as metadata to files.
    556543<Break/>
    557544Greenstone extracts metadata automatically from documents into a metadata set
    … …  
    566553        <ContentsGroup linkto="simple">
    567554          <ContentsItem>
    568             Adding a metadata set
    569           </ContentsItem>
    570         </ContentsGroup>
    571         <ContentsGroup linkto="advanced">
    572           <ContentsItem>
    573             Updating a set
    574           </ContentsItem>
    575           <ContentsItem>
    576             Creating new sets
    577           </ContentsItem>
    578           <ContentsItem>
    579             Exporting a set
     555            {5.2.contents.1}
     556          </ContentsItem>
     557          <ContentsItem>
     558            {5.2.contents.2}
    580559          </ContentsItem>
    581560        </ContentsGroup>
    … …  
    590569Librarian Interface's metadata folder and have the suffix ".mds".
    591570<Break/>
    592 To add a metadata set, choose "Metadata Sets" from the menu bar and select the
    593 "Import Set" action.  A list appears that shows the sets stored in the Librarian
    594 Interface's metadata folder.  Choose one and open it, or click "Browse" to
    595 locate metadata set files stored elsewhere. If the metadata elements have associated value trees, you will be asked whether to import
    596 all values associated with the elements in the set, just those values that make
    597 up the structure of hierarchy-based metadata, or no values at all.
    598       <Anchor name="advanced">Advanced Instructions:</Anchor>
    599 To install a newer version of a metadata set, simply add it as above.  The
    600 Librarian Interface merges the sets, but does not alter values you have
    601 entered.  You may be asked how to merge certain elements.  For example if the
    602 current set and the one you are importing share a common element (which is
    603 likely if you are installing a new version of a set), you are shown as much
    604 information about the existing and new elements as possible, and asked how to
    605 proceed.  Options include merging the elements, renaming the new one, replacing
    606 the old element entirely, or skipping this element.  When merging two elements
    607 you are confronted with the same options, but this time at the "attributes"
    608 (rather than "elements") level.  You can cancel the import operation at any
    609 time.
    610 <Break/>
    611 The ".mds" files are expressed in XML format.  You can edit an existing metadata
    612 set or create a new one with an ordinary text editor.  If you are starting a
    613 new file, copy the Document Type Definition and be sure to follow it, otherwise
    614 the Librarian Interface will be unable to load the metadata set.  Use of an
    615 XML validator or validating editor is recommended.
    616 <Break/>
    617 To export a metadata set, or part of one (e.g.  its assigned value hierarchy, or
    618 all its values), return to the Librarian Interface and choose "Export Set" from
    619 the "Metadata Set" menu.  You will be asked to select appropriate export
    620 options, and a file to export into.
     571{5.2.metadatasets}
    621572    </Section>
    622573    <Section name="appendingmetadata">
    … …  
    634585        <ContentsGroup linkto="advanced">
    635586          <ContentsItem>
    636             Adding to the metadata table
    637           </ContentsItem>
    638           <ContentsItem>
    639             Subject hierarchies
    640             <ContentsItem>
    641               Introduction to subjects
    642         </ContentsItem>
    643             <ContentsItem>
    644               Metadata set editor
    645         </ContentsItem>
    646           </ContentsItem>
    647           <ContentsItem>
    648             Text field entry
    649           </ContentsItem>
    650         </ContentsGroup>
    651         <ContentsGroup linkto="advanced">
    652           <ContentsItem>
    653587            Value hierarchies and editing values
    654588          </ContentsItem>
    … …  
    663597table.
    664598<Break/>
    665 Type the value into the value field.  Do not use the character "\", as it is
     599Type the value into the value field.  Do not use the character "|", as it is
    666600used for constructing hierarchies.  When finished, click "Append" to add the new
    667601value as metadata for the chosen file.  The value immediately appears in the
    … …  
    673607it automatically inherit the folder's values.
    674608<Break/>
    675 When you add metadata to multiple files at once, you will be prompted for confirmation for any files that already have a value for that metadata. You are shown the name of the file in question, the element's
    676 title, previously-assigned values for this element, and the new value.  The
    677 buttons offer different options: "Append" appends the metadata to the file
    678 without altering any existing values; "Append All" adds the new value to all
    679 other files too, without requiring individual confirmation; "Skip File" proceeds to the next file; "Cancel"
    680 undoes any changes and cancels the action.
    681 <Break/>
    682609If you choose metadata that occurs in some of the selected files and click
    683610"Append", it is added to the other files in the selection too.
    684611      <Anchor name="advanced">Advanced Instructions:</Anchor>
    685 You can add structure to metadata values by using paths as described in <Reference target="theenrichview">The Enrich View</Reference>.  Correct any mistakes in creating hierarchies by using
    686 the metadata set editor explained in <Reference target="editingmetadatasets">Editing Metadata Sets</Reference>.
     612You can add structure to metadata values by using paths as described in <Reference target="theenrichview">The Enrich View</Reference>.
    687613    </Section>
    688614    <Section name="addingpreviouslydefinedmetadata">
    … …  
    728654click "Replace" to alter the metadata.
    729655<Break/>
    730 The process is the same when updating a folder with child folders or multiple
    731 files, except that when you click "Replace" you are asked what to do with the
    732 other files.  The buttons offer different options: "Replace" replaces any
    733 previous value with the new one; "Replace All" adds the new value in the same
    734 way to all other files; "Skip File" skips the current file and proceeds to the
    735 next; "Cancel" undoes any changes and cancels the action.  You can only update
    736 metadata that is common to all files selected.  For a folder, this means that
    737 all its contents must share the same metadata.
     656{5.5.multiple}
    738657<Break/>
    739658The value tree shows all previous values, not just those currently assigned.
    … …  
    752671          </ContentsItem>
    753672        </ContentsGroup>
    754         <ContentsGroup linkto="advanced">
    755           <ContentsItem>
    756             Removing from the table
    757           </ContentsItem>
    758         </ContentsGroup>
    759673      </Contents>
    760674      <Anchor name="simple">Simple Instructions:</Anchor>
    761675You remove metadata the same way as you update it.  First select a file from the
    762 file tree, then use the metadata table to select the metadata.  If the metadata
    763 has a value assigned, the "Remove" button in the MetaEdit Controls becomes
    764 active.  Click it to remove the metadata from the specified file.  Other files
     676file tree, then use the metadata table to select the metadata. {5.6.remove}
     677Click it to remove the metadata from the specified file.  Other files
    765678remain unchanged, and the value remains in the Value Tree.
    766679<Break/>
    767 When you remove metadata from a folder, or from several files, you are
    768 presented with various options: removing the metadata from this file, removing
    769 it from this and all other files, and skipping this file.  You can cancel the
    770 operation at any time.  If you choose metadata that is not common to all the
    771 selected files and click "Remove", the metadata is removed from those
    772 files that have it; all others are unaffected.
     680{5.6.multiple}
    773681    </Section>
    774682    <Section name="reviewingmetadata">
    … …  
    795703spread of dates.
    796704<Break/>
    797 Select the files you wish to examine, and from the "Metadata Set" menu choose "Assigned Metadata...". A window called
     705{5.7.activate} A window called
    798706"All Metadata", dominated by a large table with many columns, appears.  The
    799707first column shows file names; the rows show all metadata values assigned to
    … …  
    835743    <Section name="importingpreviouslyassignedmetadata">
    836744      <Title>Importing Previously Assigned Metadata</Title>
    837 This section describes how to import previously assigned metadata,
    838 and install parsers to handle various metadata types.
     745{5.8.intro}
    839746      <Contents>
    840747        <ContentsGroup linkto="simple">
    … …  
    861768Having checked the mapping, you can choose "Add" to add the new metadata
    862769element to the chosen metadata set.  (This is only enabled if there is no
    863 element of the same name within the chosen set.) "Merge" maps the new element
     770element of the same name within the chosen set.) "Replace" maps the new element
    864771to the one chosen by the user.  Finally, "Ignore" does not import any metadata
    865 with this element name.
    866 <Break/>
    867 Once you have specified how to import a certain piece of metadata, the mapping
    868 information is retained for the collection's lifetime.  To correct any mistakes
    869 during importing, use the metadata set editor described in <Reference target="editingmetadatasets">Editing Metadata Sets</Reference>.
     772with this element name.  Once you have specified how to import a certain piece of metadata, the mapping
     773information is retained for the collection's lifetime.
    870774<Break/>
    871775For details on the metadata.xml files which Greenstone uses to store the metadata, see Chapter 2 of the Greenstone
    … …  
    922826what functionality is available.
    923827<Break/>
    924 First are the contact emails of the collection's creator and maintainer.  Then
    925 come two checkboxes for whether the collection should be publicly accessible,
    926 and whether it is still under construction.  The following field allows you to
    927 change the collection title.  The next one specifies (in the form of a URL) the
     828First are the contact emails of the collection's creator and maintainer. 
     829The following field allows you to change the collection title. {6.2.collectionfolder}
     830The next one specifies (in the form of a URL) the
    928831icon to show at the top left of the collection's "About" page, and the next is
    929 the icon used in the Greenstone library page to link to the collection.  Finally
    930 comes the "Collection Description" text area as described in <Reference target="creatingacollection">Creating A New Collection</Reference>.
     832the icon used in the Greenstone library page to link to the collection. {6.2.publiccheckbox}
     833Finally comes the "Collection Description" text area as described in <Reference target="creatingacollection">Creating A New Collection</Reference>.
    931834    </Section>
    932835    <Section name="plugins">
    … …  
    955858            Custom configuration
    956859          </ContentsItem>
    957           <ContentsItem>
    958             Rebuilding the plugin database
    959           </ContentsItem>
    960860        </ContentsGroup>
    961861      </Contents>
    … …  
    965865"Configuring Arguments"; it is described later.  Once you have configured the
    966866new plugin, it is added to the end of the "Currently Assigned Plugins" list.
    967 Note that a plugin may only occur once in the list.
     867{6.3.onceonly}
    968868<Break/>
    969869To remove a plugin, select it in the list and click "Remove Plugin".
    … …  
    971871Plugins are configured by providing arguments.  To alter them, select the
    972872plugin from the list and click "Configure Plugin" (or double-click
    973 the plugin).  A "Configuring Arguments" dialog appears with three parts: a
    974 text field for entering custom arguments, an area containing controls for
    975 specifying arguments, and two buttons at the bottom.
     873the plugin). {6.3.dialog}
    976874<Break/>
    977875There are different kinds of controls.  Some are checkboxes, and clicking one
    … …  
    979877checkbox and a text field.  Click the box to enable the argument, then type
    980878appropriate text (regular expression, file path etc) in the box.  Others are
    981 pull-down menus from which you can select from a given set of values.  Still
    982 others allow multiple selections from a list.  To add a value, select it and
    983 click "Add"; to remove it, select it and click "Remove".  To learn what an
     879pull-down menus from which you can select from a given set of values.  To learn what an
    984880argument does, let the mouse hover over its name for a moment and a description
    985881will appear.
    … …  
    993889building process, and are fixed in place at the end of the list (with a
    994890separator line).  To change the ordering of the other ones, select the plugin you want to move
    995 and click "Move To Top", "Move Up", "Move Down", or "Move To Bottom".
     891and click "Move Up" or "Move Down".
    996892       <Anchor name="advanced">Advanced Instructions:</Anchor>
    997893The Librarian Interface does its best to determine what arguments a plugin
    998 supports.  However, there may be cases where the user wants to specify special
    999 arguments, and for this a text field called "Custom Arguments" (at the top) is
    1000 provided.  Any text in it is appended verbatim to the end of the plugin
     894supports. {6.3.customargs} Any text in it is appended verbatim to the end of the plugin
    1001895command.
    1002896    </Section>
    … …  
    1049943          </ContentsItem>
    1050944          <ContentsItem>
     945            {6.5.replace.short}
     946          </ContentsItem>
     947          <ContentsItem>
    1051948            Remove an index
    1052949          </ContentsItem>
    1053950          <ContentsItem>
    1054951            Set default index
    1055           </ContentsItem>
    1056           <ContentsItem>
    1057             Clear default index
    1058952          </ContentsItem>
    1059953        </ContentsGroup>
    … …  
    1068962Click it to add the new index.
    1069963<Break/>
     964{6.5.replace}
     965<Break/>
    1070966To remove an index, select it from the list of assigned indexes and click
    1071967"Remove Index".
    … …  
    1073969The default index, the one used on the collection's search page, is tagged with
    1074970"[Default Index]" in the "Assigned Indexes" list.  To set it, select an index
    1075 from the list and click "Set Default".  To reset it, click "Clear Default".
     971from the list and click "Set Default".
    1076972<Break/>
    1077973If advanced searching is enabled (via the Search Types view), the index controls are different.  Each index
    … …  
    12411137          </ContentsItem>
    12421138        </ContentsGroup>
    1243         <ContentsGroup linkto="advanced">
    1244           <ContentsItem>
    1245             CustomAZList
    1246           </ContentsItem>
    1247         </ContentsGroup>
    12481139      </Contents>
    12491140      <Anchor name="simple">Simple Instructions:</Anchor>
    … …  
    12641155The ordering of classifiers in the collection's navigation bar is reflected in
    12651156their order here.  To change it, select the classifier you want to move and
    1266 click "Move To Top", "Move Up", "Move Down", or "Move To Bottom".
     1157click "Move Up" or "Move Down".
    12671158<Break/>
    12681159For further information on classifiers read Chapter 2, Greenstone
    12691160Developer's Guide -- Getting the most out of your documents.
    1270       <Anchor name="advanced">Advanced Instructions:</Anchor>
    1271 The CustomAZList classifier is a special classifier that builds an alphabetical
    1272 selection list ("AZList") and allows you to specify the letter ranges.  This
    1273 classifier has its own configuration dialogue.  When a metadata element is
    1274 selected, the "Ranges" tree automatically becomes populated with appropriate
    1275 values.  Expand or collapse the tree as desired.  Select any two values and
    1276 click "Merge" to specify a range, or select a previously merged value and click
    1277 "Split" to restore the values contained within.  When satisfied with the ranges,
    1278 click "OK" to begin processing the documents in the collection.  You can
    1279 "Cancel" the dialog without making any changes to the collection.
    12801161    </Section>
    12811162    <Section name="formatstatements">
    … …  
    13791260            Available metadata sets
    13801261          </ContentsItem>
     1262          <ContentsItem>
     1263            {6.11.contents.1}
     1264          </ContentsItem>
     1265          <ContentsItem>
     1266            {6.11.contents.2}
     1267          </ContentsItem>
     1268          <ContentsItem>
     1269            {6.11.contents.3}
     1270          </ContentsItem>
    13811271        </ContentsGroup>
    13821272      </Contents>
    … …  
    13841274This view is used to review the metadata sets that the collection uses, and the
    13851275elements that are available within each set.  Choose from the list of "Available
    1386 Metadata Sets" in order to see details of their elements.  This view is
    1387 read-only.
     1276Metadata Sets" in order to see details of their elements.
     1277<Break/>
     1278{6.11.adding}
     1279<Break/>
     1280{6.11.editing}
     1281<Break/>
     1282{6.11.removing}
    13881283    </Section>
    13891284  </Section>
    … …  
    14061301      </ContentsItem>
    14071302    </ContentsGroup>
     1303        <ContentsGroup linkto="advanced">
     1304          <ContentsItem>
     1305            Message log
     1306          </ContentsItem>
     1307        </ContentsGroup>
    14081308      </Contents>
    14091309      <Anchor name="simple">Simple Instructions:</Anchor>
    14101310The Create view is used to create the collection by running Greenstone
    1411 collection-building scripts on the information you have provided.  This is
    1412 generally straightforward: just click "Build Collection" at the bottom of the
    1413 screen.  However, the building process can be customized.  You can also use
    1414 this view to review details of previous attempts to build this collection,
    1415 whether successful or not.
    1416 <Break/>
    1417 The buttons for building and cancelling the building process are at the bottom.
    1418 Above appears a group of controls titled "Collection Import &amp; Build Options".
    1419 To the left is a list of three items, and to the right is a pane that reflects
    1420 the currently chosen item in the list, as described in the following sections.
     1311collection-building scripts on the information you have provided. {7.1.simple}
    14211312<Break/>
    14221313Clicking "Build Collection" initiates the collection building process.  The time
    14231314this takes depends on the size of the collection and the number of indexes
    1424 being created (for huge collections it can be hours). To cancel the process at
     1315being created (for huge collections it can be hours). {7.1.progressbar} To cancel the process at
    14251316any time, click "Cancel Build".
    14261317<Break/>
    14271318<!-- added -->
    14281319Once the collection has successfully built, clicking "Preview Collection" will launch a web browser showing the home page of the collection.
     1320      <Anchor name="advanced">Advanced Instructions:</Anchor>
     1321{7.1.messagelog} Select the log you want by clicking on the desired date in the "Log History" list.
    14291322    </Section>
    14301323    <Section name="buildsettings">
    … …  
    14471340      </Contents>
    14481341      <Anchor name="simple">Simple Instructions:</Anchor>
    1449 The first two entries in the list on the left are "Import" and "Build", which
    1450 give settings that apply to the import and build scripts respectively.
    1451 <Break/>
    14521342Controlling the various settings is done in a similar way to the
    14531343"Configuring Arguments" window described in the <Reference target="plugins">Document Plugins</Reference> section.  Some
    … …  
    14561346the interface restricts the range you can enter).  Others are enabled by
    14571347clicking a checkbox (click again to disable).
    1458     </Section>
    1459     <Section name="messagelog">
    1460       <Title>Message Log</Title>
    1461 <ObviousSentence>This section explains the message log.</ObviousSentence>
    1462       <Contents>
    1463         <ContentsGroup linkto="simple">
    1464           <ContentsItem>
    1465             Message log
    1466           </ContentsItem>
    1467         </ContentsGroup>
    1468       </Contents>
    1469       <Anchor name="simple">Simple Instructions:</Anchor>
    1470 The third item on the left is "Message Log".  This shows the output that
    1471 Greenstone generated when it built the collection before.  Select the
    1472 log you want by clicking on the desired date in the "Log History" list.
    1473     </Section>
    1474     <Section name="theprogressview">
    1475       <Title>The Progress View</Title>
    1476 <ObviousSentence>This section explains the building progress view.</ObviousSentence>
    1477       <Contents>
    1478         <ContentsGroup linkto="simple">
    1479           <ContentsItem>
    1480             Measuring progress
    1481           </ContentsItem>
    1482         </ContentsGroup>
    1483       </Contents>
    1484       <Anchor name="simple">Simple Instructions:</Anchor>
    1485 When you start to build a collection, the view changes immediately.  The
    1486 controls described <Reference target="thecreateview">previously</Reference> are replaced by two
    1487 progress bars and a text area.  The bars indicate progress through the import
    1488 phase, then the build phase.  The text area shows the Message Log mentioned in
    1489 the <Reference target="messagelog">previous section</Reference>.
    14901348    </Section>
    14911349  </Section>
    … …  
    15011359        <ContentsGroup linkto="simple">
    15021360      <ContentsItem>
     1361        General
     1362      </ContentsItem>
     1363      <ContentsItem>
    15031364        Mode
    15041365      </ContentsItem>
    … …  
    15151376      </Contents>
    15161377      <Anchor name="simple">Simple Instructions:</Anchor>
    1517 There are three "General" options.  If "View Extracted Metadata" is checked, the
     1378{8.1.usersemail} {8.1.languages} If you change the dictionary by choosing one from the list, you must
     1379restart the Librarian Interface in order to load the new language strings from
     1380the dictionary.
     1381<Break/>
     1382If "View Extracted Metadata" is checked, the
    15181383various controls dealing with metadata always show all metadata that has been
    15191384extracted automatically from documents.  Deselecting it hides this metadata
    15201385(although it is still available during collection design, and within the
    1521 final Greenstone collection).
    1522 <Break/>
    1523 If "Show File Size" is checked, the file size is shown next to each file in the Workspace and Collection file trees in the Gather and Enrich views.
    1524 <Break/>
    1525 The third "General" option is a pull-down list of the various languages that
    1526 the Librarian Interface can be presented in.  These correspond to the
    1527 dictionaries located in the "classes" folder of the Librarian Interface's
    1528 directory.  If you change the dictionary by choosing one from the list, you must
    1529 restart the Librarian Interface in order to load the new language strings from
    1530 the dictionary.
     1386final Greenstone collection). If "Show file sizes" is checked, the file size is shown next to each file in the Workspace and Collection file trees in the Gather and Enrich views.
    15311387<Break/>
    15321388The "Mode" panel is used to control the level of detail within the interface. At its lowest setting, "Library Assistant", the design view is disabled, arguments requiring regular expressions are hidden and the collection building produces a minimal log of events. In contrast the highest setting, "Expert", provides access to all of the features of design, including plugin positioning and regular expression arguments, and also allows the full output from the collection building to be recorded in the logs. To change or review modes, click the radio button next to the mode you are interested in. You can quickly review what mode you are in by looking at the Librarian Interface's title bar.
    … …  
    16211477    </Section>
    16221478  </Section>
    1623 
    1624   <Section name="metadatasetandprofileediting">
    1625     <Title>Metadata Set and Profile Editing</Title>
    1626 This section explains how to edit metadata sets used by the Librarian
    1627 Interface.  This is the only way to remove a value from the "Previous Values"
    1628 tree.  Although you can use the Enrich view to remove a certain value
    1629 from a record, the value remains in the value tree.  To remove it (or any
    1630 part of the metadata set, including its elements), use the metadata set editor.
    1631 <Break/>
    1632 The same tool is used to alter the instructions that map metadata from files
    1633 imported into the collection to existing metadata sets.  These are called
    1634 "importing profiles".
    1635 <Break/>
    1636 To edit a metadata set or importing profile, choose "Metadata Sets" from the menu
    1637 bar and select the "Edit Set" action.
    1638     <Section name="editingmetadatasets">
    1639       <Title>Editing Metadata Sets</Title>
    1640 <ObviousSentence>This section describes how to edit metadata sets and previously assigned values.</ObviousSentence>
    1641       <Contents>
    1642         <ContentsGroup linkto="simple">
    1643           <ContentsItem>
    1644             Editing sets
    1645           </ContentsItem>
    1646           <ContentsItem>
    1647             Editing elements
    1648           </ContentsItem>
    1649         </ContentsGroup>
    1650       </Contents>
    1651       <Anchor name="simple">Simple Instructions:</Anchor>
    1652 On the left of the "Edit Metadata Sets" dialog is a list showing what metadata
    1653 sets and profiles can be edited.  Click one of these and its details will
    1654 appear on the right in one or more tables.  Beneath are buttons for adding,
    1655 editing or removing the various parts; alongside them is the "Close" button.
    1656 Many buttons are greyed out initially, and are activated by selections in the
    1657 tables.  Now we describe how to edit sets and elements.
    1658 <Break/>
    1659 To define a new metadata set, beside "Set" click "Add", fill out the
    1660 information requested, and click "OK".  "Namespace" is a short identifier for
    1661 the new set (e.g.  "dc" for Dublin Core; "dls" for the Development Library
    1662 Subset).
    1663 <Break/>
    1664 To remove a metadata set, select it in the list on the left and click "Remove".
    1665 A confirmation prompt will appear; confirming it <strong>permanently</strong>
    1666 removes the set and all associated metadata.
    1667 <Break/>
    1668 Some information is associated with each metadata set, such as its creator and
    1669 creation date.  We call these "attributes" of the metadata set, and you can
    1670 alter them.
    1671 Beside "Attribute", click "Add" to add an attribute to the selected metadata
    1672 set, fill in the requested information -- name, language and values -- and
    1673 click "OK".  Each metadata set is considered unique, so for a new metadata set
    1674 the pull-down list for the name and value are initially empty.  Beside
    1675 "Attribute", "Edit" becomes active when an attribute is selected in the table
    1676 and leads to the same dialog as "Add" (except that the current value is already
    1677 filled out).  Beside "Attribute", "Remove" becomes active when the attribute is
    1678 selected; when clicked the attribute is removed.
    1679 <Break/>
    1680 Double clicking on a set in the list on the left will display a list of metadata elements in that set. You can add an element, remove it, and remove values from
    1681 it.  To add an element, beside "Element" click "Add" and specify the new
    1682 element's name.
    1683 <Break/>
    1684 To remove a metadata element, select it and beside "Element" click "Remove".
    1685 This <strong>permanently</strong> removes the element and all metadata
    1686 associated with it.
    1687 <Break/>
    1688 Just as information is associated with each metadata set, information can also
    1689 be associated with each metadata element -- metadata about metadata!  Again we
    1690 call these "attributes"; Examples are a language-specific name for the element,
    1691 its definition, or perhaps a general comment.
    1692 <Break/>
    1693 You edit the attributes of an element in the same way that you edit the
    1694 attributes of a metadata set, explained above.  In this case the pull-down
    1695 lists in the add and edit prompts may contain values from the same attribute of
    1696 other elements within the set.
    1697 <Break/>
    1698 You can also alter the "value tree" for an element, which
    1699 contains all the values that have been assigned to it.  You
    1700 can "Add" a value whenever an element is selected.  Choose a parent folder
    1701 (if any), enter the value and click "OK" to put the
    1702 new value in the tree.  You can "Edit" a value that you have selected in the
    1703 value tree; click "OK" to commit the changes.  Note that changing the parent
    1704 subject will cause the value to be moved to that subject.  You can "Remove" a
    1705 value that you have selected in the tree -- but note that this does
    1706 <strong>not</strong> remove all metadata referring to this value, and if the
    1707 value is still in use it will be restored the next time you save.
    1708 <Break/>
    1709 Once you have finished changing the metadata set, click "Close".
    1710     </Section>
    1711     <Section name="editingimportprofiles">
    1712       <Title>Editing Metadata Import Profiles</Title>
    1713 <ObviousSentence>This section describes how to edit metadata importing profiles.</ObviousSentence>
    1714       <Contents>
    1715         <ContentsGroup linkto="simple">
    1716           <ContentsItem>
    1717             Editing profiles
    1718           </ContentsItem>
    1719         </ContentsGroup>
    1720       </Contents>
    1721       <Anchor name="simple">Simple Instructions:</Anchor>
    1722 Double-click the "Importing Profiles" item to see a list of importing profiles
    1723 for importing from other collections into this one.  Each profile is named
    1724 after the collection to which it applies -- that is, the collection that
    1725 documents are coming from.  You can add a profile by clicking "Add" beside
    1726 "Profile" and specifying the name of the collection that it should apply to.  You
    1727 can remove a profile by selecting it and click "Remove" beside "Profile".
    1728 <Break/>
    1729 When a profile is selected, its mapping table appears.  Each line gives a
    1730 correspondence between a metadata element in the collection that the metadata
    1731 comes from, and a metadata element in the collection being constructed.  You
    1732 can edit this table.  To add a new mapping, select a source profile, then click
    1733 "Add" beside "Attribute".  The standard attribute dialog box appears, except
    1734 that the language field is disabled and the "Values" pull-down list contains
    1735 all the elements currently available in the collection.  Mappings can be edited
    1736 and removed as described above.
    1737 <Break/>
    1738 Once you have finished changing the metadata importing profile, click "Close".
    1739     </Section>
    1740   </Section>
    17411479</Document>
Note: See TracChangeset for help on using the changeset viewer.