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

Revision 19691, 18.2 KB (checked in by anna, 10 years ago)

Added French translations. Many thanks to Guillaume Hatt and John Rose.

  • Property svn:executable set to *
Line 
1creator     greenstone@cs.waikato.ac.nz
2maintainer  greenstone@cs.waikato.ac.nz
3public      true
4
5buildtype   mgpp
6
7indexes     text dls.Title,Title dls.Subject dls.Organization dls.Keyword
8
9levels  section document
10
11plugin  GreenstoneXMLPlugin
12plugin  HTMLPlugin -description_tags -OIDtype dirname
13plugin  MetadataXMLPlugin
14plugin  ArchivesInfPlugin
15plugin  DirectoryPlugin
16
17classify    List -metadata dls.Title
18
19classify    Hierarchy -metadata "dls.Subject" -sort dls.Title
20
21classify    List -sort_leaf_nodes_using dls.Title -metadata dls.Organization -bookshelf_type always
22
23classify    List -metadata dls.Keyword -buttonname Howto
24
25format CL4VList "<td>[link][icon][/link]</td><td>[link][dls.Keyword][/link]"
26
27format SearchVList "<td valign=top>[link][icon][/link]</td><td>{If}{[parent(All\': \'):Title],[parent(All\': \'):Title]:}[link][Title][/link]</td>"
28
29format 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>"
30
31format DocumentText "<h3>[Title]</h3>\\n\\n<p>[Text]"
32format DocumentImages true
33format DocumentButtons "Expand Text|Expand Contents|Highlight|Detach|Print"
34format DocumentSearchResultLinks true
35
36format HList "[link][highlight][Title][/highlight][/link]"
37
38format DocumentHeading "{Or}{[parent(Top):Title],[Title],untitled}<br>"
39
40format SearchTypes "plain,form"
41
42# Authentication directives
43
44authenticate        document
45public_documents    Jfb33fe Jfb34fe
46
47auth_group      demo
48
49# -- English strings ----------------
50collectionmeta  collectionname [l=en] "Authentication demo"
51
52collectionmeta  .text [l=en] "text"
53collectionmeta  .dls.Title,Title [l=en] "titles"
54collectionmeta  .dls.Subject [l=en] "subjects"
55collectionmeta  .dls.Organization [l=en] "organizations"
56collectionmeta  .dls.Keyword [l=en] "how to"
57
58collectionmeta  .document [l=en] "book"
59collectionmeta  .section [l=en] "chapter"
60
61collectionmeta  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\"}"
62
63# -- French strings ----------------
64collectionmeta  collectionname [l=fr] "Démonstration d\'authentification"
65
66# -- Spanish strings ----------------
67collectionmeta  collectionname [l=es] "Demostración de autenticación"
68
69# -- Russian strings ----------------
70collectionmeta  collectionname [l=ru] "ДеЌПМстрацОя аутеМтОфОкацОО"
71
72# -- Simplified Chinese strings ----------------
73collectionmeta  collectionname [l=zh] "讀证挔瀺銆藏"
74
75collectionmeta  .text [l=zh] "文本"
76collectionmeta  .dls.Title,Title [l=zh] "题名"
77collectionmeta  .dls.Subject [l=zh] "䞻题"
78collectionmeta  .dls.Organization [l=zh] "机构"
79collectionmeta  .dls.Keyword [l=zh] "劂䜕"
80
81collectionmeta  .document [l=zh] "乊"
82collectionmeta  .section [l=zh] "ç« "
83
84# -- English text ----------------
85collectionmeta  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.
86
87<p><center><b> To access this collection try user:</b> <i>demo</i> <b>and password:</b> <i>demo</i></center></p>
88
89<h3>How the collection works</h3>\n
90
91<p>
92The <a href=\"_httpcollection_/etc/collect.cfg\" target=collect.cfg>collection
93configuration file</a> is exactly the same as for the original demo collection apart from the authentication directives, one plugin option (and this description).
94
95<p>
96The authentication scheme controls access to the collection. It works in two
97steps. First it determines whether to restrict access to the collection as a
98whole or to individual documents in it, and in the latter case which documents
99those are (either by giving a list of private documents for which access is to
100be authenticated, or specifying that all documents are private except for a
101given list of public documents). Then for access-restricted documents it
102determines which user groups are to have access.\n
103
104<p>
105Authentication is activated by the <i>authenticate</i> directive with the value
106<i>collection</i> or <i>document</i> depending on whether authentication is to
107be performed on the full collection or on a per-document basis (the default
108value is <i>collection</i>). If authentication is on a <i>document</i> basis,
109then one can <i>either</i> specify a list of private documents (in which
110case all others are public) or a list of public documents (in which case
111all others are private) using directives <i>private_documents</i> or
112<i>public_documents</i>. The documents themselves are specified using Greenstone
113document identifiers (separated by spaces): the easiest way to determine these
114is to locate each document in the collection and look at the <i>d</i> argument
115in its Greenstone URL. \n
116
117<p>In this case, we have used the <i>-OIDtype dirname</i> option to HTMLPlugin,
118which specifies that directory names should be used as identifiers. This works
119for collections where each document is in a separate directory. We have used
120this option to ensure that identifiers remain the same across different
121platforms (which may not be the case for HASH identifiers), as we need to
122specify identifiers here for the authentication directives.\n
123
124<p>
125The <i>auth_groups</i> directive specifies the Greenstone groups for to which
126access will be permitted, if the document (or collection) is one of those that
127requires authentication. It is followed by a group name (or a list of group
128names separated by spaces). The Greenstone <i>admin</i> pages allow you to
129define groups and add members to them.\n
130"
131
132# -- French text ----------------
133collectionmeta  collectionextra [l=fr] "
134Cette collection de démonstration contient le même contenu que la
135collection de démonstration originale fournie avec Greenstone, mais elle
136inclue également quelques commandes d\'authentification basiques. Deux
137documents sont diffusés de maniÚre publique (Farming snails 1 & 2), alors
138que le reste des documents requiÚrent une authentification afin de pouvoir
139les consulter.
140
141<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>
142
143<h3>Comment marche cette collection?</h3>
144
145<p>
146Ce <a href=\"_httpcollection_/etc/collect.cfg\" target=collect.cfg>fichier de configuration de collection</a> est exactement le même que celui de la collection de démonstration originale sauf pour les directives d'authentification, une option de plugiciel (et cette description).
147
148<p>
149Le schéma d\'authentification contrÎle l\'accÚs à la collection. Il fonctionne en
150deux é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.
151
152<p>
153L\'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>.
154Ces documents eux-mêmes sont specifiés en utilisant les identificateurs de
155documents de Greenstone (séparés par des espaces) : la façon la plus facile de
156les determiner est de localiser chaque document dans la collection et de
157regarder son argument <i>d</i> dans son URL Greenstone.
158
159<p>Dans ce cas, nous avons utilisé l'option <i>-OIDtype dirname</i> du plugiciel HTMLPlugin, qui précise que les noms de répertoires seront utilisés comme identifiants. Cela fonctionne pour les collections dans lesquelles chaque document est stocké dans un répertoire distinct. Nous avons utilisé cette option pour que les identifiants restent identiques sur différentes plateformes (ce qui ne pourrait être le cas avec les identifiants de hachage), puisque nous avons besoin ici de préciser les identifiants pour définir les options d'identification.\n
160
161<p>
162La 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
163de 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.
164"
165
166# -- Spanish text ----------------
167collectionmeta  collectionextra [l=es] "
168Esta 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.
169<p>
170
171<center><b>
172Para tener acceso a esta colección ingrese el nombre de usuario:
173</b><i>demo</i><b> y la contraseña: </b><i>demo</i>
174</center>
175<p>
176
177<h3>Cómo trabaja esta colección</h3>
178<p>
179El <a href=\"_httpcollection_/etc/collect.cfg\" target=collect.cfg>archivo de configuración</a> es exactamente el mismo que el de la demo original salvo las directivas para la autenticación (y su descripción).
180
181<p>
182El 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.
183<p>
184
185La 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
186
187<p>En este caso, hemos usado la opción <i>-OIDtype dirname</i> del HTMLPlugin,
188la cual especifica que deben usarse los nombres de las carpetas como identificadores. Esto funciona para cualquier colección en donde cada documento está en una carpeta separada. Hemos usado esta opción para asegurarnos de que los identificadores permanezcan inalterados en diferentes plataformas (lo cual no es el caso de los identificadores HASH), ya que aquí necesitamos especificar identificadores en las directivas de autenticación.\n
189
190La 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.
191"
192
193# -- Russian text ----------------
194collectionmeta  collectionextra [l=ru] "
195ДаММая ЎеЌПМстрацОПММая кПллекцОя сПЎержОт те же ЌатерОалы чтП О ПрОгОМальМая ЎеЌПМстрацОПММая кПллекцОя ГрОМстПуМ, МП включает кПЌаМЎы базПвПй аутеМтОфОкацОО. Два ЎПкуЌеМта ЎПступМы Ўля ПткрытПгП ЎПступа (РазвеЎеМОе улОтПк 1 О 2), МП ЎругОе ЎПкуЌеМты требуют вхПЎа Ўля прПсЌПтра.
196
197<p><center><b> Ð”ля ЎПступа к этПй кПллекцОО МеПбхПЎОЌП ввестО user:</b> <i>demo</i> <b>О password:</b> <i>demo</i></center></p>
198
199<h3>Как рабПтает кПллекцОя</h3>\n
200
201<p>
202<!-- _text1_  -->
203
204<p>
205СхеЌа аутеМтОфОкацОО управляет ЎПступПЌ к кПллекцОО. ОМа является ЎвухступеМчатПй. СМачала ПМа решает, ПграМОчОть лО ЎПступ к кПллекцОО в целПЌ ОлО к ПтЎельМыЌ ЎПкуЌеМтаЌ. В пПслеЎМеЌ случае ПпреЎеляется, какОе ЎПкуЌеМты являются такПвыЌО (ОлО преЎставляя спОсПк тех ÐŽÐŸÐºÑƒÐŒÐµÐœÑ‚Пв, к кПтПрыЌ требуется разрешеМОе Ма ЎПступ, ОлО же ПпреЎеляя, чтП все ЎПкуЌеМты являются МеЎПступМыЌО за ОсключеМОеЌ тех, чтП включеМы в спОсПк ПбщеЎПступМых ÐŽÐŸÐºÑƒÐŒÐµÐœÑ‚Пв). ТПгЎа Ўля ЎПкуЌеМтПв ПграМОчеММПгП ЎПступа ПпреЎеляется, какОЌ пПльзПвателяЌ разрешеМ к МОЌ ЎПступ.
206
207<p>
208<!-- _text3_ --> СпецОфОку саЌОх ÐŽÐŸÐºÑƒÐŒÐµÐœÑ‚Пв ПпреЎеляют, ОспПльзуя ОЎеМтОфОкатПры ЎПкуЌеМта в Greenstone (распреЎелеММых Ð¿ÐŸ ПбластяЌ). СаЌый легкОй спПсПб Ох ÐŸÑ‚МесеМОя сПстПОт в тПЌ, чтПбы ПпреЎелОть ЌестПМахПжЎеМОе кажЎПгП ЎПкуЌеМта в кПллекцОО О рассЌПтреть егП <i>d</i>-аргуЌеМт в URL Greenstone.
209
210<p><!-- _text2_ -->\n
211<p>
212ДОректОва <i>auth_groups</i> ПпреЎеляет группы Greenstone, к кПтПрыЌ ЎПступ буЎет разрешеМ, еслО ЎПкуЌеМт (ОлО кПллекцОя) ПтМПсОтся к теЌ, Ўля кПтПрых Ñ‚ребуется аутеМтОфОкацОя. ЭтП ПпреЎеляется МазваМОеЌ группы (ОлО спОскПЌ МазваМОй групп ПпреЎелеММых ÐŸÐ±Ð»Ð°ÑÑ‚ей). <i>Admin</i> страМОцы Greenstone пПзвПляет ПпреЎелять группы О ЎПбавлять к МОЌ МПвые.
213"
214
215# -- Simplified Chinese text ----------------
216collectionmeta  collectionextra [l=zh] "
217本挔瀺銆藏所包含的文档䞎Greenstone挔瀺銆藏䞭䞀样䜆本銆藏还包括䞀些基本的讀证功胜。
218其䞭䞀䞪文档是公共可见的Farming snails 1 和 2而其他的文档则芁求先登圕再浏览。
219<p><center><b>芁访问本銆藏甚户名䞺</b> <i>demo</i> <b>密码䞺:</b>
220<i>demo</i></center></p> 
221 
222<h3>本銆藏劂䜕工䜜</h3>\n
223 
224<p>陀了讀证配眮䞀䞪插件参数以及本銆藏描述之倖本銆藏的
225<a href=\"_httpcollection_/etc/collect.cfg\" target=collect.cfg>配眮文件</a>䞎挔瀺銆藏的
226配眮文件䞀暡䞀样。
227 
228<p>讀证暡匏控制本銆藏的访问权限。讀证暡匏分䞀步。銖先它确定是吊对敎䞪銆藏或者銆藏䞭的单
229䞪文档进行访问限制而圚后者情况䞋芁么讟定䞀䞪需芁讀证才胜访问的私有文档列衚或者给定
230䞀䞪公共文档列衚陀该列衚之倖所有文档均䞺私有文档。然后对限制性访问的文档确定哪些甚户组
231拥有访问权限。\n
232 
233<p>讀证暡匏由讟定<i>authenticate</i>参数的倌䞺<i>collection</i>或者<i>document</i>
234来激掻取哪䞪倌取决于是吊圚敎䞪銆藏或者单䞪文档的基础䞊进行讀证猺省倌䞺<i>collection</i>。
235劂果讀证是基于<i>document</i>文档的则<i>芁么</i>讟定䞀䞪私有文档的列衚歀时所有其他
236文档郜将是公共文档或者讟定䞀䞪公共文档列衚歀时所有其他文档郜是私有文档这通过䜿甚
237<i>private_documents</i>或者<i>public_documents</i>参数来讟眮。文档本身甚Greenstone的
238文档标识笊以空栌闎隔确定这些文档的最简单方匏是圚銆藏䞭扟到这些文档然后查看它们
239Greenstone URL的<i>d</i>参数倌。\n
240 
241<p>圚这种情况䞋我们已经讟眮了HTMLPlugin的<i>-OIDtype dirname</i>参数该参数指明文件目圕名
242应被甚䜜标识笊。这种讟眮适甚于每䞪文档郜圚䞀䞪单独的文件目圕䞭。我们䜿甚这䞪选项来确保圚䞍同系统䞋
243这些标识笊郜是䞀样的而HASH标识笊圚䞍同系统䞭可胜䞍同因䞺我们需芁圚<i>authenticate</i>参数
244䞭甚到这些标识笊。\n
245 
246<p><i>auth_groups</i>参数指定了允讞访问的Greenstone甚户组劂果该文档或銆藏是需芁讀证的。
247圚这䞪参数后面是䞀䞪组名或者是䞀䞪甚空栌闎隔的组名列衚。Greenstone <i>admin</i>页面提䟛了
248定义甚户组以及添加甚户到甚户组的功胜。\n
249"
Note: See TracBrowser for help on using the browser.