X-Git-Url: http://lists.indexdata.dk/cgi-bin?a=blobdiff_plain;f=doc%2Fpazpar2_conf.xml;h=5c81fb514d6539be166c7cb53b5290d7a91f3c9e;hb=01ea3147d50de8e22e1999135ee26bfdec6c0ecc;hp=b3a7068a2497eb3d7cbc4a20bb03ad13225e9119;hpb=aa701392d44695d923349ccc36bb7ba6c4373b6a;p=pazpar2-moved-to-github.git diff --git a/doc/pazpar2_conf.xml b/doc/pazpar2_conf.xml index b3a7068..5c81fb5 100644 --- a/doc/pazpar2_conf.xml +++ b/doc/pazpar2_conf.xml @@ -8,7 +8,7 @@ %common; ]> - + Pazpar2 @@ -121,9 +121,7 @@ This nested element controls the behavior of pazpar2 with respect to your data model. In pazpar2, incoming records are - normalized, using XSLT, into an internal representation (see - the retrievalprofile secion. + normalized, using XSLT, into an internal representation. The 'service' section controls the further processing and extraction of data from the internal representation, primarily through the 'metdata' sub-element. @@ -244,91 +242,6 @@ - queryprofile - - At the moment, this directive is ignored; there is one global - CCL-mapping file which governs the mapping of queries to Z39.50 - type-1. This file is located in etc/default.bib. This will change - shortly. - - - - retrievalprofile - - Note: In the present version, there is a single retrieval - profile. However, in a future release, it will be possible to - associate unique retrieval profiles with different targets, or to - generate retrieval profiles using XSLT from the ZeeRex description of - a target. - - - - The following data elements are recognized for the retrievalprofile - directive: - - - - requestsyntax - - - This element specifies the request syntax to be used in queries. It only - makes sense for Z39.50-type targets. - - - - - nativesyntax - - - This element specifies the native syntax and encoding of the - result records. The default is XML. The following attributes - are defined: - - - name - - - The name of the syntax. Currently recognized values are - 'iso2709' (MARC), and 'xml'. - - - - - format - - - The format, or schema, to be expected. Default is - 'marc21'. - - - - - encoding - - - The encoding of the response record. Typical values for - MARC records are 'marc8' (general MARC-8), 'marc8s' - (MARC-8, but maps to precomposed UTF-8 characters, more - suitable for use in web browsers), 'latin1'. - - - - - mapto - - - Specifies the flavor of MARCXML to map results to. - Default is 'marcxml'. 'marcxchange' is also possible, and - useful for Danish DANMARC records. - - - - - - - - - EXAMPLE @@ -356,21 +269,12 @@ - - - - marc21 - - - - ]]> - TARGET SETTINGS + TARGET SETTINGS Pazpar2 features a cunning scheme by which you can associate various kinds of attributes, or settings with search targets. This is done @@ -381,8 +285,8 @@ search against a given target, or it can associate arbitrary name=value pairs with groups of targets -- for instance, if you would like to place all commercial full-text bases in one group for selection - purposes, or you would like to control what targets are accessible to a - given user. + purposes, or you would like to control what targets are accessible + to users by default. @@ -391,11 +295,25 @@ process any settings files found therein. + + Clients of the pazpar2 webservice interface can selectively override + settings for individual targets within the scope of one session. This + can be used in conjunction with an external authentication system to + determine which resources are to be accessible to which users. Pazpar2 + itself has no notion of end-users, and so can be used in conjunction + with any type of authentication system. Similarly, the authentication + tokens submitted to access-controlled search targets can similarly be + overriden, to allow use of pazpar2 in a consortial or multi-library + environment, where different end-users may need to be represented to + some search targets in different ways. This, again, can be managed + using an external database or other lookup mechanism. + + SETTINGS FILE FORMAT Each file contains a root element named <settings>. It may contain one or more <set> elements. The settings and set - elements may contain the following attributes. Attributes in set + elements may contain the following attributes. Attributes in the set node overrides those in the setting root element. Each set node must specify (directly, or inherited from the parent node) at least a target, name, and value. @@ -426,17 +344,6 @@ - - user - - - This specifies the user ID to which this setting applies. A - given setting may have values for any number of users, or it - may have a 'default' value which is applied when no user is - specified, or when no user-specific value is available. - - - name @@ -475,7 +382,7 @@ - By setting defaults for user, target, name, or value in the root + By setting defaults for target, name, or value in the root settings node, you can use the settings files in many different ways. For instance, you can use a single file to set defaults for many different settings, like search fields, retrieval syntaxes, @@ -486,6 +393,74 @@ within your application. + + The following examples illustrate uses of the settings system to + associate settings with targets to meet different requirements. + + + + The example below associates a set of default values that can be + used across many targets. Note the wildcard for targets. + This associates the given settings with all targets for which no + other information is provided. + + + + + + + + + + + + + + + + + + + + + + + + + + + + ]]> + + + + The next example shows certain settings overriden for one target, + one which returns XML records containing DublinCore elements, and + which furthermore requires a username/password. + + + + + + + + ]]> + + + + The following example associates a specific name/value combination + with a number of targets. The targets below are access-restricted, + and can only be used by users with special credentials. + + + + + ]]> + + RESERVED SETTING NAMES @@ -513,11 +488,12 @@ - pz:syntax + pz:requestsyntax This specifies the record syntax to use when requesting - records from a given server. + records from a given server. The value can be a symbolic name like + marc21 or xml, or it can be a Z39.50-style dot-separated OID. @@ -543,6 +519,74 @@ + + pz:nativesyntax + + + The representation (syntax) of the retrieval records. Currently + recognized values are iso2709 and xml. + + + + + pz:encoding + + + The native encoding (character set) of retrieval records. Can be anything + recognized by conv, but typical values are marc8 and latin1. + The default is UTF-8. + + + + + pz:xslt + + + Provides the path of an XSLT stylesheet which will be used to + map incoming records to the internal representation. + + + + + pz:authentication + + + Sets an authentication string for a given server. See the section on + authorization and authentication for discussion. + + + + + pz:allow + + + Allows or denies access to the resources it is applied to. Possible + values are '0' and '1'. The default is '1' (allow access to this resource). + See the manual section on authorization and authentication for discussion + about how to use this setting. + + + + + pz:maxrecs + + + Controls the maximum number of records to be retrieved from a + server. The default is 100. + + + + + pz:id + + + This setting can't be 'set' -- it contains the ID (normally + ZURL) for a given target, and is useful for filtering -- + specifically when you want to select one or more specific + targets in the search command. + + +