Changeset 37743

Timestamp:

2023-05-10T00:32:11+12:00 (11 months ago)

Author:

anupama

Message:

A tutorial of sorts covering the few essential points of divergence from GLI in WebSwing GLI that I noticed when going through the GS3 tutorials using WebSwing GLI on Windows. Is WebSwing GLI also for GS2? For now I'm assuming it's only been set up for GS3.

File:

• documentation/trunk/tutorials/xml-source/tutorial_en.xml (modified) (1 diff)

documentation/trunk/tutorials/xml-source/tutorial_en.xml

@@ -7167 +7167 @@
 </Tutorial>
 </MajorVersion>
+<MajorVersion number="3">
+<Tutorial id="webswing_gli">
+<Title>
+<Text id="wsg-01">Using WebSwing GLI (Web GLI)</Text>
+</Title>
+<Version initial="2.88|3.11" current="2.87|3.11"/>
+<Content>
+<Comment>
+<Text id="wsg-02">When a librarian or other collection designer wants to create/edit a collection on a Greenstone installation that's running on a remote server machine (such as on a cloud), there are several options to connect to the remote machine. There is the new <i>WebSwing GLI</i>, which allows you to use the remote Greenstone installation's GLI through your local web browser, the specifics of which are described in this tutorial. There is also <i>client-gli</i>, which requires you to first set up the remotely running Greenstone server to support client-GLI applications connecting to it. It also requires you to have a Greenstone installed in order to run a client-GLI. (In the past, there was also the <i>GLI applet</i>, but support for Java applets has been deprecated by browsers over the past years.) WebSwing GLI is the easiest route, as it is already set up and ready to use once you have your Greenstone server up and running. For this reason, going forward, WebSwing GLI will be maintained as the most up-to-date version of GLI that allows creating and editing collections on a remotely running Greenstone 3.</Text>
+</Comment>
+<Comment>
+<Text id="wsg-03">The following assumes you have a Greenstone 3 server that's already running, whether on a cloud or locally such as at the default location of http://localhost:8383/greenstone3/library.</Text>
+</Comment>
+<Heading>
+<Text id="wsg-04">Creating a user account</Text>
+</Heading>
+<Comment>
+<Text id="wsg-05">
+To connect with GLI to you need a user account that has collection-editing permissions or you can use the default "admin" user account that is already set up with the permissions of  <i>all-collections-editor<i>. Refer to the tutorial <b>Customization: Themes</b> as to the password for the admin user, unless you've already changed its default password.</Text>
+</Comment>
+<NumberedItem>
+<Text id="wsg-06">To create a new user account that is allowed to create collections and edit the ones it creates:</Text>
+<Text id="wsg-06a">Visit your running Greenstone server's home page in the browser. Scroll down to the link labelled <i>Administration Page</i> and click it. As it says, it "Allows you to manage users". Before proceeding, you'll be asked to log in as the <i>admin</i> user (or as any custom users you created with administration privileges) in order to add new users.</Text>
+<Text id="wsg-06b">Press the button <b>Add a New User</b>.</Text>
+<Text id="wsg-06c">Fill out the fields. As a bare minimum, you will need to enter a username for the new user, enter a password for the account twice and assign what <i>Groups</i> the new user belongs to. Groups controls both access permissions and content creation permissions: whether the new user is in the right group to view restricted Greenstone collections and documents, and whether the user is in the right group to edit certain (or any) collection.</Text>
+<Text id="wsg-06d">If you wish to give your new user the all-mighty rights of an administrator, you can add "administrator" to their Groups field. Usually, you will not want to go around giving every new user administrator rights. There are 3 kinds of pre-existing Groups that determine a user's content creation permissions: if they belong to <i>all-collections-editor</i> (like the default <i>admin</i> user does), they can create any Greenstone collection and edit any collection. If their Groups field contains <i>personal-collections-editor</i>, they have the right to create any collection they want, but only to edit the collections they created and not those created by others. Setting a user's Groups field to <i>COLLNAME-collection-editor</i>, where you have to edit COLLNAME to a specific collection's shortname, will allow the user to edit that collection. For instance, if a user has  <i>lucene-jdbm-demo-collection-editor</i> in its list of groups, they have the right to edit the default Greenstone 3 collection "lucene-jdbm-demo".
+<Text id="wsg-06e">For now, you could add "personal-collections-editor" to your new user's group to give them the right to create any collection and edit those. This will be sufficient to cover most Greenstone 3 tutorials. But for your user to have the additionally ability to edit the default "lucene-jdbm-demo" demonstration collection, you can append <i>lucene-jdbm-demo-collection-editor</i> to the groups field (separated by comma). Alternatively, you can just set the user's Groups field to <i>all-collections-editor</i>, if you're going to go through all the tutorials with WebSwing GLI using this new user account.</Text>
+</NumberedItem>
+<Heading>
+<Text id="wsg-07">Accessing WebSwing GLI: a Greenstone Librarian Interface (GLI) accessible over your browser</Text>
+</Heading>
+<NumberedItem>
+<Text id="wsg-08">Start the Greenstone Librarian Interface:</Text>
+  <Text id="wsg-08a">Visit your running Greenstone server's home page in the browser. By default, for a locally running Greenstone, this would be at http://localhost:8383/greenstone3/library. Scroll down to the link <i>Greenstone Librarian Interface (GLI)</i> and click it. After some time a popup dialog will request a username and password. Enter the details for either the default <i>admin</i> account, or any user created earlier. WebSwing GLI will load in your browser. Once it's finished loading up, you can start using GLI <i>almost</i> as usual.</Text>
+</NumberedItem>
+<NumberedItem>
+<Text id="wsg-09">WebSwing GLI is mostly the same as regular GLI except for a few notable differences:</Text>
+<Text id="wsg-09a">In the <AutoText key="glidict::GUI.Gather"/> panel, the <b>Workspace</b> tree view will not give you access to the file system (of either your machine or the remote machine running Greenstone) for web security reasons. With WebSwing GLI, you won't be gathering your documents by dragging and dropping them but by using a file browser to upload them into your collection. When you have a new or existing collection open in WebSwing GLI, you will find an Upload icon at the bottom right of WebSwing GLI's <AutoText key="glidict::GUI.Gather"/> panel. You can use this to upload either individual files or a zipped file from your local machine onto the remote Greenstone collection. Often, you will find you need to upload many documents or folders of documents, not individual ones. In that case, first zip up your documents locally, then use the Upload icon to select the zip to upload it. If GLI offers to add the ZipPlugin to your collection, you can choose to cancel out of it, as you generally mean to unzip them yourself when using WebSwing GLI in the gathering documents phase. Once the uploaded zip appears in the <b>Collection</b> tree view, rightclick on it and select <AutoText key="glidict::CollectionPopupMenu.Unzip"/>.</Text>
+
+<Text id="wsg-09b">Regular GLI allows you to double-click on the documents you've gathered to view them whenever you have a default application set up to view the file type of the selected file. WebSwing GLI can only allow you to view documents that your browser is able to display. Double-clicking on all other documents will download them onto your local machine, where you can then view them if you have the appropriate application installed for that file type.</Text>
+
+<Text id="wsg-09c">Similar to the Upload icon in the Gather panel, in the the <AutoText key="glidict::CDM.GUI.General"/> section of the <AutoText key="glidict::GUI.Format"/> panel you will find that the two browse buttons (the <AutoText key="glidict::CDM.General.Icon_Collection"/> and <AutoText key="glidict::CDM.General.Icon_Collection_Small"/>), which allow you to select custom images to use for your collection on the home page and about page, now actually has the net effect of uploading image files you select from your local file system onto your collection on the remote Greenstone installation.</Text>
+</NumberedItem>
+<NumberedItem>
+<Text id="wsg-10">For the rest, WebSwing GLI will work like regular GLI in the tutorials. So you are now set to, for instance, go through the <b>A simple image collection</b> tutorial  using WebSwing GLI this time, bearing in mind the above differences. Try it out to familiarise yourself with WebSwing GLI.</Text>
+</NumberedItem>
+</Content>
+</Tutorial>
+</MajorVersion>
 </TutorialList>