root/collections/documented-examples/trunk/authen-e/etc/collect.cfg @ 19191

Revision 19191, 13.7 KB (checked in by kjdon, 11 years ago)

made the coll use dirname oidtype, to keep identifiers constant across platforms. added new text for that

  • Property svn:executable set to *
Line 
1creator     greenstone@cs.waikato.ac.nz
2maintainer  greenstone@cs.waikato.ac.nz
3public      true
4
5buildtype   mgpp
6searchtypes plain,form
7
8indexes     text dls.Title,Title dls.Subject dls.Organization dls.Keyword
9
10levels      section document
11
12plugin      GreenstoneXMLPlugin
13plugin      HTMLPlugin -description_tags -OIDtype dirname
14plugin      MetadataXMLPlugin
15plugin      ArchivesInfPlugin
16plugin      DirectoryPlugin
17
18classify    List -metadata dls.Title
19
20classify    Hierarchy -metadata dls.Subject -sort dls.Title
21
22classify    List -metadata dls.Organization -bookshelf_type always -sort_leaf_nodes_using dls.Title
23
24classify    List -metadata dls.Keyword -buttonname Howto
25
26format CL4VList "<td>[link][icon][/link]</td><td>[link][dls.Keyword][/link]"
27
28format SearchVList "<td valign=top>[link][icon][/link]</td><td>{If}{[parent(All\': \'):Title],[parent(All\': \'):Title]:}[link][Title][/link]</td>"
29
30format 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>"
31
32format DocumentText "<h3>[Title]</h3>\\n\\n<p>[Text]"
33format DocumentImages true
34format DocumentButtons "Expand Text|Expand Contents|Highlight|Detach|Print"
35format DocumentSearchResultLinks true
36
37format HList "[link][highlight][Title][/highlight][/link]"
38
39format DocumentHeading "{Or}{[parent(Top):Title],[Title],untitled}<br>"
40
41# Authentication directives
42
43authenticate        document
44public_documents    Jfb33fe Jfb34fe
45
46auth_group      demo
47
48# -- English strings ----------------
49collectionmeta  collectionname [l=en] "Authentication demo"
50
51collectionmeta .text [l=en] "text"
52collectionmeta .dls.Title,Title [l=en] "titles"
53collectionmeta .dls.Subject [l=en] "subjects"
54collectionmeta .dls.Organization [l=en] "organizations"
55collectionmeta .dls.Keyword [l=en] "how to"
56
57collectionmeta .document [l=en] "book"
58collectionmeta .section [l=en] "chapter"
59
60collectionmeta  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\"}"
61
62# -- French strings ----------------
63collectionmeta  collectionname [l=fr] "Démonstration d'authentification"
64
65# -- Spanish strings ----------------
66collectionmeta  collectionname [l=es] "Demostración de autenticación"
67
68# -- Russian strings ----------------
69collectionmeta  collectionname [l=ru] "ДеЌПМстрацОя аутеМтОфОкацОО"
70
71
72# -- English text ----------------
73collectionmeta  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.
74
75<p><center><b> To access this collection try user:</b> <i>demo</i> <b>and password:</b> <i>demo</i></center></p>
76
77<h3>How the collection works</h3>\n
78
79<p>
80The <a href=\"_httpcollection_/etc/collect.cfg\" target=collect.cfg>collection
81configuration file</a> is exactly the same as for the original demo collection apart from the authentication directives, one plugin option (and this description).
82
83<p>
84The authentication scheme controls access to the collection. It works in two
85steps. First it determines whether to restrict access to the collection as a
86whole or to individual documents in it, and in the latter case which documents
87those are (either by giving a list of private documents for which access is to
88be authenticated, or specifying that all documents are private except for a
89given list of public documents). Then for access-restricted documents it
90determines which user groups are to have access.\n
91
92<p>
93Authentication is activated by the <i>authenticate</i> directive with the value
94<i>collection</i> or <i>document</i> depending on whether authentication is to
95be performed on the full collection or on a per-document basis (the default
96value is <i>collection</i>). If authentication is on a <i>document</i> basis,
97then one can <i>either</i> specify a list of private documents (in which
98case all others are public) or a list of public documents (in which case
99all others are private) using directives <i>private_documents</i> or
100<i>public_documents</i>. The documents themselves are specified using Greenstone
101document identifiers (separated by spaces): the easiest way to determine these
102is to locate each document in the collection and look at the <i>d</i> argument
103in its Greenstone URL. \n
104
105<p>In this case, we have used the <i>-OIDtype dirname</i> option to HTMLPlugin,
106which specifies that directory names should be used as identifiers. This works
107for collections where each document is in a separate directory. We have used
108this option to ensure that identifiers remain the same across different
109platforms (which may not be the case for HASH identifiers), as we need to
110specify identifiers here for the authentication directives.\n
111
112<p>
113The <i>auth_groups</i> directive specifies the Greenstone groups for to which
114access will be permitted, if the document (or collection) is one of those that
115requires authentication. It is followed by a group name (or a list of group
116names separated by spaces). The Greenstone <i>admin</i> pages allow you to
117define groups and add members to them.\n
118"
119
120
121# -- French text ----------------
122collectionmeta  collectionextra [l=fr] "
123Cette collection de démonstration contient le même contenu que la
124collection de démonstration originale fournie avec Greenstone, mais elle
125inclue également quelques commandes d'authentification basiques. Deux
126documents sont diffusés de maniÚre publique (Farming snails 1 & 2), alors
127que le reste des documents requiÚrent une authentification afin de pouvoir
128les consulter.
129
130<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>
131
132<h3>Comment marche cette collection?</h3>
133
134<p>
135_text1_
136
137<p>
138Le schéma d'authentification contrÎle l'accÚs à la collection. Il fonctionne en
139deux é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.
140
141<p>
142L'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>.
143Ces documents eux-mêmes sont specifiés en utilisant les identificateurs de
144documents de Greenstone (séparés par des espaces) : la façon la plus facile de
145les determiner est de localiser chaque document dans la collection et de
146regarder son argument <i>d</i> dans son URL Greenstone.
147
148<p>_text2_\n
149
150<p>
151La 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
152de 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.
153"
154
155
156# -- Spanish text ----------------
157collectionmeta  collectionextra [l=es] "
158Esta 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.
159<p>
160
161<center><b>
162Para tener acceso a esta colección ingrese el nombre de usuario:
163</b><i>demo</i><b> y la contraseña: </b><i>demo</i>
164</center>
165<p>
166
167<h3>Cómo trabaja esta colección</h3>
168<p>
169
170_text1_
171
172<p>
173El 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.
174<p>
175
176La 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
177
178<p>_text2_\n
179
180La 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.
181"
182
183
184# -- Russian text ----------------
185collectionmeta  collectionextra [l=ru] "
186ДаММая ЎеЌПМстрацОПММая кПллекцОя сПЎержОт те же ЌатерОалы чтП О ПрОгОМальМая ЎеЌПМстрацОПММая кПллекцОя ГрОМстПуМ, МП включает кПЌаМЎы базПвПй аутеМтОфОкацОО. Два ЎПкуЌеМта ЎПступМы Ўля ПткрытПгП ЎПступа (РазвеЎеМОе улОтПк 1 О 2), МП ЎругОе ЎПкуЌеМты требуют вхПЎа Ўля прПсЌПтра.
187
188<p><center><b> Ð”ля ЎПступа к этПй кПллекцОО МеПбхПЎОЌП ввестО user:</b> <i>demo</i> <b>О password:</b> <i>demo</i></center></p>
189
190<h3>Как рабПтает кПллекцОя</h3>\n
191
192<p>
193_text1_
194
195<p>
196СхеЌа аутеМтОфОкацОО управляет ЎПступПЌ к кПллекцОО. ОМа является ЎвухступеМчатПй. СМачала ПМа решает, ПграМОчОть лО ЎПступ к кПллекцОО в целПЌ ОлО к ПтЎельМыЌ ЎПкуЌеМтаЌ. В пПслеЎМеЌ случае ПпреЎеляется, какОе ЎПкуЌеМты являются такПвыЌО (ОлО преЎставляя спОсПк тех ÐŽÐŸÐºÑƒÐŒÐµÐœÑ‚Пв, к кПтПрыЌ требуется разрешеМОе Ма ЎПступ, ОлО же ПпреЎеляя, чтП все ЎПкуЌеМты являются МеЎПступМыЌО  за ОсключеМОеЌ тех, чтП включеМы в спОсПк ПбщеЎПступМых ÐŽÐŸÐºÑƒÐŒÐµÐœÑ‚Пв). ТПгЎа Ўля ЎПкуЌеМтПв ПграМОчеММПгП ЎПступа ПпреЎеляется, какОЌ пПльзПвателяЌ разрешеМ к МОЌ ЎПступ.
197
198<p>
199_text3_ СпецОфОку саЌОх ÐŽÐŸÐºÑƒÐŒÐµÐœÑ‚Пв ПпреЎеляют, ОспПльзуя ОЎеМтОфОкатПры ЎПкуЌеМта в Greenstone (распреЎелеММых Ð¿ÐŸ ПбластяЌ). СаЌый легкОй спПсПб Ох ÐŸÑ‚МесеМОя сПстПОт в тПЌ, чтПбы ПпреЎелОть ЌестПМахПжЎеМОе кажЎПгП ЎПкуЌеМта в кПллекцОО О рассЌПтреть  егП <i>d</i>-аргуЌеМт в URL Greenstone.
200
201<p>_text2_\n
202<p>
203ДОректОва <i>auth_groups</i> ПпреЎеляет группы Greenstone, к кПтПрыЌ ЎПступ буЎет разрешеМ, еслО ЎПкуЌеМт (ОлО кПллекцОя) ПтМПсОтся к теЌ, Ўля кПтПрых Ñ‚ребуется аутеМтОфОкацОя. ЭтП ПпреЎеляется МазваМОеЌ группы (ОлО спОскПЌ МазваМОй групп ПпреЎелеММых ÐŸÐ±Ð»Ð°ÑÑ‚ей). <i>Admin</i> страМОцы Greenstone пПзвПляет ПпреЎелять группы О ЎПбавлять к МОЌ МПвые.
204"
205
Note: See TracBrowser for help on using the browser.