source: collections/documented-examples/trunk/authen-e/etc/collect.cfg@ 19238

creator     [email protected]
maintainer  [email protected]
public      true

buildtype   mgpp

indexes     text dls.Title,Title dls.Subject dls.Organization dls.Keyword

levels      section document

plugin      GreenstoneXMLPlugin
plugin      HTMLPlugin -description_tags -OIDtype dirname
plugin      MetadataXMLPlugin
plugin      ArchivesInfPlugin
plugin      DirectoryPlugin

classify    List -metadata dls.Title

classify    Hierarchy -metadata dls.Subject -sort dls.Title

classify    List -metadata dls.Organization -bookshelf_type always -sort_leaf_nodes_using dls.Title 

classify    List -metadata dls.Keyword -buttonname Howto

format CL4VList "<td>[link][icon][/link]</td><td>[link][dls.Keyword][/link]"

format SearchVList "<td valign=top>[link][icon][/link]</td><td>{If}{[parent(All\': \'):Title],[parent(All\': \'):Title]:}[link][Title][/link]</td>"

format VList "<td valign=top>[link][icon][/link]</td><td valign=top>[highlight]{Or}{[Title],Untitled}[/highlight]{If}{[Date],<br><small><i>_textdate_[Date]</i></small>}{If}{[NumPages],<br><small><i>_textnumpages_[NumPages]</i></small>}{If}{[Source],<br><small><i>_textsource_[Source]</i></small>}</td>"

format DocumentText "<h3>[Title]</h3>\\n\\n<p>[Text]"
format DocumentImages true
format DocumentButtons "Expand Text|Expand Contents|Highlight|Detach|Print"
format DocumentSearchResultLinks true

format HList "[link][highlight][Title][/highlight][/link]"

format DocumentHeading "{Or}{[parent(Top):Title],[Title],untitled}<br>"

format SearchTypes "plain,form"

# Authentication directives

authenticate        document
public_documents    Jfb33fe Jfb34fe

auth_group      demo

# -- English strings ----------------
collectionmeta  collectionname [l=en] "Authentication demo"

collectionmeta .text [l=en] "text"
collectionmeta .dls.Title,Title [l=en] "titles"
collectionmeta .dls.Subject [l=en] "subjects"
collectionmeta .dls.Organization [l=en] "organizations"
collectionmeta .dls.Keyword [l=en] "how to"

collectionmeta .document [l=en] "book"
collectionmeta .section [l=en] "chapter"

collectionmeta  depositormetadata [l=en] "{\"name\":\"dls.Title\",\"label\":\"Title\",\"tooltip\":\"dls.Title: The title of this resource.\",\"type\":\"text\"}, {\"name\":\"dls.Organization\",\"label\":\"Organization\",\"tooltip\":\"dls.Organization: The organization responsible for producing this resource.\",\"type\":\"text\"}, {\"name\":\"dls.Subject\",\"label\":\"Subject\",\"tooltip\":\"dls.Subject: The subject of this resource.\",\"type\":\"text\"}, {\"name\":\"dls.Keyword\",\"label\":\"Keyword\",\"tooltip\":\"dls.Keyword: A more specific indication of what the resource can be used for.\",\"type\":\"text\"}, {\"name\":\"dls.Language\",\"label\":\"Language\",\"tooltip\":\"dls.Language: The language of this resource.\",\"type\":\"text\"}"

# -- French strings ----------------
collectionmeta  collectionname [l=fr] "Démonstration d'authentification"

# -- Spanish strings ----------------
collectionmeta  collectionname [l=es] "Demostración de autenticación"

# -- Russian strings ----------------
collectionmeta  collectionname [l=ru] "ДеЌПМстрацОя аутеМтОфОкацОО"


# -- English text ----------------
collectionmeta  collectionextra [l=en] "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 & 2), while the others require logging in to view.

<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>\n

<p>
The <a href=\"_httpcollection_/etc/collect.cfg\" target=collect.cfg>collection
configuration file</a> is exactly the same as for the original demo collection apart from the authentication directives, one plugin option (and this description). 

<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.\n

