Pleade Paramètres configurables par les archivistes

Cette section décrit les paramètres du fichier : <app>/parametres.xconf

Ce fichier contient des paramètres utiles dans tous les modules Pleade. Il est donc nécessaire d'y porter attention pour toute installation. Il s'agit d'un fichier XML ; il est donc conseillé d'utiliser un éditeur XML ou un éditeur de texte qui respecte le jeu de caractères Unicode UTF-8 pour y effectuer des modifications.

Pour modifier un paramètre, il suffit de modifier le contenu de l'élément, sans toucher aux balises.

Paramètres principaux

default-lang

Paramètre	Défaut	Valeurs possible	Description
<default-lang>	fr	fr en	La langue par défaut de l'interface

enable-language-selection

Paramètre	Défaut	Valeurs possible	Description
<enable-language-selection>	false	true false	Active la sélection de la langue depuis l'interface

Fonctionnalités EADEAC

Certaines fonctionnalités du module eadeac peuvent être activées ou désactivées en modifiant simplement la valeur d'un paramètre :

eadeac-active-eac

Paramètre	Défaut	Valeurs possible	Description
<eadeac-active-eac>	true	true false	Active l'affichage des notices EAC dans la fenêtre EAD

eadeac-active-basket

Paramètre	Défaut	Valeurs possible	Description
<eadeac-active-basket>	true	true false	Active le porte-documents

eadeac-active-basket-zip

Paramètre	Défaut	Valeurs possible	Description
<eadeac-active-basket-zip>	true	true false	Active l'export ZIP du contenu du porte documents avec les pièces attachées

eadeac-basket-zip-include-doc

Paramètre	Défaut	Valeurs possible	Description
<eadeac-basket-zip-include-doc>	true	true false	Permet l'inclusion du fragment lui même (au format PDF) dans l'export ZIP

eadeac-active-basket-pdf

Paramètre	Défaut	Valeurs possible	Description
<eadeac-active-basket-pdf>	true	true false	Export du contenu du panier au format PDF

eadeac-format-basket-pdf

Paramètre	Défaut	Valeurs possible	Description
<eadeac-format-basket-pdf>	document	document basket	Format de l'export PDF du panier To do : à compléter.

eadeac-persistent-basket

Paramètre	Défaut	Valeurs possible	Description
<eadeac-persistent-basket>	false	true false	Activation du panier persistant (stockage en base de données pour chaque utilisateur).

eadeac-active-pdf

Paramètre	Défaut	Valeurs possible	Description
<eadeac-active-pdf>	true	true false	Active l'export PDF

eadeac-pdf-use-special

Paramètre	Défaut	Valeurs possible	Description
<eadeac-pdf-use-special>	(vide)	vide, XSL-FO standards ; /path/to/custom-xsl-fo-dir/	Spécifie si l'export PDF doit utiliser des feuilles de style particulières : si vide : XSL-FO standards de Pleade libre ; sinon dossier contenant les XSL-FO spécifiques (situé au même endroit que les XSL-FO standards).

eadeac-active-synch-toc

Paramètre	Défaut	Valeurs possible	Description
<eadeac-active-synch-toc>	true	true false	Active la synchronisation du fragment EAD avec le sommaire dans la fenêtre EAD

Paramètres relatifs aux formulaires de recherche, à l'affichage des résultats, cadre de classement, rubrique, etc.

ead-max-results

Paramètre	Défaut	Valeurs possible	Description
<ead-max-results>	1000	n (entier positif)	Le nombre maximal de résultats de recherche qui seront affichés.

sort-limit

Paramètre	Défaut	Valeurs possible	Description
<sort-limit>	100	n (entier positif)	Le nombre de résultats à partir duquel on désactive les fonctionnalités de tri, pour éviter de surcharger le serveur.

ead-docs-not-searchable

