[(#REM)

	Documentation de la configuration du plugin

	@author		Jonathan OCHEJ
	@license	GPL - https://www.gnu.org/licenses/gpl-3.0.html
]

<h1 class="grostitre">Configuration [(#PLUGIN{dsfr_composants,nom})]</h1>

[(#ALERTE_MESSAGE{
	La librairie DSFR applique des styles CSS particuliers sur les balises HTML communes (p,a,input...).
	Elle ne peut en aucun cas être chargée sur l'espace privé de SPIP au risque de casser l'affichage de certains éléments.
, '', notice})]

[(#ALERTE_MESSAGE{
	Le plugin <strong>#PLUGIN{dsfr_lib,nom}</strong> est nécessaire car il contient tous les fichiers (css, javascript, icônes, pictogrammes..)
	de la librairie DSFR chargés automatiquement par le plugin <strong>[(#PLUGIN{dsfr_composants,nom})]</strong>.
	Différents paramètres de configuration peuvent être appliqués pour le chargement de la librairie DSFR.
, '', info})]

<h2>Paramètres de configuration de la librairie DSFR</h2>
<p>
	Les paramètres suivants sont à définir directement dans le fichier <code>config/mes_options.php</code>.
	<br>Vous pouvez consulter la <a href="https://www.systeme-de-design.gouv.fr/utilisation-et-organisation/developpeurs/prise-en-main" rel="external">documentation de prise en main du DSFR</a> pour plus d'informations.
</p>


#BOITE_OUVRIR{#CHEMIN_IMAGE{documentation_dsfr_composants_configuration.svg}|balise_svg{'',cadre-icone}|concat{<h2>Constante <code>_DSFR_CHARGER_CSS_UTILITY</code></h2>},simple,titrem}
	<p>
		Les classes utilitaires, notamment les icônes, sont disponibles dans un fichier à part nommé <code>utility.css</code>.
		Par défaut, le plugin [(#PLUGIN{dsfr_composants,nom})] charge automatiquement ce fichier. 
	</p>
	<ul class="spip">
		<li><strong>Type :</strong> booléen <code>bool</code></li>
		<li><strong>Par défaut :</strong> <code>true</code></li>
	</ul>

	<h3>Désactiver le chargement des classes utilitaires</h3>
	<p>
		Pour ne pas charger les classes utilitaires,
		<br>définissez la constante avec la valeur <code>false</code> dans le fichier <code>config/mes_options.php</code>.
	</p>
	[(#VAL{define('_DSFR_CHARGER_CSS_UTILITY', false);}|spip_balisage_code{1,'',php})]

	<h3>Valeur actuelle</h3>
	[(#CONST**{_DSFR_CHARGER_CSS_UTILITY}|var_export{1}|spip_balisage_code{1,'',php})]
#BOITE_FERMER


#BOITE_OUVRIR{#CHEMIN_IMAGE{documentation_dsfr_composants_configuration.svg}|balise_svg{'',cadre-icone}|concat{<h2>Constante <code>_DSFR_API_JS_MODE</code></h2>},simple,titrem}
	<p>
		Le mode sélectionné permet de déterminer le contexte dans lequel doit fonctionner le DSFR
		et de modifier son comportement.
	</p>
	<p>
		Voir : <a href="https://www.systeme-de-design.gouv.fr/utilisation-et-organisation/developpeurs/api-javascript/" rel="external">https://www.systeme-de-design.gouv.fr/utilisation-et-organisation/developpeurs/api-javascript/</a>
	</p>
	<ul class="spip">
		<li><strong>Type :</strong> chaîne de caractères <code>string</code></li>
		<li><strong>Par défaut :</strong> <code>auto</code></li>
		<li>
			<strong>Valeurs possibles :</strong>
			<ul class="spip">
				<li><code>auto</code> choisi automatiquement le mode le plus approprié.</li>
				<li><code>manual</code> le lancement du moteur est laissé à l'utilisateur via la commande : <code>dsfr.start();</code>.</li>
				<li><code>runtime</code> le lancement se fait immédiatement dès l'initialisation du DSFR.</li>
				<li><code>loaded</code> le lancement se fait une fois la page totalement chargée.</li>
			</ul>
		</li>
	</ul>

	<h3>Valeur actuelle</h3>
	[(#CONST**{_DSFR_API_JS_MODE}|var_export{1}|spip_balisage_code{1,'',php})]
#BOITE_FERMER


#BOITE_OUVRIR{#CHEMIN_IMAGE{documentation_dsfr_composants_configuration.svg}|balise_svg{'',cadre-icone}|concat{<h2>Constante <code>_DSFR_API_JS_VERBOSE</code></h2>},simple,titrem}
	<p>
		Le mode <code>verbose</code> est une option disponible dans le DSFR qui fournit des détails supplémentaires 
		sur ce que fait le framework JS au démarrage ou lors de la navigation, il produit une sortie détaillée à des fins de diagnostic.
	</p>
	<ul class="spip">
		<li><strong>Type :</strong> booléen <code>bool</code></li>
		<li><strong>Par défaut :</strong> <code>false</code></li>
	</ul>

	<h3>Valeur actuelle</h3>
	[(#CONST**{_DSFR_API_JS_VERBOSE}|var_export{1}|spip_balisage_code{1,'',php})]
#BOITE_FERMER


#BOITE_OUVRIR{#CHEMIN_IMAGE{documentation_dsfr_composants_configuration.svg}|balise_svg{'',cadre-icone}|concat{<h2>Constante <code>_DSFR_API_JS_LEVEL</code></h2>},simple,titrem}
	<p>
		La propriété <code>level</code> dans la configuration ou en paramètre de l'URL permet de mettre un niveau de log particulier.
		Différents niveaux sont disponibles permettant une granularité plus fine des messages dans la console.
	</p>
	<ul class="spip">
		<li><strong>Type :</strong> chaîne de caractères <code>string</code></li>
		<li><strong>Par défaut :</strong> <code>info</code></li>
		<li>
			<strong>Valeurs possibles :</strong>
			<ul class="spip">
				<li><code>log</code> toutes les actions opérées en js sont décrites.</li>
				<li><code>debug</code> les actions principales sont décrites (création et destruction d'instance, démarrage et arrêt de l'API).</li>
				<li><code>info</code> niveau par défaut.</li>
				<li><code>warn</code> affiche les avertissements.</li>
				<li><code>error</code> affiche uniquement les erreurs.</li>
			</ul>
		</li>
	</ul>

	<h3>Activer le niveau de log maximum</h3>
	<p>
		Si vous souhaitez voir dans la console toutes les actions opérées en js,
		<br>définissez la constante avec la valeur <code>log</code> dans le fichier <code>config/mes_options.php</code>.
	</p>
	[(#VAL{define('_DSFR_API_JS_LEVEL', 'log');}|spip_balisage_code{1,'',php})]

	<h3>Valeur actuelle</h3>
	[(#CONST**{_DSFR_API_JS_LEVEL}|var_export{1}|spip_balisage_code{1,'',php})]
#BOITE_FERMER


#BOITE_OUVRIR{#CHEMIN_IMAGE{documentation_dsfr_composants_configuration.svg}|balise_svg{'',cadre-icone}|concat{<h2>Constante <code>_DSFR_API_JS_PRODUCTION</code></h2>},simple,titrem}
	<p>
		Le mode <code>production</code> lorsqu'il est activé, permet de retirer tous les logs de la console.
		Par défaut, même en mode <code>verbose:false</code>, les logs d'initialisation du DSFR et des analytics sont présent dans la console.
		Ce mode est à mettre à <code>true</code> sur la version du site en production (disponible au public).
	</p>
	<ul class="spip">
		<li><strong>Type :</strong> booléen <code>bool</code></li>
		<li><strong>Par défaut :</strong> <code>false</code></li>
	</ul>

	<h3>Valeur actuelle</h3>
	[(#CONST**{_DSFR_API_JS_PRODUCTION}|var_export{1}|spip_balisage_code{1,'',php})]
#BOITE_FERMER


#BOITE_OUVRIR{#CHEMIN_IMAGE{documentation_dsfr_composants_configuration.svg}|balise_svg{'',cadre-icone}|concat{<h2>Constante <code>_DSFR_API_ANALYTICS</code></h2>},simple,titrem}
	<p>
		Le marquage du Système de Design de l'État s'inscrit dans le cadre de la gestion du marché de mesure 
		d'audience au niveau interministériel pour les sites et applications de l'État.
	</p>
	<p>
		Le système de design apporte avec lui un outil de collecte de données analytics basé sur la solution Eulérian.
	</p>
	<p>
		Voir : <a href="https://www.systeme-de-design.gouv.fr/utilisation-et-organisation/developpeurs/api-analytics/" rel="external">https://www.systeme-de-design.gouv.fr/utilisation-et-organisation/developpeurs/api-analytics/</a>
	</p>
	<p>
		Pour activer le fonctionnement du package Analytics, une configuration particulière du DSFR est nécessaire.
		<br>Exemple de configuration : <a href="https://github.com/GouvernementFR/dsfr/blob/main/src/analytics/doc/analytics/installation/configuration.md" rel="external">https://github.com/GouvernementFR/dsfr/blob/main/src/analytics/doc/analytics/installation/configuration.md</a>
	</p>

	<h3>Exemple</h3>
	<p>
		Pour le plugin, il faut définir la configuration sous forme de tableau PHP dans le fichier <code>config/mes_options.php</code>.
	</p>
[(#VAL{"define('_DSFR_API_ANALYTICS', \[
	'domain'	=> 'mon.domainedetracking.com',
	'page'		=> \[
		'template'		=> 'article',
	\],
	'site'		=> \[
		'entity'		=> 'Ministère de l\'éducation nationale',
	\],
\]);"}|spip_balisage_code{1,'',php})]

	<h3>Valeur actuelle</h3>
	[(#CONST**{_DSFR_API_ANALYTICS}|var_export{1}|spip_balisage_code{1,'',php})]
#BOITE_FERMER