<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. \n

<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.\n

<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.\n
"


# -- French text ----------------
collectionmeta  collectionextra [l=fr] "
Cette collection de démonstration contient le même contenu que la
collection de démonstration originale fournie avec Greenstone, mais elle
inclue également quelques commandes d'authentification basiques. Deux
documents sont diffusés de maniÚre publique (Farming snails 1 & 2), alors
que le reste des documents requiÚrent une authentification afin de pouvoir
les consulter.

<p><center><b>Pour accéder à cette collection, essayez utilisateur :  </b> <i>demo</i> <b> et mot de passe : </b> <i>demo.</i></center></p>

<h3>Comment marche cette collection?</h3>

<p>
_text1_

<p>
Le schéma d'authentification contrÎle l'accÚs à la collection. Il fonctionne en 
deux étapes. Dans un premier temps il détermine s'il faut restreindre l'accÚs à la collection dans son ensemble ou à des documents spécifiques qu'elle contient, et dans ce dernier cas, de quels documents il s'agit (soit en donnant une liste de documents privés dont l'accÚs nécessite une authentification, soit en déclarant que tous les documents sont privés à l'exeption d'une liste de documents publics donnée). Ensuite, pour les documents à accÚs restreint, il détermine les utilisateurs qui y ont accÚs. 

<p>
L'authentification est activée par la directive <i>authenticate</i> avec la valeur <i>collection</i> ou <i>document</i>, suivant que la restriction d'accÚs s'applique à toute la collection ou sur des documents spécifiques (la valeur par défaut est <i>collection</i>). Si l'authentification est effectuée sur la base <i>document</i>, on peut donc soit spécifier une liste de documents privés (dans ce cas tous les autres sont publiques), soit une liste de documents publics (dans ce cas tous les autres sont privés)en utilisant les directives <i>private_documents</i> ou <i>public_documents</i>. 
Ces documents eux-mêmes sont specifiés en utilisant les identificateurs de 
documents de Greenstone (séparés par des espaces) : la façon la plus facile de 
les determiner est de localiser chaque document dans la collection et de 
regarder son argument <i>d</i> dans son URL Greenstone.

<p>_text2_\n

<p>
La directive <i>auth-groups</i> précise les groupes Greenstone pour lesquels l'accÚs sera permis, si le document (ou la collection) est de ceux qui exigent une authentification. Il est suivi par un nom de groupe (ou une liste de noms 
de groupe séparés par des espaces). Les pages <i>admin</i>de Greenstone vous permettent de définir des groupes et d'y ajouter des membres.
"


# -- Spanish text ----------------
collectionmeta  collectionextra [l=es] "
Esta colección de demostración de Greenstone contiene el mismo material que la colección de demo original, pero incluye además algunos comandos de autenticación básica. Solo dos documentos tienen libre acceso (Farming snails 1 & 2), mientras que los restantes requieren autenticación para poder visualizarse.
<p>

<center><b>
Para tener acceso a esta colección ingrese el nombre de usuario: 
</b><i>demo</i><b> y la contraseña: </b><i>demo</i>
</center>
<p>

<h3>Cómo trabaja esta colección</h3>
<p>

_text1_

<p>
El esquema de autenticación controla el acceso a la colección. Consiste de dos pasos. Primero determina si se va a restringir el acceso a toda la colección o sólo a documentos individuales dentro de la misma y, en este último caso, a qué documentos (ya sea dando una lista de los documentos confidenciales para los cuales el acceso está limitado a determinadas cuentas o especificando que todos los documentos son confidenciales, excepto por una lista dada de documentos del dominio público). A continuación para los documentos con acceso restringido determina qué usuarios tendrán acceso a ellos.
<p>

