aide.php
Gestion de l'aide en ligne de SPIP
L'aide en ligne de SPIP est disponible sous forme d'articles de www.spip.net qui ont des repères nommés arttitre, artdesc etc.
La fonction inc_aider_dist reçoit soit ces repères,
soit le nom du champ de saisie, le nom du squelette le contenant et enfin
l'environnement d'exécution du squelette (inutilisé pour le moment).
Le tableau global aider_index donne ces repères.
Table of Contents
Functions
- aide_index() : array<string|int, mixed>
- Déclaration de l'index d'aide
- aide_index_alias_historiques() : array<string|int, mixed>
- Quelques mappages d'alias historiques <= SPIP 4
- inc_aide_dist() : string
- Générer un lien d'aide (icône + lien)
- aide_generer_url() : string
- Génère l'url d'une entrée d'aide
- aider_icone() : string
- Créer l'icône d'aide
- aide_data() : array<string|int, mixed>
- aide_contenu() : string
- Retrouve le contenu d'une aide demandée
- aide_langues() : array<string|int, mixed>
- Retourne la liste des langues dans laquelle une aide est cherchée On part par défaut de spip_lang
- aide_pre_echappe_html_propre() : mixed
- Gérer le raccourcis `<aide:code>...</aide:code>`
Functions
aide_index()
Déclaration de l'index d'aide
aide_index() : array<string|int, mixed>
Return values
array<string|int, mixed>aide_index_alias_historiques()
Quelques mappages d'alias historiques <= SPIP 4
aide_index_alias_historiques() : array<string|int, mixed>
Return values
array<string|int, mixed>inc_aide_dist()
Générer un lien d'aide (icône + lien)
inc_aide_dist([string $aide = '' ]) : string
Parameters
- $aide : string = ''
-
clé d'identification du groupe d'aide souhaité. Peut indiquer une entrée spécifique. Tel que 'raccourcis' ou 'raccourcis/liens' icone et lien… vide si on ne trouve pas le groupe d'aide demandé.
Tags
Return values
stringaide_generer_url()
Génère l'url d'une entrée d'aide
aide_generer_url(string $groupe[, string|null $entree = null ]) : string
Parameters
- $groupe : string
- $entree : string|null = null
Return values
stringaider_icone()
Créer l'icône d'aide
aider_icone(string $url[, string $clic = '' ]) : string
Parameters
- $url : string
-
URL vers l'aide
- $clic : string = ''
-
Contenu de la balise de lien.
Tags
Return values
string —Icone d'aide
aide_data()
aide_data([string|null $groupe = null ]) : array<string|int, mixed>
Parameters
- $groupe : string|null = null
Return values
array<string|int, mixed>aide_contenu()
Retrouve le contenu d'une aide demandée
aide_contenu(string $groupe, string $entree) : string
Parameters
- $groupe : string
- $entree : string
Return values
stringaide_langues()
Retourne la liste des langues dans laquelle une aide est cherchée On part par défaut de spip_lang
aide_langues([mixed $lang = null ]) : array<string|int, mixed>
pt_br => pt => langue_du_site => langue_par_defaut => fr
Parameters
- $lang : mixed = null
Return values
array<string|int, mixed>aide_pre_echappe_html_propre()
Gérer le raccourcis `<aide:code>...</aide:code>`
aide_pre_echappe_html_propre(mixed $flux) : mixed
Parameters
- $flux : mixed