Differences

This shows you the differences between two versions of the page.

--- en:user_advanced:web_editor [2016/06/23 06:30] – anupama
+++ en:user_advanced:web_editor [2024/06/03 23:51] (current) – [Online Document Editing in Greenstone 3] kjdon
@@ Line 1: / Line 1: @@
-======  Using Greenstone 3's Web Editor ======
-The following instructions are by Georgy Litvinov.
-**Requirements:** a Greenstone3 installation, a collection to test it on.
-. Run the Greenstone 3 server (gs3-server) and visit your digital library home page in the browser. If you have installed Greenstone 3 on your PC, the URL to visit would be ''http://localhost:8383/greenstone3/library'' or ''http://127.0.0.1:8383/greenstone3/library''
-. You need to be logged in to edit your collection. To do so when using the default Greenstone 3 library interface, you'd click the ''Login'' button at the top right of the home page. (For the half-tone interface, click on the down arrow at the bottom of the home page to View More options, and then follow the Login link). Use the username and password you created during installation. The default is admin for both. If you haven't change the defaults, you can do so by running ''ant config-admin'' from the command line.
+======  Online Document Editing in Greenstone 3 ======
-. You need to enable the document edit mode. To do so, click on the button with your account name at the top right of the page (where the Login button was). From the drop-down list, choose ''Enable edit mode''.
+Greenstone 3 allows you to edit the content and metadata of documents online in a web browser. This functionality is available to logged-in users who have been assigned to either the "all-collections-editor" group, or the "collname-collection-editor" group, where collname is the short identifier of the collection (its folder name in the collect folder).
-. Open the document you wish to edit. You can do this by using Search or to locate your document, or you can simply open the document after Browsing to it with a collection classifier.
+You need to be logged in to edit the collection. To do so when using the default Greenstone 3 library interface, you'd click the ''Login'' button at the top right of the home page. (For the half-tone interface, click on the down arrow at the bottom of the home page to View More options, and then follow the Login link).
-. With a document open, click on the ''Edit content'' button to the right.
+You can use the administrator username (admin) and password you created during installation. The default is admin for both. If you haven't change the defaults, you can do so by running ''ant config-admin'' from the command line. Alternatively (and preferably), create your own account (from the Register link on the home page). An admin user will need to assign the correct group to the new username. (See the [[en:user_advanced:gs3_user_management|user management]] page.)
-. You'll now be you able to edit the internal content of your document much like in your favourite text editor. Click on anywhere in the text body of the document to see a cursor to start editing the content.
+Open the document you wish to edit. You can do this by using Search or to locate your document, or you can simply open the document after Browsing to it with a collection classifier.
-. You can modify metadata by pressing ''edit metadata'' button above the document body.
+You need to enable the document edit mode. To do so, click on the button with your account name at the top right of the page (where the Login button was). From the drop-down list, choose ''Enable edit mode''. Note, that if you are not in the right group, 'Enable edit mode' will be be available (3.09 and later).
-. If you want to add new metadata, fill in the field underneath the metadata table with a new metadata name and click on the button ''Add new metadata''. Your new metadata entry will appear at the end of the metadata table. Then enter a value for your new metadata entry.
+With a document open, click on the ''Edit content'' button to the right.
-. If your collection uses a **hierarchy classifier**, you can use the web editor to assign each document to a position in the hierarchy you've already defined in the hierarchy classifier's hfile.
+You'll now be you able to edit the internal content of your document much like in your favourite text editor. Click on anywhere in the text body of the document to see a cursor to start editing the content.
-To add a document to the hierarchy classifier, you need to add a metadata entry just as you did in step 8 above, but with the metadata name set to the ''metadata'' option configured for the hierarchy classifier. For instance, if you built your hierarchy classifier with the metadata option set to dc.Creator, then you'd use the web editor to Add New Metadata with name ''dc.Creator'' for the document.
+You can modify metadata by pressing ''edit metadata'' button above the document body.
+If you want to add new metadata, fill in the field underneath the metadata table with a new metadata name and click on the button ''Add new metadata''. Your new metadata entry will appear at the end of the metadata table. Then enter a value for your new metadata entry.
-To choose the hierarchy position that you want to assign to your document, click on the value cell for the new metadata field added. To the right of the metadata table, you will then see a flyout menu appear from which you can select the hierarchy position. You can also manually enter the hierarchy position as the metadata value (e.g. ''2.3''). In that case, you will see all the matching suggestions for that hierarchical position from which you can choose. A more detailed example follows below.
-. To save your changes, just click on the ''Save and Rebuild'' button and wait for the build to complete.
+To save your changes, just click on the ''Save and Rebuild'' button and wait for the build to complete.
 ==== Using the web editor to insert a document into a hierarchy created by a hierarchical classifier ====