La función de autenticación se activa por medio de la directiva <i>authenticate</i> con el valor <i>collection</i> o <i>document</i>, dependiendo de si la autenticación se debe realizar para tener acceso a toda la colección o por cada documento (el valor por omisión es <i>colección</i>). Si la autenticación se va a realizar con base en cada <i>documento</i>, entonces se puede establecer una lista de documentos confidenciales (en cuyo caso todos los demás son del dominio público) o una lista de documentos de dominio público (en cuyo caso todos los demás documentos son confidenciales) usando las directivas <i>private_documents</i> o <i>public_documents</i>. Los documentos mismos se especifican por medio de los identificadores de documento de Greenstone (separados por espacios). La forma más fácil de determinarlos es localizar cada documento en la colección y ver el argumento d en su URL.\n

<p>_text2_\n

La directiva <i>auth_groups</i> especifica los grupos a los cuales se permite el acceso, si el documento (o la colección) es uno de los que requieren autenticación. Está seguida por el nombre del grupo (o una lista de nombres de grupos separados por espacios). Las páginas <i>admin</i> de Greenstone le permiten definir los grupos y añadir miembros. 
"


# -- Russian text ----------------
collectionmeta  collectionextra [l=ru] "
ДаММая ЎеЌПМстрацОПММая кПллекцОя сПЎержОт те же ЌатерОалы чтП О ПрОгОМальМая ЎеЌПМстрацОПММая кПллекцОя ГрОМстПуМ, МП включает кПЌаМЎы базПвПй аутеМтОфОкацОО. Два ЎПкуЌеМта ЎПступМы Ўля ПткрытПгП ЎПступа (РазвеЎеМОе улОтПк 1 О 2), МП ЎругОе ЎПкуЌеМты требуют вх
ПЎа Ўля прПсЌПтра.

<p><center><b> Для ЎПступа к этПй кПллекцОО МеПбх
ПЎОЌП ввестО user:</b> <i>demo</i> <b>О password:</b> <i>demo</i></center></p>

<h3>Как рабПтает кПллекцОя</h3>\n

<p>
_text1_

<p>
Сх
еЌа аутеМтОфОкацОО управляет ЎПступПЌ к кПллекцОО. ОМа является Ўвух
ступеМчатПй. СМачала ПМа решает, ПграМОчОть лО ЎПступ к кПллекцОО в целПЌ ОлО к ПтЎельМыЌ ЎПкуЌеМтаЌ. В пПслеЎМеЌ случае ПпреЎеляется, какОе ЎПкуЌеМты являются такПвыЌО (ОлО преЎставляя спОсПк тех
 ЎПкуЌеМтПв, к кПтПрыЌ требуется разрешеМОе Ма ЎПступ, ОлО же ПпреЎеляя, чтП все ЎПкуЌеМты являются МеЎПступМыЌО  за ОсключеМОеЌ тех
, чтП включеМы в спОсПк ПбщеЎПступМых
 ЎПкуЌеМтПв). ТПгЎа Ўля ЎПкуЌеМтПв ПграМОчеММПгП ЎПступа ПпреЎеляется, какОЌ пПльзПвателяЌ разрешеМ к МОЌ ЎПступ.

<p>
_text3_ СпецОфОку саЌОх
 ЎПкуЌеМтПв ПпреЎеляют, ОспПльзуя ОЎеМтОфОкатПры ЎПкуЌеМта в Greenstone (распреЎелеММых
 пП ПбластяЌ). СаЌый легкОй спПсПб Ох
 ПтМесеМОя сПстПОт в тПЌ, чтПбы ПпреЎелОть ЌестПМах
ПжЎеМОе кажЎПгП ЎПкуЌеМта в кПллекцОО О рассЌПтреть  егП <i>d</i>-аргуЌеМт в URL Greenstone.

<p>_text2_\n
<p>
ДОректОва <i>auth_groups</i> ПпреЎеляет группы Greenstone, к кПтПрыЌ ЎПступ буЎет разрешеМ, еслО ЎПкуЌеМт (ОлО кПллекцОя) ПтМПсОтся к теЌ, Ўля кПтПрых
 требуется аутеМтОфОкацОя. ЭтП ПпреЎеляется МазваМОеЌ группы (ОлО спОскПЌ МазваМОй групп ПпреЎелеММых
 Пбластей). <i>Admin</i> страМОцы Greenstone пПзвПляет ПпреЎелять группы О ЎПбавлять к МОЌ МПвые.
"