Ignore:
Timestamp:
2006-01-13T16:00:24+13:00 (18 years ago)
Author:
kjdon
Message:

changes to help for 2.63

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/gli/help/en/help.xml

    r9641 r11036  
    313313program (see <Reference target="fileassociations">File Associations</Reference>).
    314314<Break/>
    315 The Workspace file tree shows the sources of data available to the Librarian Interface -- the local file system (including disk and CD-ROM drives), the contents of existing Greenstone collections, and the cache of downloaded files if Web mirroring is enabled. You can copy and view these files but you cannot move, delete, or edit them, with the exception of the downloaded files, which can be deleted.  Navigate this space to find the files you want to include in the collection.
     315The Workspace file tree shows the sources of data available to the Librarian Interface -- the local file system (including disk and CD-ROM drives), the contents of existing Greenstone collections, and the cache of downloaded files. You can copy and view these files but you cannot move, delete, or edit them, with the exception of the downloaded files, which can be deleted.  Navigate this space to find the files you want to include in the collection.
    316316<Break/>
    317317The Collection file tree represents the contents of the collection so
     
    457457tree.
    458458      <Anchor name="advanced">Advanced Instructions:</Anchor>
    459 You can specify a custom filter by typing in a pattern to match files against.
     459You can specify a custom filter by typing in a pattern to match files against (Librarian Systems Specialist and Expert modes only).
    460460Use standard file system abbreviations such as "*.*" or "*.doc" ("*" matches
    461461any characters).
     
    497497<Break/>
    498498On 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
    499 grey at the top, and can be resized by dragging the separating line. Clicking any row transfers its details to the metadata editing controls below. If several files are selected, black text indicates that the value is common to all of the
     499grey at the top, and can be resized by dragging the separating line. If several files are selected, black text indicates that the value is common to all of the
    500500selected files, while grey text indicates that it is not.  Black values may be
    501501updated or removed, while grey ones can be removed from those that have it, or
     
    506506cannot be edited or removed, only appended to or overwritten.  Click on the
    507507folder icon to go immediately to the folder where the metadata is assigned.
    508 <Break/>
    509 The metadata editing controls at the lower right appear only when a file is selected from the tree and a row is selected from the table. Use them to update, append,
    510 and remove the metadata value.  The value field is for entering or editing the
    511 metadata value.  Beside it is a button labelled "..." which, when clicked,
    512 opens a larger editing box.  In the buttons below, "Append" assigns the value as
    513 new metadata and adds it to any existing values for the selected element,
    514 "Replace" overwrites the selected existing value with the new one, and "Remove" clears
    515 the selected value.  Underneath, labelled "All Previous Values", is the "Value
    516 Tree".
    517508<Break/>
    518509The Value Tree expands and collapses.  Usually it is a list that shows all
     
    527518Greenstone extracts metadata automatically from documents into a metadata set
    528519whose elements are prefixed by "ex.".  This has no value tree and cannot be
    529 edited, so the edit controls are hidden if such an entry is selected.  The
    530 "..." button still serves to expand the value, but the text cannot be edited.
     520edited.
    531521    </Section>
    532522    <Section name="selectingmetadatasets">
     
    580570table.
    581571<Break/>
    582 Type the value into the value field.  Do not use the character "|", as it is
    583 used for constructing hierarchies.  When finished, click "Append" to add the new
    584 value as metadata for the chosen file.  The value immediately appears in the
    585 Metadata table.
     572Type the value into the value field.  Use the "|" character to add structure, as described in <Reference target="theenrichview">The Enrich View</Reference>. Pressing the [Up] or [Down] arrow keys will save the metadata value and move the selection appropriately. Pressing [Enter] will save the metadata value and create a new empty entry for the metadata element, allowing you to assign multiple values to a metadata element.
    586573<Break/>
    587574You can also add metadata to a folder, or to several multiply selected files at
     
    589576folders.  Keep in mind that if you assign metadata to a folder, any new files in
    590577it automatically inherit the folder's values.
    591 <Break/>
    592 If you choose metadata that occurs in some of the selected files and click
    593 "Append", it is added to the other files in the selection too.
    594       <Anchor name="advanced">Advanced Instructions:</Anchor>
    595 You can add structure to metadata values by using paths as described in <Reference target="theenrichview">The Enrich View</Reference>.
    596578    </Section>
    597579    <Section name="addingpreviouslydefinedmetadata">
     
    612594the required value from the value tree, expanding hierarchy folders as
    613595necessary.  The value of the selected entry automatically appears in the Value
    614 text field (alternatively, use the value tree's auto-select and auto-complete
    615 features).  Click "Append" to add the metadata to the selected file.
     596field (alternatively, use the value tree's auto-select and auto-complete
     597features).
    616598<Break/>
    617599The process of adding metadata with already-existing values to folders
     
    619601    </Section>
    620602    <Section name="updatingmetadata">
    621       <Title>Updating Metadata</Title>
     603      <Title>Editing or Removing Metadata</Title>
    622604<ObviousSentence>This section explains how to update the metadata assigned to a file.</ObviousSentence>
    623605      <Contents>
     
    632614      </Contents>
    633615      <Anchor name="simple">Simple Instructions:</Anchor>
    634 To update the value of a piece of metadata, first choose the file to which that
    635 value applies, and then the metadata element whose value you want to change.
    636 Your selection appears in the metadata edit controls.  Edit the value field and
    637 click "Replace" to alter the metadata.
     616To edit or remove a piece of metadata, first select the appropriate file, and then the metadata value from teh table. Edit the value field, deleting all text if you wish to remove the metadata.
    638617<Break/>
    639618The process is the same when updating a folder with child folders or multiple files, but you can only update metadata that is common to all files/folders selected.
    640619<Break/>
    641 The value tree shows all previous values, not just those currently assigned.
    642 Thus the value you have replaced will remain in the value tree.
    643     </Section>
    644     <Section name="removingmetadata">
    645       <Title>Removing Metadata</Title>
    646 <ObviousSentence>This section explains how to remove metadata from a file.</ObviousSentence>
    647       <Contents>
    648         <ContentsGroup linkto="simple">
    649           <ContentsItem>
    650             Removing from files
    651           </ContentsItem>
    652           <ContentsItem>
    653             Removing from folders or multiple files
    654           </ContentsItem>
    655         </ContentsGroup>
    656       </Contents>
    657       <Anchor name="simple">Simple Instructions:</Anchor>
    658 You remove metadata the same way as you update it.  First select a file from the
    659 file tree, then use the metadata table to select the metadata. If the metadata has a value assigned, the "Remove" button becomes active.
    660 Click it to remove the metadata from the specified file.  Other files
    661 remain unchanged, and the value remains in the Value Tree.
    662 <Break/>
    663 Removing metadata from folders or multiple files works the same way.
     620The value tree shows all currently assigned values as well as previous values for the current session, so changed or deleted values will remain in the tree. Closing the collection and then re-opening it will remove the values which are no longer assigned.
    664621    </Section>
    665622    <Section name="reviewingmetadata">
     
    693650Drawing the table can take some time if many files are selected.  You can continue to use the Librarian
    694651Interface while the "All Metadata" window is open.
    695 <Break/>
    696 Click "Close" to hide the window.
    697652      <Anchor name="advanced">Advanced Instructions:</Anchor>
    698 You can also view the "All Metadata" table by selecting the files you wish to
    699 examine, right-clicking, and choosing "Assigned Metadata...".  If a folder has
    700 been selected, all its child files are included in the table.
    701 <Break/>
    702653When it gets too large, you can filter the "All Metadata" table by applying
    703654filters to the columns.  As new filters are added, only those rows that match
     
    751702Having checked the mapping, you can choose "Add" to add the new metadata
    752703element to the chosen metadata set.  (This is only enabled if there is no
    753 element of the same name within the chosen set.) "Replace" maps the new element
     704element of the same name within the chosen set.) "Merge" maps the new element
    754705to the one chosen by the user.  Finally, "Ignore" does not import any metadata
    755706with this element name.  Once you have specified how to import a certain piece of metadata, the mapping
     
    772723This section introduces you to the design view and explains how to navigate
    773724between the various views within this pane.
    774       <Contents>
    775         <ContentsGroup linkto="simple">
    776           <ContentsItem>
    777             Choosing a design section
    778           </ContentsItem>
    779         </ContentsGroup>
    780       </Contents>
    781       <Anchor name="simple">Simple Instructions:</Anchor>
     725<Break/>
    782726With the Librarian Interface, you can configure how the collection appears to
    783727the user.  The configuration options are divided into different sections, each
     
    869813<Break/>
    870814The plugins in the list are executed in order, and the ordering is sometimes
    871 important.  Two plugins, ArcPlug and RecPlug, are vital to the collection
    872 building process, and are fixed in place at the end of the list (with a
    873 separator line).  To change the ordering of the other ones, select the plugin you want to move
    874 and click "Move Up" or "Move Down".
    875        <Anchor name="advanced">Advanced Instructions:</Anchor>
    876 The Librarian Interface does its best to determine what arguments a plugin
    877 supports. However, there may be cases where the user wants to specify special arguments, and for this a text field called "Custom Arguments" (at the bottom) is provided. Any text in it is appended verbatim to the end of the plugin
    878 command.
    879     </Section>
     815important. The order of the plugins can be changed in Library Systems Specialist and Expert modes only (see <Reference target="preferences">Preferences</Reference>).    </Section>
    880816    <Section name="searchtypes">
    881817      <Title>Search Types</Title>
    882 This section explains how to modify a new design feature in Greenstone, Search Types, which allow fielded searching. Under "Design Sections", click "Search Types".
     818This section explains how to modify a new design feature in Greenstone, Search Types, which allow fielded searching. The search types specify what kind of search interface should be provided: form, for fields searching, and/or plain for regular searching. Under "Design Sections", click "Search Types".
    883819      <Contents>
    884820        <ContentsGroup linkto="simple">
     
    973909Partitions" and "Assign Languages".  To learn more about partitions read about
    974910subcollections and subindexes in Chapter 2 of the Greenstone Developer's Guide.
    975 
     911<Break/>
     912The Partition Indexes screen is only enables in Library Systems Specialist and Expert modes (see <Reference target="preferences">Preferences</Reference>). Note that the total number of partitions generated is a combination of all indexes, subcollection filters and languages chosen. Two indexes with two subcollection filters in two languages would yield eight index partitions.
    976913      <Section name="definefilters">
    977914        <Title>Define Filters</Title>
     
    991928        </Contents>
    992929        <Anchor name="simple">Simple Instructions:</Anchor>
    993 Filters allows you to group together into a subcollection all documents in an
     930Filters allow you to group together into a subcollection all documents in an
    994931index for which a metadata value matches a given pattern.
    995932<Break/>
    996933To create a filter, click the "Define Filters" tab and enter a name for the
    997 new filter into the "Name the subcollection filter" field.  Next choose a
     934new filter into the "Subcollection filter name:" field.  Next choose a
    998935document attribute to match against, either a metadata element or the name of
    999936the file in question.  Enter a regular expression to use during the matching.
     
    1037974To make a partition the default one, select it from the list and click "Set
    1038975Default".
    1039 <Break/>
    1040 To clear the default partition, click "Clear Default".
    1041976      </Section>
    1042977      <Section name="assignlanguages">
     
    10731008<Break/>
    10741009To set the default language, select it from the list and click "Set Default".
    1075 <Break/>
    1076 To clear the default language, click "Clear Default".
    10771010      </Section>
    10781011    </Section>
     
    10801013      <Title>Cross-Collection Searching</Title>
    10811014Greenstone can search across several different collections as though they were
    1082 one.  This is done by creating a "super-collection" that comprises the
    1083 individual collections.  Under "Design Sections", click "Cross-Collection Search".
     1015one. This is done by specifying a list of other collections to be searched along with the current one.  Under "Design Sections", click "Cross-Collection Search".
    10841016      <Contents>
    10851017        <ContentsGroup linkto="simple">
     
    10961028searching.
    10971029<Break/>
     1030If the individual collections do not have the same indexes (including subcollection partitions and language partitions) as each other, cross-collection searching will not work properly. The user will only be able to search using indexes common to all collections.
     1031<Break/>
    10981032For further details, see Chapter 1 of the Greenstone Developer's Guide.
    10991033    </Section>
     
    11231057      <Anchor name="simple">Simple Instructions:</Anchor>
    11241058To add a classifier, select it using the "Select classifier to add" pull-down list near the
    1125 bottom and then click "Add Specified Classifier".  A window appears entitled
     1059bottom and then click "Add Classifier".  A window appears entitled
    11261060"Configuring Arguments"; instructions for this dialog are just the same as for
    11271061plugins (see <Reference target="plugins">Document Plugins</Reference>).  Once you have configured the new
     
    11291063list.
    11301064<Break/>
    1131 To remove a classifier, select it from the list and click "Remove Selected
    1132 Classifier".
     1065To remove a classifier, select it from the list and click "Remove Classifier".
    11331066<Break/>
    11341067To change the arguments a classifier, select it from the list and click
    1135 "Configure Selected Classifier" (or double-click on the classifier in the
     1068"Configure Classifier" (or double-click on the classifier in the
    11361069list).
    11371070<Break/>
     
    11451078    <Section name="formatstatements">
    11461079      <Title>Format Features</Title>
    1147 Format commands control the structure and appearance of the collection.  They
    1148 affect such things as where buttons appear when a document is shown, and what
     1080The web pages you see when using Greenstone are not pre-stored but are generated 'on the fly' as they are needed. Format commands are used to change the appearance of these generated pages. They affect such things as where buttons appear when a document is shown, and what
    11491081links are displayed by the DateList classifier.  Format commands are not easy
    11501082to develop, and you should read Chapter 2 of the Greenstone Developer's Guide.
     
    12221154      </Contents>
    12231155      <Anchor name="simple">Simple Instructions:</Anchor>
    1224 First choose the an entry from the "Features" list.  The language-specific
     1156First choose an entry from the "Features" list.  The language-specific
    12251157strings associated with this feature appear below.  Use the "Language of
    12261158translation" pull-down list to select the target language, and type the
     
    14131345choose the application from the "Browse" dialog.  "%1" can be used in the launch
    14141346command to insert the name of the file being opened.  Once these are filled out,
    1415 "Add Association" is enabled and can be clicked to add the association.
     1347"Add" is enabled and can be clicked to add the association.
    14161348<Break/>
    14171349To edit an association, select an existing file extension.  Any existing
    14181350associated command is shown in the launch command field.  Edit it, and then
    1419 click "Replace Association".
    1420 <Break/>
    1421 To remove an association, select an existing file extension and click "Remove Association".
     1351click "Replace".
     1352<Break/>
     1353To remove an association, select an existing file extension and click "Remove".
    14221354(The file extension remains in the "For Files Ending" pull-down list.)
    14231355<Break/>
Note: See TracChangeset for help on using the changeset viewer.