SPIP Code

Documentation du code de SPIP et de ses plugins

Aide SPIP

Documentation

Table of Contents

Packages

Application

Functions

aide_index()  : array<string, array<string|int, string>>
Déclaration de l'index d'aide
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{}|array{titre: string, slug?: string, intro?: string, entrees: array{titre: string, link?: string, groupe?: string, slug?: string, texte: string}[]}
Affichage du menu de gauche avec analyse de la section demandée
aide_contenu()  : string
Retrouve le contenu d'une aide demandée
aide_langues()  : array<string|int, string>
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()  : string
Gérer le raccourcis `<aide:code>...</aide:code>`

Functions

aide_index()

Déclaration de l'index d'aide

aide_index() : array<string, array<string|int, string>>
Return values
array<string, array<string|int, string>>

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
uses
aider_icone()
Return values
string

aide_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
string

aider_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
global

string $spip_lang

global

string $spip_lang_rtl

used-by
inc_aide_dist()
Return values
string —

Icone d'aide

aide_data()

Affichage du menu de gauche avec analyse de la section demandée

aide_data([string $groupe = '' ]) : array{}|array{titre: string, slug?: string, intro?: string, entrees: array{titre: string, link?: string, groupe?: string, slug?: string, texte: string}[]}
Parameters
$groupe : string = ''
Return values
array{}|array{titre: string, slug?: string, intro?: string, entrees: array{titre: string, link?: string, groupe?: string, slug?: string, texte: string}[]}

aide_contenu()

Retrouve le contenu d'une aide demandée

aide_contenu(string $groupe, string $entree) : string
Parameters
$groupe : string
$entree : string
Return values
string

aide_langues()

Retourne la liste des langues dans laquelle une aide est cherchée On part par défaut de spip_lang

aide_langues([string|null $lang = null ]) : array<string|int, string>

pt_br => pt => langue_du_site => langue_par_defaut => fr

Parameters
$lang : string|null = null
Return values
array<string|int, string>

aide_pre_echappe_html_propre()

Gérer le raccourcis `<aide:code>...</aide:code>`

aide_pre_echappe_html_propre(string $text) : string
Parameters
$text : string
Return values
string

Search results