+If your collection uses a **hierarchy classifier**, you can use the web editor to assign each document to a position in the hierarchy you've already defined in the hierarchy classifier's hfile.
+To add a document to the hierarchy classifier, you need to add a metadata entry just as you did  above, but with the metadata name set to the ''metadata'' option configured for the hierarchy classifier. For instance, if you built your hierarchy classifier with the metadata option set to dc.Creator, then you'd use the web editor to Add New Metadata with name ''dc.Creator'' for the document.
+To choose the hierarchy position that you want to assign to your document, click on the value cell for the new metadata field added. To the right of the metadata table, you will then see a flyout menu appear from which you can select the hierarchy position. You can also manually enter the hierarchy position as the metadata value (e.g. ''2.3''). In that case, you will see all the matching suggestions for that hierarchical position from which you can choose. A more detailed example follows below.
 . Let's take the lucene-jdbm-demo collection as an example. Its ''etc/collectionConfig.xml'' file contains the following:
@@ Line 52: / Line 55: @@
 </code>
-. Add the hierarchy file, hfile, by creating it with whatever name you assigned above (subject_hierarchy.txt), with content of the following format. Then place this file in the collection's etc folder:
+. Add the hierarchy file, hfile, by creating it with whatever name you assigned above (subject_hierarchy.txt), with content of the following format. Then place this file in the collection's ''etc'' folder:
 <code>
 1 "First level. First element"
@@ Line 62: / Line 65: @@
 </code>
-The subject_hierarchy.txt hfile in our example contains the following existing metadata (from dc.Subject and Keywords) thus organising the Subjects classifier into an outline:
+The "subject_hierarchy.txt" hfile in our example contains the following //existing// metadata (from dc.Subject and Keywords assigned to documents) thus organising the Subjects into an outline or hierarchy:
 <code>
@@ Line 73: / Line 76: @@
 </code>
-. Rebuild the collection and preview the hierarchy classifier. The hierarchy exists in the form of book nodes you can expand, but there are no documents in them. This is where the web editor comes in, making it easier to assign each document to somewhere in the existing hierarchy you created in the hfile.
+. Rebuild the collection and preview the hierarchy classifier "Topic Hierarchy". You'll see that the hierarchy now exists in the form of book nodes that you can expand, but it's just an empty outline at this stage as there are no documents under them.
+This is where the web editor comes in, making it easier to assign each document to somewhere in the existing hierarchy that you created in the hfile.
+. Log in to your Greenstone 3 digital library and preview a document in your collection. Press the ''Edit content'' button to the right of the open document. Then press the ''edit metadata'' button that appears near the //document's heading//. The metadata associated with the document will be displayed in a table. At the bottom of the document's metadata table, type the metadata name on which the hierarchy is built (''dc.Subject'' in our example) and press the ''Add new metadata'' button.
+. Click in the value cell of the new ''dc.Subject'' metadata field that now appears at the bottom of the document's metadata table. Clicking in it should make a flyout appear to the right displaying the hierarchical topics and allowing you choose the one you want this document to appear under.
-. Log in to your Greenstone 3 digital library and preview a document in your collection. Press the ''Edit content'' button to the right of the open document. Then press the ''edit metadata'' button that appears near the //document heading//. At the bottom of the document's metadata table, type the metadata name on which the hierarchy is built (''dc.Subject'' in our example) and press the ''Add new metadata'' button.
+For instance, heading 3 in our hfile is "Communication, Information and Documentation", so if you select this from the flyout, then the document will appear under that topic.
-Click in the value cell of the new ''dc.Subject'' metadata field that now appears at the bottom of the document's metadata table. A flyout should appear to the right allowing you to choose what hierarchical topic you want this document to appear under. For instance, heading 3 in our hfile is "Communication, Information and Documentation", so if you select this from the flyout, then the document will appear under that topic.
+Alternatively you could have typed "3" as the value for the ''dc.Subject'' metadata field that you added, at which point the flyout would try to show you the subject for this and its subtopics. If you left the value at "3", the document will once again appear under "Communication, Information and Documentation" (as this is associated with heading 3 in our hfile) when you now press the Save and Rebuild button to incorporate your changes.
-Alternatively you could have typed "3" as the value for the dc.Subject metadata that you added and it will likewise appear under "Communication, Information and Documentation" when you now press the Save and Rebuild button to incorporate your changes.
+. After modifying the metadata for the document, press Save and Rebuild. Then preview to see your changes take effect, by visiting the "Topic hierarchy" classifier. Check under the appropriate book nodes and you'll see that your documents have been added under them.