Index: /documentation/trunk/tutorials/xml-source/tutorial_en.xml
===================================================================
--- /documentation/trunk/tutorials/xml-source/tutorial_en.xml (revision 23280)
+++ /documentation/trunk/tutorials/xml-source/tutorial_en.xml (revision 23281)
@@ -3236,30 +3236,35 @@
-Collections built with Lucene indexer support incremental addition of documents. The import and build process by default delete old index files in the index directory and intermediate files in the archives directory. With incremental building, the import and build process will keep the old files and only process the new ones that havenât been indexed.
-In this tutorial we will learn how to use for incremental building. Please note that Greenstone supports incremental addition of documents, but if you want to change the metadata or classifier or to delete or modify an existing document in the collection, then you will need to do a full import and build.
+Collections built with the Lucene indexer support incremental addition, updates, and deletion of documents and metadata. The import and build processes by default delete old index files in the index directory and intermediate files in the archives directory. With incremental building, the import and build process will keep the old files and only process the new or modified ones.
+Incremental import can be done with any collection, but incremental modification of the indexes can only be done for collections that use the Lucene indexer.
+The first part of this tutorial looks at using the for incremental building. The depositor only supports addition of new documents and associated metadata. If you want to delete or modify existing documents and their metadata, you will need to use GLI or command line building.
- is Greenstoneâs runtime support for institutional repositories since Greenstone 2.71. It provides the collection building work flow through the web interface. only works with the Web library server, not the local library server. Greenstone users belonging to the user group have access to .
+ is Greenstoneâs runtime support for institutional repositories. It provides the collection building work flow through a web interface. only works with the Web library server, not the local library server. Greenstone users belonging to the user group have access to .Enabling
-Enabling involves two steps: first we need to install a Web Server (Apache) and configure Greenstone to use the Web Server instead of local server; then we can enable .
-
-We are going to use the Apache HTTP Server as the Web Server. Apache is an open source HTTP server developed by The Apache Software Foundation. It can be downloaded from the Apache Server website. This page in the Greenstone Wiki provides a detailed walkthrough of how to install Apache on Linux, MacOS and Windows, and how to configure Greenstone to work with Apache. Please follow this page unless you have already configured Greenstone with a Web Server.
+For Windows users, first make sure that you are using a Web Server (e.g. Apache) instead of the Local Library Server. The binary installation of Greenstone will install Apache, but by default the Local Library Server will be used. To switch to using Apache, rename the GSDLHOME → server.exe file to something else. Note: You might need to set permissions for the GSDLHOME → tmp and GSDLHOME → collect or GSDLHOME → collect → your_accessible_collection directory.
-
-
-Now suppose we have already installed Apache and have configured Greenstone to use the Apache Web server. In Greenstone, is disabled by default. To enable it, edit the file GSDLHOME → etc → main.cfg. Look for the "depositor" line, and change disabled to enabled.
-There is one more thing need to be done here. By default only users from the user group have access to so we need to add the account, which we are going to use, to this group. To do this, we need the facility, which is also disabled by default. To enable it, look for the "status" line in main.cfg file and change disabled to enabled, if it is not already so.
-
-
-If we are on a Windows machine, restart the Greenstone library.
-
-
-Now we change the group membership of the account. Go to the Greenstone library home page. Two new buttons appears right below button, named and respectively. Click button, click the link on the left under section. Sign in and you will see a list of all the registered accounts in your Greenstone library. At the end of each entry there are two links: and . Click on the user account, and one can see more detailed information about the current user account. If it's not already there, add at the end of the and make it read:
-
-administrator,colbuilder,all-collections-editor
-
+In Greenstone, is disabled by default. To enable it, edit the file GSDLHOME → etc → main.cfg. Look for the "depositor" line, and change disabled to enabled.
+
+Setting a user group
+
+Use of involves an authentication step. A user will need a Greenstone account which belongs to an appropriate user group. The user group gives access to edit any collection, while the ***-collection-editor group gives a user access to edit the *** collection, where *** is the collection's short name (or directory name). By default, the admin account is a member of the all-collections-editor group.
+The Greenstone admin pages are used to add new users and modify their group settings. Admin pages may have been enabled when you installed Greenstone. If not, they can be activated by changing the "status" line in the main.cfg file and changing disabled to enabled
+
+To access the administration pages, go to your Greenstone home page and click the (below the list of collections). To see the list of users, click the link on the left under section. You will need to sign in. You can use the admin account, or any other account which has been added to the group. If you didn't set up the admin pages when you installed Greenstone, then a default admin account will be created with password "admin". PLease change this immediately.
+
+
+Lets modify the groups for the demo user. This user was added for the authentication demonstration collection to allow restricted access to some of the documents. If this user doesn't exist for you, create a new user by clicking on the link under the section on the left. Give it the name "demo" and password "demo".
+
+
+ We'll give this user access to modify the Demo Lucene collection that we will be using for this tutorial. If you have given the collection the title "Demo Lucene", then it's short name is likely to be demoluce. You can check this in GLI: Open the Demo Lucene collection, go to Format->General, and look for the collection folder item. Here we assume demoluce.
+
+
+At the end of each user entry there are two links: and . Click on the user account, and you will be shown more detailed information about the demo user. Add at the end of the line, using a comma to separate group entries. (Note, if your collection shortname is not demoluce, then replace demoluce with the appropriate name in ***-collection-editor.
+
+Click . Click the link on the left side and return to the Greenstone home page.
@@ -3268,14 +3273,15 @@
-On the Greenstone library home page, click button. You will see a drop-down selection list of all the available collections. Select Demo Lucene from the list and sign in with the account.
-
-
-The next page asks to fill in the metadata fields — , , , and . These metadata fields are from the Development Library Subset (DLS) metadata set, which is the metadata set used in the Demo Lucene collection. In order to ensure the new document will be displayed in the classifiers, next we will specify these metadata for the new document.
-
-However, the default metadata fields to be displayed here are the , and from the Dublin Core Metadata Set. You can customize which metadata fields are required for items added through in the section on the panel in the Greenstone Librarian Interface.
-
-We are going to deposit this file: sample_files → demo_NewFiles → r9006e.htm. Double click r9006e.htm and have a look at its content. Suppose we already have the values for these metadata fields.
-Type in the filed:
+On the Greenstone library home page, click button. You will see a drop-down selection list of all the available collections. Select Demo Lucene from the list and sign in with the account.
+
+
+The next page asks you to fill in the metadata fields — , , , and . These metadata fields are from the Development Library Subset (DLS) metadata set, which is the metadata set used in the Demo Lucene collection. In order to ensure the new document will be displayed in the classifiers, next we will specify these metadata for the new document.
+
+The default metadata fields that would be displayed here for a new collection are the , and from the Dublin Core Metadata Set. You can customize which metadata fields are required for items added through in the section on the panel in the Greenstone Librarian Interface.
+
+We are going to deposit this file: sample_files → demo_NewFiles → r9006e.htm. Double click r9006e.htm and have a look at its content.
+Type the following in the field:Selected guidelines for the management of records and archives: a RAMP reader (r9006e)
+(Note, You can copy this and the following metadata values across from the sample_files → demo_NewFiles → r9006e-metadata.txt).In the field, type UNESCOIn the field, type:
@@ -3284,14 +3290,14 @@
manage records and archivesFinally in the field, type: English
-(You can copy these metadata values across from the sample_files → demo_NewFiles → r9006e-metadata.txt).
-
-
-Click the button. Click Browse... button and select sample_files → demo → new → r9006e.htm, click the button and check the document has been uploaded successfully.
-
-
-Click the button and wait for the process being finished. You will see the message if the collection has been built successfully or error messages if something goes wrong.
-
-
-Click to preview the newly built collection and check out the newly added document is displayed correctly. For example, in the organizations classifier you will find a new bookshelf named has been created, and click it will show the new document.
+
+
+
+Click the button. Click the Browse... button and select sample_files → demo → new → r9006e.htm, click the button and check the document has been uploaded successfully.
+
+
+Click the button and wait for the process to finish. You will see the message if the collection has been built successfully or error messages if something has gone wrong.
+
+
+Click to preview the newly built collection and check that the newly added document is displayed correctly. For example, in the organizations classifier you should find a new bookshelf named , which contains the new document.
@@ -3299,8 +3305,5 @@
- also supports batch addition of new documents. This is achieved by zipping the new documents (together with their metadata files) first and upload/deposit the zip file. Please note that the collection must have in order to be able process the uploaded zip file, otherwise you need to add the first in Librarian Interface.
-
-
-Because the Demo Lucene collection doesn't have yet, so we change this first. Open the Demo Lucene collection in the Greenstone Librarian Interface. Go to the section on the panel. Add from the drop down list and close the Greenstone Librarian Interface.
+ also supports batch addition of new documents. This is achieved by zipping up the new documents (together with their metadata files) and depositing the zip file. Please note that the collection must have in order to be able process the uploaded zip file, otherwise you need to add the first in Librarian Interface.
@@ -3308,10 +3311,10 @@
-Leave the metadata fields blank, because the zip file we are adding contains a file which specifies these metadata values. Click the button, select sample_files → demo_NewFiles → new_files.zip, which contains two new HTML documents and a file. Click and then the button.
-
-
-After the building is finished, click to preview the collection. On the collection's home page, it says the collection now contains 14 documents. Check the titles classifier for the new documents Above and beyond and Utilization and construction of pit silos have been added successfully.
-
-A major benefit of using is that the user can upload documents and metadata remotely, without having to have Greenstone installed at the client end. is a tool for remote data input, allowing you to also deposit items to collections built with the MG or MGPP indexers. The difference is that the MG and MGPP indexers need to rebuild the index after adding a new item, while the Lucene indexer doesn't need to.
+Leave the metadata fields blank, because the zip file we are adding contains files which specify these metadata values. Click the button, select sample_files → demo_NewFiles → new_files.zip, which contains two new HTML documents along with their associated images and files. Click and then the button.
+
+
+After the building is finished, click to preview the collection. On the collection's home page, it says the collection now contains 14 documents. Check the titles classifier to see that the new documents Above and beyond and Utilization and construction of pit silos have been added successfully.
+
+A major benefit of using is that the user can upload documents and metadata remotely, without having to have Greenstone installed at the client end. is a tool for remote data input, allowing you to also deposit items to collections built with the MG or MGPP indexers. The difference is that the MG and MGPP indexers need to rebuild the entire index after adding a new item, while the Lucene indexer incrementally adds the new document to the existing index.