Paramètre	Défaut	Valeurs possible	Description
<ead-docs-not-searchable>	(vide)	liste d'<eadid>	La liste des identifiants de documents EAD qui ne doivent pas être retournés dans des résultats de recherche.

ead-cdc-results-auto-expand

Paramètre	Défaut	Valeurs possible	Description
<ead-cdc-results-auto-expand>	_all	_all, déplie tous les niveaux ; n (entier positif), déplie n niveaux ; docs:n, déplie s'il y a au moins n documents résultats ; units:n, déplie s'il y a au moins n unités résultats ; docs:n;units:n : déplie si l'un des deux critères est satisfait.	Niveau déplié par défaut pour le cadre de classement, dans les résultats de recherche. To do : J'ai trouvé deux définitions contradictoires, laquelle est la bonne ? docs:10;units:100, « ouvre s'il y a 10 documents ou 100 unités » ; docs:10;units:100, ouvre s'il y a moins de 10 documents (instruments de recherche) ou s'il y a moins de 100 unités de description qui ont été trouvés. .

eadeac-cdc-result-sort-key

Paramètre	Défaut	Valeurs possible	Description
<eadeac-cdc-result-sort-key>	(vide)	champs de recherche	La liste des clés de tri pour les IR d'une rubrique du cadre de classement ou d'une rubrique (subset), séparées par un « ; » (point-virgule). Une clé de tri est un champ qui paraît dans les résultats de recherche (champ déclaré avec l'attribut brief="true").

ead-cdc-auto-expand

Paramètre	Défaut	Valeurs possible	Description
<ead-cdc-auto-expand>	0 (zéro)	entier positif, indique le nombre de niveaux à déplier (ainsi 1 ouvre le premier niveau, le second niveau sera visible) ; _all, tous les niveaux seront ouverts.	Depuis Pleade-3.4. Niveau déplié par défaut pour le cadre de classement. Notice : L'ouverture de tous les niveaux peut se révéler gourmand en ressources sur le poste de l'utilisateur. N'utilisez un niveau élevé ou la valeur _all que si votre cadre de classement n'est pas trop gros.

news-days

Paramètre	Défaut	Valeurs possible	Description
<news-days>	20	n (entier positif)	Le nombre de jours durant lesquels une publication est considérée comme nouvelle. Toute publication nouvelle sera marquée dans le cadre de classement et les résultats de recherche. Pour désactiver cette fonctionnalité, il suffit d'indiquer 0.

news-maxratio

Paramètre	Défaut	Valeurs possible	Description
<news-maxratio>	100	n (entier positif)	Le pourcentage à partir duquel on ne distingue plus de nouveautés. Par exemple, si la valeur est 60 et si plus de 60% des IR sont nouvellement publiés, l'indication ne s'affichera pas. Ceci permet d'éviter que l'ensemble des documents soient marqués comme nouveaux en cas de (re-)publication d'un grand lot d'IR.

eadeac-suggest-hpp

Paramètre	Défaut	Valeurs possible	Description
<eadeac-suggest-hpp>	10	n (entier positif)	Le nombre d'occurrences retournées dans les listes de suggestions des formulaires de recherche. Important : Il faut aussi adapter autoComp.maxResultsDisplayed dans <app>/theme/js/module-eadeac-search-form.js.

suggest-starts-with

Paramètre	Défaut	Valeurs possible	Description
<suggest-starts-with>	false	true false	Les résultats du suggest sont ceux : commençants par le terme saisi (true) ; contenants le terme saisi (false).

Gestion des droits (LDAP)

acces-all-users

Paramètre	Défaut	Valeurs possible	Description
<acces-all-users>	all	all, (vide), liste d'utilisateurs séparés par « ; ».	Liste des utilisateurs qui ont accés à tout les documents. all signifie que tout les utilisateurs ont accés. vide, on considére qu'on est dans le mode all Liste d'utilisateurs séparés par « ; » (point-virgule). To do : À valider.

acces-all-groups

Paramètre	Défaut	Valeurs possible	Description
<acces-all-groups>	all	all, (vide), liste de groupes séparés par « ; ».	Liste des groupes qui ont accé à tout les documents. all signifie que tout les groupes ont accés. vide, on considére qu'on est dans le mode all Liste de groupes séparés par « ; » (point-virgule). To do : À valider.

Gestion des mode d'affichage pour les résultats de recherche EAD

ead-default-print-result-mode

Paramètre	Défaut	Valeurs possible	Description
<ead-default-print-result-mode>	cdc	cdc, tab, mosaic, custom,	Depuis Pleade-3.5. C'est le mode d'affichage par défaut des résultats EAD. Si ce paramètre est vide ou, si les problême persiste, c'est le format cdc qui est utilisé. Si aucun mode n'est spécifié pour un résultats, c'est ce mode d'affichage qui sera utilisé. S'il contient un élément alors, dans la page d'affichage des résultats de recherche, le box de sélection des formats ne sera pas affiché.

Exemple:

<ead-default-print-result-mode>cdc</ead-default-print-result-mode>

Utilisation de l'attribut action

To do :

À déplacer dans la doc des formulaires.

On peut également définir le format d'affichage utilisé dans l'écran des résultats valide avec le formulaire de recherche avec l'attribut action de la balise <form>.

Pour avoir le format souhaité, la valeur se trouvant dans l'attribut action doit être précédé du code du format souhaité plus un tiret. Exemple:

<form
  action="mosaic-results.html"
>
  ...
</form>

ead-print-result-mode-activated

Paramètre	Défaut	Valeurs possible	Description
<ead-print-result-mode-activated>	mosaic;cdc;tab	cdc, tab, mosaic, custom, composition des valeurs précédentes.	Depuis Pleade-3.5. Indique la liste des modes d'affichage qui sont actifs. Les élements sont séparés par un « ; » (point-virgule), sans espace. Si la valeur est vide, on utilise le mode par défaut (cf <ead-default-print-result-mode>). L'ordre des valeurs controle l'ordre d'affichage des boutons dans l'interface.

Exemple:

<ead-print-result-mode-activated>mosaic;cdc;tab</ead-print-result-mode-activated>

ead-cdc-show-not-illustrated

Paramètre	Défaut	Valeurs possible	Description
<ead-cdc-show-not-illustrated>	false	false, true,	Depuis Pleade-3.5. La valeur true permet l'affichage, dans le mode cdc, des résultats sans illustrations.

Exemple :

<ead-cdc-show-not-illustrated>true</ead-cdc-show-not-illustrated>

ead-mosaic-show-not-illustrated

Paramètre	Défaut	Valeurs possible	Description
<ead-mosaic-show-not-illustrated>	false	false, true,	Depuis Pleade-3.5. La valeur true permet l'affichage, dans le mode mosaic, des résultats sans illustrations.

Exemple :

<ead-mosaic-show-not-illustrated>true</ead-mosaic-show-not-illustrated>

ead-tab-show-not-illustrated

Paramètre	Défaut	Valeurs possible	Description
<ead-tab-show-not-illustrated>	false	false, true,	Depuis Pleade-3.5. La valeur true permet l'affichage, dans le mode tab, des résultats sans illustrations.

Exemple:

<ead-tab-show-not-illustrated>true</ead-tab-show-not-illustrated>

eadeac-search-help-mode

Paramètre	Défaut	Valeurs possible	Description
<eadeac-search-help-mode>	panels	panels tooltips	Le mode d'affichage de l'aide dans les formulaires de recherche.

eadeac-navindex-from-input

Paramètre	Défaut	Valeurs possible	Description
<eadeac-navindex-from-input>	false	true false	Prise en compte de la saisie de l'utilisateur dans un champ à l'ouverture de la liste des index correspondant.

display-modes

To do :

À déplacer dans la doc des formulaires.

Paramètre	Défaut	Valeurs possible	Description
display-modes	cdc, tab, mosaic, custom, composition des valeurs précédentes.	-	Depuis Pleade-3.5. Indique les formats d'affichage qui seront disponible dans la page de résultats. C'est un attribut à placer dans la balise <form> du fichier de configuration de votre formulaire. Son comportement est identique à celui de <ead-print-result-mode-activated>. Si le paramètre est présent mais vide, c'est l'équivalent de display-mode="cdc".

Exemple :

<form
  action="results.html"
  max-chars="50"
  documents="ead"
  display-modes="cdc;mosaic"
>
    ...
</form>

only-illustrated

To do :

À déplacer dans la doc des formulaires.

Paramètre	Défaut	Valeurs possible	Description
<only-illustrated>	false	true false	Depuis Pleade-3.5. Permet l'affichage des résultats sans illustrations. C'est un attribut à placer dans la balise <form> du fichier de configuration de votre formulaire. La valeur true permet l'affichage, dans le mode cdc, des résultats sans illustrations. Ce paramètre impacte tous les formats d'affichage qui ont été défini dans le formulaire de recherche (EAD, METS, etc.) Si only-illsutrated="true", seule les résultats illustrés seront affichés.

<form
  action="results.html"
  max-chars="50"
  documents="ead"
  only-illustrated="true"
>
    ...
</form>

Personnalisation de l'affichage d'un document dans la fenêtre EAD

ead-archdesc-toc

Paramètre	Défaut	Valeurs possible	Description
<ead-archdesc-toc>	true	true false	Affichage du premier niveau de description (<archdesc>) avec un sommaire pour naviguer plus facilement.

img-thumbnail-size

Paramètre	Défaut	Valeurs possible	Description
<img-thumbnail-size>	150	n (entier positif)	Taille, en pixels, des vignettes affichées dans la fenêtre EAD. Remarques : Ce paramètre ne s'applique que dans le cas de vignettes non pré-traitées.

ead-docs-not-searchable-specific-form

Paramètre	Défaut	Valeurs possible	Description
<ead-docs-not-searchable-specific-form>	false	true false	Depuis Pleade-3.3.2. Affichage du formulaire de recherche spécifique pour les documents EAD non cherchables. Par défaut (valeur false), à la place du formulaire, on affiche un message signalant que le document n'est pas cherchable ; Si ce paramètre vaut true, la recherche spécique s'effectue aussi sur les unités non cherchables (searchable=0).

Personnalisation de la visionneuse

nombre-maximal-images

Paramètre	Défaut	Valeurs possible	Description
<nombre-maximal-images>	10	entier positif	Le nombre maximal d'images que l'on peut télécharger dans un ZIP ou un PDF.

Personnalisation des impressions

eadeac-images-in-pdf

Paramètre	Défaut	Valeurs possible	Description
<eadeac-images-in-pdf>	unit-only	none, aucune image ; all, images partout ; unit-only, seulement dans les PDF simples, sans sous-unités. To do : n-limited, à implémenter.	Méthode de traitement des images pour les impressions PDF d'unités documentaires EAD. Par défaut, les images ne sont incluses que dans l'impression d'une unité documentaire seule.

droits

Paramètre	Défaut	Valeurs possible	Description
<droits>	Pleade 3 - ACHANGER	texte libre	La mention de copyright à inclure dans les PDF et les images téléchargées

Personnalisation de l'entrepôt OAI

ead-oai-repo-name

Paramètre	Défaut	Valeurs possible	Description
<ead-oai-repo-name>	(vide)	texte libre Important : Le nom est requis pour que l'entrepôt OAI soit actif.	Le nom de l'entrepôt OAI.

ead-oai-repo-admin-email

Paramètre	Défaut	Valeurs possible	Description
<ead-oai-repo-admin-email>	(vide)	une adresse email valide	L'adresse de courriel associée à l'entrepôt OAI.

ead-oai-repo-nb

Paramètre	Défaut	Valeurs possible	Description
<ead-oai-repo-nb>	100	n (entier positif)	Le nombre d'enregistrements retournés par « page » OAI.

ead-oai-repo-records

Paramètre	Défaut	Valeurs possible	Description
<ead-oai-repo-records>	components	components finding aids	Indique si l'entrepôt OAI est constitué : d'instruments de recherche (« finding aids ») d'unités de description (« components »).

ead-oai-pleade-title

Paramètre	Défaut	Valeurs possible	Description
<ead-oai-pleade-title>	get-title-unittitle	-	Méthode de construction du titre généré pour l'enregistrement OAI d'un composant. Les valeurs possibles correspondent aux codes des méthodes de construction du titre généré du formulaire de publication des documents EAD. To do : À préciser.

ead-oai-pleade-title-sep

Paramètre	Défaut	Valeurs possible	Description
<ead-oai-pleade-title-sep>	// (deux barres obliques)	toute chaîne de caractères	Séparateur à utiliser entre les éléments d'informations constituant le titre généré.

ead-oai-pleade-title-lang

Paramètre	Défaut	Valeurs possible	Description
<ead-oai-pleade-title-lang>	fr	-	Langue du titre des enregistrements OAI. Notice : Ce paramètre est obsolète.

ead-oai-includehasPart

Paramètre	Défaut	Valeurs possible	Description
<ead-oai-includehasPart>	false	true false	Inclusion des liens vers les sous-unités dans l'enregistrement d'un composant.

ead-oai-inheritDesc

Paramètre	Défaut	Valeurs possible	Description
<ead-oai-inheritDesc>	false	true false	Inclusion des descripteurs des composants parent dans l'enregistrement OAI d'un composant.

ead-oai-relationMode

Paramètre	Défaut	Valeurs possible	Description
<ead-oai-relationMode>	url	url filename	Forme sous laquelle seront écrites les relations (liens) dans les enregistrements OAI.

Répertoires des documents (EAD, EAC, METS)

Important :

Pour le moment on ne modifie pas ces paramètres.

<ead-docs-dir>${pleade.ead-docs-dir}</ead-docs-dir>
<eac-docs-dir>${pleade.eac-docs-dir}</eac-docs-dir>
<mets-docs-dir>${pleade.mets-docs-dir}</mets-docs-dir>

Paramétrage de l'affichage des résultats

show-bottom-pagination

Paramètre	Défaut	Valeurs possible	Description
<show-bottom-pagination>	false	false, pas d'affichage (la navigation est présente uniquement en haut) ; true, affichage de la navigation en pied de page ;	Depuis Pleade-3.5. Contrôle l’affichage -en doublon- du bloc de navigation en pied de page. Cette double navigation n’apparaît pas si il aucun ou trop de résultats sont retournés.

notice-as-modal

Paramètre	Défaut	Valeurs possible	Description
<notice-as-modal>	false	true, une pop-in modal est utilisé ; false, nouvel écran ;	Depuis Pleade-3.5. Contrôle la façon dont les notices seront ouverte dans le contexte des résultats de recherche : une pop-in modal ; nouvel écran. To do : pour l'EAD je force la désactivation car il y encore pas mal de travail suite a la perte de contexte (cf. <app>/module-eadeac/xsl/mosaic-results.xsl puis le template mode="add-link-to-ead").

Default (false)	true
-

Contrôle des formulaires de recherche

show-search-form-in-result

Paramètre	Défaut	Valeurs possible	Description
<show-search-form-in-result>	false	true false	Depuis Pleade-3.4. Affichage du formulaire dans le contexte des résultats de recherche. Lorsque cette option est activée, le formulaire de recherche s'affichera dans les cas : aucun résultat ; trop de résultats. Et on masquera le bouton pour modifier la requête.

Default (false)	true