Fichier plugins-dist/aide/inc/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.

Source

Proposer une amélioration

Liste des constantes

Valeur

  • "@(<img([^<>] +)?\ssrc=['\"])img_pack\/@ims"

Utilisé par

Package

Note

  • (mais ce serait bien de le faire en SQL une bonne fois)

Valeur

  • ',<h([12])(?:\s+class="spip")?' . '>([^/]+?)(?:/(.+?))?</h\1>,ism'

Utilisé par

Package

Liste des fonctions

array aide_fichier( string $path , array $help_server )

Paramètres

  1. string $path
  2. array $help_server

Retour

  • array

Package

Proposer une amélioration
string aide_fixe_img( string $contenu , string $server )

Paramètres

  1. string $contenu
  2. string $server

Retour

  • string

Utilisé par

Package

Proposer une amélioration

Extraire la seule section demandée, qui commence par son nom entourée d'une balise h2 et se termine par la prochaine balise h2 ou h1 ou le /body final.

string aide_section( string $aide , string $contenu , integer $prof = 2 )

Paramètres

  1. string $aide

    Titre de la section d'aide

  2. string $contenu
  3. integer $prof = 2

    Dans quel hn doit-on mettre le titre de section

Retour

  • string

Utilisé par

Package

Proposer une amélioration
string aider_icone( string $url , string $clic = '' )

Paramètres

  1. string $url

    URL vers l'aide

  2. string $clic = ''

    Contenu de la balise de lien.

Retour

  • string

    Icone d'aide

Utilisé par

Variables globales

  • string $spip_lang
  • string $spip_lang_rtl

Package

Proposer une amélioration
string generer_url_aide_img( string | array $args )

Paramètres

  1. string | array $args

    Arguments à transmettre à l'URL :

    • string : tel que arg1=yy&arg2=zz
    • array : tel que array( arg1 => yy, arg2 => zz )

Retour

  • string

    URL

Package

Proposer une amélioration
string inc_aide_dist( string $aide = '' , string $skel = '' , array $env = array() , boolean $aide_spip_directe = false )

Paramètres

  1. string $aide = ''

    clé d'identification de l'aide souhaitée

  2. string $skel = ''

    Nom du squelette qui appelle ce bouton d'aide

  3. array $env = array()

    Environnement du squelette

  4. boolean $aide_spip_directe = false

    false : Le lien généré est relatif à notre site (par défaut) true : Le lien est réalisé sur spip.net/aide/ directement...

Retour

  • string

Utilise

Package

Proposer une amélioration