source: documented-examples/trunk/authen-e/resources/collectionConfig.properties@ 36246

Last change on this file since 36246 was 36246, checked in by anupama, 2 years ago

First attempt at porting authen-e DEC (documented example collection) to GS3. At present all but 2 docs (farming butterflies, fb33fe and fb34fe) are private and accessible only to users in the group: demo. This is as in the GS2 version of authen-e. The collection description text still needs to be updated and the collectionCofig.properties files for the 5 languages already supported should have the collection description split into multilines, but there's now an overridden about.xsl, as Dr Bainbridge described, that will ensure the coll description is loaded from teh collectionConfig.props file for the selected language where available. I've also worked out how GS3 allows displayItem static strings to be declared in props file to be called from the collectionConfig.xml file. An example is textsource, which replaced the GS2 macro _textsource_.

File size: 2.9 KB
Line 
1name=Authentication demo
2shortDescription=Collection demonstrating document-level collection authentication in Greenstone 3.
3description=<p>This demonstration collection contains the same material as the original Greenstone demo collection, but it includes some basic authentication commands. Two documents are publicly available (Farming snails 1 &amp; 2), while the others require logging in to view.</p> <p><center><b> To access this collection try user:</b> <i>demo</i> <b>and password:</b> <i>demo</i></center></p> <h3>How the collection works</h3> <p> The collection configuration file is exactly the same as for the original demo collection apart from the authentication directives, one plugin option (and this description).</p> <p> The authentication scheme controls access to the collection. It works in two steps. First it determines whether to restrict access to the collection as a whole or to individual documents in it, and in the latter case which documents those are (either by giving a list of private documents for which access is to be authenticated, or specifying that all documents are private except for a given list of public documents). Then for access-restricted documents it determines which user groups are to have access.</p> <p> Authentication is activated by the <i>authenticate</i> directive with the value <i>collection</i> or <i>document</i> depending on whether authentication is to be performed on the full collection or on a per-document basis (the default value is <i>collection</i>). If authentication is on a <i>document</i> basis, then one can <i>either</i> specify a list of private documents (in which case all others are public) or a list of public documents (in which case all others are private) using directives <i>private_documents</i> or <i>public_documents</i>. The documents themselves are specified using Greenstone document identifiers (separated by spaces): the easiest way to determine these is to locate each document in the collection and look at the <i>d</i> argument in its Greenstone URL.</p> <p>In this case, we have used the <i>-OIDtype dirname</i> option to HTMLPlugin, which specifies that directory names should be used as identifiers. This works for collections where each document is in a separate directory. We have used this option to ensure that identifiers remain the same across different platforms (which may not be the case for HASH identifiers), as we need to specify identifiers here for the authentication directives.</p> <p> The <i>auth_groups</i> directive specifies the Greenstone groups for to which access will be permitted, if the document (or collection) is one of those that requires authentication. It is followed by a group name (or a list of group names separated by spaces). The Greenstone <i>admin</i> pages allow you to define groups and add members to them. </p>
4textdate=publication date:
5textnumpages=no. of pages:
6textsource=source ref:
Note: See TracBrowser for help on using the repository browser.