Changeset 5413
- Timestamp:
- 2003-09-02T12:36:01+12:00 (21 years ago)
- File:
-
- 1 edited
-
trunk/gli/help/in.xml (modified) (58 diffs)
Legend:
- Unmodified
- Added
- Removed
-
trunk/gli/help/in.xml
r5410 r5413 1 1 <Document> 2 <Section name=" 1">2 <Section name="introduction"> 3 3 <Title>1.0 Introduction</Title> 4 The 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>5 <Section name=" 1-1">4 The 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. 5 <Section name="ofmiceandmenus"> 6 6 <Title>1.1 Of Mice and Menus</Title> 7 7 This section provides basic information about interacting with the Librarian Interface. 8 8 If you are familiar with programs such as Internet Explorer or Microsoft 9 Office and are comfortable with mouse clicks and menus, skip to the next 10 section. 9 Office and are comfortable with mouse clicks and menus, skip to the <Reference target="howtoavoidthisdocument">next section</Reference>. 11 10 <Contents> 12 11 <ContentsGroup linkto="simple"> … … 59 58 press [S] to "Save" a collection. 60 59 </Section> 61 <Section name=" 1-2">60 <Section name="howtoavoidthisdocument"> 62 61 <Title>1.2 How to Avoid Reading This Document</Title> 63 62 Don't read this help text all the way through! Just read enough to learn … … 88 87 </Section> 89 88 90 <Section name=" 2">89 <Section name="startingoff"> 91 90 <Title>2.0 Starting Off</Title> 92 91 This section covers how to create, save and load a collection. 93 <Section name=" 2-1">92 <Section name="creatingacollection"> 94 93 <Title>2.1 Creating a New Collection</Title> 95 94 This section describes how to create a new collection. … … 142 141 should describe, in as much detail as possible, what the collection is about. 143 142 Use the [Enter] key to break it into paragraphs. 144 <Break/>145 Now choose whether to view or hide the metadata that Greenstone extracts146 automatically from documents. (This option can be changed later -- see Section147 10.1 -- Preferences.)148 143 <Break/> 149 144 Finally you must specify whether the new collection will have the same … … 160 155 press [ALT] and the underlined character at the same time. 161 156 </Section> 162 <Section name=" 2-2">157 <Section name="savingacollection"> 163 158 <Title>2.2 Saving the Collection</Title> 164 159 This section describes how to save a collection, and the Save Collection Prompt. … … 178 173 Save your work regularly by opening the "File" menu and choosing "Save". 179 174 Saving a collection is not the same as making it ready for use in Greenstone 180 (see Section 8 -- Producing Your Collection).175 (see <Reference target="producingthecollection">Producing Your Collection</Reference>). 181 176 <Break/> 182 177 The Librarian Interface protects your work by saving it whenever you exit the … … 187 182 installation's "collect" folder. 188 183 </Section> 189 <Section name=" 2-3">184 <Section name="openingacollection"> 190 185 <Title>2.3 Opening an Existing Collection</Title> 191 186 This section tells you how to open existing collections using the Open … … 223 218 </Section> 224 219 225 <Section name=" 3">220 <Section name="huntingforfiles"> 226 221 <Title>3.0 Hunting For Your Files</Title> 227 222 The Librarian Interface can run in different configurations. This section only … … 234 229 When using web resources, the Librarian Interface operates in two stages. This 235 230 section describes the first, Hunting, where you browse the Internet for files 236 of interest. The next sectiondescribes the second stage, Mirroring, where these files can be downloaded.237 <Section name=" 3-1">231 of interest. The <Reference target="downloadingfiles">next section</Reference> describes the second stage, Mirroring, where these files can be downloaded. 232 <Section name="thehuntview"> 238 233 <Title>3.1 The Hunt view</Title> 239 234 This section describes how to use the simplified browsing interface to locate resources on the Internet. … … 260 255 </Section> 261 256 262 <Section name=" 4">257 <Section name="downloadingfiles"> 263 258 <Title>4.0 Downloading Chosen Files</Title> 264 To enable web mirroring see Section 3.0 -- Hunting For Your Files.259 To enable web mirroring see <Reference target="huntingforfiles">Hunting For Your Files</Reference>. 265 260 To download web pages you need to install the mirroring tool wget (version v1.8 266 261 recommended) and make it accessible from the Librarian Interface "install" … … 270 265 files you need. This section explains the Librarian Interface's mirroring 271 266 process. 272 <Section name=" 4-1">267 <Section name="themirrorview"> 273 268 <Title>4.1 The Mirror view</Title> 274 269 This section describes how to configure a download task and control the downloading process. … … 323 318 when they finish successfully (ones that fail are controlled by the "Automatically remove failed downloads..." checkbox). 324 319 <Anchor name="advanced">Advanced Instructions:</Anchor> 325 Section 10.1 -- Preferencesdescribes how to establish an Internet connection320 The <Reference target="preferences">Preferences section</Reference> describes how to establish an Internet connection 326 321 via a proxy. If authentication is needed, the proxy server prompts for 327 322 identification and password. The Librarian Interface does not store passwords … … 330 325 </Section> 331 326 332 <Section name=" 5">327 <Section name="collectingfiles"> 333 328 <Title>5.0 Collecting Files for Your Collection</Title> 334 329 Once you have a new collection you need to get some files into it. These may 335 330 come from your ordinary file space, or from other Greenstone collections. Some 336 331 may already have attached metadata. This section describes how to import files. 337 <Section name=" 5-1">332 <Section name="thegatherview"> 338 333 <Title>5.1 The Gather View</Title> 339 334 This section introduces the Gather area that you use to select what files … … 374 369 Double-click a folder, or single-click the switch symbol beside it, to expand (or collapse) 375 370 its contents. Double-click a file to open it using its associated application 376 program (see Section 10.2 -- File Associations).371 program (see <Reference target="fileassociations">File Associations</Reference>). 377 372 <Break/> 378 373 The Workspace file tree shows the sources of data available to the Librarian … … 395 390 <Break/> 396 391 Two large buttons occupy the lower right corner of the screen. "New Folder", with a picture 397 of a folder, creates new folders (see Section 5.2 -- Creating folders).392 of a folder, creates new folders (see <Reference target="creatingfolders">Creating folders</Reference>). 398 393 "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. 399 394 <Anchor name="advanced">Advanced Instructions:</Anchor> … … 409 404 right-click the mapped folder and select "Unmap Folder". 410 405 </Section> 411 <Section name=" 5-2">406 <Section name="creatingfolders"> 412 407 <Title>5.2 Creating Folders</Title> 413 408 This section shows how to create new folders. … … 435 430 Folder" and proceeding as above. 436 431 </Section> 437 <Section name=" 5-3">432 <Section name="addingfiles"> 438 433 <Title>5.3 Adding Files</Title> 439 434 This section shows how to get files into your collection. … … 475 470 operation proceeds, you may be prompted (perhaps several times) for extra 476 471 information to match the imported metadata to the metadata sets in your 477 collection. This process involves many different prompts, described in the 478 section 6.8 -- Importing Previously Assigned Metadata. For a more detailed 472 collection. This process involves many different prompts, described in the <Reference target="importingpreviouslyassignedmetadata">Importing Previously Assigned Metadata</Reference> section. For a more detailed 479 473 explanation of associating metadata with files read Chapter 2 of the Greenstone 480 474 Developer's Guide -- Getting the most out of your documents. 481 475 </Section> 482 <Section name=" 5-4">476 <Section name="removingfiles"> 483 477 <Title>5.4 Removing Files</Title> 484 478 This section describes how to remove files and folders from your collection. … … 499 493 There are several methods for removing files and folders. You must first 500 494 indicate what items to remove by selecting one or more files and folders as 501 described in section 5.1 -- The Gather View.495 described in <Reference target="thegatherview">The Gather View</Reference>. 502 496 <Break/> 503 497 Once files have been selected, click the "delete" button to remove them, or … … 505 499 the delete button and drop them there. 506 500 </Section> 507 <Section name=" 5-5">501 <Section name="filteringthetree"> 508 502 <Title>5.5 Filtering the Tree</Title> 509 503 "Filtering" the collection tree allows you to narrow down the search for particular files. … … 533 527 </Section> 534 528 535 <Section name=" 6">529 <Section name="enrichingacollection"> 536 530 <Title>6.0 Enriching the Collection with Metadata</Title> 537 531 Having gathered several files into the collection, now enrich them with … … 540 534 sources (also see Chapter 2 of the Greenstone Developer's Guide -- Getting the most 541 535 out of your documents). 542 <Section name=" 6-1">536 <Section name="theenrichview"> 543 537 <Title>6.1 The Enrich View</Title> 544 538 This section describes how to input and edit metadata using the Enrich view. … … 603 597 "..." button still serves to expand the value, but the text cannot be edited. 604 598 </Section> 605 <Section name=" 6-2">599 <Section name="selectingmetadatasets"> 606 600 <Title>6.2 Selecting Metadata Sets</Title> 607 601 This section explains how to specify metadata elements and how to add … … 664 658 options, and a file to export into. 665 659 </Section> 666 <Section name=" 6-3">660 <Section name="appendingmetadata"> 667 661 <Title>6.3 Appending New Metadata</Title> 668 662 This section explains how to add metadata and values to files, and how … … 728 722 "Append", it is added to the other files in the selection too. 729 723 <Anchor name="advanced">Advanced Instructions:</Anchor> 730 You can add structure to metadata values by using paths as described in Section 731 6.1 -- The Enrich View. Correct any mistakes in creating hierarchies by using 732 the metadata set editor explained in Section 11.1 -- Editing Metadata Sets. 733 </Section> 734 <Section name="6-4"> 724 You can add structure to metadata values by using paths as described in <Reference target="theenrichview">The Enrich View</Reference>. Correct any mistakes in creating hierarchies by using 725 the metadata set editor explained in <Reference target="editingmetadatasets">Editing Metadata Sets</Reference>. 726 </Section> 727 <Section name="addingpreviouslydefinedmetadata"> 735 728 <Title>6.4 Adding Previously Defined Metadata</Title> 736 729 This section explains how to add metadata that uses values already present in the value tree. … … 755 748 or multiple files is just the same. 756 749 </Section> 757 <Section name=" 6-5">750 <Section name="updatingmetadata"> 758 751 <Title>6.5 Updating Metadata</Title> 759 752 This section explains how to update the metadata assigned to a file. … … 786 779 Thus the value you have replaced will remain in the value tree. 787 780 </Section> 788 <Section name=" 6-6">781 <Section name="removingmetadata"> 789 782 <Title>6.6 Removing Metadata</Title> 790 783 This section explains how to remove metadata from a file. … … 818 811 files that have it; all others are unaffected. 819 812 </Section> 820 <Section name=" 6-7">813 <Section name="reviewingmetadata"> 821 814 <Title>6.7 Reviewing Assigned Metadata</Title> 822 815 This section describes how to view all metadata assigned to an entire collection. … … 879 872 descending ordering. 880 873 </Section> 881 <Section name=" 6-8">874 <Section name="importingpreviouslyassignedmetadata"> 882 875 <Title>6.8 Importing Previously Assigned Metadata</Title> 883 876 This section describes how to import previously assigned metadata, … … 913 906 Once you have specified how to import a certain piece of metadata, the mapping 914 907 information is retained for the collection's lifetime. To correct any mistakes 915 during importing, use the metadata set editor described in Section 11 -- Editing 916 Metadata Sets. 908 during importing, use the metadata set editor described in <Reference target="editingmetadatasets">Editing Metadata Sets</Reference>. 917 909 <Break/> 918 910 For details on the metadata.xml files which Greenstone uses to store the metadata, see Chapter 2 of the Greenstone … … 921 913 </Section> 922 914 923 <Section name=" 7">915 <Section name="designingacollection"> 924 916 <Title>7.0 Designing Your Collection's Appearance</Title> 925 917 Once your files are marked up with metadata, you next decide how it should … … 928 920 languages are supported? Where do the buttons appear on the page? These 929 921 things can be customized; this section describes how to do it. 930 <Section name=" 7-1">922 <Section name="thedesignview"> 931 923 <Title>7.1 The Design View</Title> 932 924 This section introduces you to the design view and explains how to navigate … … 951 943 read Chapters 1 and 2 of the Greenstone Developer's Guide. 952 944 </Section> 953 <Section name=" 7-2">945 <Section name="generalsettings"> 954 946 <Title>7.2 General Settings</Title> 955 947 This section explains how to review and alter the general settings associated … … 975 967 icon to show at the top left of the collection's "About" page, and the next is 976 968 the icon used in the Greenstone library page to link to the collection. Finally 977 comes the "Collection Description" text area as described in section 2.1 -- 978 Creating A New Collection. 979 </Section> 980 <Section name="7-3"> 969 comes the "Collection Description" text area as described in <Reference target="creatingacollection">Creating A New Collection</Reference>. 970 </Section> 971 <Section name="plugins"> 981 972 <Title>7.3 Document Plugins</Title> 982 973 This section describes how to configure the document plugins the … … 1049 1040 command. 1050 1041 </Section> 1051 <Section name=" 7-4">1042 <Section name="searchtypes"> 1052 1043 <Title>7.4 Search Types</Title> 1053 1044 This section explains how to modify a new design feature in Greenstone, Search Types, which allow fielded searching. Under "Design Sections", click "Search Types". … … 1072 1063 Searches", which activates the other controls. This migrates the collection to 1073 1064 Greenstone 2.4 format, which supports fielded searching, and means that (a) 1074 the index design is different (explained in section 7.5 -- Search Indexes), 1075 (b) there are more text fragments to translate (see Section 7.10 -- 1076 Translation), and (c) the collection will not be usable under older Greenstone 1065 the index design is different (explained in the <Reference target="searchindexes">Search Indexes</Reference> section), 1066 (b) there are more text fragments to translate (see <Reference target="translatetext">Translation</Reference>), and (c) the collection will not be usable under older Greenstone 1077 1067 installations. If you later uncheck this field, most of your collection will 1078 1068 be migrated back to Greenstone 2.39. However the Librarian Interface cannot … … 1089 1079 Up" or "Move Down". The first one will be the default. 1090 1080 </Section> 1091 <Section name=" 7-5">1081 <Section name="searchindexes"> 1092 1082 <Title>7.5 Search Indexes</Title> 1093 1083 Indexes 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". … … 1133 1123 To create indexes on all sources, click the "Add All" button. The name of each index will default to the source name. To change the name, select an index, change its details, and click "Replace Index". 1134 1124 </Section> 1135 <Section name=" 7-6">1125 <Section name="partitionindexes"> 1136 1126 <Title>7.6 Partition Indexes</Title> 1137 1127 Indexes are built on particular text or metadata sources. The search space can … … 1144 1134 subcollections and subindexes in Chapter 2 of the Greenstone Developer's Guide. 1145 1135 1146 <Section name=" 7-6-1">1136 <Section name="definefilters"> 1147 1137 <Title>7.6.1 Define Filters</Title> 1148 1138 The section explains how to define a partition filter. … … 1179 1169 appear in the editing controls and click "Replace Filter" to commit the changes. 1180 1170 </Section> 1181 <Section name=" 7-6-2">1171 <Section name="assignpartitions"> 1182 1172 <Title>7.6.2 Assign Partitions</Title> 1183 1173 This section explains how to assign a previous defined partition filter. … … 1210 1200 To clear the default partition, click "Clear Default". 1211 1201 </Section> 1212 <Section name=" 7-6-3">1202 <Section name="assignlanguages"> 1213 1203 <Title>7.6.3 Assign Languages</Title> 1214 1204 This section details how to restrict search indexes to particular languages. … … 1247 1237 </Section> 1248 1238 </Section> 1249 <Section name=" 7-7">1239 <Section name="xcollectionsearching"> 1250 1240 <Title>7.7 Cross-Collection Searching</Title> 1251 1241 Greenstone can search across several different collections as though they were … … 1268 1258 For further details, see Chapter 1 of the Greenstone Developer's Guide. 1269 1259 </Section> 1270 <Section name=" 7-8">1260 <Section name="classifiers"> 1271 1261 <Title>7.8 Classifiers</Title> 1272 1262 This section explains how to assign "classifiers", which are used for browsing, … … 1300 1290 bottom and then click "Add Specified Classifier". A window appears entitled 1301 1291 "Configuring Arguments"; instructions for this dialog are just the same as for 1302 plugins (see Section 7.3 -- Plugins). Once you have configured the new1292 plugins (see <Reference target="plugins">Document Plugins</Reference>). Once you have configured the new 1303 1293 classifier, it is added to the end of the "Currently Assigned Classifiers" 1304 1294 list. … … 1328 1318 "Cancel" the dialog without making any changes to the collection. 1329 1319 </Section> 1330 <Section name=" 7-9">1320 <Section name="formatstatements"> 1331 1321 <Title>7.9 Format Features</Title> 1332 1322 Format commands control the structure and appearance of the collection. They … … 1388 1378 If 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. 1389 1379 </Section> 1390 <Section name=" 7-10">1380 <Section name="translatetext"> 1391 1381 <Title>7.10 Translate Text</Title> 1392 1382 This section describes the translation view, where you can define … … 1419 1409 area, and click "Replace Translation". 1420 1410 </Section> 1421 <Section name=" 7-11">1411 <Section name="metadatasets"> 1422 1412 <Title>7.11 Metadata Sets</Title> 1423 1413 This section explains the metadata set review panel. … … 1438 1428 </Section> 1439 1429 1440 <Section name=" 8">1430 <Section name="producingthecollection"> 1441 1431 <Title>8.0 Producing Your Collection</Title> 1442 1432 Having collected the documents for the collection, annotated them with 1443 1433 metadata, and designed how the collection will appear, you can now produce the 1444 1434 collection using Greenstone. This section explains how. 1445 <Section name=" 8-1">1435 <Section name="thecreateview"> 1446 1436 <Title>8.1 The Create View</Title> 1447 1437 This section explains the Create view used to produce a collection. … … 1469 1459 any time, click "Cancel Build". 1470 1460 </Section> 1471 <Section name=" 8-2">1461 <Section name="buildsettings"> 1472 1462 <Title>8.2 Import and Build Settings</Title> 1473 1463 This section explains how to access the various import and build settings. … … 1492 1482 <Break/> 1493 1483 Controlling the various settings is done in a similar way to the 1494 "Configuring Arguments" window described under Section 7.3 -- Plugins. Some1484 "Configuring Arguments" window described in the <Reference target="plugins">Document Plugins</Reference> section. Some 1495 1485 fields require numeric arguments, and you can either type these in or use the 1496 1486 up and down arrows to increase or decrease the current value (in some cases, … … 1498 1488 clicking a checkbox (click again to disable). 1499 1489 </Section> 1500 <Section name=" 8-3">1490 <Section name="messagelog"> 1501 1491 <Title>8.3 Message Log</Title> 1502 1492 This section explains the message log. … … 1513 1503 log you want by clicking on the desired date in the "Log History" list. 1514 1504 </Section> 1515 <Section name=" 8-4">1505 <Section name="theprogressview"> 1516 1506 <Title>8.4 The Progress View</Title> 1517 1507 This section explains the building progress view. … … 1525 1515 <Anchor name="simple">Simple Instructions:</Anchor> 1526 1516 When you start to build a collection, the view changes immediately. The 1527 controls described in the first section of this sectionare replaced by two1517 controls described <Reference target="thecreateview">previously</Reference> are replaced by two 1528 1518 progress bars and a text area. The bars indicate progress through the import 1529 1519 phase, then the build phase. The text area shows the Message Log mentioned in 1530 the previous section.1520 the <Reference target="messagelog">previous section</Reference>. 1531 1521 </Section> 1532 1522 </Section> 1533 1523 1534 <Section name=" 9">1524 <Section name="previewingthecollection"> 1535 1525 <Title>9.0 Previewing the Collection</Title> 1536 1526 This section explains how to use the "Preview" view to inspect the collection you have produced. 1537 <Section name=" 9-1">1527 <Section name="thepreviewview"> 1538 1528 <Title>9.1 The Preview View</Title> 1539 1529 This section explains how to use the "Preview" view to inspect the collection you have produced. … … 1552 1542 </Section> 1553 1543 1554 <Section name=" 10">1544 <Section name="miscellaneous"> 1555 1545 <Title>10.0 Miscellaneous</Title> 1556 1546 This section describes features of the Librarian Interface that are not associated 1557 1547 with any particular view. 1558 <Section name=" 10-1">1548 <Section name="preferences"> 1559 1549 <Title>10.1 Preferences</Title> 1560 1550 This section explains the preferences dialog, accessed by opening "File" -> "Preferences". … … 1609 1599 next to warning messages you want to see again. 1610 1600 </Section> 1611 <Section name=" 10-2">1601 <Section name="fileassociations"> 1612 1602 <Title>10.2 File Associations</Title> 1613 1603 The Librarian Interface uses particular application programs to open particular … … 1650 1640 </Section> 1651 1641 1652 <Section name=" 11">1642 <Section name="metadatasetandprofileediting"> 1653 1643 <Title>11.0 Metadata Set and Profile Editing</Title> 1654 1644 This section explains how to edit metadata sets used by the Librarian … … 1664 1654 To edit a metadata set or importing profile, choose "Metadata Sets" from the menu 1665 1655 bar and select the "Edit Set" action. 1666 <Section name=" 11-1">1656 <Section name="editingmetadatasets"> 1667 1657 <Title>11.1 Editing Metadata Sets</Title> 1668 1658 This section describes how to edit metadata sets and previously assigned values. … … 1737 1727 Once you have finished changing the metadata set, click "Close". 1738 1728 </Section> 1739 <Section name=" 11-2">1729 <Section name="editingimportprofiles"> 1740 1730 <Title>11.2 Editing Metadata Import Profiles</Title> 1741 1731 This section describes how to edit metadata importing profiles.
Note:
See TracChangeset
for help on using the changeset viewer.
