Il y a 389 articles et 19 utilisateurs inscrits (ce bandeau est défini dans MediaWiki:Sitenotice)

« Pleade Paramètres configurables par les archivistes » : différence entre les versions

De AJLSM
Aller à la navigation Aller à la recherche
← Modification précédente

Groche (discussion | contributions)

2 groupes d'utilisateurs
312 modifications
annuler
VisuelWikicode
m ajout catégorie: annexe
 
(17 versions intermédiaires par le même utilisateur non affichées)
Ligne 1 : Ligne 1 :
= Paramètres adaptables par les archivistes ({{path|parametres.xconf}}) =
Cette section décrit les paramètres du fichier : {{path|{{app}}/parametres.xconf}}
 
Ce fichier se trouve à l'emplacement suivant : {{path|{{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 {{value|UTF-8}} pour y effectuer des modifications.
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 {{value|UTF-8}} pour y effectuer des modifications.
Ligne 9 : Ligne 7 :
== Paramètres principaux ==
== Paramètres principaux ==


{| class="wikitable sortable"
=== {{var|default-lang}} ===
{| class="wikitable"
|-
|-
!Paramètre !! Description
! Paramètre !! Défaut !! Valeurs possible !! Description
|-
| {{tag|default-lang}}
|| {{value|fr}}
||
* {{value|fr}}
* {{value|en}}
|| La langue par défaut de l'interface
|}
=== {{var|enable-language-selection}} ===
{| class="wikitable"
|-
|-
| {{var|default-lang}} || La langue par défaut de l'interface
! Paramètre !! Défaut !! Valeurs possible !! Description
* Valeur par défaut : {{value|fr}} ;
* Valeurs autorisées : {{value|fr}}, {{value|en}}.
|-
|-
| {{var|enable-language-selection}} || Active la sélection de la langue depuis l'interface
| {{tag|enable-language-selection}}
* Valeur par défaut : {{value|false}} ;
|| {{value|false}}
* Valeurs autorisées : {{value|true}} ou {{value|false}}
||
* {{value|true}}
*  {{value|false}}
|| Active la sélection de la langue depuis l'interface
|}
|}
== Fonctionnalités EADEAC ==
== 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 :
Certaines fonctionnalités du module eadeac peuvent être activées ou désactivées en modifiant simplement la valeur d'un paramètre :
{| class="wikitable sortable"
 
=== {{var|eadeac-active-eac}} ===
{| class="wikitable"
|-
|-
!Paramètre !! Description
! Paramètre !! Défaut !! Valeurs possible !! Description
|-
|-
| {{var|eadeac-active-eac}} || Active l'affichage des notices EAC dans la fenêtre EAD
| {{tag|eadeac-active-eac}}
* Valeur par défaut : {{value|true}} ;
|| {{value|true}}
* Valeurs autorisées : {{value|true}} ou {{value|false}}.
||
* {{value|true}}
*  {{value|false}}
|| Active l'affichage des notices EAC dans la fenêtre EAD
|}
=== {{var|eadeac-active-basket}} ===
{| class="wikitable"
|-
|-
| {{var|eadeac-active-basket}} || Active le porte-documents
! Paramètre !! Défaut !! Valeurs possible !! Description
* Valeur par défaut : {{value|true}} ;
* Valeurs autorisées : {{value|true}} ou {{value|false}}.
|-
|-
| {{var|eadeac-active-basket-zip}} || Active l'export ZIP du contenu du porte documents avec les pièces attachées
| {{tag|eadeac-active-basket}}
* Valeur par défaut : {{value|true}} ;
|| {{value|true}}
* Valeurs autorisées : {{value|true}} ou {{value|false}}.
||
* {{value|true}}
*  {{value|false}}
|| Active le porte-documents
|}
=== {{var|eadeac-active-basket-zip}} ===
{| class="wikitable"
|-
|-
| {{var|eadeac-basket-zip-include-doc}} || Permet l'inclusion du fragment lui même (au format PDF) dans l'export ZIP
! Paramètre !! Défaut !! Valeurs possible !! Description
* Valeur par défaut : {{value|true}} ;
* Valeurs autorisées : {{value|true}} ou {{value|false}}.
|-
|-
| {{var|eadeac-active-basket-pdf}} || Export du contenu du panier au format PDF
| {{tag|eadeac-active-basket-zip}}
* Valeur par défaut : {{value|true}} ;
|| {{value|true}}
* Valeurs autorisées : {{value|true}} ou {{value|false}}.
||
* {{value|true}}
*  {{value|false}}
|| Active l'export ZIP du contenu du porte documents avec les pièces attachées
|}
=== {{var|eadeac-basket-zip-include-doc}} ===
{| class="wikitable"
|-
|-
| {{var|eadeac-format-basket-pdf}} || Format de l'export PDF du panier
! Paramètre !! Défaut !! Valeurs possible !! Description
* Valeur par défaut : {{value|document}}
* Valeurs autorisées : {{value|document}} ou {{value|basket}}
|-
|-
| {{var|eadeac-persistent-basket}} || Activation du panier persistant
| {{tag|eadeac-basket-zip-include-doc}}
* Valeur par défaut : {{value|false}} ;
|| {{value|true}}
* Valeurs autorisées : {{value|true}} ou {{value|false}}.
||
* {{value|true}}
*  {{value|false}}
|| Permet l'inclusion du fragment lui même (au format PDF) dans l'export ZIP
|}
=== {{var|eadeac-active-basket-pdf}} ===
{| class="wikitable"
|-
|-
| {{var|eadeac-active-pdf}} || Active l'export PDF
! Paramètre !! Défaut !! Valeurs possible !! Description
* Valeur par défaut : {{value|true}} ;
* Valeurs autorisées : {{value|true}} ou {{value|false}}.
|-
|-
| {{var|eadeac-active-synch-toc}} || Active la synchronisation du fragment EAD avec le sommaire dans la fenêtre EAD
| {{tag|eadeac-active-basket-pdf}}
* Valeur par défaut : {{value|true}} ;
|| {{value|true}}
* Valeurs autorisées : {{value|true}} ou {{value|false}}
||
* {{value|true}}
*  {{value|false}}
|| Export du contenu du panier au format PDF
|}
|}
=== {{var|eadeac-format-basket-pdf}} ===
{| class="wikitable"
|-
! Paramètre !! Défaut !! Valeurs possible !! Description
|-
| {{tag|eadeac-format-basket-pdf}}
|| {{value|document}}
||
* {{value|document}}
*  {{value|basket}}
|| Format de l'export PDF du panier
{{todo|à compléter}}
|}
=== {{var|eadeac-persistent-basket}} ===
{| class="wikitable"
|-
! Paramètre !! Défaut !! Valeurs possible !! Description
|-
| {{tag|eadeac-persistent-basket}}
|| {{value|false}}
||
* {{value|true}}
*  {{value|false}}
|| Activation du panier persistant (stockage en base de données pour chaque utilisateur).
|}
=== {{var|eadeac-active-pdf}} ===
{| class="wikitable"
|-
! Paramètre !! Défaut !! Valeurs possible !! Description
|-
| {{tag|eadeac-active-pdf}}
|| {{value|true}}
||
* {{value|true}}
*  {{value|false}}
|| Active l'export PDF
|}
=== {{var|eadeac-pdf-use-special}} ===
{| class="wikitable"
|-
! Paramètre !! Défaut !! Valeurs possible !! Description
|-
| {{tag|eadeac-pdf-use-special}}
|| (vide)
||
* vide, XSL-FO standards ;
* {{value|/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).
|}
=== {{var|eadeac-active-synch-toc}} ===
{| class="wikitable"
|-
! Paramètre !! Défaut !! Valeurs possible !! Description
|-
| {{tag|eadeac-active-synch-toc}}
|| {{value|true}}
||
* {{value|true}}
*  {{value|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. ==
== Paramètres relatifs aux formulaires de recherche, à l'affichage des résultats, cadre de classement, rubrique, etc. ==
{| class="wikitable sortable"
=== {{var|ead-max-results}} ===
{| class="wikitable"
|-
! Paramètre !! Défaut !! Valeurs possible !! Description
|-
| {{tag|ead-max-results}}
|| {{value|1000}}
||
* {{value|n}} (entier positif)
|| Le nombre maximal de résultats de recherche qui seront affichés.
|}
=== {{var|sort-limit}} ===
{| class="wikitable"
|-
|-
!Paramètre !! Description
! Paramètre !! Défaut !! Valeurs possible !! Description
|-
|-
| {{var|ead-max-results}} || Le nombre maximal de résultats de recherche qui seront affichés.
| {{tag|sort-limit}}
* Valeur par défaut : {{value|1000}} ;
|| {{value|100}}
* Valeurs autorisées : {{value|tout entier}}.
||
* {{value|n}} (entier positif)
|| Le nombre de résultats à partir duquel on désactive les fonctionnalités de tri, pour éviter de surcharger le serveur.
|}
=== {{var|ead-docs-not-searchable}} ===
{| class="wikitable"
|-
|-
| {{var|sort-limit}} || Le nombre de résultats à partir duquel on désactive les fonctionnalités de tri, pour éviter de surcharger le serveur.
! Paramètre !! Défaut !! Valeurs possible !! Description
* Valeur par défaut : {{value|100}} ;
* Valeurs autorisées : {{value|tout entier}}.
|-
|-
| {{var|ead-docs-not-searchable}} || La liste des identifiants de documents EAD qui ne doivent pas être retournés dans des résultats de recherche.
| {{tag|ead-docs-not-searchable}}
* Valeur par défaut : (vide)
|| (vide)
* Valeurs autorisées : liste des identifiants séparés par un espace.
||
* liste d'{{tag|eadid}}
|| La liste des identifiants de documents EAD qui ne doivent pas être retournés dans des résultats de recherche.
|}
 
=== {{var|ead-cdc-results-auto-expand}} ===
{| class="wikitable"
|-
|-
| {{var|ead-cdc-auto-expand}} || Niveau déplié par défaut pour le cadre de classement.
! Paramètre !! Défaut !! Valeurs possible !! Description
* Valeur par défaut : {{value|0}} ;
|-
* Valeurs autorisées :
| {{tag|ead-cdc-results-auto-expand}}
** {{value|entier positif}} : indique le niveau à ouvrir ; ainsi {{value|1}} ouvre le premier niveau, le second niveau sera visible ;
|| {{value|_all}}
** {{value|_all}} : {{value|_all}} signifie que tous les niveaux seront ouverts.
||
{{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 {{value|_all}} que si votre cadre de classement n'est pas trop gros}}
* {{value|_all}}, déplie '''tous''' les niveaux ;
{{new|3.4}}
* {{value|n}} (entier positif), déplie {{value|n}} niveaux ;
* {{value|docs:n}}, déplie s'il y a au moins {{value|n}} ''documents'' résultats ;
* {{value|units:n}}, déplie s'il y a au moins {{value|n}} ''unités'' résultats ;
* {{value|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.
{{todo|J'ai trouvé deux définitions contradictoires, laquelle est la bonne ?
* {{value|docs:10;units:100}}, « ouvre s'il y a 10 documents ou 100 unités » ;
* {{value|docs:10;units:100}}, ouvre s'il y a moins de {{value|10}} documents (instruments de recherche) ou s'il y a moins de 100 unités de description qui ont été trouvés.
}}
|}
 
=== {{var|eadeac-cdc-result-sort-key}} ===
{| class="wikitable"
|-
|-
| {{var|ead-cdc-results-auto-expand}} || Niveau déplié par défaut pour le cadre de classement, dans les résultats de recherche.
! Paramètre !! Défaut !! Valeurs possible !! Description
* Valeur par défaut : {{value|_all}} ;
* Valeurs autorisées :
** {{value|entier positif}} : Un chiffre indiquera le niveau à ouvrir ;
** {{value|_all}} : signifie que tous les niveaux sont ouverts ;
** {{value|docs:#;units:#}} : permet de mettre une contrainte sur le dépliement.
:: Par exemple, {{var|docs:10;units:100}} indique que les entrées seront ouvertes uniquement s'il y a moins de 10 instruments de recherche ou s'il y a moins de 100 unités de description qui ont été trouvés.
|-
|-
| {{var|eadeac-cdc-result-sort-key}} || 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 « ; ».  
| {{tag|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 « {{value|;}} » (point-virgule).
Une clé de tri est un champ qui paraît dans les résultats de recherche (champ déclaré avec l'attribut {{value|brief="true"}}).
Une clé de tri est un champ qui paraît dans les résultats de recherche (champ déclaré avec l'attribut {{value|brief="true"}}).
|}
=== {{var|ead-cdc-auto-expand}} ===
{| class="wikitable"
|-
! Paramètre !! Défaut !! Valeurs possible !! Description
|-
|-
| {{var|news-days}} || Le nombre de jours durant lesquels une publication est considérée comme nouvelle.  
| {{tag|ead-cdc-auto-expand}}
Toute publication nouvelle sera marquée dans le cadre de classement et les résultats de recherche.  
|| {{value|0}} (zéro)
||
* {{value|entier positif}}, indique le nombre de niveaux à déplier (ainsi {{value|1}} ouvre le premier niveau, le second niveau sera visible) ;
* {{value|_all}}, tous les niveaux seront ouverts.
||
{{new|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 {{value|_all}} que si votre cadre de classement n'est pas trop gros}}
|}
 
=== {{var|news-days}} ===
{| class="wikitable"
|-
! Paramètre !! Défaut !! Valeurs possible !! Description
|-
| {{tag|news-days}}
|| {{value|20}}
||
* {{value|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 {{value|0}}.
Pour désactiver cette fonctionnalité, il suffit d'indiquer {{value|0}}.
* Valeur par défaut : {{value|20}} ;
|}
* Valeurs autorisées : {{value|entier positif}}.
=== {{var|news-maxratio}} ===
{| class="wikitable"
|-
|-
| {{var|news-maxratio}} || 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.  
! Paramètre !! Défaut !! Valeurs possible !! Description
|-
| {{tag|news-maxratio}}
|| {{value|100}}
||
* {{value|n}} (entier positif)
| | Le pourcentage à partir duquel on ne distingue plus de nouveautés. Par exemple, si la valeur est {{value|60}} et si plus de {{value|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.
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.
* Valeur par défaut : {{value|60}} ;
|}
* Valeurs autorisées : {{value|entier positif}}.
=== {{var|eadeac-suggest-hpp}} ===
{| class="wikitable"
|-
|-
| {{var|eadeac-suggest-hpp}} || Le nombre d'occurrences retournées dans les listes de suggestions des formulaires de recherche.
! Paramètre !! Défaut !! Valeurs possible !! Description
* Valeur par défaut : {{value|10}} ;
|-
* Valeurs autorisées : {{value|entier positif}}.
| {{tag|eadeac-suggest-hpp}}
|| {{value|10}}
||
* {{value|n}} (entier positif)
|| Le nombre d'occurrences retournées dans les listes de suggestions des formulaires de recherche.
{{important|Il faut aussi adapter {{var|autoComp.maxResultsDisplayed}} dans {{path|{{app}}/theme/js/module-eadeac-search-form.js}}}}
{{important|Il faut aussi adapter {{var|autoComp.maxResultsDisplayed}} dans {{path|{{app}}/theme/js/module-eadeac-search-form.js}}}}
|}
=== {{var|suggest-starts-with}} ===
{| class="wikitable"
|-
! Paramètre !! Défaut !! Valeurs possible !! Description
|-
| {{tag|suggest-starts-with}}
|| {{value|false}}
||
* {{value|true}}
* {{value|false}}
|| Les résultats du suggest sont ceux :
* ''commençants'' par le terme saisi ({{value|true}}) ;
* ''contenants'' le terme saisi ({{value|false}}).
|}
== Gestion des droits (LDAP) ==
=== {{var|acces-all-users}} ===
{| class="wikitable"
|-
! Paramètre !! Défaut !! Valeurs possible !! Description
|-
| {{tag|acces-all-users}}
|| {{value|all}}
||
* {{value|all}},
* (vide),
* liste d'utilisateurs séparés par « {{value|;}} ».
|| Liste des utilisateurs qui ont accés à tout les documents.
* {{value|all}} signifie que tout les utilisateurs ont accés.
* vide, on considére qu'on est dans le mode {{value|all}}
* Liste d'utilisateurs séparés par « {{value|;}} » (point-virgule).
{{todo|À valider}}
|}
=== {{var|acces-all-groups}} ===
{| class="wikitable"
|-
! Paramètre !! Défaut !! Valeurs possible !! Description
|-
| {{tag|acces-all-groups}}
|| {{value|all}}
||
* {{value|all}},
* (vide),
* liste de groupes séparés par « {{value|;}} ».
|| Liste des groupes qui ont accé à tout les documents.
* {{value|all}} signifie que tout les groupes ont accés.
* vide, on considére qu'on est dans le mode {{value|all}}
* Liste de groupes séparés par « {{value|;}} » (point-virgule).
{{todo|À valider}}
|}
== Gestion des mode d'affichage pour les résultats de recherche EAD ==
<!--+
  | Gestion des mode d'affichage pour les résultats de recherche EAD.
  | Il faut utiliser des noms de mode totalement différent pour faciliter le traitement.
  | Trois modes sont actuellement diponibles:
  | - cdc: mode d'affichage en cadre de classement
  | - tab: mode d'affichage en tableau (différent du mode d'affichage en list).
  | - mosaic: mode d'affichage en mosaïque.
  +-->
=== {{var|ead-default-print-result-mode}} ===
{| class="wikitable"
|-
! Paramètre !! Défaut !! Valeurs possible !! Description
|-
| {{tag|ead-default-print-result-mode}}
|| {{value|cdc}}
||
* {{value|cdc}},
* {{value|tab}},
* {{value|mosaic}},
* {{value|custom}},
|| {{new|3.5}}
C'est le mode d'affichage par défaut des résultats EAD.
Si ce paramètre est {{value|vide}} ou, si les problême persiste, c'est le format {{value|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:
<syntaxhighlight lang="xml">
<ead-default-print-result-mode>cdc</ead-default-print-result-mode>
</syntaxhighlight>
==== Utilisation de l'attribut {{attr|action}} ====
{{todo|À 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 {{attr|action}} de la balise {{tag|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:
<syntaxhighlight lang="xml" hightlight="2">
<form
  action="mosaic-results.html"
>
  ...
</form>
</syntaxhighlight>
=== {{var|ead-print-result-mode-activated}} ===
{| class="wikitable"
|-
! Paramètre !! Défaut !! Valeurs possible !! Description
|-
| {{tag|ead-print-result-mode-activated}}
|| {{value|mosaic;cdc;tab}}
||
* {{value|cdc}},
* {{value|tab}},
* {{value|mosaic}},
* {{value|custom}},
* composition des valeurs précédentes.
|| {{new|3.5}}
Indique la liste des modes d'affichage qui sont actifs. Les élements sont séparés par un « {{value|;}} » (point-virgule), sans espace.
Si la valeur est vide, on utilise le mode par défaut (cf [[#ead-default-print-result-mode|{{tag|ead-default-print-result-mode}}]]).
L'ordre des valeurs controle l'ordre d'affichage des boutons dans l'interface.
|}
Exemple:
<syntaxhighlight lang="xml">
<ead-print-result-mode-activated>mosaic;cdc;tab</ead-print-result-mode-activated>
</syntaxhighlight>
=== {{var|ead-cdc-show-not-illustrated}} ===
{| class="wikitable"
|-
|-
| {{var|eadeac-search-help-mode}} || Le mode d'affichage de l'aide dans les formulaires de recherche. Les valeurs possibles sont {{value|panels}} et {{value|tooltips}}.
! Paramètre !! Défaut !! Valeurs possible !! Description
* Valeur par défaut : {{value|panels}} ;
* Valeurs autorisées : {{value|panels}} ou {{value|tooltips}}.
|-
|-
| {{var|eadeac-navindex-from-input}} || Prise en compte de la saisie de l'utilisateur dans un champ à l'ouverture de la liste des index correspondant.
| {{tag|ead-cdc-show-not-illustrated}}
* Valeur par défaut : {{value|false}} ;
|| {{value|false}}
* Valeurs autorisées : {{value|true}} ou {{value|false}}
||
* {{value|false}},
* {{value|true}},
|| {{new|3.5}}
La valeur {{value|true}} permet l'affichage, dans le mode {{value|cdc}}, des résultats sans illustrations.
|}
|}
Exemple :
<syntaxhighlight lang="xml">
<ead-cdc-show-not-illustrated>true</ead-cdc-show-not-illustrated>
</syntaxhighlight>


== Affichage des documents dans la fenêtre EAD ==
=== {{var|ead-mosaic-show-not-illustrated}} ===
{| class="wikitable sortable"
{| class="wikitable"
|-
|-
!Paramètre !! Description
! Paramètre !! Défaut !! Valeurs possible !! Description
|-
|-
| {{var|ead-archdesc-toc}} || Affichage du premier niveau de description (archdesc) avec un sommaire pour naviguer plus facilement.
| {{tag|ead-mosaic-show-not-illustrated}}
* Valeur par défaut : {{value|true}} ;
|| {{value|false}}
* Valeurs autorisées : {{value|true}} ou {{value|false}}.
||
* {{value|false}},
* {{value|true}},
|| {{new|3.5}}
La valeur {{value|true}} permet l'affichage, dans le mode {{value|mosaic}}, des résultats sans illustrations.
|}
Exemple :
<syntaxhighlight lang="xml">
<ead-mosaic-show-not-illustrated>true</ead-mosaic-show-not-illustrated>
</syntaxhighlight>
 
=== {{var|ead-tab-show-not-illustrated}} ===
{| class="wikitable"
|-
|-
| {{var|img-thumbnail-size}} || Taille, en pixels, des vignettes affichées dans la fenêtre EAD. Ce paramètre ne s'applique que dans le cas de vignettes non pré-traitées.
! Paramètre !! Défaut !! Valeurs possible !! Description
* Valeur par défaut : {{value|150}} ;
* Valeurs autorisées : {{value|entier positif}}.
|-
|-
| {{var|ead-docs-not-searchable-specific-form}} || Affiche un formulaire de recherche capable de chercher dans les documents non cherchables, ou un message indiquant que le document n'est pas cherchable.
| {{tag|ead-tab-show-not-illustrated}}
{{new|3.3.2}} ;
|| {{value|false}}
* Valeur par défaut : {{value|false}} ;
||
* Valeurs autorisées : {{value|true}} ou {{value|false}}
* {{value|false}},
* {{value|true}},
|| {{new|3.5}}
La valeur {{value|true}} permet l'affichage, dans le mode {{value|tab}}, des résultats sans illustrations.
|}
Exemple:
<syntaxhighlight lang="xml">
<ead-tab-show-not-illustrated>true</ead-tab-show-not-illustrated>
</syntaxhighlight>
 
 
=== {{var|eadeac-search-help-mode}} ===
{| class="wikitable"
|-
! Paramètre !! Défaut !! Valeurs possible !! Description
|-
| {{tag|eadeac-search-help-mode}}
|| {{value|panels}}
||
* {{value|panels}}
*  {{value|tooltips}}
|| Le mode d'affichage de l'aide dans les formulaires de recherche.
|}
 
=== {{var|eadeac-navindex-from-input}} ===
{| class="wikitable"
|-
! Paramètre !! Défaut !! Valeurs possible !! Description
|-
| {{tag|eadeac-navindex-from-input}}
|| {{value|false}}
||
* {{value|true}}
*  {{value|false}}
|| Prise en compte de la saisie de l'utilisateur dans un champ à l'ouverture de la liste des index correspondant.
|}
 
 
=== {{var|display-modes}} ===
{{todo|À déplacer dans la doc des formulaires}}
{| class="wikitable"
|-
! Paramètre !! Défaut !! Valeurs possible !! Description
|-
| {{attr|display-modes}}
||
* {{value|cdc}},
* {{value|tab}},
* {{value|mosaic}},
* {{value|custom}},
* composition des valeurs précédentes.
|| -
|| {{new|3.5}}
Indique les formats d'affichage qui seront disponible dans la page de résultats.
 
C'est un attribut à placer dans la balise {{tag|form}} du fichier de configuration de votre formulaire.
Son comportement est identique à celui de [[#ead-print-result-mode-activated|{{tag|ead-print-result-mode-activated}}]].
Si le paramètre est présent mais vide, c'est l'équivalent de {{attr|display-mode&#61;"{{value|cdc}}"}}.
|}
Exemple :
<syntaxhighlight lang="xml" highlight="5">
<form
  action="results.html"
  max-chars="50"
  documents="ead"
  display-modes="cdc;mosaic"
>
    ...
</form>
</syntaxhighlight>
 
=== {{var|only-illustrated}} ===
{{todo|À déplacer dans la doc des formulaires}}
{| class="wikitable"
|-
! Paramètre !! Défaut !! Valeurs possible !! Description
|-
| {{tag|only-illustrated}}
|| {{value|false}}
||
* {{value|true}}
*  {{value|false}}
|| {{new|3.5}}
Permet l'affichage des résultats sans illustrations.
 
C'est un attribut à placer dans la balise {{tag|form}} du fichier de configuration de votre formulaire.
 
La valeur {{value|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 {{attr|only-illsutrated&#61;"{{value|true}}"}}, seule les résultats illustrés seront affichés.
|}
<syntaxhighlight lang="xml" highlight="5">
<form
  action="results.html"
  max-chars="50"
  documents="ead"
  only-illustrated="true"
>
    ...
</form>
</syntaxhighlight>
 
== Personnalisation de l'affichage d'un document dans la fenêtre EAD ==
=== {{var|ead-archdesc-toc}} ===
{| class="wikitable"
|-
! Paramètre !! Défaut !! Valeurs possible !! Description
|-
| {{tag|ead-archdesc-toc}}
|| {{value|true}}
||
* {{value|true}}
*  {{value|false}}
|| Affichage du premier niveau de description ({{tag|archdesc}}) avec un sommaire pour naviguer plus facilement.
|}
=== {{var|img-thumbnail-size}} ===
{| class="wikitable"
|-
! Paramètre !! Défaut !! Valeurs possible !! Description
|-
| {{tag|img-thumbnail-size}}
|| {{value|150}}
||
* {{value|n}} (entier positif)
|| Taille, en pixels, des vignettes affichées dans la fenêtre EAD.
{{remarque|Ce paramètre ne s'applique que dans le cas de vignettes non pré-traitées}}
|}
=== {{var|ead-docs-not-searchable-specific-form}} ===
{| class="wikitable"
|-
! Paramètre !! Défaut !! Valeurs possible !! Description
|-
| {{tag|ead-docs-not-searchable-specific-form}}
|| {{value|false}}
||
* {{value|true}}
*  {{value|false}}
|| {{new|3.3.2}}
Affichage du formulaire de recherche spécifique pour les documents EAD non cherchables.
* Par défaut (valeur {{value|false}}), à la place du formulaire, on affiche un message signalant que le document n'est pas cherchable ;
* Si ce paramètre vaut {{value|true}}, la recherche spécique s'effectue aussi sur les unités non cherchables ({{attr|searchable}}={{value|0}}).
|}
|}
== Personnalisation de la visionneuse ==
== Personnalisation de la visionneuse ==
{| class="wikitable sortable"
=== {{var|nombre-maximal-images}} ===
{| class="wikitable"
|-
|-
!Paramètre !! Description
! Paramètre !! Défaut !! Valeurs possible !! Description
|-
|-
| {{var|nombre-maximal-images}} || Le nombre maximal d'images que l'on peut télécharger dans un ZIP ou un PDF
| {{tag|nombre-maximal-images}}
* Valeur par défaut : {{value|10}} ;
|| {{value|10}}
* Valeurs autorisées : {{value|entier positif}}.
||
* {{value|entier positif}}
|| Le nombre maximal d'images que l'on peut télécharger dans un ZIP ou un PDF.
|}
|}
== Personnalisation des impressions ==
== Personnalisation des impressions ==
{| class="wikitable sortable"
=== {{var|eadeac-images-in-pdf}} ===
{| class="wikitable"
|-
! Paramètre !! Défaut !! Valeurs possible !! Description
|-
|-
!Paramètre !! Description
| {{tag|eadeac-images-in-pdf}}
|| {{value|unit-only}}
||
* {{value|none}}, aucune image ;
* {{value|all}}, images partout ;
* {{value|unit-only}}, seulement dans les PDF simples, sans sous-unités.
* {{todo|{{value|{{var|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.
|}
=== {{var|droits}} ===
{| class="wikitable"
|-
|-
| {{var|eadeac-images-in-pdf}} || 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.
! Paramètre !! Défaut !! Valeurs possible !! Description
* Valeur par défaut : {{value|unit-only}} ;
* Valeurs possibles :
** {{value|none}} (aucune image),
** {{value|all}} (images partout),
** {{value|unit-only}} (seulement dans les PDF simples, sans sous-unités)
|-
|-
| {{var|droits}} || La mention de copyright à inclure dans les PDF et les images téléchargées
| {{tag|droits}}
* Valeur par défaut : (vide)
|| {{value|Pleade 3 - ACHANGER}}
* Valeurs autorisées : toute chaîne de caractères
||
* texte libre
|| La mention de copyright à inclure dans les PDF et les images téléchargées
|}
|}
== Personnalisation de l'entrepôt OAI ==
== Personnalisation de l'entrepôt OAI ==
{| class="wikitable sortable"
=== {{var|ead-oai-repo-name}} ===
{| class="wikitable"
|-
|-
!Paramètre !! Description
! Paramètre !! Défaut !! Valeurs possible !! Description
|-
|-
| {{var|ead-oai-repo-name}} || Le nom de l'entrepôt OAI.
| {{tag|ead-oai-repo-name}}
* Valeur par défaut : (vide)
|| (vide)
* Valeurs autorisées : toute chaîne de caractères
||
* texte libre
{{important|Le nom est requis pour que l'entrepôt OAI soit actif}}
{{important|Le nom est requis pour que l'entrepôt OAI soit actif}}
|| Le nom de l'entrepôt OAI.
|}
=== {{var|ead-oai-repo-admin-email}} ===
{| class="wikitable"
|-
! Paramètre !! Défaut !! Valeurs possible !! Description
|-
| {{tag|ead-oai-repo-admin-email}}
|| (vide)
||
* une adresse email valide
|| L'adresse de courriel associée à l'entrepôt OAI.
|}
=== {{var|ead-oai-repo-nb}} ===
{| class="wikitable"
|-
! Paramètre !! Défaut !! Valeurs possible !! Description
|-
| {{tag|ead-oai-repo-nb}}
|| {{value|100}}
||
* {{value|n}} (entier positif)
|| Le nombre d'enregistrements retournés par « page » OAI.
|}
=== {{var|ead-oai-repo-records}} ===
{| class="wikitable"
|-
|-
| {{var|ead-oai-repo-admin-email}} || L'adresse de courriel associée à l'entrepôt OAI
! Paramètre !! Défaut !! Valeurs possible !! Description
* Valeur par défaut : (vide)
|-
* Valeurs autorisées : une adresse email
| {{tag|ead-oai-repo-records}}
{{important|Le nom est requis pour que l'entrepôt OAI soit actif}}
|| {{value|components}}
||
* {{value|components}}
*  {{value|finding aids}}
|| Indique si l'entrepôt OAI est constitué :
* d'instruments de recherche (« {{value|finding aids}} »)
* d'unités de description (« {{value|components}} »).
|}
=== {{var|ead-oai-pleade-title}} ===
{| class="wikitable"
|-
! Paramètre !! Défaut !! Valeurs possible !! Description
|-
| {{tag|ead-oai-pleade-title}}
|| {{value|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.
{{todo|À préciser}}
|}
=== {{var|ead-oai-pleade-title-sep}} ===
{| class="wikitable"
|-
! Paramètre !! Défaut !! Valeurs possible !! Description
|-
| {{tag|ead-oai-pleade-title-sep}}
|| {{value|//}} (deux barres obliques)
||
* toute chaîne de caractères
|| Séparateur à utiliser entre les éléments d'informations constituant le titre généré.
|}
=== {{var|ead-oai-pleade-title-lang}} ===
{| class="wikitable"
|-
! Paramètre !! Défaut !! Valeurs possible !! Description
|-
| {{tag|ead-oai-pleade-title-lang}}
|| {{value|fr}}
|| -
|| Langue du titre des enregistrements OAI.
{{notice|Ce paramètre est obsolète}}
|}
=== {{var|ead-oai-includehasPart}} ===
{| class="wikitable"
|-
! Paramètre !! Défaut !! Valeurs possible !! Description
|-
| {{tag|ead-oai-includehasPart}}
|| {{value|false}}
||
* {{value|true}}
*  {{value|false}}
|| Inclusion des liens vers les sous-unités dans l'enregistrement d'un composant.
|}
=== {{var|ead-oai-inheritDesc}} ===
{| class="wikitable"
|-
! Paramètre !! Défaut !! Valeurs possible !! Description
|-
| {{tag|ead-oai-inheritDesc}}
|| {{value|false}}
||
* {{value|true}}
* {{value|false}}
|| Inclusion des descripteurs des composants parent dans l'enregistrement OAI d'un composant.
|}
=== {{var|ead-oai-relationMode}} ===
{| class="wikitable"
|-
|-
| {{var|ead-oai-repo-nb}} || Le nombre d'enregistrements retournés par « page » OAI.
! Paramètre !! Défaut !! Valeurs possible !! Description
* Valeur par défaut : {{value|100}} ;
* Valeurs autorisées : {{value|entier positif}}.
|-
|-
| {{var|ead-oai-repo-records}} || Indique si l'entrepôt OAI est constitué d'instruments de recherche (« {{value|finding aids}} ») ou d'unités de description (« {{value|components}} »).
| {{tag|ead-oai-relationMode}}
* Valeur par défaut : {{value|components}} ;
|| {{value|url}}
* Valeurs autorisées : {{value|components}} ou {{value|finding aids}}.
||
* {{value|url}}
* {{value|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}}
<syntaxhighlight lang="xml">
<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>
</syntaxhighlight>
 
 
== Paramétrage de l'affichage des résultats ==
=== {{var|show-bottom-pagination}} ===
{| class="wikitable"
|-
|-
| {{var|ead-oai-pleade-title}} || 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.
! Paramètre !! Défaut !! Valeurs possible !! Description
|-
|-
| {{var|ead-oai-pleade-title-sep}} || Séparateur à utiliser entre les éléments d'informations constituant le titre généré.
| {{tag|show-bottom-pagination}}
* Valeur par défaut : {{value|//}} ;
|| {{value|false}}
* Valeurs autorisées : toute chaîne de caractères
||
* {{value|false}}, pas d'affichage (la navigation est présente uniquement en haut) ;
* {{value|true}}, affichage de la navigation en pied de page ;
||
{{new|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.
|}
 
=== {{var|notice-as-modal}} ===
{| class="wikitable"
|-
|-
| {{var|ead-oai-pleade-title-lang}} || Langue du titre des enregistrements OAI.
! Paramètre !! Défaut !! Valeurs possible !! Description
{{important|Ce paramètre n'est pas utilisé}}
|-
|-
| {{var|ead-oai-includehasPart}} || Inclusion des liens vers les sous-unités dans l'enregistrement d'un composant.
| {{tag|notice-as-modal}}
* Valeur par défaut : {{value|false}} ;
|| {{value|false}}
* Valeurs autorisées : {{value|true}} ou {{value|false}}.
||
* {{value|true}}, une pop-in modal est utilisé ;
* {{value|false}}, nouvel écran ;
||
{{new|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.
{{todo|pour l'{{EAD}} je <b>force la désactivation</b> car il y encore pas mal de travail suite a la perte de contexte (cf. {{path|{{app}}/module-eadeac/xsl/mosaic-results.xsl}} puis le template {{attr|mode&#61;"add-link-to-ead"}})}}
|}
 
{| class="wikitable"
|-
|-
| {{var|ead-oai-inheritDesc}} || Inclusion des descripteurs des composants parent dans l'enregistrement OAI d'un composant.
! Default ({{value|false}}) || {{value|true}}
* Valeur par défaut : {{value|false}} ;
* Valeurs autorisées : {{value|true}} ou {{value|false}}.
|-
|-
| {{var|ead-oai-relationMode}} || Forme sous laquelle seront écrites les relations (liens) dans les enregistrements OAI.
| -
* Valeur par défaut : {{value|URL}} ;
||
* Valeurs possibles : {{value|URL}} ou {{value|filename}}.
[[Fichier:Notice-as-modal-true.png|500px]]
|}
|}


== Contrôle des formulaires de recherche ==
=== {{var|show-search-form-in-result}} ===
{| class="wikitable"
|-
! Paramètre !! Défaut !! Valeurs possible !! Description
|-
| {{tag|show-search-form-in-result}}
|| {{value|false}}
||
* {{value|true}}
* {{value|false}}
||
{{new|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.
|}
{| class="wikitable"
|-
! Default ({{value|false}}) || {{value|true}}
|-
| [[Fichier:Show-search-form-in-result-false.png|500px]]
||
[[Fichier:Show-search-form-in-result-true-highlight.png|500px]]
|}


[[category:conf]]
[[category:conf]]

Dernière version du 24 avril 2013 à 10:50

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

[modifier | modifier le wikicode]

default-lang

[modifier | modifier le wikicode]
Paramètre Défaut Valeurs possible Description
<default-lang> fr
  • fr
  • en
 La langue par défaut de l'interface

enable-language-selection

[modifier | modifier le wikicode]
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

[modifier | modifier le wikicode]

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

[modifier | modifier le wikicode]
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

[modifier | modifier le wikicode]
Paramètre Défaut Valeurs possible Description
<eadeac-active-basket> true
  • true
  • false
 Active le porte-documents

eadeac-active-basket-zip

[modifier | modifier le wikicode]
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

[modifier | modifier le wikicode]
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

[modifier | modifier le wikicode]
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

[modifier | modifier le wikicode]
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

[modifier | modifier le wikicode]
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

[modifier | modifier le wikicode]
Paramètre Défaut Valeurs possible Description
<eadeac-active-pdf> true
  • true
  • false
 Active l'export PDF

eadeac-pdf-use-special

[modifier | modifier le wikicode]
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

[modifier | modifier le wikicode]
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.

[modifier | modifier le wikicode]

ead-max-results

[modifier | modifier le wikicode]
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

[modifier | modifier le wikicode]
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

[modifier | modifier le wikicode]
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

[modifier | modifier le wikicode]
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

[modifier | modifier le wikicode]
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

[modifier | modifier le wikicode]
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

[modifier | modifier le wikicode]
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

[modifier | modifier le wikicode]
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

[modifier | modifier le wikicode]
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

[modifier | modifier le wikicode]
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)

[modifier | modifier le wikicode]

acces-all-users

[modifier | modifier le wikicode]
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

[modifier | modifier le wikicode]
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

[modifier | modifier le wikicode]

ead-default-print-result-mode

[modifier | modifier le wikicode]
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

[modifier | modifier le wikicode]
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

[modifier | modifier le wikicode]
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

[modifier | modifier le wikicode]
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

[modifier | modifier le wikicode]
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

[modifier | modifier le wikicode]
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

[modifier | modifier le wikicode]
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

[modifier | modifier le wikicode]
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

[modifier | modifier le wikicode]
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

[modifier | modifier le wikicode]
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

[modifier | modifier le wikicode]

ead-archdesc-toc

[modifier | modifier le wikicode]
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

[modifier | modifier le wikicode]
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

[modifier | modifier le wikicode]
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

[modifier | modifier le wikicode]

nombre-maximal-images

[modifier | modifier le wikicode]
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

[modifier | modifier le wikicode]

eadeac-images-in-pdf

[modifier | modifier le wikicode]
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

[modifier | modifier le wikicode]
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

[modifier | modifier le wikicode]

ead-oai-repo-name

[modifier | modifier le wikicode]
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

[modifier | modifier le wikicode]
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

[modifier | modifier le wikicode]
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

[modifier | modifier le wikicode]
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

[modifier | modifier le wikicode]
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

[modifier | modifier le wikicode]
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

[modifier | modifier le wikicode]
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

[modifier | modifier le wikicode]
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

[modifier | modifier le wikicode]
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

[modifier | modifier le wikicode]
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)

[modifier | modifier le wikicode]
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

[modifier | modifier le wikicode]

show-bottom-pagination

[modifier | modifier le wikicode]
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

[modifier | modifier le wikicode]
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

[modifier | modifier le wikicode]

show-search-form-in-result

[modifier | modifier le wikicode]
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 :

  1. aucun résultat ;
  2. trop de résultats.

Et on masquera le bouton pour modifier la requête.

Default (false) true

Récupérée de "https://mediawiki.ajlsm.com/index.php?title=Pleade_Paramètres_configurables_par_les_archivistes&oldid=1863"