Commentaire sur la fiche : Paramètres d’une mini-application
Si la réponse à cette question ne vous parait pas claire ou si elle vous semble obsolète, n’hésitez pas à nous en faire part.
Et nous sommes preneurs également de toute correction de faute d’orthographe ou de grammaire...
Rappel du texte de la fiche :
Les paramètres d’une mini-application sont définis dans le fichier apps/{nom de l'application}/app.ini
de l’application et peuvent être surchargés pour chaque fichothèque dans le fichier custom/app-{nom de l'application}.ini
.
Les paramètres sont définis sous la forme clé=valeur
et peuvent être désactivé en étant précédé par un #
. Lorsqu’un paramètre est indiqué comme booléen les valeurs possibles sont true
ou false
.
Cette liste correspond aux paramètres définis dans la classe Java fr.exemole.bdfserver.tools.apps.AppConf
.
Paramètres d’activation
active
: (booléen) indique si l’application est active ou non, ce paramètre est le plus susceptible d’être modifié dans le fichier de personnalisationcustom/app-{nom de l'application}.ini
, en particulier dans le cas des fichothèques multiples : une mini-application ne peut être pertinente que pour certaines fichothèquesmulti_active
: (booléen) indique que cette application est disponible comme « application centrale », accessible via{nom du contexte Tomcat}/app-{nom de l'application}
(voir ci-dessous)
Paramètres principaux
Ces paramètres vont affectés en particulier les fichiers Javascript et CSS inclus dans l’application.
core_jslibs
: liste des bibliothèques Javascript à inclure (séparées par une virgule)core_jqueryextensions
: listes des extensions JQuery à inclure (séparées par une virgule)core_codemirrormodes
: liste des modes de CodeMirror à inclure (séparés par une virgule) ; ajoute automatiquement la bibliothèque tierce CodeMirrorcore_leafletextensions
: listes des extensions Leaflet à inclure (séparées par une virgule) ; ajoute automatiquement la bibliothèque tierce Leafletcore_thirdlibs
: liste des bibliothèques tierces à inclure (séparées par une virgule) ; à utiliser, si elles n’ont pas été incluse par des bibliothèques Javascriptcore_themecssfiles
: liste des fichiers de thème CSS à inclure (séparés par une virgule) ; ces fichiers sont ceux se trouvant danstheme/css/
core_includefichecss
: (booléen) indique qu’il faut inclure les fichiers CSS nécessaires à l’affichage d’une fichecore_jsorder
: ordre d’appel des fichiers Javascript de l’application ; en l’absence de ce paramètre, les fichiers sont inclus par ordre alphabétiquecore_bodycssclass
: classe CSS à appliquer à l’élément<body>
de l’applicationcore_bdfuserneed
: indique si l’authentification est nécessaire pour l’accès à l’application ; les valeurs possibles sontmandatory
(par défaut, authentification obligatoire),if_any
(si jamais l’internaute est authentifié, l’application en sera informée) ounone
(aucune authentification)core_titlephrasename
: nom technique de la phrase de titre de l’application ; en remplissant ce paramètre, la configuration de ce titre sera disponible dans l’interface de configuration des intitulés de la fichothèque
Paramètres de l’écran d’authentification
login_sessionmessage
: clé de localisation du message d’accueillogin_availablespheres
: sphères disponibles dans la liste déroulante des sphèreslogin_defaultsphere
: sphère par défautlogin_titlephrasename
: nom technique du titre long de l’application ; en remplissant ce paramètre, la configuration de ce titre sera disponible dans l’interface de configuration des intitulés de la fichothèque
Paramètres passés en argument
Tout paramètre commençant par args_
sera passé comme propriété d’un objet Javascript global ARGS défini dans la page HTML de la mini-application. Le nom exact de la propriété est constitué des caractères suivant le préfixe args_
. Ce type de paramètre est particulièrement utile dans les fichiers de personnalisation par fichothèque (custom/app-{nom de l'application}.ini
) pour permettre de contextualiser facilement l’application en fonction de la fichothèque.
À propos des mini-applications centrales
Les mini-applications centrales sont les mini-applications qui, dans le cas des fichothèques multiples, concernent l’ensemble des fichothèques (par exemple, une page d’accueil à l’intégralité des fichothèques). Elles sont accessibles via {nom du contexte Tomcat}/app-{nom de l'application}
, contrairement aux mini-applications de fichothèques qui sont accessibles via {nom du contexte Tomcat}/{nom de la fichothèque}/app-{nom de l'application}
.
Les mini-applications centrales possèdent le paramètre spécifique suivant :
multi_noauthentification
: si égaltrue
la mini-application ne demande aucune authentification, sinon l’authentification se base sur les sphères centrales