Changeset 5410 for trunk/gli/help


Ignore:
Timestamp:
2003-09-02T11:19:15+12:00 (21 years ago)
Author:
mdewsnip
Message:

Many improvements to XML structure. More to come.

File:
1 edited

Legend:

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

    r5405 r5410  
    11<Document>
    2   <Section>
    3     <Section name="1-0">
    4       <Title>1.0 Introduction</Title>
     2  <Section name="1">
     3    <Title>1.0 Introduction</Title>
    54The Greenstone Librarian Interface is a tool for collecting and marking up documents, then building digital library collections.  It provides access to the Greenstone Digital Library Software's functionality from a graphical point and click interface. <Reference target="1-2">Hello</Reference>
    6     </Section>
    75    <Section name="1-1">
    86      <Title>1.1 Of Mice and Menus</Title>
     
    5553Exit the Librarian Interface program by choosing "Exit" from the "File"
    5654menu.  Your collection will be saved first.
    57 
    5855       <Anchor name="advanced">Advanced Instructions:</Anchor>
    5956To access a menu, hold down [ALT] and press the corresponding letter
     
    9087    </Section>
    9188  </Section>
    92   <Section>
    93     <Section name="2-0">
    94       <Title>2.0 Starting Off</Title>
     89
     90  <Section name="2">
     91    <Title>2.0 Starting Off</Title>
    9592This section covers how to create, save and load a collection.
    96     </Section>
    9793    <Section name="2-1">
    9894      <Title>2.1 Creating a New Collection</Title>
     
    160156<Break/>
    161157Clicking "Cancel" returns you to the main screen immediately.
    162 
    163158      <Anchor name="advanced">Advanced Instructions:</Anchor>
    164159Buttons, like menus, have one character underlined.  To "click" the button,
     
    187182The Librarian Interface protects your work by saving it whenever you exit the
    188183program or load another collection.
    189 
    190184      <Anchor name="advanced">Advanced Instructions:</Anchor>
    191185Saved collections are written to a file named for the collection and with file
     
    215209collection that resides outside Greenstone's "collect" folder, click "Browse"
    216210for a file system browsing dialog.
    217 
    218211      <Anchor name="advanced">Advanced Instructions:</Anchor>
    219212In case more than one Greenstone Librarian Interface program is running
     
    229222    </Section>
    230223  </Section>
    231   <Section>
    232     <Section name="3-0">
    233       <Title>3.0 Hunting For Your Files</Title>
     224
     225  <Section name="3">
     226    <Title>3.0 Hunting For Your Files</Title>
    234227The Librarian Interface can run in different configurations.  This section only
    235228applies when the "hunt" and/or "mirror" views are enabled.  If these tabs do
     
    242235section describes the first, Hunting, where you browse the Internet for files
    243236of interest. The next section describes the second stage, Mirroring, where these files can be downloaded.
    244     </Section>
    245237    <Section name="3-1">
    246238      <Title>3.1 The Hunt view</Title>
     
    267259    </Section>
    268260  </Section>
    269   <Section>
    270     <Section name="4-0">
    271       <Title>4.0 Downloading Chosen Files</Title>
     261
     262  <Section name="4">
     263    <Title>4.0 Downloading Chosen Files</Title>
    272264To enable web mirroring see Section 3.0 -- Hunting For Your Files.
    273265To download web pages you need to install the mirroring tool wget (version v1.8
     
    278270files you need.  This section explains the Librarian Interface's mirroring
    279271process.
    280     </Section>
    281272    <Section name="4-1">
    282273      <Title>4.1 The Mirror view</Title>
     
    331322current download task from the list.  Download tasks are removed from the list
    332323when they finish successfully (ones that fail are controlled by the "Automatically remove failed downloads..." checkbox).
    333 
    334324      <Anchor name="advanced">Advanced Instructions:</Anchor>
    335325Section 10.1 -- Preferences describes how to establish an Internet connection
     
    339329    </Section>
    340330  </Section>
    341   <Section>
    342     <Section name="5-0">
    343       <Title>5.0 Collecting Files for Your Collection</Title>
     331
     332  <Section name="5">
     333    <Title>5.0 Collecting Files for Your Collection</Title>
    344334Once you have a new collection you need to get some files into it.  These may
    345335come from your ordinary file space, or from other Greenstone collections.  Some
    346336may already have attached metadata.  This section describes how to import files.
    347     </Section>
    348337    <Section name="5-1">
    349338      <Title>5.1 The Gather View</Title>
     
    408397of a folder, creates new folders (see Section 5.2 -- Creating folders).
    409398"Delete", with a garbage can, removes files. Clicking the Delete button will remove any selected files from the Collection file tree. Alternatively, files can be deleted by dragging them onto the Delete button.
    410 
    411399       <Anchor name="advanced">Advanced Instructions:</Anchor>
    412400To select several sequential items, select the first and then hold down [Shift]
     
    481469Only the "highest" items in a selection are moved.  A folder is higher than its
    482470children.  You cannot select files within a folder and also the folder itself.
    483 
    484471      <Anchor name="advanced">Advanced Instructions:</Anchor>
    485472When you add a file, the Librarian Interface searches through the source
     
    539526operations do not alter the collection, nor do they affect the folders in the
    540527tree.
    541 
    542528      <Anchor name="advanced">Advanced Instructions:</Anchor>
    543529You can specify a custom filter by typing in a pattern to match files against.
     
    546532    </Section>
    547533  </Section>
    548   <Section>
    549     <Section name="6-0">
    550       <Title>6.0 Enriching the Collection with Metadata</Title>
     534
     535  <Section name="6">
     536    <Title>6.0 Enriching the Collection with Metadata</Title>
    551537Having gathered several files into the collection, now enrich them with
    552538additional information called "metadata".  This section explains how metadata is
     
    554540sources (also see Chapter 2 of the Greenstone Developer's Guide -- Getting the most
    555541out of your documents).
    556     </Section>
    557542    <Section name="6-1">
    558543      <Title>6.1 The Enrich View</Title>
     
    655640all values associated with the elements in the set, just those values that make
    656641up the structure of hierarchy-based metadata, or no values at all.
    657 
    658642      <Anchor name="advanced">Advanced Instructions:</Anchor>
    659643To install a newer version of a metadata set, simply add it as above.  The
     
    743727If you choose metadata that occurs in some of the selected files and click
    744728"Append", it is added to the other files in the selection too.
    745 
    746729      <Anchor name="advanced">Advanced Instructions:</Anchor>
    747730You can add structure to metadata values by using paths as described in Section
     
    867850<Break/>
    868851Click "Close" to hide the window.
    869 
    870852      <Anchor name="advanced">Advanced Instructions:</Anchor>
    871853You can also view the "All Metadata" table by selecting the files you wish to
     
    938920    </Section>
    939921  </Section>
    940   <Section>
    941     <Section name="7-0">
    942       <Title>7.0 Designing Your Collection's Appearance</Title>
     922
     923  <Section name="7">
     924    <Title>7.0 Designing Your Collection's Appearance</Title>
    943925Once your files are marked up with metadata, you next decide how it should
    944926appear to users as a Greenstone collection.  What kind of information is
     
    946928languages are supported?  Where do the buttons appear on the page?  These
    947929things can be customized; this section describes how to do it.
    948     </Section>
    949930    <Section name="7-1">
    950931      <Title>7.1 The Design View</Title>
     
    10611042separator line).  To change the ordering of the other ones, select the plugin you want to move
    10621043and click "Move To Top", "Move Up", "Move Down", or "Move To Bottom".
    1063 
    10641044       <Anchor name="advanced">Advanced Instructions:</Anchor>
    10651045The Librarian Interface does its best to determine what arguments a plugin
     
    11631143Partitions" and "Assign Languages".  To learn more about partitions read about
    11641144subcollections and subindexes in Chapter 2 of the Greenstone Developer's Guide.
    1165     </Section>
    1166     <Section name="7-6-1">
    1167       <Title>7.6.1 Define Filters</Title>
     1145
     1146      <Section name="7-6-1">
     1147        <Title>7.6.1 Define Filters</Title>
    11681148The section explains how to define a partition filter.
    1169       <Contents>
    1170         <ContentsGroup linkto="simple">
    1171           <ContentsItem>
    1172             Add a filter
    1173           </ContentsItem>
    1174           <ContentsItem>
    1175             Remove a filter
    1176           </ContentsItem>
    1177           <ContentsItem>
    1178             Update a filter
    1179           </ContentsItem>
    1180         </ContentsGroup>
    1181       </Contents>
    1182       <Anchor name="simple">Simple Instructions:</Anchor>
     1149        <Contents>
     1150          <ContentsGroup linkto="simple">
     1151            <ContentsItem>
     1152              Add a filter
     1153            </ContentsItem>
     1154            <ContentsItem>
     1155              Remove a filter
     1156            </ContentsItem>
     1157            <ContentsItem>
     1158              Update a filter
     1159            </ContentsItem>
     1160          </ContentsGroup>
     1161        </Contents>
     1162        <Anchor name="simple">Simple Instructions:</Anchor>
    11831163Filters allows you to group together into a subcollection all documents in an
    11841164index for which a metadata value matches a given pattern.
     
    11981178To alter a filter, select it from the list, change any of the values that
    11991179appear in the editing controls and click "Replace Filter" to commit the changes.
    1200     </Section>
    1201     <Section name="7-6-2">
    1202       <Title>7.6.2 Assign Partitions</Title>
     1180      </Section>
     1181      <Section name="7-6-2">
     1182        <Title>7.6.2 Assign Partitions</Title>
    12031183This section explains how to assign a previous defined partition filter.
    1204       <Contents>
    1205         <ContentsGroup linkto="simple">
    1206           <ContentsItem>
    1207             Add a partition
    1208           </ContentsItem>
    1209           <ContentsItem>
    1210             Remove a partition
    1211           </ContentsItem>
    1212           <ContentsItem>
    1213             Set default partition
    1214           </ContentsItem>
    1215           <ContentsItem>
    1216             Clear default partition
    1217           </ContentsItem>
    1218         </ContentsGroup>
    1219       </Contents>
    1220       <Anchor name="simple">Simple Instructions:</Anchor>
     1184        <Contents>
     1185          <ContentsGroup linkto="simple">
     1186            <ContentsItem>
     1187              Add a partition
     1188            </ContentsItem>
     1189            <ContentsItem>
     1190              Remove a partition
     1191            </ContentsItem>
     1192            <ContentsItem>
     1193              Set default partition
     1194            </ContentsItem>
     1195            <ContentsItem>
     1196              Clear default partition
     1197            </ContentsItem>
     1198          </ContentsGroup>
     1199        </Contents>
     1200        <Anchor name="simple">Simple Instructions:</Anchor>
    12211201Having defined a subcollection filter, use the "Assign Partitions" tab to build
    12221202indexes for it (or for a group of filters).  Select the desired filter (or
     
    12291209<Break/>
    12301210To clear the default partition, click "Clear Default".
    1231     </Section>
    1232     <Section name="7-6-3">
    1233       <Title>7.6.3 Assign Languages</Title>
     1211      </Section>
     1212      <Section name="7-6-3">
     1213        <Title>7.6.3 Assign Languages</Title>
    12341214This section details how to restrict search indexes to particular languages.
    12351215You do this by generating a partition using the "Assign Languages" tab of the
    12361216"Partition Indexes" view.
    1237       <Contents>
    1238         <ContentsGroup linkto="simple">
    1239           <ContentsItem>
    1240             Language controls
    1241           </ContentsItem>
    1242           <ContentsItem>
    1243             Add language
    1244           </ContentsItem>
    1245           <ContentsItem>
    1246             Remove language
    1247           </ContentsItem>
    1248           <ContentsItem>
    1249             Set default language
    1250           </ContentsItem>
    1251           <ContentsItem>
    1252             Clear default language
    1253           </ContentsItem>
    1254         </ContentsGroup>
    1255       </Contents>
    1256       <Anchor name="simple">Simple Instructions:</Anchor>
     1217        <Contents>
     1218          <ContentsGroup linkto="simple">
     1219            <ContentsItem>
     1220              Language controls
     1221            </ContentsItem>
     1222            <ContentsItem>
     1223              Add language
     1224            </ContentsItem>
     1225            <ContentsItem>
     1226              Remove language
     1227            </ContentsItem>
     1228            <ContentsItem>
     1229              Set default language
     1230            </ContentsItem>
     1231            <ContentsItem>
     1232              Clear default language
     1233            </ContentsItem>
     1234          </ContentsGroup>
     1235        </Contents>
     1236        <Anchor name="simple">Simple Instructions:</Anchor>
    12571237To add a new language to partition by, use the "Assign Languages" tab to build
    12581238an index for it.  Select the desired language from the "Language to add"
     
    12651245<Break/>
    12661246To clear the default language, click "Clear Default".
     1247      </Section>
    12671248    </Section>
    12681249    <Section name="7-7">
     
    13361317For further information on classifiers read Chapter 2, Greenstone
    13371318Developer's Guide -- Getting the most out of your documents.
    1338 
    13391319      <Anchor name="advanced">Advanced Instructions:</Anchor>
    13401320The CustomAZList classifier is a special classifier that builds an alphabetical
     
    14051385For more information about variables and the feature components, read Chapter 2
    14061386of the Greenstone Developer's Guide.
    1407 
    14081387      <Anchor name="advanced">Advanced Instructions:</Anchor>
    14091388If the "Allow Extended Options" checkbox is ticked, some advanced formatting options are enabled. The list of features that can be formatted is changed slightly, and more variables are available to be used in the format command, providing greater control over the page layout.
     
    14581437    </Section>
    14591438  </Section>
    1460   <Section>
    1461     <Section name="8-0">
    1462       <Title>8.0 Producing Your Collection</Title>
     1439
     1440  <Section name="8">
     1441    <Title>8.0 Producing Your Collection</Title>
    14631442Having collected the documents for the collection, annotated them with
    14641443metadata, and designed how the collection will appear, you can now produce the
    14651444collection using Greenstone.  This section explains how.
    1466     </Section>
    14671445    <Section name="8-1">
    14681446      <Title>8.1 The Create View</Title>
     
    14741452    </ContentsGroup>
    14751453      </Contents>
    1476            
    14771454The Create view is used to create the collection by running Greenstone
    14781455collection-building scripts on the information you have provided.  This is
     
    15541531    </Section>
    15551532  </Section>
    1556   <Section>
    1557     <Section name="9-0">
    1558       <Title>9.0 Previewing the Collection</Title>
     1533
     1534  <Section name="9">
     1535    <Title>9.0 Previewing the Collection</Title>
    15591536This section explains how to use the "Preview" view to inspect the collection you have produced.
    1560     </Section>
    15611537    <Section name="9-1">
    15621538      <Title>9.1 The Preview View</Title>
     
    15751551    </Section>
    15761552  </Section>
    1577   <Section>
    1578     <Section name="10-0">
    1579       <Title>10.0 Miscellaneous</Title>
     1553
     1554  <Section name="10">
     1555    <Title>10.0 Miscellaneous</Title>
    15801556This section describes features of the Librarian Interface that are not associated
    15811557with any particular view.
    1582     </Section>
    15831558    <Section name="10-1">
    15841559      <Title>10.1 Preferences</Title>
     
    16741649    </Section>
    16751650  </Section>
    1676   <Section>
    1677     <Section name="11-0">
    1678       <Title>11.0 Metadata Set and Profile Editing</Title>
     1651
     1652  <Section name="11">
     1653    <Title>11.0 Metadata Set and Profile Editing</Title>
    16791654This section explains how to edit metadata sets used by the Librarian
    16801655Interface.  This is the only way to remove a value from the "Previous Values"
     
    16891664To edit a metadata set or importing profile, choose "Metadata Sets" from the menu
    16901665bar and select the "Edit Set" action.
    1691     </Section>
    16921666    <Section name="11-1">
    16931667      <Title>11.1 Editing Metadata Sets</Title>
Note: See TracChangeset for help on using the changeset viewer.