Changeset 5279


Ignore:
Timestamp:
2003-08-27T10:42:43+12:00 (21 years ago)
Author:
jmt12
Message:

A revised help text document

File:
1 edited

Legend:

Unmodified
Added
Removed

  • trunk/gli/help/in.txt

    r5172 r5279  
    44<$DESCRIPTION>
    55The Greenstone Librarian Interface is a tool for collecting and marking up documents, then building digital
    6 library collections. It gives you access to the Greenstone Digital Library
     6library collections.  It provides access to the Greenstone Digital Library
    77Software's functionality from an graphical point and click interface.
    88<$FOOTER>
    … …  
    3535<a name="SI">Simple Instructions:</a>
    3636
    37 The Librarian Interface behaves like other Microsoft Windows programs and draws upon
    38 ordinary knowledge of Windows. Will will briefly describe several basic interaction concepts and the terms used to describe then.
    39 
    40 Any part of the screen that you can interact with, such as a button or text field, is called a control. There is always one control that currently be interacted with using the keyboard which is visually highlighted and called the focus. Several controls allow you to select
    41 them or parts of them where the selections are highlighted in dark blue. A control can be available for interaction, or enabled, or be greyed-out and non-resposive, or disabled.
    42 
    43 The standard mouse actions, such as moving, left and right clicking and double-clicking are available. Furthermore many components allow an interaction known as drag'n'drop. To drag click and hold the left mouse button over an item in a control, then move the mouse to another control. If the control visually changes in some way you can release the button to drop the item there. Not all controls are so-called drop targets.
    44 
    45 While most gui interaction is achived with the mouse, you can use the keyboard to type into text fields. When a keyboard alternative is available for a control we put the key's name in square brackets, and use a plus sign to show when other keys must be pressed at the same time. Thus [Tab] can be used to control focus.
    46 
    47 You can exit the Librarian Interface program by choosing the "Exit" from the "File" menu. Your collection will be saved before the program exits.
     37The Librarian Interface follows Microsoft Windows conventions and draws upon
     38ordinary knowledge of Windows.
     39
     40Any part of the screen that you interact with, such as a button or text field,
     41is called a "control".  At any given time one control, called the "focus", is
     42highlighted and responds to the keyboard.  Several controls allow you to select
     43parts that are highlighted in dark blue.  Some controls are greyed out to
     44indicate that they are disabled.
     45
     46You can move and left- or right-click the mouse in the usual way.  Many
     47components also allow you to "drag" them, by clicking and holding the left
     48mouse button, move them with the mouse, and "drop" them elsewhere by releasing
     49the button.  Potential drop targets alter their appearance when a component
     50hovers over them.
     51
     52You can use the keyboard to type into text fields.  Keyboard alternatives are
     53available for many controls, indicated by a key name in square brackets -- for
     54example, [Tab] alters the focus.  The plus sign shows if other keys must be
     55pressed at the same time.
     56
     57Exit the Librarian Interface program by choosing "Exit" from the "File"
     58menu.  Your collection will be saved first.
     59
    4860<$NORMAL>
    4961<a name="AI">Advanced Instructions:</a>
    5062
    51 To quickly access any menu within the menu bar, hold down the [ALT] key and then press the underlined letter corresponding to that menu. For example, to access the "File" menu press [ALT] + [F]. To choose items from a submenu, press the key matching the indicated letter. Thus once in the File menu, press [S] to "Save" a collection.
     63To access a menu, hold down [ALT] and press the corresponding letter
     64(underlined).  For example, for the "File" menu press [ALT] + [F].  To choose an
     65item, press the corresponding key.  For example.  Thus once in the File menu
     66press [S] to "Save" a collection.
     67
    5268<$FOOTER>
    5369
    … …  
    56721.2 How to Avoid Reading This Document
    5773<$DESCRIPTION>
    58 You don't have to read this help text all the way through! You just have
    59 to know how to get help when you need it.
     74Don't read this help text all the way through!  Just read enough to learn
     75how to get help when you need it.
    6076
    6177<$CONTENTS_HEADER>
    … …  
    7288<a name="SI">Simple Instructions:</a>
    7389
    74 One of the menu items is "Help". This provides context sensitive help by highlighting what it thinks is the most appropriate help item with a little book icon.
    75 
    76 Some controls have tool tips associated with them. If you leave you mouse
    77 pointer over them, for a second or two, the tip will appear detailing
    78 what the control does.
    79 
    80 Before using the Librarian Interface, you should be generally familiar with Greenstone and its documentation.
     90The "Help" menu item marks what may be the most appropriate help item with a
     91little book icon.
     92
     93For many controls, if you station the mouse over them a
     94"tool tip" appears that says what they do.
     95
     96Before using the Librarian Interface, first read the Greenstone
     97documentation.
     98
    8199<$FOOTER>
    82100
    … …  
    851032.0 Starting Off
    86104<$DESCRIPTION>
    87 This chapter covers how to create, save and load a collection session.
     105This chapter covers how to create, save and load a collection.
    88106<$FOOTER>
    89107
    … …  
    120138<a name="SI">Simple Instructions:</a>
    121139
    122 To create a new collection, open the "File" menu and choose the menu item "New". The new collection prompt appears. Several fields need to be filled out. The values you enter here can be changed later in the design view.
    123 
    124 The collection title is the text that will be displayed at the top of your collection's homepage, and can be any length.
    125 
    126 Collection name is the filename of your collection and must be unique.
    127 
    128 The author's email must be a valid email address.
    129 
    130 The collection description should describe, in as much detail as possible, what your new collection is about. It is unlimited in length, and you can use the [Enter] key to break it into paragraphs. You cannot use the [Tab] key to set margins.
    131 
    132 Now you may choose whether to initially view or hide metadata automatically extracted by Greenstone. You may change this option later in preferences - see section 10.1 - Preferences.
    133 
    134 The final control allows you to specify if the new collection should have the same appearance and metadata sets as an existing collection. You may also choose to start a default "New Collection".
    135 
    136 Once you have entered information in these fields, click the "OK" button to create the collection. If you chose the "New Collection" for your base collection, then you will be presented with another prompt asking you what metadata sets should initially be available in your collection. Click the check boxes beside the sets you require.
    137 
    138 If at any time you decide not to create a new collection, click the "Cancel" button. The prompt will close and you will return to the main screen.
     140To create a new collection, open the "File" menu and choose "New".  Several
     141fields need to be filled out -- but you can change their values later if you
     142need to, in the design view.
     143
     144"Title" is the text displayed at the top of your collection's homepage.  It can
     145be any length.
     146
     147"Short Name" is the collection's filename.  It must be unique.
     148
     149"Author's Email" should be a valid email address.
     150
     151"Description of content"
     152should describe, in as much detail as possible, what the collection is about.
     153Use the [Enter] key to break it into paragraphs.
     154
     155Now choose whether to view or hide the metadata that Greenstone extracts
     156automatically from documents.  (This option can be changed later -- see Section
     15710.1 -- Preferences.)
     158
     159Finally you must specify whether the new collection will have the same
     160appearance and metadata sets as an existing collection, or whether to start a
     161default "New Collection".
     162
     163Click "OK" to create the collection.  If you chose "New Collection" you are
     164prompted for the metadata sets to use in it.  You can choose more than one, and
     165you can add others later.
     166
     167Clicking "Cancel" returns you to the main screen immediately.
    139168<$NORMAL>
    140169<a name="AI">Advanced Instructions:</a>
    141170
    142 Buttons, like menus, have one character underlined. If you press [ALT] and the underlined character at the same time, the response will be just as if you clicked the button.
     171Buttons, like menus, have one character underlined.  To "click" the button,
     172press [ALT] and the underlined character at the same time.
     173
    143174<$FOOTER>
    144175
    145176<$FILE name=2-2.htm>
    146177<$HEADER>
    147 2.2 Saving Your Collection
     1782.2 Saving the Collection
    148179<$DESCRIPTION>
    149180This section describes how to save a collection, and the Save Collection Prompt.
    … …  
    161192<a name="SI">Simple Instructions:</a>
    162193
    163 You should regularly save your collection by opening the "File" menu and choosing the "Save" command. Once saving is complete you will be returned to the main screen ready to continue. Saving a collection is not the same as producing a collection ready for use in Greenstone (see chapter 8 - Producing Your Collection).
    164 
    165 If the current collection is unsaved and you take any action that might lose it (such as exiting the program or loading another collection), the Librarian Interface will save the collection first.
     194Save your work regularly by opening the "File" menu and choosing "Save".
     195Saving a collection is not the same as making it ready for use in Greenstone
     196(see Chapter 8 -- Producing Your Collection).
     197
     198The Librarian Interface protects your work by saving it whenever you exit the
     199program or load another collection.
    166200
    167201<$NORMAL>
    168202<a name="AI">Advanced Instructions:</a>
    169203
    170 When you save a collection its data will be written to a file, whose name is the same as the collection name, with file extension ".col". This file is located in a folder of the same name within the collect folder of your Greenstone installation.
     204Saved collections are written to a file named for the collection and with file
     205extension ".col", located in a folder of the same name within your Greenstone
     206installation's "collect" folder.
     207
    171208<$FOOTER>
    172209
    … …  
    190227<a name="SI">Simple Instructions:</a>
    191228
    192 To open an existing collection, choose "Open" from the "File" menu to get the Open Collection prompt.
    193 
    194 A dialog will appear showing a list of the collections installed in Greenstone. You may select one to see its description, and then click "Open" to load the selected collection. If your collection is saved somewhere other that the Greenstone collect folder, click "Browse" to be presented with a typical file system browsing dialog. Click "Cancel" to exit the dialog.
     229To open an existing collection, choose "Open" from the "File" menu to get the
     230Open Collection prompt.  A list of your Greenstone collections appears.
     231Select one to see its description, and click "Open" to load it.  If you seek a
     232collection that resides outside Greenstone's "collect" folder, click "Browse"
     233for a file system browsing dialog.
    195234
    196235<$NORMAL>
    197236<a name="AI">Advanced Instructions:</a>
    198237
    199 GLI uses the concept of file locking to allow for several instances of the application to be run without users accidently overwriting each others work. When you open or create a collection a small temporary lock file is created in that collection's folder. Before the Librarian Interface opens a collection, it checks whether a lock file exists, and if so refuses to open the collection. You can quickly tell if the collection is locked by the colour of its icon: greenstone green for a normal collection, red for a locked collection. However, sometimes lock files are left behind when the Librarian Interface is exited prematurely. In this case you can choose to steal control over the collection. Be warned though, stealing the lock from a collection that is currently opened by someone else will cause the changes of one of the users to be lost after saving.
     238In case more than one Greenstone Librarian Interface program is running
     239concurrently, the relevant directories are "locked" to prevent interference.
     240On opening a collection, a small temporary lock file is created in its
     241folder.  Before opening a collection, the Librarian Interface checks to ensure
     242that no lock file already exists.  You can tell whether a collection is locked
     243by the colour of its icon: green for a normal collection, red for a locked
     244one.  However, when the Librarian Interface is exited prematurely the lock file
     245is sometimes left in place.  When you open such a collection, the Librarian asks
     246if you want to "steal" control of it.  Never steal a collection that someone
     247else is currently working on.
     248
    200249<$QUESTION_FOOTER>
    201250<$FOOTER>
    … …  
    2052543.0 Hunting For Your Files
    206255<$DESCRIPTION>
    207 Please note that this section is only relevant if you have run the Librarian Interface with the browse and/or mirror workflow views enabled. If not enabled at the time of collection creation then those tabs will not appear, nor will any preference option related to these features. To enable edit the "config.xml" file found in the Librarian Interface installation folder, or in the ".gli" folder in you home folder if you are on a multiuser system. Set the values of "workspace.browse" and/or "workspace.mirror" to "true".
    208 
    209 While the Librarian Interface allows you to import files from anywhere on the local file system, it was originally designed to locate web-based resources. To support this required two distinct stages. This chapter describes the first, Hunting, where you browse the internet for files of interest.
     256
     257The Librarian Interface can run in different configurations.  This chapter only
     258applies when the "browse" and/or "mirror" views are enabled.  If these tabs do
     259not appear, advanced users can enable them by editing the "config.xml" file in
     260the Librarian Interface installation folder (or, on a multiuser system, in your
     261home directory's ".gli" folder) to set the values of "workspace.browse" and
     262"workspace.mirror" to "true".
     263
     264When using web resources, the Librarian Interface operates in two stages.  This
     265chapter describes the first, Hunting, where you browse the Internet for files
     266of interest.
     267
    210268<$FOOTER>
    211269
    … …  
    2142723.1 The Hunt view
    215273<$DESCRIPTION>
    216 This section describes how to use the simplified browsing interface to locate resources on the internet.
     274This section describes how to use the simplified browsing interface to locate resources on the Internet.
    217275<$CONTENTS_HEADER>
    218276<$SECTION>
    … …  
    226284<a name="SI">Simple Instructions:</a>
    227285
    228 The Hunt view is accessed by clicking on its tab. The majority of the screen is dedicated to the view of the webpage. It is the same as any web-page shown in similar internet browing software, with hyperlinks underlined and highlighted. Clicking on a hyperlink will take you to the page it refers to. At the very bottom of the screen is the status bar which gives you feedback as to what the browser is doing.
    229 
    230 Directly above the page view is the address field. You type URL addresses into this box. The field will also be updated to show the address of any page you click through to or are redirected to.
    231 
    232 To the left and right of the address field are six buttons. These provide control over the web page being shown. The buttons are, from left to right: Back, Reload, Home, Go, Stop and Forward. These behave similar to the controls on equivalent internet browsing applications.
     286The Hunt view is accessed by clicking on its tab.  Most of the screen shows a
     287web page.  Hyperlinks work in the usual way.  Underneath the page is a status bar
     288that shows you what the browser is doing.
     289
     290You type URL addresses into the address field above the page.
     291
     292To the left and right of the address field are web browser buttons for Back,
     293Reload, Home, Go, Stop and Forward.
     294
    233295<$FOOTER>
    234296
    … …  
    2372994.0 Downloading Chosen Files
    238300<$DESCRIPTION>
    239 Please refer to section 3.1 - The Hunt View, for details on how to enable mirroring.
    240 
    241 The current system of downloading requires you to have a copy of the open source mirroring tool wget installed (preferrably WGet v1.8) and have it accessible from the Librarian Interface install folder.
    242 
    243 As mentioned in the previous section, sourcing files from the web is a two stage process. The second stage, having found the files you wish to gather, is to download (or mirror) onto the local filespace. This chapter explains the Librarian Interfaces mirroring process.
     301To enable web mirroring see Section 3.1 -- The Hunt View.
     302To download web pages you need to install the mirroring tool wget (version v1.8
     303recommended) and make it accessible from the Librarian Interface "install"
     304folder.
     305
     306When using web resources, the second stage is to download (or "mirror") the
     307files you need.  This chapter explains the Librarian Interface's mirroring
     308process.
     309
    244310<$FOOTER>
    245311
    … …  
    2483144.1 The Mirror view
    249315<$DESCRIPTION>
    250 This section describes how to configure a download task, and how to control the downloading process.
     316This section describes how to configure a download task and control the downloading process.
    251317<$CONTENTS_HEADER>
    252318<$SECTION>
    … …  
    268334<a name="SI">Simple Instructions:</a>
    269335
    270 The "Mirror" view is accessed by clicking on its tab within the row of tabs. To the left of the screen is the workspace tree described in section 5.1 - The Gather View. The bottom of the screen is initially blank, but will later contain a list of pending download jobs. Finally the right of the screen is covered with the controls used to configure a new download job.
    271 
    272 The workspace tree contains a folder "Public WebCache", which is only present when mirroring is enabled, and can be thought of as the shared cache of files. Any files downloaded here will be availble to any other collections built with this Librarian Interface. A second folder, "Private WebCache", only appears once a collection has been opened. This file cache is stored with the collection, so only this collection has access to it. In either case, files will be stored into these areas using their full path names as determined from the url of these source page. Thus a new folder will be created for the url host name, then more as necessary as the path specifies. This ensures that each file is distinct.
    273 
    274 In the download configuration controls the very top field is used to enter the url to the target resource you wish to retrieve. If you have been browsing using the "Hunt" view, this field will automatically be filled with the url of the last page visited. The next control, labelled "Download Depth" informs the Librarian Interface how many times you wish to follow hyperlinks and download the resources found there as well. A depth of 0 means no hyperlinks will be followed and only the target resource will be retrieved, while ticking the infinite box could possibly cause you to mirror the entire internet! The depth is ignored when downloading media other than html pages. The next control lets you choose the destination for the files downloaded, by clicking on the radio button. Ticking "Automatically download embedded objects" causes any objects needed to render the page properly to be downloaded. Note that this is independant of the download depth setting. The next control lets you determine if the Librarian Interface can mirror files from paths above the target url. The "Only mirror within the same site" control restricts the mirroring to files with the same host name. The next control determines whether local files should ever be overwritten during download and the second to last control, within the "Download List Options" group, allows you to specify what should happen to download tasks if they fail for some reason. Note that changes to this control are immediate, rather than part of a specific download job. The final control to discuss is the "Download" button which creates a new job based on the configuration settings, then adds it to the download list.
    275 
    276 Initially blank, the download list will eventually contain several entries, each representing a download task, and each with the same general appearance. Looking at a single task, you will notice two buttons to the left and right, and a central region with several lines of text and a progress bar. The text gives details of the task, and will update as the task progresses, while the progress bar gives an indicating of activity. The button to the left, with the play triangle on it, will begin the current task. Once it has been pressed the downloading will begin, and its icon will change to double vertical bars or pause. Pressing pause will pause the current download. The button to the right, with the stop square, will cause the current download task to be removed from the list. If a download task completes successfully it will automatically be removed from the download list, while whether it is removed on failure is controlled by the single download list option.
     336Access the "Mirror" view by clicking its tab.  On the left is the workspace tree
     337described in section 5.1 -- The Gather View.  The bottom of the screen shows a
     338list of pending download jobs.  On the right are the controls used to control
     339downloading.
     340
     341Files are downloaded into a folder in the workspace tree called "Public
     342WebCache" (only present when mirroring is enabled), and can be used in all
     343collections built with the Librarian Interface.  When a collection is open a
     344second folder, "Private WebCache", appears, associated with that collection so
     345that it alone has access.  Files in both these areas are named by their full web
     346URL.  A new folder is created for each host, followed by others for each part
     347of the path.  This ensures that each file is distinct.
     348
     349Use the first of the download configuration controls to enter the URL of a
     350target resource.  If you have come from the "Hunt" view, this field points to
     351the last page visited.  Use the "Download Depth" control to determine how many
     352hyperlinks to follow when downloading: 0 means no hyperlinks and grabs just the
     353target resource; "infinite" would grab the entire Internet!  The depth limit is
     354ignored when downloading media other than html pages.  Use the next radio
     355button control to choose whether the files are cached into the shared public
     356folder or the private collection-specific folder.  Checking "Automatically
     357download embedded objects" also downloads any objects needed to render the page
     358properly (irrespective of the depth setting).  Use the next control to
     359determine whether to mirror files from paths above the target URL.  "Only
     360mirror within the same site" restricts the mirroring to files with the same
     361host name.  The next control determines whether local files can be overwritten
     362during download.  The next one, in the "Download List Options" group,
     363determines what happens to download tasks that fail for some reason.  This
     364takes effect immediately, rather than pertaining to a specific download job as
     365the other specifications do.  The final control is a "Download" button which
     366adds to the download list a new job corresponding to the configuration
     367settings.
     368
     369The download list has an entry for each unfinished download.  For each entry, a
     370central region with several lines of text and a progress bar is flanked by two
     371buttons.  The text gives details of the task, and updates as the task
     372progresses, while the bar measures progress.  The "play" triangle on the left
     373button starts the current task and then changes to a double vertical bar, which
     374pauses the current download.  The "stop" square on the right button removes the
     375current download task from the list.  Download tasks are removed from the list
     376when they finish successfully (ones that fail are controlled by the "Download
     377List Options").
    277378
    278379<$NORMAL>
    279380<a name="AI">Advanced Instructions:</a>
    280381
    281 See section 10.1 - Preferences, for details on how to establish a connection to the internet via a proxy. If authentication is needed for connection to the proxy server you will be prompted, at least once, for a login and password. A valid login/password is persistant for the remainder of that Librarian Interface session, but is not stored between sessions.
     382Section 10.1 -- Preferences describes how to establish an Internet connection
     383via a proxy.  If authentication is needed, the proxy server prompts for
     384identification and password.  The Librarian Interface does not store passwords
     385between sessions.
     386
    282387<$FOOTER>
    283388
    … …  
    2863915.0 Collecting Files for Your Collection
    287392<$DESCRIPTION>
    288 You have created a new collection and it's time to import some
    289 files into it. These files may be sourced from several areas, including
    290 previous Greenstone Collections. You may also choose to import files that
    291 already have metadata assigned to them. The actions involved
    292 in this file gathering stage are detailed within this chapter.
     393
     394Once you have a new collection you need to get some files into it.  These may
     395come from your ordinary file space, or from other Greenstone collections.  Some
     396may already have attached metadata.  This chapter describes how to import files.
     397
    293398<$FOOTER>
    294399
    … …  
    320425<a name="SI">Simple Instructions:</a>
    321426
    322 The Librarian Interface starts with the Gather view. If, later, you need to return
    323 to this view, notice the tabs (like file-cabinet tabs) directly below
    324 the menu bar. Clicking a tab opens the view with that name.
    325 
    326 There are two large areas titled "Workspace" and "Collection". These are
    327 used to move files into your collection. They contain file
    328 trees, which are graphical structures representing folders and the files they contain.
    329 
    330 Select any item in the tree by clicking on it once. (There are more ways;
    331 see below.) Double-clicking a folder expands out the folders children or, if they're already expanded, collapses them away. You can also expand and collapse folders by clicking on
    332 the little switch symbol. If you double-click
    333 on a file the Librarian Interface will attempt to open it in whatever program is
    334 associated with it (see section 10.2 - File Associations).
    335 
    336 There are two different file trees; the Workspace and the Collection.
    337 The Workspace contains the sources of data that are available to the Librarian Interface.
    338 These include: the complete local file system (including all disk and
    339 CD-ROM drives), the contents of existing Greenstone collections, and the public and private
    340 download caches if Web mirroring is enabled. The files in this tree are
    341 read-only: you can copy and view them but you cannot move, delete, or edit them. Navigate around this tree until you find the files you
    342 want to include in your collection.
    343 
    344 The Collection Tree represents the contents
    345 of your collection so far. Initially, it will be empty.
    346 
    347 If you move the mouse pointer over the small vertical grey bar that separates
    348 the two trees, the shape of the pointer changes, and you can alter the
    349 two spaces by dragging the mouse.
    350 
    351 At the bottom are the Status Area and the Control Buttons. The Status
    352 Area tells you about the state of the Librarian Interface: how many items you have
    353 selected and what action you are requesting. When you start performing
    354 actions that involve files it reports on the progress of the operation.
    355 Actions involving large files can take some time to complete.
    356 
    357 Three large Control Buttons occupy the lower right corner of the screen.
    358 The first is the Cancel button, which is used to immediately cancel
    359 any file movement tasks that are occurring. The next is the
    360 New Folder button, which is used to create new folders: it shows a picture
    361 of a folder (see section 5.2 - Creating folders). The last is the Delete button, which
    362 is used to remove files; it shows a garbage can.
     427The Librarian Interface starts with the Gather view.  To return to this view
     428later, click the "Gather" tab directly below the menu bar.
     429
     430The two large areas titled "Workspace" and "Collection" are used to move files
     431into your collection.  They contain "file trees", graphical structures that
     432represent files and folders.
     433
     434Select an item in the tree by clicking it.  (There are other ways; see below.)
     435Double-click a folder, or the switch symbol beside it, to expand (or collapse)
     436its contents.  Double-click a file to open it using its associated application
     437program (see Section 10.2 -- File Associations).
     438
     439The Workspace file tree shows the sources of data available to the Librarian
     440Interface -- the local file system (including disk and CD-ROM drives), the
     441contents of existing Greenstone collections, and the public and private
     442download caches if Web mirroring is enabled.  You can copy and view these files
     443but you cannot move, delete, or edit them.  Navigate this space to find the
     444files you want to include in the collection.
     445
     446The Collection file tree represents the contents of the collection so
     447far.  Initially, it is empty.
     448
     449You can resize the spaces by mousing over the grey bar that separates the trees
     450(the shape of the pointer changes) and dragging.
     451
     452Beneath is the Status Area, which describes the state of the Librarian
     453Interface: how many items are selected and what action is requested.  It
     454reports on the progress of actions that involve files, which can take some time
     455to complete.
     456
     457Three large buttons occupy the lower right corner of the screen.  "Cancel"
     458stops any file movement tasks that are occurring.  "New Folder", with a picture
     459of a folder, creates new folders (see Section 5.2 -- Creating folders).
     460"Delete", with a garbage can, removes files.
     461
     462<$NORMAL> <a name="AI">Advanced Instructions:</a>
     463
     464To select several contiguous items, select the first and then hold down [Shift]
     465and click on the last -- the selection will encompass all intervening
     466items.  Select non-sequential files by holding down [Ctrl] while clicking.  Use
     467these two methods together to select groups of non-adjacent items.
     468
     469Certain folders -- such as the one containing your own web pages -- sometimes
     470have special significance.  The Librarian Interface can map such pages to at
     471the first level of the file tree.  To do this, right-click the desired
     472folder.  Select "Map", and enter a name for the folder.  To remove an item,
     473right-click the mapped folder and select "Unmap Folder".
     474
     475<$FOOTER>
     476
     477<$FILE name=5-2.htm>
     478<$HEADER>
     4795.2 Creating Folders
     480<$DESCRIPTION>
     481This section shows how to create new folders.
     482<$CONTENTS_HEADER>
     483<$SECTION>
     484<a href="#SI">Simple instructions</a>
     485<$SUBSECTION>
     486The new folder button
     487<$SUBSECTION>
     488The right-button menu
     489<$CONTENTS_FOOTER>
     490<$NORMAL>
     491<a name="SI">Simple Instructions:</a>
     492
     493Use folders in the Workspace file tree to group files together and make them
     494easier to find.  Folders can be placed inside folders.  There is virtually no
     495limit to how many folders you can have or how deeply they can be nested.
     496
     497To create a new folder, optionally select an existing folder in the Collection
     498Tree and click the New Folder button.  The new folder appears within the
     499selected one, or at the top level if none is selected.  You are prompted for the
     500folder's name (default "New Folder").
     501
     502Folders can also be created by right-clicking over a folder, choosing "New
     503Folder" and proceeding as above.
     504
     505<$FOOTER>
     506
     507<$FILE name=5-3.htm>
     508<$HEADER>
     5095.3 Adding Files
     510<$DESCRIPTION>
     511This section shows how to get files into your collection.
     512
     513<$CONTENTS_HEADER>
     514<$SECTION>
     515<a href="#SI">Simple instructions</a>
     516<$SUBSECTION>
     517Dragging a file
     518<$SUBSECTION>
     519Multiple files
     520<$SECTION>
     521<a href="#AI">Advanced instructions</a>
     522<$SUBSECTION>
     523Existing metadata
     524<$CONTENTS_FOOTER>
     525<$NORMAL>
     526<a name="SI">Simple Instructions:</a>
     527
     528Files can be copied into the collection by dragging and dropping.  The mouse
     529pointer becomes a ghost of the selected item (or, if more than one is selected,
     530the number of them).  Drop the selection into the Collection Tree to copy the
     531files there (if the source was the Workspace Tree) or move them around within
     532the collection (if the source was the Collection Tree).
     533
     534When copying multiple files, they are all placed in the target folder at the
     535same level, irrespective of the folder structure they occupied originally.
     536When you copy a second file with the same name into the same folder, you are
     537asked whether to overwrite the first one.  Respond "No" and the file will not be
     538copied, but the others will be.  To cancel all remaining copy actions, click the
     539"stop" button.
     540
     541Only the "highest" items in a selection are moved.  A folder is higher than its
     542children.  You cannot select files within a folder and also the folder itself.
     543
    363544<$NORMAL>
    364545<a name="AI">Advanced Instructions:</a>
    365546
    366 To select several
    367 contiguous items, select the one at the start of the range and then hold
    368 down a [Shift] key while clicking on the one at the end of the range --
    369 the selection will encompass all intervening items. You can select non-sequential
    370 files by holding down the [Ctrl] key while clicking on the target items.
    371 These two methods can be used in combination to select groups of non-adjacent items.
    372 
    373 If you have folders that have special significance, such as the root folder of your home web pages, the Librarian Interface can provide more convenient access to these folders by creating a special mapping to it. This causes it to appear at the first level of the tree. To create a mapping right click over the desired folder. Once you've clicked "Map" a prompt will appear asking you for a meaningful alias for this folder. Providing a name and clicking "OK" will create the folder mapping. To remove a mapping right click over the mapped folder then click "Unmap Folder".
    374 <$FOOTER>
    375 
    376 <$FILE name=5-2.htm>
    377 <$HEADER>
    378 5.2 Creating Folders
    379 <$DESCRIPTION>
    380 This section shows how to create new folders.
    381 <$CONTENTS_HEADER>
    382 <$SECTION>
    383 <a href="#SI">Simple instructions</a>
    384 <$SUBSECTION>
    385 The new folder button
    386 <$SUBSECTION>
    387 The right-button menu
    388 <$CONTENTS_FOOTER>
    389 <$NORMAL>
    390 <a name="SI">Simple Instructions:</a>
    391 
    392 Folders are used in the tree to group files together, and to introduce
    393 structure that makes it easier to find files. Folders can be placed inside
    394 folders. There is virtually no limit to how many folders you can have
    395 or how deeply they can be nested.
    396 
    397 To create a folder, select a folder from the Collection Tree and click the New Folder button. You are prompted for the folders name, which will default to "New Folder". Once you accept the dialog, the named folder will appear within the selected one. If no folder was selected the new folder is created at the top level.
    398 
    399 Folders can be created more conveniently using the context sensitive right-click menu. Move
    400 the mouse pointer over the parent folder and click the right mouse button.
    401 Choose "New Folder" and proceed as above.
    402 <$FOOTER>
    403 
    404 <$FILE name=5-3.htm>
    405 <$HEADER>
    406 5.3 Adding Files
    407 <$DESCRIPTION>
    408 This section shows how to get files into your collection.
    409 
    410 <$CONTENTS_HEADER>
    411 <$SECTION>
    412 <a href="#SI">Simple instructions</a>
    413 <$SUBSECTION>
    414 Dragging a file
    415 <$SUBSECTION>
    416 Multiple files
     547When you add a file, the Librarian Interface searches through the source
     548folders for auxiliary files containing metadata previously assigned to the
     549added file and, if it finds one, begins to import this metadata.  As the
     550operation proceeds, you may be prompted (perhaps several times) for extra
     551information to match the imported metadata to the metadata sets in your
     552collection.  This process involves many different prompts, described in the
     553section 6.8 -- Importing Previously Assigned Metadata.  For a more detailed
     554explanation of associating metadata with files read Chapter 2 of the Greenstone
     555Developer's Guide -- Getting the most out of your documents.
     556
     557<$FOOTER>
     558
     559<$FILE name=5-4.htm>
     560<$HEADER>
     5615.4 Removing Files
     562<$DESCRIPTION>
     563This section describes how to remove files and folders from your collection.
     564<$CONTENTS_HEADER>
     565<$SECTION>
     566<a href="#SI">Simple instructions</a>
     567<$SUBSECTION>
     568The delete button
     569<$SUBSECTION>
     570The delete key
     571<$SUBSECTION>
     572Delete by drag and drop
     573<$CONTENTS_FOOTER>
     574<$NORMAL>
     575<a name="SI">Simple Instructions:</a>
     576
     577There are several methods for removing files and folders.  You must first
     578indicate what items to remove by selecting one or more files and folders as
     579described in section 5.1 -- The Gather View.
     580
     581Once files have been selected, click the "delete" button to remove them, or
     582press the [Delete] key on your keyboard, or drag them from the collection to
     583the delete button and drop them there.
     584
     585<$FOOTER>
     586
     587<$FILE name=5-5.htm>
     588<$HEADER>
     5895.5 Filtering the Tree
     590<$DESCRIPTION>
     591"Filtering" the collection tree allows you to narrow down the search for particular files.
     592<$CONTENTS_HEADER>
     593<$SECTION>
     594<a href="#SI">Simple instructions</a>
     595<$SUBSECTION>
     596The filter control
    417597<$SECTION>
    418598<a href="#AI">Advanced instructions</a>
    419599<$SUBSECTION>
    420 Existing metadata
    421 <$CONTENTS_FOOTER>
    422 <$NORMAL>
    423 <a name="SI">Simple Instructions:</a>
    424 
    425 Files can be copied into the collection using the drag-and-drop method
    426 introduced earlier. If you start dragging a selection of files, the mouse pointer becomes a ghost of the item (if just one was selected)
    427 or the number of selected items (if more than one was selected). Drop the selection into the Collection Tree to copy the files there (if the source was the Workspace Tree) or move them about within your collection (if the source was the Collection Tree).
    428 
    429 Some extra rules apply when copying multiple files. No matter what folder
    430 structure the files occupied before you copied them, they are all placed
    431 in the target folder at the same level. If you try to copy two files with
    432 the same name into the same folder, the Librarian Interface will ask whether you
    433 want to overwrite the first one. If you select "No", the file in question will
    434 not be copied, but the other files will. If instead you wish to cancel
    435 all remaining copy actions click the stop button as described in the "Gather"
    436 View.
    437 
    438 Another rule is that only the highest items in a selection will be moved.
    439 A folder is higher than its children. You cannot select several files within a folder and the
    440 folder itself.
     600Custom filtering
     601<$CONTENTS_FOOTER>
     602<$NORMAL>
     603<a name="SI">Simple Instructions:</a>
     604
     605The "All Files" pull-down menu underneath each tree shows a list of predefined
     606filters, such as "Images".  Choosing this temporarily hides all other files in
     607the tree.  To restore the tree, change the filter back to "All Files".  These
     608operations do not alter the collection, nor do they affect the folders in the
     609tree.
     610
    441611<$NORMAL>
    442612<a name="AI">Advanced Instructions:</a>
    443613
    444 When you add a file, the Librarian Interface searches through the source folders for auxiliary files containing
    445 metadata previously assigned to the added file and, if it finds one it recognizes, begins a
    446 process of importing this metadata. As this operation proceeds, you may
    447 be prompted several times to provide extra information to enable the Librarian Interface
    448 to correctly match the imported metadata to the metadata sets in your collection. This process involves many different prompts, which are
    449 described in the section 6.8 - Importing Previously Assigned
    450 Metadata. For a more detailed explaination of associating metadata with files see chapter 2 of the Greenstone Developers Manual - Getting the most out of your documents.
    451 <$FOOTER>
    452 
    453 <$FILE name=5-4.htm>
    454 <$HEADER>
    455 5.4 Removing Files
    456 <$DESCRIPTION>
    457 This section shows how to remove files and folders from your collection.
    458 <$CONTENTS_HEADER>
    459 <$SECTION>
    460 <a href="#SI">Simple instructions</a>
    461 <$SUBSECTION>
    462 The delete button
    463 <$SUBSECTION>
    464 The delete key
    465 <$SUBSECTION>
    466 Delete by drag and drop
    467 <$CONTENTS_FOOTER>
    468 <$NORMAL>
    469 <a name="SI">Simple Instructions:</a>
    470 
    471 There are several methods for removing files and folders. All remove actions require you to first select the items to
    472 remove. You may select one or more files and folders using the
    473 techniques outlined in section 5.1 - The Gather View.
    474 
    475 Once some files have been selected, click once on the delete button to remove the files. A second method is to make your selection and then press the [Delete] key on your keyboard. The final way to remove files uses the same drag and drop method you used to copy the files, except this time you drag from your collection down to the delete button and drop them there.
    476 <$FOOTER>
    477 
    478 <$FILE name=5-5.htm>
    479 <$HEADER>
    480 5.5 Filtering the Tree
    481 <$DESCRIPTION>
    482 In order to allow you to narrow down your search for particular files,
    483 we introduce the concept of filtering the trees.
    484 <$CONTENTS_HEADER>
    485 <$SECTION>
    486 <a href="#SI">Simple instructions</a>
    487 <$SUBSECTION>
    488 The filter control
    489 <$SECTION>
    490 <a href="#AI">Advanced instructions</a>
    491 <$SUBSECTION>
    492 Custom filtering
    493 <$CONTENTS_FOOTER>
    494 <$NORMAL>
    495 <a name="SI">Simple Instructions:</a>
    496 
    497 There is a combobox
    498 control at the bottom of the trees; it says "All Files". If
    499 you select the down arrow button at the end of the box, you will see a
    500 list of predefined filters, such as "Images". Choosing
    501 one of these temporarily hides all files within the tree that do not match the chosen
    502 filter. To restore the tree to its original
    503 state, restore the filter to "All Files". Note
    504 that filtering does not change what files are in your collection, nor
    505 does it affect the folders within the tree.
    506 
    507 <$NORMAL>
    508 <a name="AI">Advanced Instructions:</a>
    509 
    510 You can specify a custom filter by typing in a pattern against which files will be matched. This pattern should use standard file system abbreviations such as "*.*" or "*.doc" (where "*" will match any string of characters).
     614You can specify a custom filter by typing in a pattern to match files against.
     615Use standard file system abbreviations such as "*.*" or "*.doc" ("*" matches
     616any characters).
     617
    511618<$FOOTER>
    512619
    513620<$FILE name=6-0.htm>
    514621<$HEADER>
    515 6.0 Enriching Your Collection with Metadata
    516 <$DESCRIPTION>
    517 Now that you have gathered several files into your collection it is time to
    518 enrich them with additional information. This process is also known
    519 as marking-up or assigning metadata. This chapter explains how metadata
    520 is created, edited, assigned and retrieved within the Librarian Interface, and
    521 how to use external sources of metadata (See chapter 2 of the Greenstone Developers Manual - Getting the most out of your documents).
     6226.0 Enriching the Collection with Metadata
     623<$DESCRIPTION>
     624
     625Having gathered several files into the collection, now enrich them with
     626additional information called "metadata".  This chapter explains how metadata is
     627created, edited, assigned and retrieved, and how to use external metadata
     628sources (see Chapter 2 of the Greenstone Developer's Guide -- Getting the most
     629out of your documents).
     630
    522631<$FOOTER>
    523632
    … …  
    5266356.1 The Enrich View
    527636<$DESCRIPTION>
    528 This section describes how to input and edit metadata using the Enrich
    529 view.
     637This section describes how to input and edit metadata using the Enrich view.
    530638<$CONTENTS_HEADER>
    531639<$SECTION>
    … …  
    534642The collection tree
    535643<$SUBSECTION>
    536 The metaedit controls
     644The MetaEdit Controls
    537645<$SUBSECTION>
    538646The value tree
    … …  
    543651<a name="SI">Simple Instructions:</a>
    544652
    545 The Enrich view is where you assign metadata to the documents in your
    546 collection. Metadata is data about data -- typically information such
    547 as title, author, creation date, and so on. Each metadata item has two
    548 parts: element that tells what kind of item it is (such
    549 as author), and value that gives the value of that metadata element
    550 (such as the name of the author).
    551 
    552 On the left of the "Enrich" view is the Collection Tree. When you select files their details appear in the Metadata Table on the right.
    553 
    554 The Metadata Table is a spreadsheet-like table that occupies the upper
    555 right of the screen once a file is selected. It shows all metadata assigned for the selected
    556 files. Names of the columns are shown in grey labels at the top. You can resize
    557 columns by selecting and dragging the lines separating their
    558 names. Clicking any row of the table transfers its details to the MetaEdit
    559 Controls. If several files are selected in the tree, then each metadata row contains black or grey text. Black text indicates that the metadata is common to all of the selected files and may be updated or removed. Grey text indicates the metadata is not common, but can be append to the remaining files, or removed from those that have it.
    560 
    561 Having selected a file, you may find a folder icon alongside some of the metadata entries. This indicates metadata that is inherited from one of the parent folders of this file. Such inherited metadata cannot be edited or removed, only appended to or overwritten. Click on the icon to be taken directly to the folder where the metadata is assigned.
    562 
    563 On the lower right are the MetaEdit Controls. They remain hidden until
    564 you select a file from the tree and then a row from the table; when they appear you use them to append, update and
    565 remove metadata associated with the selected file. The first new control is the value field where you may enter or edit the value for the selected metadata. Beside the field is a button labelled "..." which, when clicked, will open a larger text area for the value to be edited in. Next is a row of buttons; "Append" is used to assign the current content of value field as new metadata, which is added to any existing values for the selected element, "Replace" causes the current content of value field to overwrite any existing values, and "Remove clears any existing values. The final control to discusss is labelled "All Previous Values", and is called the Value Tree.
    566 
    567 The Value Tree expands and collapses just as
    568 you expect. Usually this tree acts as a list, showing all previous
    569 values that have been entered for the selected element. Clicking an entry
    570 in the Value Tree automatically enters it into the value field. Conversely, typing in the text field auto-selects the Value Tree
    571 entry that starts with the characters you have typed. Pressing [Enter]
    572 auto-completes the typing with the selected value.
    573 
    574 Unlike an ordinary list, the Value Tree can also show hierarchical structures. Values can be grouped into subjects. Note that a subject can be assigned as a metadata value. You can figure out
    575 the path to a certain value by tracing from the highest level down to
    576 the value in question. This path can be typed into the text field using
    577 the character "\" to separate the various levels. For example, in a hierarchy
    578 that represents pack of playing cards you might type "Cards\Red\Diamonds\Seven".
    579 
    580 The extracted metadata set, denoted with the namespace "ex", has no value tree and cannot be edited. Thus selecting an extract metadata entry from the table will cause the edit controls to be hidden. The "..." button remains available to expand the value, but the text can not be edited.
     653Use the Enrich view to assign metadata to the documents in the collection.
     654Metadata is data about data -- typically title, author, creation date, and so
     655on.  Each metadata item has two parts: "element" tells what kind of item it is
     656(such as author), and "value" gives the value of that metadata element (such as
     657the author's name).
     658
     659On the left of the "Enrich" view is the Collection Tree.  When you select files
     660their details appear in the Metadata Table on the right.
     661
     662The Metadata Table appears the upper right of the screen when files are
     663selected and shows all metadata for the selected files.  Columns are named in
     664grey at the top, and can be resized by dragging the separating line.  Clicking
     665any row transfers its details to the MetaEdit Controls below.  If several files
     666are selected, black text indicates that the value is common to all of the
     667selected files, while grey text indicates that it is not.  Black values may be
     668updated or removed, while grey ones can be removed from those that have it, or
     669appended to the others.
     670
     671A folder icon may appear beside some metadata entries.  This indicates that the
     672values are inherited from a parent (or ancestor) folder.  Inherited metadata
     673cannot be edited or removed, only appended to or overwritten.  Click on the
     674folder icon to go immediately to the folder where the metadata is assigned.
     675
     676The MetaEdit Controls at the lower right appear only when a file is selected
     677from the tree and a row is selected from the table.  Use them to update, append,
     678and remove the metadata value.  The value field is for entering or editing the
     679metadata value.  Beside it is a button labelled "..." which, when clicked,
     680opens a larger editing box.  In the buttons below, "Append" assigns the value as
     681new metadata and adds it to any existing values for the selected element,
     682"Replace" overwrites any existing value(s) with the new one, and "Remove clears
     683any existing values.  Underneath, labelled "All Previous Values", is the "Value
     684Tree".
     685
     686The Value Tree expands and collapses.  Usually it is a list that shows all
     687values entered previously for the selected element.  Clicking an entry
     688automatically places it into the value field.  Conversely, typing in the text
     689field selects the Value Tree entry that starts with the characters you have
     690typed.  Pressing [Enter] auto-completes the typing with the selected value.
     691
     692The Value Tree also shows hierarchical structures.  Values can be grouped
     693together, and a group can be assigned as a metadata value.  Each value has a
     694"path" obtained by tracing down to it from the tree root, and the path can be
     695typed into the text field using the character "\" to separate the levels.  For
     696example, in a hierarchy that represents a pack of playing cards you might type
     697"Cards\Red\Diamonds\Seven".
     698
     699Greenstone extracts metadata automatically from documents into a metadata set
     700whose elements are prefixed by "ex.".  This has no value tree and cannot be
     701edited, so the edit controls are hidden if such an entry is selected.  The
     702"..." button still serves to expand the value, but the text cannot be edited.
     703
    581704<$FOOTER>
    582705
    … …  
    604727<a name="SI">Simple Instructions:</a>
    605728
    606 Sets of predefined elements, known as a metadata set, can be loaded from
    607 the Librarian Interface's folder. An example is the Dublin Core metadata set.
    608 When you add a metadata set to your collection, its elements become available
    609 for selection. You can have more than one set; to prevent name clashes
    610 a short identifier that identifies the metadata set is prepended to the
    611 element name. For instance the Dublin Core element Creator becomes "dc.Creator".
    612 
    613 To add a metadata set, open the "Metadata Set" menu from the menu bar and
    614 select the "Import Set" action. You will be presented with a prompt that shows
    615 the contents of the Librarian Interface's metadata folder. Choose an ".mds" metadata set file and open it, or click "Browse" to locate metadata set files elsewhere on the file system. Next you may be prompted as to whether you wish to import all of the values associated with the elements in this set, just those values that make up the structure of hierarchy-based metadata, or no values at all. Afterwards you will be returned to the main screen.
     729Sets of predefined metadata elements are known as "metadata sets".  An example
     730is the Dublin Core metadata set.  When you add a metadata set to your
     731collection, its elements become available for selection.  You can have more than
     732one set; to prevent name clashes a short identifier that identifies the
     733metadata set is pre-pended to the element name.  For instance the Dublin Core
     734element Creator becomes "dc.Creator".  Metadata sets are stored in the
     735Librarian Interface's folder and have the suffix ".mds".
     736
     737To add a metadata set, choose "Metadata Sets" from the menu bar and select the
     738"Import Set" action.  A list appears that shows the sets stored in the Librarian
     739Interface's metadata folder.  Choose one and open it, or click "Browse" to
     740locate metadata set files stored elsewhere.  You may be asked whether to import
     741all values associated with the elements in the set, just those values that make
     742up the structure of hierarchy-based metadata, or no values at all.
     743
    616744<$NORMAL>
    617745<a name="AI">Advanced Instructions:</a>
    618746
    619 To install a newer version of a metadata set, simply add it as above.
    620 The Librarian Interface merges the two sets, but will not lose track of values you have entered. You may be prompted
    621 as to how to merge certain elements. For example if a currently available
    622 set and the set you are importing have an element of the same name (which
    623 is most likely if you are installing a new version of a set), you
    624 will be presented with a prompt showing as much information about the
    625 existing and new elements as possible, and providing you with several
    626 options on how to proceed with the merging. These options include merging
    627 the two elements, renaming the new element so there is no longer a clash,
    628 replacing the old element entirely, or not adding this element by skipping
    629 it. Merging the elements provides the same options, but at an
    630 element attributes level. You may of course choose to cancel the metadata
    631 set import at any time.
    632 
    633 The ".mds" files themselves are expressed in XML format. To edit an existing
    634 metadata set, or to create a brand new one, you can use an ordinary text editor.
    635 If you are starting a new file, copy the Document Type Definition to the top of your new file and ensure that you follow
    636 it, otherwise the Librarian Interface will be unable to load your metadata set.
    637 Use of an XML validator or validating editor is recommended.
    638 
    639 Any time you want to export a metadata set, or part of a metadata set (e.g. its
    640 assigned value hierarchy, or all its values), return to the Librarian Interface and
    641 choose "Export Set" from the "Metadata Set" menu. A prompt will ask
    642 you to select appropriate export options, and a file to export into.
     747To install a newer version of a metadata set, simply add it as above.  The
     748Librarian Interface merges the sets, but does not alter values you have
     749entered.  You may be asked how to merge certain elements.  For example if the
     750current set and the one you are importing share a common element (which is
     751likely if you are installing a new version of a set), you are shown as much
     752information about the existing and new elements as possible, and asked how to
     753proceed.  Options include merging the elements, renaming the new one, replacing
     754the old element entirely, or skipping this element.  When merging two elements
     755you are confronted with the same options, but this time at the "attributes"
     756(rather than "elements") level.  You can cancel the import operation at any
     757time.
     758
     759The ".mds" files are expressed in XML format.  You can edit an existing metadata
     760set or create a new one with an ordinary text editor.  If you are starting a
     761new file, copy the Document Type Definition and be sure to follow it, otherwise
     762the Librarian Interface will be unable to load the metadata set.  Use of an
     763XML validator or validating editor is recommended.
     764
     765To export a metadata set, or part of one (e.g.  its assigned value hierarchy, or
     766all its values), return to the Librarian Interface and choose "Export Set" from
     767the "Metadata Set" menu.  You will be asked to select appropriate export
     768options, and a file to export into.
     769
    643770<$FOOTER>
    644771
    … …  
    669796Text field entry
    670797<$SECTION>
    671 <a href="#QA">Problems and solutions</a>
    672 <$SUBSECTION>
    673 How do I fix a value that has ended up in the wrong subject?
    674 <$CONTENTS_FOOTER>
    675 <$NORMAL>
    676 <a name="SI">Simple Instructions:</a>
    677 
    678 We now add a metadata item -- both element and value -- to a file. First
    679 select the file from the Collection file tree on the left. The action causes any metadata previously
    680 assigned to this file to appear in the table at the right.
    681 
    682 Next select the metadata element you want to by clicking on its row in the table.
    683 
    684 Now focus on the value field and type your value. Be careful not to use the character
    685 "\", as it is used for constructing hierarchies. When finished click "Append" to add the new value
    686 as metadata for the chosen file. The metadata immediately appears in the
    687 Metadata Table.
    688 
    689 You can also add metadata to a folder, or to several files at once
    690 that have been multiply selected.  This adds it to all files within
    691 the folder or selection, and to any child folders. However keep in mind that if you assign metadata to a folder that any new files added to that folder will automatically inherit the aforementioned metadata.
    692 
    693 When you
    694 add metadata in this way, or if previous metadata exists for the element you have selected, you will be prompted for the action to
    695 take on the files it contains. The prompt includes the name of the
    696 file in question, the element's title, any previously-assigned values
    697 for this element, and the new value that you have entered. The buttons
    698 offer different options: "Append" appends the metadata to the specified
    699 file without altering any existing values; "Append All" adds the new
    700 value in the same way to all child files; "Replace" replaces any
    701 previous value with the new one; "Replace All" adds the new value in
    702 the same way to all child files; "Skip File" skips the current file
    703 and proceeds to the next; "Cancel" undoes any changes and cancels
    704 the action.
    705 
    706 If you choose metadata that is not common to all the selected files, and press "Append", the metadata will be added
    707 as necessary to make it common to all files in the selection.
     798<a href="#AI">Advanced instructions</a>
     799<$SUBSECTION>
     800Value hierarchies and editing values
     801<$CONTENTS_FOOTER>
     802<$NORMAL>
     803<a name="SI">Simple Instructions:</a>
     804
     805We now add a metadata item -- both element and value -- to a file.  First select
     806the file from the Collection file tree on the left.  The action causes any
     807metadata previously assigned to this file to appear in the table at the right.
     808
     809Next select the metadata element you want to add by clicking its row in the
     810table.
     811
     812Type the value into the value field.  Do not use the character "\", as it is
     813used for constructing hierarchies.  When finished, click "Append" to add the new
     814value as metadata for the chosen file.  The value immediately appears in the
     815Metadata table.
     816
     817You can also add metadata to a folder, or to several multiply selected files at
     818once.  It is added to all files within the folder or selection, and to child
     819folders.  Keep in mind that if you assign metadata to a folder, any new files in
     820it automatically inherit the folder's values.
     821
     822When you add metadata to an element that already has some, you need to decide
     823what to do.  You are shown the name of the file in question, the element's
     824title, previously-assigned values for this element, and the new value.  The
     825buttons offer different options: "Append" appends the metadata to the file
     826without altering any existing values; "Append All" adds the new value to all
     827other files too; "Replace" replaces the previous value; "Replace All" replaces
     828it for all other files too; "Skip File" proceeds to the next file; "Cancel"
     829undoes any changes and cancels the action.
     830
     831If you choose metadata that occurs in some of the selected files and click
     832"Append", it is added to the other files in the selection too.
     833
    708834<$NORMAL>
    709835<a name="AI">Advanced Instructions:</a>
    710836
    711 You can add structure to metadata values by using paths as described in section 6.1 - The Enrich View. Correct any mistakes in creating hierarchies by using the metadata set editor explained in chapter 11.1 - Editing Metadata Sets.
     837You can add structure to metadata values by using paths as described in section
     8386.1 -- The Enrich View.  Correct any mistakes in creating hierarchies by using
     839the metadata set editor explained in Chapter 11.1 -- Editing Metadata Sets.
     840
    712841<$FOOTER>
    713842
    … …  
    729858<a name="SI">Simple Instructions:</a>
    730859
    731 To add metadata that has an already-existing value, first select the file
    732 and then select the required value from the value tree, expanding subject
    733 folders as necessary. The value of any selected entry in the tree automatically
    734 appears in the Value text field. Alternatively, you can use the auto-select
    735 and auto-complete features of the value tree. Click "Append" to add the metadata
    736 to the selected file.
     860To add metadata that has an existing value, first select the file, then select
     861the required value from the value tree, expanding subject folders as
     862necessary.  The value of the selected entry automatically appears in the Value
     863text field (alternatively, use the value tree's auto-select and auto-complete
     864features).  Click "Append" to add the metadata to the selected file.
    737865
    738866The process of adding metadata with already-existing values to folders
    739 or multiple files is just the same. 
     867or multiple files is just the same.
    740868<$FOOTER>
    741869
    … …  
    757885<a name="SI">Simple Instructions:</a>
    758886
    759 To update the value of a certain piece of metadata, first choose the file
    760 to which that value applies, and then the metadata
    761 element whose value you want to change. Your selection appears in the metadata edit controls, and "Replace" is enabled. Edit the value in the value field and then click "Replace" to alter the metadata.
    762 
    763 The process is the same when updating a folder with child folders or
    764 multiple files, except that pressing "Replace" yields a prompt to specify
    765 what to do with child files. The buttons offer different options: "Replace"
    766 replaces any previous value with the new one; "Replace All" adds the
    767 new value in the same way to all child files; "Skip File" skips the
    768 current file and proceeds to the next; "Cancel" undoes any changes and
    769 cancels the action. You can only update metadata that
    770 is common to all files selected. For a folder this means that all
    771 its children must share the same metadata.
    772 
    773 Note that the value tree shows all previous values, not just those currently assigned. Thus the value you have replaced will still be in the value tree.
     887To update the value of a piece of metadata, first choose the file to which that
     888value applies, and then the metadata element whose value you want to change.
     889Your selection appears in the metadata edit controls.  Edit the value field and
     890click "Replace" to alter the metadata.
     891
     892The process is the same when updating a folder with child folders or multiple
     893files, except that when you click "Replace" you are asked what to do with the
     894other files.  The buttons offer different options: "Replace" replaces any
     895previous value with the new one; "Replace All" adds the new value in the same
     896way to all other files; "Skip File" skips the current file and proceeds to the
     897next; "Cancel" undoes any changes and cancels the action.  You can only update
     898metadata that is common to all files selected.  For a folder, this means that
     899all its contents must share the same metadata.
     900
     901The value tree shows all previous values, not just those currently assigned.
     902Thus the value you have replaced will remain in the value tree.
     903
    774904<$FOOTER>
    775905
    … …  
    795925<a name="SI">Simple Instructions:</a>
    796926
    797 You remove metadata the same way as you update it. First select a file
    798 from the file tree, then use the metadata table to select the metadata. If the metadata has a value
    799 assigned, the "Remove" button in the MetaEdit Controls becomes active.
    800 Click it to remove the metadata from the specified file. Other files remain
    801 unchanged, and the value still appears in the Value Tree.
    802 
    803 If you remove metadata from a folder with children or from multiple
    804 files, a prompt presents several options. "Remove" removes the metadata
    805 from this file; "Remove All" removes it from all remaining files; "Skip"
    806 leaves the metadata in this file and proceeds to the next; "Cancel"
    807 undoes any changes and cancels the action. Note that if you choose metadata
    808 that is not common to all the selected files, and you click the "Remove"
    809 button in the edit controls, the metadata will be removed from those
    810 files that have it. Those that do not contain this metadata will be unaffected.
     927You remove metadata the same way as you update it.  First select a file from the
     928file tree, then use the metadata table to select the metadata.  If the metadata
     929has a value assigned, the "Remove" button in the MetaEdit Controls becomes
     930active.  Click it to remove the metadata from the specified file.  Other files
     931remain unchanged, and the value remains in the Value Tree.
     932
     933When you remove metadata from a folder, or from several files, you are
     934presented with various options: removing the metadata from this file, removing
     935it from this and all other files, and skipping this file.  You can cancel the
     936operation at any time.  If you choose metadata that is not common to all the
     937selected files and click "Remove", the metadata is removed from those
     938files that have it; all others are unaffected.
     939
    811940<$FOOTER>
    812941
    … …  
    8159446.7 Reviewing Assigned Metadata
    816945<$DESCRIPTION>
    817 This section shows how to view all metadata assigned to an entire collection.
     946This section describes how to view all metadata assigned to an entire collection.
    818947
    819948<$CONTENTS_HEADER>
    … …  
    832961<a name="SI">Simple Instructions:</a>
    833962
    834 Sometimes you need to see all metadata assigned to all files. For instance,
    835 you may wonder how many files are left to work on, or you may want to
    836 get some idea of the spread of dates.
    837 
    838 From the "Metadata Set" menu choose the "Assigned Metadata..." action. This opens
    839 a window called "All Metadata". The window is dominated by
    840 a large table with many columns. The first column
    841 shows file names; the remaining ones show metadata element names.
    842 Each row shows all metadata values assigned to that file.
    843 
    844 You can carry on using the Librarian Interface even while the all metadata window is open. Preparatory work must be done when creating the view's model, so drawing the table can take some time.
    845 
    846 Once you have finished reviewing the metadata, click "Close" to hide the window.
     963Sometimes you need to see the metadata assigned to all files -- for instance,
     964to determine how many files are left to work on, or to get some idea of the
     965spread of dates.
     966
     967>From the "Metadata Set" menu choose "Assigned Metadata...".  A window called
     968"All Metadata", dominated by a large table with many columns, appears.  The
     969first column shows file names; the rows show all metadata values assigned to
     970that file.
     971
     972Drawing the table can take some time.  You can continue to use the Librarian
     973Interface while the "All Metadata" window is open.
     974
     975Click "Close" to hide the window.
    847976<$NORMAL>
    848977<a name="AI">Advanced Instructions:</a>
    849978
    850 You may view the all metadata table at any time by selecting the
    851 files you wish to audit and opening the right click menu. Click on
    852 the item "Assigned Metadata...". If a folder has been selected, all its
    853 child files will be included in the table.
    854 
    855 The all metadata table quickly becomes daunting to navigate, so
    856 a filtering mechanism is included, modelled on Microsoft Excel's
    857 concept of autofilters.  It allows a single filter to be applied to
    858 each column of the table. As new filters are added, only those
    859 rows that match the filters set on all columns remain visible. To set,
    860 modify or clear a filter, click on the icon of a funnel, at the top of the
    861 column you wish to filter.  A new prompt appears allowing you to
    862 control filtering. Once a filter is set, the column header, and the
    863 funnel within it, changes colour to indicate that the column is being
    864 filtered.
    865 
    866 The prompt itself contains four main components. The top field reminds
    867 you of the name of the column, the second to bottom combobox control allows
    868 you to change the alphabetical order of the values in the column (move
    869 rows as necessary) and the bottom area offers you buttons to set and
    870 clear the filter. This leaves the middle area, where the filtering is
    871 actually controlled. Initially the Simple tab will be selected. This allows
    872 you to filter a column so that it only shows rows which contain a certain
    873 existing metadata value. Note that the * matches all values. Just choose
    874 the value you want to limit the column to, then set the filter.
    875 
    876 There is also an "Advanced" tab. While the simple filter
    877 is essentially a "must equal", the advanced tab allows several different matching
    878 operations such as: must start with, does not contain, alphabetically
    879 less than and is equal to. Furthermore, the value to be matched
    880 can be edited to be any string, including the wildcard matching character "*", not just values that already exist within
    881 that column (although by default these values are made available as the
    882 drop down list connected to the value combobox). You may also choose whether
    883 the matching should be case sensitive. Finally, the advanced filtering allows
    884 you to specify a second condition that must be matched. This allows you
    885 to specify ranges of values accepted (by selecting the AND checkbox then
    886 filling out the filter) or possibly alternate values accepted (by selecting
    887 the OR checkbox instead).
    888 
    889 Once you have finished select the ordering, click "Set Filter".
    890 The new filter will be applied to the column.
    891 
    892 If at any time you wish to stop adding a new filter, or to
    893 remove a current filter, click the "Clear Filter" button. Note that the
    894 details of a filter are retained even when the filter is cleared.
    895 
    896 To quickly sort the table, choose the column to sort by,
    897 select a simple filter of "*", then choose ascending or descending ordering.
     979You can also view the "All Metadata" table by selecting the files you wish to
     980examine, right-clicking, and choosing "Assigned Metadata...".  If a folder has
     981been selected, all its child files are included in the table.
     982
     983When it gets too large, you can filter the "All Metadata" table by applying
     984filters to the columns.  As new filters are added, only those rows that match
     985them remain visible.  To set, modify or clear a filter, click on the "funnel"
     986icon at the top of a column.  You are prompted for information about the filter.
     987Once a filter is set, the column header changes colour.
     988
     989The prompt has a "Simple" and an "Advanced" tab.  The Simple version filters
     990columns so that they only show rows that contain a certain metadata value ("*"
     991matches all values).  You can select metadata values from the pull-down list.
     992The Advanced version allows different matching operations: must start with,
     993does not contain, alphabetically less than and is equal to.  The value to be
     994matched can be edited to be any string (including "*"), and you can choose
     995whether the matching should be case insensitive.  Finally, you can specify a
     996second matching condition that you can use to specify a range of values (by
     997selecting AND) or alternative values (by selecting OR).  Below this area is a
     998box that allows you to change the sort order (ascending or descending).  Once
     999you have finished, click "Set Filter" to apply the new filter to the column.
     1000Click "Clear Filter" to remove a current filter.  Note that the filter details
     1001are retained even when the filter is cleared.
     1002
     1003For example, to sort the "All Metadata" table, choose a column, select the
     1004default filter setting (a Simple filter on "*"), and choose ascending or
     1005descending ordering.
     1006
    8981007<$FOOTER>
    8991008
    … …  
    90210116.8 Importing Previously Assigned Metadata
    9031012<$DESCRIPTION>
    904 This section details the process for importing previously assigned metadata,
    905 and how to install parsers to handle various metadata types.
     1013This section describes how to import previously assigned metadata,
     1014and install parsers to handle various metadata types.
    9061015
    9071016<$CONTENTS_HEADER>
    … …  
    9141023<a name="SI">Simple Instructions:</a>
    9151024
    916 If metadata has been previously assigned to a certain file, and that
    917 metadata is in a form recognized by the Librarian Interface, the metadata will be
    918 imported when you add the file. If the Librarian Interface does not know how to map
    919 previously assigned metadata onto the metadata sets available in the
    920 collection it will prompt the user for how to do so.
    921 
    922 Below the brief instructions area three are three controls.  The first shows the name of
    923 the metadata element that the Librarian Interface is importing, just as it
    924 appears in the source file. This field
    925 cannot be edited or changed. The second control allows you to choose
    926 what metadata set this element should map to. The third control allows you
    927 to choose which metadata element the original element should map to if
    928 you intend to merge elements.
    929 
    930 Librarian Interface attempts to automatically select the closest match, in terms of set and element, to the metadata its importing. The user than chooses what action to take. The actions allowed are: "Add", "Merge" or "Ignore". The add button allows you to add a new element to the chosen metadata set with the name as given in the original. This control is only enabled if there is no element of the same name within the chosen set. Merging maps the original element to the element chosen by the user. Finally, ignore skips importing any metadata with this element name.
    931 
    932 Once the Librarian Interface knows how to import a certain piece of metadata
    933 from a certain source location, it retains this information as an import profile for the
    934 lifetime of the collection. To correct any mistakes during importing, use the metadata set editor described in chapter 11 - Editing Metadata Sets.
    935 
    936 For details on how design metadata.xml files see chapter 2 of the Greenstone Developers Manual - Getting the most out of your documents.
     1025If metadata in a form recognized by the Librarian Interface has been previously
     1026assigned to a file -- for example, when you choose documents from an existing
     1027Greenstone collection -- it is imported automatically when you add the file.
     1028To do this, the metadata must be mapped to the metadata sets available in the
     1029collection.
     1030
     1031The Librarian Interface prompts for the necessary information.  The prompt
     1032gives brief instructions and then shows the name of the metadata element that
     1033is being imported, just as it appears in the source file.  This field cannot be
     1034edited or changed.  Next you choose what metadata set the new element should map
     1035to, and then the appropriate metadata element in that set.  The system
     1036automatically selects the closest match, in terms of set and element, for the
     1037new metadata.
     1038
     1039Having checked the mapping, you can choose "Add" to add the new metadata
     1040element to the chosen metadata set.  (This is only enabled if there is no
     1041element of the same name within the chosen set.) "Merge" maps the new element
     1042to the one chosen by the user.  Finally, "Ignore" does not import any metadata
     1043with this element name.
     1044
     1045Once you have specified how to import a certain piece of metadata, the mapping
     1046information is retained for the collection's lifetime.  To correct any mistakes
     1047during importing, use the metadata set editor described in Chapter 11 -- Editing
     1048Metadata Sets.
     1049
     1050For details on how design metadata.xml files see Chapter 2 of the Greenstone
     1051Developer's Guide -- Getting the most out of your documents.
    9371052
    9381053<$FOOTER>
    … …  
    94210577.0 Designing Your Collection's Appearance
    9431058<$DESCRIPTION>
    944 Once you have a set of marked-up files, it is time to consider how it
    945 will appear to users as a Greenstone collection.  What kind of
    946 information will be searchable?  What ways are provided to browse
    947 through the documents?  What languages are supported?  Where do the
    948 buttons appear on the page?  Many such features can be customized; this
    949 chapter shows how to do it.
     1059
     1060Once your files are marked up with metadata, you next decide how it should
     1061appear to users as a Greenstone collection.  What kind of information is
     1062searchable?  What ways are provided to browse through the documents?  What
     1063languages are supported?  Where do the buttons appear on the page?  These
     1064things can be customized; this chapter describes how to do it.
     1065
    9501066<$FOOTER>
    9511067
    … …  
    95410707.1 The Design View
    9551071<$DESCRIPTION>
    956 This section introduces you to the design view, and explains how to navigate
    957 between the various sub-views within this pane.
     1072This section introduces you to the design view and explains how to navigate
     1073between the various views within this pane.
    9581074
    9591075<$CONTENTS_HEADER>
    … …  
    9661082<a name="SI">Simple Instructions:</a>
    9671083
    968 The Librarian Interface provides a graphical user interface for configuring how the collection
    969 appears to the user. It divides the configuration commands that are available into
    970 different sections, each associated with a particular stage of the
    971 collection navigation or presentation.
    972 
    973 The design view is split into two halves. On the left is a list of
    974 different sub-views, and on the right are the controls associated with
    975 the current sub-view. To change to a different sub-view, click its
    976 name in the list.
    977 
    978 To understand all of the stages and terms involved in designing a collection please ensure you have read chapters 1 & 2 of the Greenstone Developers Manual.
     1084With the Librarian Interface, you can configure how the collection appears to
     1085the user.  The configuration options are divided into different sections, each
     1086associated with a particular stage of navigating or presenting information.
     1087
     1088On the left is a list of different views, and on the right are the controls
     1089associated with the current one.  To change to a different view, click its name
     1090in the list.
     1091
     1092To understand the stages and terms involved in designing a collection, first
     1093read Chapters 1 & 2 of the Greenstone Developer's Guide.
     1094
    9791095<$FOOTER>
    9801096
    … …  
    9841100<$DESCRIPTION>
    9851101This section explains how to review and alter the general settings associated
    986 with your collection.
     1102with your collection.  First, under "Design Sections", click "General".
    9871103
    9881104<$CONTENTS_HEADER>
    … …  
    9951111<a name="SI">Simple Instructions:</a>
    9961112
    997 This is where the values provided during
    998 collection creation can be modified.
    999 
    1000 At the top of the page is an instruction box, which appears for each
    1001 of the different sections.  The brief list of instructions it contains
    1002 is intended as a reminder of what functionality is available.
    1003 
    1004 The first two fields below the instructions give the contact email of
    1005 the collection's creator and maintainer, and must be valid email
    1006 addresses. The next two controls are checkboxes, whose purpose is explained by their labels. The following field allows you to change the collection title. The "Url to about page icon" specifies the icon to show at the top left of the about page of your collection, while the "Url to home page icon" is used in the Greenstone library page to link to your collection. The final control is the "Collection Description" text area, which is functionally the same as the one explained in section 2.1 - Creating A New Collection.
     1113Here the values provided during collection creation can be modified.
     1114
     1115At the top of the page is an instruction box, which appears for each of the
     1116different sections.  It contains a brief list of instructions to remind you
     1117what functionality is available.
     1118
     1119First are the contact emails of the collection's creator and maintainer.  Then
     1120come two checkboxes for whether the collection should be publicly accessible,
     1121and whether it is still under construction.  The following field allows you to
     1122change the collection title.  The next one specifies (in the form of a URL) the
     1123icon to show at the top left of the collection's "About" page, and the next is
     1124the icon used in the Greenstone library page to link to the collection.  Finally
     1125comes the "Collection Description" text area as described in section 2.1 --
     1126Creating A New Collection.
     1127
    10071128<$FOOTER>
    10081129
    10091130<$FILE name=7-3.htm>
    10101131<$HEADER>
    1011 7.3 Document Plugins
    1012 <$DESCRIPTION>
    1013 This section describes how to configure the document plugins used in your
    1014 Greenstone collection. It explains how you specify what
    1015 plugins to use, what parameters to pass to them, and in what order
    1016 they occur.
     11327.3 Plug-Ins
     1133<$DESCRIPTION>
     1134This section describes how to configure the document plug-ins the
     1135collection uses. It explains how you specify what
     1136plug-ins to use, what parameters to pass to them, and in what order
     1137they occur.  Under "Design Sections", click "Plug-ins".
    10171138
    10181139<$CONTENTS_HEADER>
    … …  
    10371158<a name="SI">Simple Instructions:</a>
    10381159
    1039 To add a plug-in, use the "Select plug-in to add" combobox. Once a plug-in is selected, click "Add Specified
    1040 Plug-in". A window will appear titled "Configuring
    1041 Arguments"; it is described in detail later. Once you have completed configuration the new
    1042 plug-in will be added to the end of the "Currently Assigned Plugins" list.  Note that a plug-in may only occur in this
    1043 list once.
    1044 
    1045 To remove a plug-in, select it from the list
    1046 and then click "Remove Selected Plug-in".
    1047 
    1048 Plugins are configured by providing arguments, and to alter these arguments, select
    1049 the desired plug-in from the list then click
    1050 "Configure Selected Plug-in" or double-click on the desired plug-in. This will cause the "Configuring
    1051 Arguments" dialog to appear. This window has three parts,
    1052 a text field for entering custom arguments, an area containing controls for specifying arguments, and
    1053 two buttons at the very bottom.
    1054 
    1055 The controls come in several flavours.  The most basic is represented by a checkbox. Clicking the checkbox instructs the
    1056 Librarian Interface to add the appropriate flag. Another type of control is
    1057 a text parameter argument comprising a checkbox and a text
    1058 field. Click on the checkbox to enable this argument, then type
    1059 appropriate text (regular expression, file path etc) in the box. The
    1060 next type of control uses a combobox from which you can select one of
    1061 a limited set of values. The final control allows multiple selections from a list. To
    1062 add a value, select it from the combobox and click "Add"; to remove it,
    1063 select it and click "Remove". To review exactly what an argument does,
    1064 leave the mouse pointer hovering over its name for a moment and a description will appear.
    1065 
    1066 When you have
    1067 changed the configuration to suit, click "OK" to commit the
    1068 changes and close the dialog, or "Cancel" to close the dialog without
    1069 changing any plug-in arguments.
    1070 
    1071 The ordering of plugins in the list is important.  The plugins
    1072 in the list are executed in order. Two plugins, ArcPlug and
    1073 RecPlug, are vital to the collection building process. These plugins are
    1074 fixed in place at the end of the list -- denoted by a separator
    1075 line. Only the plugins above the line can be moved.  To change the
    1076 ordering, select the plug-in you want to move.  There are four
    1077 options; "Move To Top", "Move Up", "Move Down", and "Move To Bottom",
    1078 which re-order the list in corresponding ways.  You cannot move a
    1079 component outside the list bounds, nor can you move a fixed component.
     1160To add a plug-in, use the "Select plug-in to add" pull-down list near the
     1161bottom and then click "Add Specified Plug-in".  A window appears entitled
     1162"Configuring Arguments"; it is described later.  Once you have configured the
     1163new plug-in, it is added to the end of the "Currently Assigned Plug-Ins" list.
     1164Note that a plug-in may only occur once in the list.
     1165
     1166To remove a plug-in, select it in the list and click "Remove Selected Plug-in".
     1167
     1168Plug-Ins are configured by providing arguments.  To alter them, select the
     1169plug-in from the list and click "Configure Selected Plug-in" (or double-click
     1170the plug-in).  A "Configuring Arguments" dialog appears with three parts: a
     1171text field for entering custom arguments, an area containing controls for
     1172specifying arguments, and two buttons at the bottom.
     1173
     1174There are different kinds of controls.  Some are checkboxes, and clicking one
     1175adds the appropriate option to the plug-in.  Others are text strings, with a
     1176checkbox and a text field.  Click the box to enable the argument, then type
     1177appropriate text (regular expression, file path etc) in the box.  Others are
     1178pull-down menus from which you can select from a given set of values.  Still
     1179others allow multiple selections from a list.  To add a value, select it and
     1180click "Add"; to remove it, select it and click "Remove".  To learn what an
     1181argument does, let the mouse hover over its name for a moment and a description
     1182will appear.
     1183
     1184When you have changed the configuration, click "OK" to commit the changes and
     1185close the dialog, or "Cancel" to close the dialog without changing any plug-in
     1186arguments.
     1187
     1188The plug-ins in the list are executed in order, and the ordering is sometimes
     1189important.  Two plug-ins, ArcPlug and RecPlug, are vital to the collection
     1190building process, and are fixed in place at the end of the list (with a
     1191separator line).  To change the ordering, select the plug-in you want to move
     1192and click "Move To Top", "Move Up", "Move Down", or "Move To Bottom".
     1193
     1194<$NORMAL> <a name="AI">Advanced Instructions:</a>
     1195
     1196The Librarian Interface does its best to determine what arguments a plug-in
     1197supports.  However, there may be cases where the user wants to specify special
     1198arguments, and for this a text field called "Custom Arguments" (at the top) is
     1199provided.  Any text in it is appended verbatim to the end of the plug-in
     1200command.
     1201
     1202<$FOOTER>
     1203
     1204<$FILE name=7-4.htm>
     1205<$HEADER>
     12067.4 Search Types
     1207<$DESCRIPTION>
     1208This section explains how to modify a new design feature in Greenstone, Search Types, which allow fielded searching.  Under "Design Sections", click "Search Types".
     1209
     1210<$CONTENTS_HEADER>
     1211<$SECTION>
     1212<a href="#SI">Simple instructions</a>
     1213<$SUBSECTION>
     1214What enabling advanced searches means
     1215<$SUBSECTION>
     1216Adding a new search type
     1217<$SUBSECTION>
     1218Removing a search type
     1219<$SUBSECTION>
     1220Changing the order of search types
     1221<$CONTENTS_FOOTER>
     1222<$NORMAL>
     1223<a name="SI">Simple Instructions:</a>
     1224
     1225When you enter the Search Types view, first check "Enable Advanced
     1226Searches", which activates the other controls.  This migrates the collection to
     1227Greenstone 2.4 format, which supports for fielded searching, and means that (a)
     1228the index design is different (explained in section 7.5 -- Search Indexes),
     1229(b) there are more text fragments to translate (see Section 7.10 --
     1230Translation), and (c) the collection will not be usable under older Greenstone
     1231installations.  If you later uncheck this field, most of your collection will
     1232be migrated back to Greenstone 2.39.  However the Librarian Interface cannot
     1233convert the new index specifications into older ones, so you will have to
     1234re-enter them manually.
     1235
     1236To add a search type, select it from the "Search Types" list and click "Add New
     1237Search Type".  Each type can only appear in the list once.
     1238
     1239To remove a search type, select it from the "Currently Assigned Search Types"
     1240list and click "Remove Selected Search Type".  The list must contain at least
     1241one search type.
     1242
     1243To change to order of a search type, select it from the list and click "Move
     1244Up" or "Move Down".
     1245
     1246<$FOOTER>
     1247
     1248<$FILE name=7-5.htm>
     1249<$HEADER>
     12507.5 Search Indexes
     1251<$DESCRIPTION>
     1252Indexes specify what parts of the collection are searchable.  This section explains how to add and remove indexes, and set a default index.  Under "Design Sections", click "Search Indexes".
     1253
     1254<$CONTENTS_HEADER>
     1255<$SECTION>
     1256<a href="#SI">Simple instructions</a>
     1257<$SUBSECTION>
     1258Add an index
     1259<$SUBSECTION>
     1260Remove an index
     1261<$SUBSECTION>
     1262Set default index
     1263<$SUBSECTION>
     1264Clear default index
     1265<$CONTENTS_FOOTER>
     1266<$NORMAL>
     1267<a name="SI">Simple Instructions:</a>
     1268
     1269To add an index, type a name for it into the "Index Name" field.  Select which
     1270of the possible information sources to index by clicking the checkboxes beside
     1271them.  The list shows all the assigned metadata elements, as well the full
     1272text.  Having selected the data sources, choose the granularity of the index,
     1273using the "At the level" menu.  Once these details are complete, "Add Index"
     1274becomes active (unless there is an existing index with the same settings).
     1275Click it to add the new index.
     1276
     1277To remove an index, select it from the list of assigned indexes and click
     1278"Remove Index".
     1279
     1280The default index, the one used on the collection's search page, is tagged with
     1281"[Default Index]" in the "Assigned Indexes" list.  To set it, select an index
     1282from the list and click "Set Default".  To reset it, click "Clear Index".
     1283
     1284If advanced searching is enabled, the index controls are different.  Each index
     1285is based on just one data source.  There is a new data source "allfields" which
     1286is equivalent to entering a list of all the metadata elements.  Levels are not
     1287assigned to a specific index, but apply across all indexes: thus indexes and
     1288levels are added separately.  Indexes are removed in the same way as above, but
     1289the default index can no longer controls be set and cleared -- it is simply the
     1290first index assigned.
     1291
     1292<$FOOTER>
     1293
     1294<$FILE name=7-6.htm>
     1295<$HEADER>
     12967.6 Partition Indexes
     1297<$DESCRIPTION>
     1298
     1299Indexes are built on particular text or metadata sources.  The search space can
     1300be further controlled by partitioning the index, either by language or by a
     1301predetermined filter.  This section describes how to do this.  Under "Design
     1302Sections", click "Partition Indexes".
     1303
     1304The "Partition Indexes" view has three tabs; "Define Filters", "Assign
     1305Partitions" and "Assign Languages".  To learn more about partitions read about
     1306subcollections and subindexes in Chapter 2 of the Greenstone Developer's Guide.
     1307
     1308<$FOOTER>
     1309
     1310<$FILE name=7-6-1.htm>
     1311<$HEADER>
     13127.6.1 Define Filters
     1313<$DESCRIPTION>
     1314The section explains how to define a partition filter.
     1315<$CONTENTS_HEADER>
     1316<$SECTION>
     1317<a href="#SI">Simple instructions</a>
     1318<$SUBSECTION>
     1319Add a filter
     1320<$SUBSECTION>
     1321Remove a filter
     1322<$SUBSECTION>
     1323Update a filter
     1324<$CONTENTS_FOOTER>
     1325<$NORMAL>
     1326<a name="SI">Simple Instructions:</a>
     1327
     1328Filters allows you to group together into a subcollection all documents in an
     1329index for which a metadata value matches a given pattern.
     1330
     1331To create a filter, click the "Define Filters" tab and enter a name for the
     1332new filter into the "Name the subcollection filter" field.  Next choose a
     1333document attribute to match against, either a metadata element or the name of
     1334the file in question.  Enter a regular expression to use during the matching.
     1335You can toggle between "Including" documents that match the filter, or
     1336"Excluding" them.  Finally, you can specify any of the standard PERL regular
     1337expression flags to use when matching (e.g.  "i" for case-insensitive matching).
     1338Finally, click "Add" to add the filter to the "Defined Subcollection Filters"
     1339list.
     1340
     1341To remove a filter, select it from the list and click "Remove".
     1342
     1343To alter a filter, select it from the list, change any of the values that
     1344appear in the editing controls and click "Update" to commit the changes.
     1345
     1346<$FOOTER>
     1347
     1348<$FILE name=7-6-2.htm>
     1349<$HEADER>
     13507.6.2 Assign Partitions
     1351<$DESCRIPTION>
     1352This section explains how to assign a previous defined partition filter.
     1353<$CONTENTS_HEADER>
     1354<$SECTION>
     1355<a href="#SI">Simple instructions</a>
     1356<$SUBSECTION>
     1357Add a partition
     1358<$SUBSECTION>
     1359Remove a partition
     1360<$SUBSECTION>
     1361Set default partition
     1362<$SUBSECTION>
     1363Clear default partition
     1364<$CONTENTS_FOOTER>
     1365<$NORMAL>
     1366<a name="SI">Simple Instructions:</a>
     1367
     1368Having defined a subcollection filter, use the "Assign Partitions" tab to build
     1369indexes for it (or for a group of filters).  Select the desired filter (or
     1370filters) from the "Defined Subcollection Filters" list and click "Add
     1371Partition".
     1372
     1373To remove a partition, select it from the list and click "Remove Partition".
     1374
     1375To make a partition the default one, select it from the list and click "Set
     1376Default Partition".
     1377
     1378To clear the default partition, click "Clear Default Partition".
     1379<$FOOTER>
     1380
     1381<$FILE name=7-6-3.htm>
     1382<$HEADER>
     13837.6.3 Assign Languages
     1384<$DESCRIPTION>
     1385This section details how to restrict search indexes to particular languages.
     1386You do this by generating a partition using the "Assign Languages" tab of the
     1387"Partition Indexes" view.
     1388<$CONTENTS_HEADER>
     1389<$SECTION>
     1390<a href="#SI">Simple instructions</a>
     1391<$SUBSECTION>
     1392Language controls
     1393<$SUBSECTION>
     1394Add language
     1395<$SUBSECTION>
     1396Remove language
     1397<$SUBSECTION>
     1398Set default language
     1399<$SUBSECTION>
     1400Clear default language
     1401<$CONTENTS_FOOTER>
     1402<$NORMAL>
     1403<a name="SI">Simple Instructions:</a>
     1404
     1405To add a new language to partition by, use the "Assign Languages" tab to build
     1406an index for it.  Select the desired language from the "Language to add"
     1407pull-down list and click "Add Language".
     1408
     1409To remove a language, select it from the "Language Selection" list and click
     1410"Remove Language".
     1411
     1412To set the default language, select it from the list and click "Set Default
     1413Language".
     1414
     1415To clear the default language, click "Clear Default Language".
     1416<$FOOTER>
     1417
     1418<$FILE name=7-7.htm>
     1419<$HEADER>
     14207.7 Cross-Collection Searching
     1421<$DESCRIPTION>
     1422
     1423Greenstone can search across several different collections as though they were
     1424one.  This is done by creating a "super-collection" that comprises the
     1425individual collections.  Under "Design Sections", click "Super-Collection".
     1426
     1427<$CONTENTS_HEADER>
     1428<$SECTION>
     1429<a href="#SI">Simple instructions</a>
     1430<$SUBSECTION>
     1431Selecting a collection
     1432<$CONTENTS_FOOTER>
     1433<$NORMAL>
     1434<a name="SI">Simple Instructions:</a>
     1435
     1436The Super-Collection view shows a checklist of available collections.  The
     1437current collection is ticked and cannot be deselected.  To add another
     1438collection to be searched in parallel, click it in the list (click again to
     1439remove it).  If only one collection is selected, there is no cross-collection
     1440searching.
     1441
     1442For further details, see Chapter 1 of the Greenstone Developer's Guide.
     1443<$FOOTER>
     1444
     1445<$FILE name=7-8.htm>
     1446<$HEADER>
     14477.8 Classifiers
     1448<$DESCRIPTION>
     1449
     1450This section explains how to assign "classifiers", which are used for browsing,
     1451to the collection.  Under "Design Sections", click "Classifiers".
     1452
     1453<$CONTENTS_HEADER>
     1454<$SECTION>
     1455<a href="#SI">Simple instructions</a>
     1456<$SUBSECTION>
     1457Classifier selection and configuration
     1458<$SUBSECTION>
     1459Add a classifier
     1460<$SUBSECTION>
     1461Remove a classifier
     1462<$SUBSECTION>
     1463Configure a classifier
     1464<$SUBSECTION>
     1465Alter classifier ordering
     1466<$SECTION>
     1467<a href="#AI">Advanced instructions</a>
     1468<$SUBSECTION>
     1469CustomAZList
     1470<$CONTENTS_FOOTER>
     1471<$NORMAL>
     1472<a name="SI">Simple Instructions:</a>
     1473
     1474To add a classifier, use the "Select classifier to add" pull-down list near the
     1475bottom and then click "Add Specified Classifier".  A window appears entitled
     1476"Configuring Arguments"; instructions for this dialog are just the same as for
     1477plug-ins (see Section 7.3 -- Plug-Ins).  Once you have configured the new
     1478classifier, it is added to the end of the "Currently Assigned Classifiers"
     1479list.
     1480
     1481To remove a classifier, select it from the list and click "Remove Selected
     1482Classifier".
     1483
     1484To change the arguments a classifier, select it from the list and click
     1485"Configure Selected Classifier" (or double-click on the classifier in the
     1486list).
     1487
     1488The ordering of classifiers in the collection's navigation bar is reflected in
     1489their order here.  To change it, select the classifier you want to move and
     1490click "Move To Top", "Move Up", "Move Down", or "Move To Bottom".
     1491
     1492For further information on classifiers read Chapter 2, Greenstone
     1493Developer's Guide -- Getting the most out of your documents.
     1494
    10801495<$NORMAL>
    10811496<a name="AI">Advanced Instructions:</a>
    10821497
    1083 When you enter the plug-in configuration dialog, the focus is
    1084 initially on a text field called "Custom Arguments".  This field is
    1085 provided because although the Librarian Interface does its best to determine the
    1086 arguments supported by the plug-in, there may be cases when the user
    1087 wants to specify special arguments. Any text in it is appended
    1088 verbatim to the end of the plug-in command.
    1089 <$FOOTER>
    1090 
    1091 <$FILE name=7-4.htm>
    1092 <$HEADER>
    1093 7.4 Search Types
    1094 <$DESCRIPTION>
    1095 This sections explains how to modify a new design feature in Greenstone, Search Types. These are part of MGPP, and extend Greenstone to allow fielded searching.
    1096 
    1097 <$CONTENTS_HEADER>
    1098 <$SECTION>
    1099 <a href="#SI">Simple instructions</a>
    1100 <$SUBSECTION>
    1101 What enabling advanced searches means
    1102 <$SUBSECTION>
    1103 Adding a new search type
    1104 <$SUBSECTION>
    1105 Removing a search type
    1106 <$SUBSECTION>
    1107 Changing the order of search types
    1108 <$CONTENTS_FOOTER>
    1109 <$NORMAL>
    1110 <a name="SI">Simple Instructions:</a>
    1111 When you first enter the Search Types view, most of the visible controls will be disabled. The only useful one is a checkbox labelled "Enable Advanced Searches". If you click on this control, advanced searching will be enabled and the other controls will become enabled. However be warned that enabling this control causes this collection to be migrated to Greenstone 2.4 format, which is necessary for fielded searhing to work. This means that the index design will be slightly different (explained in section 7.5 - Search Indexes), there will be more text fragments to translate (see section 7.10 - Translation), and most importantly your final collection will not be usable under older Greenstones. You may later choose to uncheck this field and most of your collection will be migrated back to Greenstone 2.39, however the Librarian Interface cannot convert modern index commands into older one, so you will have to re-enter them manually.
    1112 
    1113 Once your collection is enabled for advanced searches you can add a search type by selecting it from the "Search Types" combobox, then clicking "Add New Search Type". Each type can only appear in the list once.
    1114 
    1115 To remove a search type, select it from the "Currently Assigned Search Types" list, and click "Remove Selected Search Type". The list must always contain one search type.
    1116 
    1117 To change to order of a search type, again select it from the list, and then click one of the movement buttons; "Move Up" or "Move Down".
    1118 <$FOOTER>
    1119 
    1120 <$FILE name=7-5.htm>
    1121 <$HEADER>
    1122 7.3 Search Indexes
    1123 <$DESCRIPTION>
    1124 Indexes specify what areas of the collection will be searchable. This section explains how to add and remove indexes, and how to set a default index.
    1125 
    1126 <$CONTENTS_HEADER>
    1127 <$SECTION>
    1128 <a href="#SI">Simple instructions</a>
    1129 <$SUBSECTION>
    1130 Add an index
    1131 <$SUBSECTION>
    1132 Remove an index
    1133 <$SUBSECTION>
    1134 Set default index
    1135 <$SUBSECTION>
    1136 Clear default index
    1137 <$CONTENTS_FOOTER>
    1138 <$NORMAL>
    1139 <a name="SI">Simple Instructions:</a>
    1140 
    1141 To add an index, first provide a name
    1142 for it by typing into the "Index Name" field. Select what information sources are to be indexed by clicking the checkboxes beside entires in the list of available sources. This list shows
    1143 all the assigned metadata elements, as well the full
    1144 text. Having selected the data sources, choose the granularity of the index, using the "At the level" combobox. Once
    1145 these details are complete, if there is not already an
    1146 index with the same settings, "Add Index" becomes active. Click it to add the new index to the list of assigned
    1147 indexes.
    1148 
    1149 To remove an index, select it from the list of indexes beneath the
    1150 instructions and to the right, and click the "Remove Index"
    1151 button. The selected index will then be removed from the list.
    1152 
    1153 If advanced searching is enabled, then the index controls are slightly different. Each index can only be based on one data source, and there is a new data source "allfields" which is equivilent to entering a comma separated list of all the metadata elements. Furthermore levels are not assigned to a specific index, but instead across all indexes built. Thus indexes and levels are added separately. Removing these indexes is preformed in exactly the same way as above, however there are no longer controls for setting and clearing the default index (as the default index is simply the first index assigned).
    1154 
    1155 The default index is the one used on the collection's search page, as is shown in the "Assigned Indexes" list with the added label "[Default Index]". To
    1156 set it, select the desired index from the list and click "Set Default". Note that if no default index is assigned, the first index will be used.
    1157 
    1158 To reset the default index click "Clear Index".
    1159 <$FOOTER>
    1160 
    1161 <$FILE name=7-6.htm>
    1162 <$HEADER>
    1163 7.6 Partition Indexes
    1164 <$DESCRIPTION>
    1165 We have seen how indexes are built is such a way as to restrict searching to particular data sources. It is possible to further narrow the search space by partitioning each index, either by some predetermined filter or by language. The sections within describe the controls available for altering these partitions. The "Partition Indexes" view is comprised of an instructions text area and a tabbed pane with three tabs; "Define Filters", "Assign Partitions" and "Assign Languages". To learn more about partitions read about subcollections and subindexes in chapter 2, Greenstone Developers Guide.
    1166 <$FOOTER>
    1167 
    1168 
    1169 <$FILE name=7-6-1.htm>
    1170 <$HEADER>
    1171 7.6.1 Define Filters
    1172 <$DESCRIPTION>
    1173 <$CONTENTS_HEADER>
    1174 <$SECTION>
    1175 <a href="#SI">Simple instructions</a>
    1176 <$SUBSECTION>
    1177 Add a filter
    1178 <$SUBSECTION>
    1179 Remove a filter
    1180 <$SUBSECTION>
    1181 Update a filter
    1182 <$CONTENTS_FOOTER>
    1183 <$NORMAL>
    1184 <a name="SI">Simple Instructions:</a>
    1185 
    1186 The filters allows you to group together all documents
    1187 in an index for which a data source, such as a metadata value, matches a given
    1188 pattern. Such a grouping is termed a subcollection.
    1189 
    1190 To add a new filter, first give it a name by typing into the
    1191 "Name the subcollection filter". Next, choose what data source, from any metadata or the name of the file in question, must match in
    1192 order to belong to this filter. Next, enter a regular expression
    1193 that will be used during the matching.  You can toggle between "Including"
    1194 documents that match the filter, or "Excluding" them.  Finally, you
    1195 can specify flags to be set while matching. These may be any of the
    1196 standard PERL regular expression flags, such as "i" for
    1197 case-insensitive matching; alternatively just leave this field
    1198 blank. Once you have filled out these fields, click on "Add" to add the filter to the "Defined Subcollection Filters" list.
    1199 
    1200 To remove a filter, select it from the list and click "Remove".
    1201 
    1202 To edit the contents of a filter, again select it from the list. The details of the selected filter will populate the editing controls. Change whatever values are appropriate then click "Update" to commit the changes.
    1203 <$FOOTER>
    1204 
    1205 <$FILE name=7-6-2.htm>
    1206 <$HEADER>
    1207 7.6.2 Assign Partitions
    1208 <$DESCRIPTION>
    1209 <$CONTENTS_HEADER>
    1210 <$SECTION>
    1211 <a href="#SI">Simple instructions</a>
    1212 <$SUBSECTION>
    1213 Add a partition
    1214 <$SUBSECTION>
    1215 Remove a partition
    1216 <$SUBSECTION>
    1217 Set default partition
    1218 <$SUBSECTION>
    1219 Clear default partition
    1220 <$CONTENTS_FOOTER>
    1221 <$NORMAL>
    1222 <a name="SI">Simple Instructions:</a>
    1223 
    1224 Once you have defined subcollection filters you can build
    1225 indexes for that filter, or for a group of
    1226 filters.
    1227 
    1228 To assign a partition, select the desired filters
    1229 from the "Defined Subcollection Filters" list, using multiple selection methods as necessary, then click "Add Partition".
    1230 
    1231 To remove an existing partition, select it from the "Assigned Subcollection Partitions" list, then click "Remove Partition".
    1232 
    1233 You can make a partition the default one by selecting it from
    1234 the list of assigned partitions, then clicking "Set Default Paritition".
    1235 
    1236 To clear the default partition, click "Clear Default Partition".
    1237 <$FOOTER>
    1238 
    1239 <$FILE name=7-6-3.htm>
    1240 <$HEADER>
    1241 7.6.3 Assign Languages
    1242 <$DESCRIPTION>
    1243 This section details how to generate index search paritions by language, and shows how to modify these partitions using the "Assign Languages" tab of the "Paritition Indexes" view.
    1244 
    1245 <$CONTENTS_HEADER>
    1246 <$SECTION>
    1247 <a href="#SI">Simple instructions</a>
    1248 <$SUBSECTION>
    1249 Language controls
    1250 <$SUBSECTION>
    1251 Add language
    1252 <$SUBSECTION>
    1253 Remove language
    1254 <$SUBSECTION>
    1255 Set default language
    1256 <$SUBSECTION>
    1257 Clear default language
    1258 <$CONTENTS_FOOTER>
    1259 <$NORMAL>
    1260 <a name="SI">Simple Instructions:</a>
    1261 
    1262 To add a new language to partition by, select the desired language from the "Language to add" combobox. Once a language is chosen, click "Add Language".
    1263 
    1264 To remove a language, select it from the "Assigned Languages" list, then click "Remove Language".
    1265 
    1266 The default language is set by selecting it from the list of supported languages, then clicking "Set Default Language".
    1267 
    1268 To unset the default language, click "Clear Default Language".
    1269 <$FOOTER>
    1270 
    1271 <$FILE name=7-7.htm>
    1272 <$HEADER>
    1273 7.7 Cross-Collection Searching
    1274 <$DESCRIPTION>
    1275 If is possible to create searchable super-collections, comprised of several collections joined together. This section explains how to specify such functionality.
    1276 
    1277 <$CONTENTS_HEADER>
    1278 <$SECTION>
    1279 <a href="#SI">Simple instructions</a>
    1280 <$SUBSECTION>
    1281 Selecting a collection
    1282 <$CONTENTS_FOOTER>
    1283 <$NORMAL>
    1284 <a name="SI">Simple Instructions:</a>
    1285 
    1286 The main cross-collection control is a checklist of available collections. The current collection is ticked already, and can't be unselected. To add a collection for cross-collection searching, click on its row in the checklist. Click again to uncheck the collection and remove it from a cross-collection search. If only one collection is selected, then no cross-collection functionality is enabled.
    1287 
    1288 For further details see chapter 1 of the Greenstone Developers Guide.
    1289 <$FOOTER>
    1290 
    1291 <$FILE name=7-8.htm>
    1292 <$HEADER>
    1293 7.8 Browsing Classifiers
    1294 <$DESCRIPTION>
    1295 This section explains the process of assigning browsing classifiers to your collection
    1296 using the Librarian Interface.
    1297 
    1298 <$CONTENTS_HEADER>
    1299 <$SECTION>
    1300 <a href="#SI">Simple instructions</a>
    1301 <$SUBSECTION>
    1302 Classifier selection and configuration
    1303 <$SUBSECTION>
    1304 Add a classifier
    1305 <$SUBSECTION>
    1306 Remove a classifier
    1307 <$SUBSECTION>
    1308 Configure a classifier
    1309 <$SUBSECTION>
    1310 Alter classifier ordering
    1311 <$SECTION>
    1312 <a href="#AI">Advanced instructions</a>
    1313 <$SUBSECTION>
    1314 CustomAZList
    1315 <$CONTENTS_FOOTER>
    1316 <$NORMAL>
    1317 <a name="SI">Simple Instructions:</a>
    1318 
    1319 To add a classifier, choose it from the combobox of known classifiers.
    1320 Click "Add Specified Classifier", configure the classifier
    1321 as desired, and commit the changes. Once this is done the new
    1322 classifier appears in the list of assigned classifiers.
    1323 
    1324 To remove a classifier, select it from the list and click "Remove
    1325 Selected Classifier".
    1326 
    1327 To change the argument configuration of a classifier, select it from
    1328 the "Currently Assigned Classifiers" list and press "Configure Selected Classifier", or double-click on the classifier in the list. Instructions for
    1329 the "Configuring Arguments" dialog are just the same as for plugins (see section 7.2 - Plugins).
    1330 
    1331 The ordering of classifiers is reflected in their order on the collections navigation bar. To change the ordering of a classifier, select it from the list and then click the desired movement button; "Move to Top", "Move Up", "Move Down", or "Move to Bottom".
    1332 
    1333 For further information on classifiers please see chapter 2, Greenstone Developers Guide - Getting the most out of your documents.
    1334 <$NORMAL>
    1335 <a name="AI">Advanced Instructions:</a>
    1336 
    1337 The CustomAZList classifier, included with the Librarian Interface, is an example of a custom classifier. It allows users to build an AZList, and specify what the various letter ranges should be. When you choose to add or configure a CustomAZList, a distinct configuration dialog should appear. Once you select a metadata element, the Librarian Interface will populate the "Ranges" tree with appropriate values. Expand or collapse the tree values as necessary. Select any two values and click "Merge" to specify a range, or select a previously merged value and click "Split" to restore the values contained within. Once you are satisfied with the ranges, click "Ok" to begin processing the documents in your collection. You may instead choose to "Cancel" the dialog without making any changes to your collection.
     1498The CustomAZList classifier is a special classifier that builds an alphabetical
     1499selection list ("AZList") and allows you to specify the letter ranges.  This
     1500classifier has its own configuration dialogue.  When a metadata element is
     1501selected, the "Ranges" tree automatically becomes populated with appropriate
     1502values.  Expand or collapse the tree as desired.  Select any two values and
     1503click "Merge" to specify a range, or select a previously merged value and click
     1504"Split" to restore the values contained within.  When satisfied with the ranges,
     1505click "OK" to begin processing the documents in the collection.  You can
     1506"Cancel" the dialog without making any changes to the collection.
     1507
    13381508<$FOOTER>
    13391509
    … …  
    134215127.9 Format Features
    13431513<$DESCRIPTION>
    1344 Format strings are how you control the structure and appearance of features of your collection, from where buttons appear on the document screen to what links are displayed in the browsable DateList classifier. The process of developing format strings can be quite daunting so familiariy with chapter 2 of the Greenstone Developers Guide is again recommended. This section discusses the format settings, and how the Librarian Interface simplifies and enhances access to this powerful feature of Greenstone.
     1514
     1515Format commands control the structure and appearance of the collection.  They
     1516affect such things as where buttons appear when a document is shown, and what
     1517links are displayed by the DateList classifier.  Format commands are not easy
     1518to develop, and you should read Chapter 2 of the Greenstone Developer's Guide.
     1519This section discusses the format settings, and how the Librarian Interface
     1520gives access to them.  Under "Design Sections", click "Format".
    13451521
    13461522<$CONTENTS_HEADER>
    … …  
    13591535<a name="SI">Simple Instructions:</a>
    13601536
    1361 You may apply a format command to any of the features selected from the "Choose Feature" combobox. As well as a predefined list of features, each of the assigned browsing classifiers is also a feature. The controls available for a selected feature are one of two types. Some features are either enabled or not, and so their controls consist of a checkbox which, if clicked, enable the command. The second type, and more common type of feature, requires a format string to be specified. The controls for this type of feature include: a text area, named "Edit Format String", for entering this string, a combobox ("Affected Component") for selecting what specific part of a feature the string is for (if necessary), and a selection of predefined "Variables". To insert a variable into your format string, ensure the caret is in the right place in the text area, select the variable from the combobox, and click "Insert". Note that you may designate a default format for a particular component by selecting the blank feature. This format will then be applied to all applicable features unless otherwise specified.
    1362 
    1363 More detail about variables and the feature components can be found in chapter 2 of the Greenstone Developers Guide.
    1364 
    1365 To add a new format command, fill out the details as explained above and click "Add Format". The new format command will appear in the list of "Currently Assigned Format Commands". Note that only one format command may be assigned for each feature/component combination.
    1366 
    1367 To update the current selected format with any modifications to its format string click "Update Format".
    1368 
    1369 To remove a format command, select it from the list, then click "Remove Format".
    1370 
    1371 To alter an assigned format command, select it from the assigned
    1372 commands list. The command's details appear in the editing controls;
    1373 change them as desired, then click "Update Format".
     1537You can apply a format command to anything in the "Choose Feature" pull-down
     1538list, which includes each classifier and a predefined list of features.  When
     1539you select a feature, there are two types of control.  Some features are simply
     1540enabled or disabled, and this is controlled by a checkbox.  Others require a
     1541format string to be specified.  For these there is a text area ("Edit Format
     1542String") for entering the string, a pull-down list ("Affected Component") for
     1543selecting which part of the feature the string applies to (if necessary), and a
     1544selection of predefined "Variables".  To insert a variable into the current
     1545position in the format string, select it from the pull-down list and click
     1546"Insert".
     1547
     1548You can specify a default format for a particular component by selecting the
     1549blank feature.  This format is then applied to all applicable features unless
     1550otherwise specified.
     1551
     1552For more information about variables and the feature components, read Chapter 2
     1553of the Greenstone Developer's Guide.
     1554
     1555To add a new format command, fill out the information as explained above and
     1556click "Add Format".  The new format command appears in the list of "Currently
     1557Assigned Format Commands".  Only one format command can be assigned to each
     1558feature/component combination.
     1559
     1560To remove a format command, select it from the list and click "Remove Format".
     1561
     1562To change a format command, select it from the list, modify the settings, and
     1563click "Update Format".
     1564
    13741565<$FOOTER>
    13751566
    … …  
    137815697.10 Translate Text
    13791570<$DESCRIPTION>
    1380 This section describes the translation view, where you can define language specific text fragments for many features within Greenstone.
     1571
     1572This section describes the translation view, where you can define
     1573language-specific text fragments for parts of the collection's interface.
     1574Under "Design Sections", click "Translation".
    13811575
    13821576<$CONTENTS_HEADER>
    … …  
    13921586<$NORMAL>
    13931587<a name="SI">Simple Instructions:</a>
    1394 To add a text fragment translation first choose the desired entry from the "Features" list. Next use the "Language of translation" combobox to select the target language, and the "Translated Text" text area will become enabled. Type the translated text into this field, referring to the content of "Initial Text Fragment" if any existed. Once finished click "Add Translation".
    1395 
    1396 To remove an existing translation, select its associated feature, then select the obsolete translation from the "Assigned Translations" table. Finally click "Remove Translation".
    1397 
    1398 To edit a translation, begin as for removing a translation. Once a translation is selected, and its text has appeared in the now enabled "Translated Text" text area, edit the fragment as necessary. Click "Update Translation" to commit the changes to the translation.
     1588
     1589First choose the an entry from the "Features" list.  The language-specific
     1590strings associated with this feature appear below.  Use the "Language of
     1591translation" pull-down list to select the target language, and type the
     1592translated text into the text area, referring to the "Initial Text Fragment" if
     1593necessary.  Click "Add Translation" when finished.
     1594
     1595To remove an existing translation, select it in the "Assigned Translations"
     1596table and click "Remove Translation".
     1597
     1598To edit a translation, select it, edit it in the "Translated Text" text
     1599area, and click "Update Translation".
     1600
    13991601<$FOOTER>
    14001602
    … …  
    140316057.11 Metadata Sets
    14041606<$DESCRIPTION>
    1405 This section explains the metadata sets sub-view.
     1607This section explains the metadata set review panel.
     1608Under "Design Sections", click "Metadata Sets".
    14061609
    14071610<$CONTENTS_HEADER>
    … …  
    14141617<a name="SI">Simple Instructions:</a>
    14151618
    1416 The metadata sets sub-view is read-only. It is used to review what
    1417 metadata sets have been imported, and what elements are available
    1418 within that set. Choose a set from the list of "Available Metadata Sets" in
    1419 order to see details of the "Elements in selected Metadata Set".
     1619This view is used to review the metadata sets that the collection uses, and the
     1620elements that are available within each set.  Choose from the list of "Available
     1621Metadata Sets" in order to see details of their elements.  This view is
     1622read-only.
     1623
    14201624<$FOOTER>
    14211625
    … …  
    142416288.0 Producing Your Collection
    14251629<$DESCRIPTION>
    1426 You have collected the documents for your collection, annotated them with metadata and designed how your collection will
    1427 appear. You may now produce your collection using Greenstone and this chapter explains how.
     1630
     1631Having collected the documents for the collection, annotated them with
     1632metadata, and designed how the collection will appear, you can now produce the
     1633collection using Greenstone.  This chapter explains how.
     1634
    14281635<$FOOTER>
    14291636
    … …  
    143216398.1 The Create View
    14331640<$DESCRIPTION>
    1434 This section explains the Create view, used to produce the collection.
    1435 
    1436 <$CONTENTS_HEADER>
    1437 <$SECTION>
    1438 <a href="#SI">Simple instructions</a>
    1439 <$SUBSECTION>
    1440 How to view the Create view
    1441 
    1442 The
    1443 Create view is used to create the collection by running the various
    1444 Greenstone collection building scripts on the data you have collected
    1445 and otherwise created. This is generally as straight-forward as
    1446 clicking "Build Collection" at the bottom of the screen.
    1447 However it is possible to customize the build process. This view
    1448 is also used to review details of previous attempts to build this
    1449 collection, successful or otherwise.
    1450 
    1451 Apart from two buttons for building and canceling the building
    1452 process, the bulk of this view is taken up by a group of controls
    1453 titled "Collection Import & Build Options".  This contains a tree located to the left of the group, and a sub-view pane which
    1454 reflects the currently chosen item in the tree. This area will be discussed more in following sections.
    1455 
    1456 Clicking "Build Collection" initiates the collection building process. The time this
    1457 takes depends on the size of your collection and the number of indexes
    1458 being created (for huge collections it can he hours). To cancel the
    1459 building process at any time, click "Cancel Build".
     1641This section explains the Create view used to produce a collection.
     1642
     1643<$CONTENTS_HEADER>
     1644<$SECTION>
     1645<a href="#SI">Simple instructions</a>
     1646<$SUBSECTION>
     1647
     1648The Create view is used to create the collection by running Greenstone
     1649collection-building scripts on the information you have provided.  This is
     1650generally straightforward: just click "Build Collection" at the bottom of the
     1651screen.  However, the building process can be customized.  You can also use this
     1652view is to review details of previous attempts to build this collection,
     1653whether successful or not.
     1654
     1655The buttons for building and cancelling the building process are at the bottom.
     1656Above appears a group of controls titled "Collection Import & Build Options".
     1657To the left is a list of three items, and to the right is a pane that reflects
     1658the currently chosen item in the list, as described in the following sections.
     1659
     1660Clicking "Build Collection" initiates the collection building process.  The time
     1661this takes depends on the size of the collection and the number of indexes
     1662being created (for huge collections it can be hours).  To cancel the process at
     1663any time, click "Cancel Build".
     1664
    14601665<$FOOTER>
    14611666
    … …  
    146416698.2 Import and Build Settings
    14651670<$DESCRIPTION>
    1466 This section explains how to access the various import and
    1467 build settings.
    1468 
    1469 For more information of importing and building please read chapter 1 of the Greenstone Developers Guide - Understanding the collection-building process.
     1671This section explains how to access the various import and build settings.
     1672For more information of importing and building read Chapter 1 of the Greenstone
     1673Developer's Guide -- Understanding the collection-building process.
    14701674
    14711675<$CONTENTS_HEADER>
    … …  
    14881692<a name="SI">Simple Instructions:</a>
    14891693
    1490 The first entry in the Option Groups tree is "Import" settings.
    1491 These settings are specific to the import script.  The second entry is
    1492 "Build" settings, which apply only to the build script.
     1694The first two entries in the list on the left are "Import" and "Build", which
     1695give settings that apply to the import and build scripts respectively.
    14931696
    14941697Controlling the various settings is done in the same way as for the
    1495 "Configuring Arguments" dialog window described under section 7.6 - Plugins.
    1496 There are two previously unseen controls: the Spinner and the
    1497 CheckList.
    1498 
    1499 The spinner is like a text field in that you can type into it and use
    1500 the checkbox to enable it. However, it only accepts numeric values,
    1501 and only within a certain range. The two up and
    1502 down arrows at the far right of the field, reminiscent of the controls
    1503 on a vertical scroll bar, allow you to increment or decrement the
    1504 value in the field.
    1505 
    1506 The CheckList control is the same as that used when selecting what
    1507 metadata sets to include in a new collection. After you have enabled
    1508 it by clicking on the checkbox next to the argument's name, you select
    1509 the active values by checking the checkbox next to them.
     1698"Configuring Arguments" window described under Section 7.3 -- Plug-Ins.  Some
     1699fields require numeric arguments, and you can either type these in or use the
     1700up and down arrows to increase or decrease the current value (in some cases,
     1701the interface restricts the range you can enter).  Others are enabled by
     1702clicking a checkbox (click again to disable).
     1703
    15101704<$FOOTER>
    15111705
    … …  
    15251719<a name="SI">Simple Instructions:</a>
    15261720
    1527 The final entry in the Option Groups tree is "Message Log". This has
    1528 little to do with the import and build arguments, but instead shows the output generated from Greenstone the
    1529 last time the collection was built. You may select the log you wish to view be clicking on the desired date / final state row in the "Log History" list.
     1721The third item on the left is "Message Log".  This shows the output that
     1722Greenstone generated when it built the collection before.  Select the
     1723log you want by clicking on the desired date in the "Log History" list.
     1724
    15301725<$FOOTER>
    15311726
    … …  
    15451740<a name="SI">Simple Instructions:</a>
    15461741
    1547 When you initiate a collection build, the view immediately
    1548 changes. The controls described in the first section of this chapter
    1549 are replaced by two progress bars and a text area. The progress bars
    1550 indicate how much of the import phase, then build phase, are
    1551 complete. Immediately below the
    1552 progress bars is the Message Log explained in the previous
    1553 section. This log shows the messages for this build
    1554 attempt.
     1742When you start to build a collection, the view changes immediately.  The
     1743controls described in the first section of this chapter are replaced by two
     1744progress bars and a text area.  The bars indicate progress through the import
     1745phase, then the build phase.  The text area shows the Message Log mentioned in
     1746the previous section.
    15551747<$FOOTER>
    15561748
    15571749<$FILE name=9-0.htm>
    15581750<$HEADER>
    1559 9.0 Previewing Your Collection
    1560 <$DESCRIPTION>
    1561 This chapter explains how to use the final view, "Preview", to inspect a collection you have produced.
     17519.0 Previewing the Collection
     1752<$DESCRIPTION>
     1753This chapter explains how to use the "Preview" view to inspect the collection you have produced.
    15621754<$FOOTER>
    15631755
    … …  
    156617589.1 The Preview View
    15671759<$DESCRIPTION>
    1568 In this section we look at how to preview our built collection before we publish it.
     1760This section explains how to use the "Preview" view to inspect the collection you have produced.
    15691761
    15701762<$CONTENTS_HEADER>
    … …  
    15771769<a name="SI">Simple Instructions:</a>
    15781770
    1579 After you have successfully built a collection, the final tab on the
    1580 main screen becomes enabled. This tab opens up the preview view so
    1581 that you can inspect the collection. The pane itself is a simplified
    1582 Web browser with initial page, and home page, set to the new
    1583 collection's about page. You can navigate the collection using standard hyperlink
    1584 clicks.
     1771Once you have built a collection the "Preview" tab on the main screen becomes
     1772enabled.  This allows you to inspect the new collection.  It shows a simplified
     1773Web browser with initial page (and home page) set to the new collection's "About" page.  You can navigate the collection using standard hyperlink clicks.
    15851774<$FOOTER>
    15861775
    … …  
    1589177810.0 Miscellaneous
    15901779<$DESCRIPTION>
    1591 This chapter describes features of the Librarian Interface which are not associated
     1780This chapter describes features of the Librarian Interface that are not associated
    15921781with any particular view.
    15931782<$FOOTER>
    … …  
    16121801<a name="SI">Simple Instructions:</a>
    16131802
    1614 There are two "General" options. If "View Extracted Metadata" is selected, then extracted metadata will be shown in the various controls dealing with metadata, while selecting "Hide Extracted Metadata" will hide it (although it will still be available during collection design, and within the finished Greenstone collection). The second option is a combobox control showing the various language dictionaries detected in the classes folder of your Librarian Interface install. To change the dictionary choose a new one from the list, then restart the application in order for the new dictionary strings to be loaded.
    1615 
    1616 The Librarian Interface has the ability to model different workflows, or progressions through the various view tabs. Use the "Workflow" tab of the preferences pane to customise what views are available. Check the box next to the view you wish to be available, otherwise leave it unchecked to cause that view to be disabled. You can use the combobox at the bottom of this page to select predetermined configurations of settings. Once you are done, closing the preferences dialog will establish these workflow settings. Note that these settings are stored with the collection, and not in the Librarian Interface configuration file. In fact the workflow settings in the configuration file are used to hide the view tabs in the Librarian Interface, rather than just disable them (useful for Librarian Interface administrators).
    1617 
    1618 The "Connection" tab contains a control where you can supply or edit the path to your locally running Greenstone library server. This tab is also used  to set the proxy information if you wish to connect to the internet, such as when Browsing or Mirroring your files (see 3.0 and 4.0 for details), but you must connect via a proxy. Check the box to enable proxy connection then fill in the details of the proxy host address and port number. When you close the preferences dialog the proxy connection will be established.
    1619 
    1620 During the course of a session you may be provided with one or more warning dialogs. These dialogs inform you of possibly unforeseen consequences of an action. If you wish you may choose to disable these dialogs by checking the "Do not show this warning again" box. However if you later decide to re-enable a warning message then the third tab of the preferences dialog, "Warnings", will allow you to do this. Simply check the box next to the warning message you wish to show again, selected from the list of dialogs.
     1803There are two "General" options.  If "View Extracted Metadata" is selected, the
     1804various controls dealing with metadata always show all metadata that has been
     1805extracted automatically from documents.  "Hide Extracted Metadata" hides it
     1806(although it is still available during collection design, and within the
     1807final Greenstone collection).
     1808
     1809The second "General" option is a pull-down list of the various languages that
     1810the Librarian Interface can be presented in.  These correspond to the
     1811dictionaries located in the "classes" folder of the Librarian Interface's
     1812directory.  If you change the dictionary by choosing one from the list, you must
     1813restart the Librarian Interface in order to load the new language strings from
     1814the dictionary.
     1815
     1816The Librarian Interface can support different workflows by determining which of
     1817the various view tabs are visible.  Use the "Workflow" tab to customise what
     1818views are available by checking the boxes next to the views that you want to be
     1819available.  Alternatively, use the pull-down list at the bottom to select
     1820predetermined configurations.  Closing the preferences dialog establishes these
     1821workflow settings.  These settings are stored with the collection, not in the
     1822Librarian Interface configuration file.
     1823
     1824The "Connection" tab lets you alter the path to the locally-running Greenstone
     1825library server, which is used when Previewing collections.  It also lets you set
     1826proxy information for connecting to the Internet (e.g.  when Browsing or
     1827Mirroring your files; see 3.0 and 4.0 for details).  Check the box to enable
     1828proxy connection and supply details of the proxy host address and port number.
     1829The proxy connection is established when you close the Preferences dialog.
     1830
     1831During the course of a session the Librarian Interface may give warning
     1832messages which inform you of possibly unforeseen consequences of an action.  You
     1833can disable the messages by checking the "Do not show this warning again" box.
     1834You can re-enable warning messages using the "Warnings" tab.  Check the box
     1835next to warning messages you want to see again.
    16211836
    16221837<$FOOTER>
    … …  
    1626184110.2 File Associations
    16271842<$DESCRIPTION>
    1628 A file association is used by the Librarian Interface to decide what application should be used to open a particular file. This section explains how to assign and edit file associations.
     1843The Librarian Interface uses particular application programs to open particular
     1844file types.  This section explains how to assign and edit these file
     1845associations.
    16291846<$CONTENTS_HEADER>
    16301847<$SECTION>
    … …  
    16391856<$NORMAL>
    16401857<a name="SI">Simple Instructions:</a>
    1641 The "Edit File Associations" dialog is accessed by opening the "File" menu and clicking "File Associations...". The dialog itself consists of an instructions text area, a combobox containing known file endings or extensions, a text field for entering file launching commands, a "Browse" button for locating applications on your component, and four buttons; "Add", "Update", "Remove" and "Cancel", the last of which hides the dialog.
    1642 
    1643 To add an association, select the target file extension from the combobox, or type in a new extension if necessary (do not include the "."). Next either type the launch command in the appropriate field, or choose the desired application from the "Browse" dialog. "%1" can be used in the launch command to insert the name of the file being opened. Once these are filled out "Add" becomes enabled and can be clicked to add the association.
    1644 
    1645 To edit an association select an existing file extension. If a launch command exists it will be shown in the launch command field. Edit this then click "Update".
    1646 
    1647 To remove an association select an existing file extension. Clicking "Remove" will cause any existing launch command for that file to be removed. The file extension, however, is retained in the "For Files Ending" combobox.
    1648 
    1649 File associations are stored in a file "assocations.xml" in your Librarian Interface installation folder.
     1858
     1859To alter file associations open the "File" menu and click "File
     1860Associations...".
     1861
     1862To add an association, select the target file extension from the pull-down
     1863list, or type in a new extension (do not include the ".").  Next either type
     1864command that launches the desired application in the appropriate field, or
     1865choose the application from the "Browse" dialog.  "%1" can be used in the launch
     1866command to insert the name of the file being opened.  Once these are filled out,
     1867"Add" is enabled and can be clicked to add the association.
     1868
     1869To edit an association, select an existing file extension.  Any existing
     1870associated command is shown in the launch command field.  Edit it, and then
     1871click "Update".
     1872
     1873To remove an association, select an existing file extension and click "Remove".
     1874(The file extension remains in the "For Files Ending" pull-down list.)
     1875
     1876File associations are stored in the Librarian Interface's folder, in a file
     1877called "associations.xml".
     1878
    16501879<$FOOTER>
    16511880
    … …  
    1654188311.0 Metadata Set and Profile Editing
    16551884<$DESCRIPTION>
    1656 This chapter explains how to edit the various metadata sets used by the Librarian Interface, and is pertinent to anyone who wishes to remove a value from the previous values tree. While it is simple to remove a certain metadata value from a record or records, the value itself still appears in the the value tree. To remove previously assigned values, or indeed any part of the metadata set including its elements, use the metadata set editor, available under the "Metadata Set" menu.
    1657 
    1658 This tool is also used to alter the import profiles, the instructions used to map metadata from files imported into the collection onto existing metadata sets.
     1885
     1886This chapter explains how to edit metadata sets used by the Librarian
     1887Interface.  This is the only way to remove a value from the "Previous Values"
     1888tree.  Although you can use the Librarian Interface to remove a certain value
     1889from a record, the value remains in the value tree.  To remove it (or any
     1890part of the metadata set, including its elements), use the metadata set editor.
     1891
     1892The same tool is used to alter the instructions that map metadata from files
     1893imported into the collection to existing metadata sets.  These are called
     1894"importing profiles".
     1895
     1896To edit a metadata set or importing profile, choose "Metadata Sets" from the menu
     1897bar and select the "Edit Set" action.
    16591898
    16601899<$FILE name=11-1.htm>
    … …  
    1662190111.1 Editing Metadata Sets
    16631902<$DESCRIPTION>
    1664 This section describes the various parts of metadata set and profile editing.
     1903This section describes how to edit metadata sets and previously assigned values.
    16651904<$CONTENTS_HEADER>
    16661905<$SECTION>
    … …  
    16701909<$SUBSECTION>
    16711910Editing elements
     1911<$CONTENTS_FOOTER>
     1912<$NORMAL>
     1913<a name="SI">Simple Instructions:</a>
     1914
     1915On the left of the "Edit Metadata Sets" dialog is a list showing what metadata
     1916sets and profiles can be edited.  Click one of these and its details will
     1917appear on the right in one or more tables.  Beneath are buttons for adding,
     1918editing or removing the various parts; alongside them is the "Close" button.
     1919Many buttons are greyed out initially, and are activated by selections in the
     1920tables.  Now we describe how to edit sets, elements and profiles.
     1921
     1922To define a new metadata set, beside "Set" click "Add", fill out the
     1923information requested, and click "OK".  "Namespace" is a short identifer for
     1924the new set (e.g.  "dc" for Dublin Core; "dls" for the Development Library
     1925Subset).
     1926
     1927To remove a metadata set, select it in the list on the left and click "Remove".
     1928A confirmation prompt will appear; confirming it <strong>permanently</strong>
     1929removes the set and all associated metadata.
     1930
     1931Some information is associated with each metadata set, such as its creator and
     1932creation date.  We call these "attributes" of the metadata set, and you can
     1933alter them.
     1934Beside "Attribute", click "Add" to add an attribute to the selected metadata
     1935set, fill in the requested information -- name, language and values -- and
     1936click "OK".  Each metadata set is considered unique, so for a new metadata set
     1937the pull-down list for the name and value are initially empty.  Beside
     1938"Attribute", "Edit" becomes active when an attribute is selected in the table
     1939and leads to the same dialog as "Add" (except that the current value is already
     1940filled out).  Beside "Attribute", "Remove" becomes active when the attribute is
     1941selected; when clicked the attribute is removed.
     1942
     1943For metadata elements you can add an element, remove it, and remove values from
     1944it.  To add an element, beside "Element" click "Add" and specify the new
     1945element's name.
     1946
     1947To remove a metadata element, select it and beside "Element" click "Remove".
     1948This <strong>permanently</strong> removes the element and all metadata
     1949associated with it.
     1950
     1951Just as information is associated with each metadata set, information can also
     1952be associated with each metadata element -- metadata about metadata!  Again we
     1953call these "attributes"; Examples are a language-specific name for the element,
     1954its definition, or perhaps a general comment.
     1955
     1956You edit the attributes of an element in the same way that you edit the
     1957attributes of a metadata set, explained above.  In this case the pull-down
     1958lists in the add and edit prompts may contain values from the same attribute of
     1959other elements within the set.  Also, you can alter the "value tree", which
     1960contains all the values that have been assigned to a particular element.  You
     1961can "Add" a value whenever an element is selected.  Choose the parent subject
     1962(if any), enter the value and optionally the alias, and click "OK" to put the
     1963new value in the tree.  You can "Edit" a value that you have selected in the
     1964value tree; click "OK" to commit the changes.  Note that changing the parent
     1965subject will cause the value to be moved to that subject.  You can "Remove" a
     1966value that you have selected in the tree -- but note that this does
     1967<strong>not</strong> remove all metadata referring to this value, and if the
     1968value is still in use it will be restored the next time you save.
     1969
     1970Once you have finished changing the metadata set, click "Close".
     1971<$FOOTER>
     1972
     1973<$FILE name=11-2.htm>
     1974<$HEADER>
     197511.2 Editing Metadata Import Profiles
     1976<$DESCRIPTION>
     1977This section describes how to edit metadata importing profiles.
     1978<$CONTENTS_HEADER>
     1979<$SECTION>
     1980<a href="#SI">Simple instructions</a>
    16721981<$SUBSECTION>
    16731982Editing profiles
    … …  
    16761985<a name="SI">Simple Instructions:</a>
    16771986
    1678 The "Edit Metadata Sets" dialog is split into three areas. The left consists of a tree containing all of the various parts of the metadata sets or profiles which can be edited. The right shows the details of the currently selected part of the tree, in one or more tables. The bottom is comprised of an array of buttons for adding, editing or removing the various parts, while along-side them is the button to close this prompt. Many of the buttons are grayed out initially, but will change depending on your selections in the tree and tables. Now we look at the slightly differing tasks of editing sets, elements and profiles.
    1679 
    1680 Click "Add" set and you will be presented with another prompt for details about the new set. The namespace is a short but unique indentifer for your new set (for the namespace for the Development Library Subset is "dls", while the Dublin Core is "dc"). Clicking "Ok" in this prompt will create the new set, while "Cancel" will dispose of the dialog without altering your collection. Removing a set can only be done when a set is selected from the tree. A click on "Remove" set causes a confirmation prompt to appear, and confirming it will <strong>permanently</strong> remove the set, and all metadata associated with it. You can also edit the attributes of a set, a process which can be repeated in several places throughout the metadata set editor. "Add" attribute becomes active as soon as a set is selected, and clicking it will provide a dialog for gathering attribute details such as name, language and value. The combobox for the name and value will be empty as each set is considered unique. Pressing "Ok" here will add the new attribute, while "Cancel" removes the prompt without altering your collection. "Edit" attribute becomes active when a certain attribute from the table is selected. The edit prompt is similar to the add one, except the previous value will be filled out. Edit as necessary and click "Ok" to update. "Remove" also becomes active, and if clicked and the subsequent confirmation made, the selected attribute is removed.
    1681 
    1682 For metadata elements there are three editing tasks you can undertake. Adding a element can be done whenever a set is selected, and is accomplished by clicking "Add" element. A prompt will appear asking for the elements name, and once filled out and submitted with the "Ok" button, a new element will be created in the selected set. To <strong>permanently</strong> remove an element, select it from the tree, click "Remove" element, and accept the confirmation dialog. Note that removing an element will remove all metadata associated with that element. You may also edit the attributes of an element, as explained above. The biggest difference is that the comboboxes in the add and edit prompts may contain values from the same attribute of other elements within the set. A feature specific to element editing is the ability to alter the value tree. The value tree contains all the past values assigned for the element selected. You can "Add" a value whenever an element is selected. Choose the parent subject (if any), enter the value and optionally the alias. Finally click "Ok" to create the node. Editing values is similar, however you must first select an entry from the value tree. Note that changing the parent subject will cause the value to be moved to that subject. Press "Ok" to commit the changes, "Cancel" otherwise. If a value in the tree is selected "Remove" value will become active, which if clicked and the confirmation made, removes the value from the tree. This <strong>does not</strong> remove all metadata referring to this value. If it is still in use this value will be restored next time you save.
    1683 
    1684 If you expand the "Importing Profiles" folder you will be presented with the source locations that have importing profiles associated with them. Not all files you include in your collection will have previous metadata, and not all those that do will require special instructions to map onto existing metadata (especially if they are built from the same metadata set). Once the "Importing Profiles" folder is selected you may "Add" file sources. The prompt displayed requires you to fill in a file name before pressing "Ok" to add the file source. If you select a file you can choose to remove it in the same fashion mentioned above. Once a file is selected, its attribute table appears. In this case the attributes are actually the mappings from the name of an element from the source file location to the name of an element within the collection. To add a new mapping, select a source file, then click "Add" attribute. The standard add/edit attribute dialog will appear, except the language field will be disabled and the values combobox will contain all of the elements currently available in the collection. "Ok" will add the new profile, otherwise "Cancel". Editing a mapping is exactly as above, as is removal.
    1685 
    1686 Once you are happy with the changes click "Close" to close the dialog.
    1687 <$FOOTER>
    1688 
     1987Double-click the "Importing Profiles" item to see a list of importing profiles
     1988for importing from other collections into this one.  Each profile is named
     1989after the collection to which it applies -- that is, the collection that
     1990documents are coming from.  You can add a profile by clicking "Add" beside
     1991"File" and specifying the name of the collection that it should apply to.  You
     1992can remove a profile by selecting it and click "Remove" beside "File".
     1993
     1994When a profile is selected, its mapping table appears.  Each line gives a
     1995correspondence between a metadata element in the collection that the metadata
     1996comes from, and a metadata element in the collection being constructed.  You
     1997can edit this table.  To add a new mapping, select a source profile, then click
     1998"Add" beside "Attribute".  The standard attribute dialog box appears, except
     1999that the language field is disabled and the "Values" pull-down list contains
     2000all the elements currently available in the collection.  Mappings can be edited
     2001and removed as described above.
     2002
     2003Once you have finished changing the metadata importing profile, click
     2004"Close".
     2005<$FOOTER>
Note: See TracChangeset for help on using the changeset viewer.