locale/fr/pgsrc/Aide%2FPluginWiki

   1 Date: Thu, 27 Jan 2011 18:00:26 +0000
   2 Mime-Version: 1.0 (Produced by PhpWiki 1.4.0)
   3 Content-Type: application/x-phpwiki;
   4   pagename=Aide%2FPluginWiki;
   5   flags="";
   6   markup=2;
   7   charset=UTF-8
   8 Content-Transfer-Encoding: binary
   9
  10 PhpWiki vous permet d'étendre PhpWiki avec de nouvelles fonctionnalités via
  11 un mécanisme de plugins. Pour faire bref, vous étendez une classe PHP
  12 que nous fournissons et vous la personnalisez pour qu'elle affiche le
  13 contenu que vous voulez. Pour plus d'informations, voyez PluginWiki,
  14 PluginBonjourLeMonde, et regardez les sources des fichiers dans lib/plugin.
  15
  16 S'il n'y a pas d'exemple de page pour ce plugin ou que vous souhaitez plus
  17 d'informations, le meilleur endroit est la source de ce plugin. Sous le
  18 répertoire racine de votre wiki, le dossier lib/plugin contient tous les
  19 fichiers PHP des plugins.
  20
  21 Certains plugins nécessitent des bibliothèques externes non fournies
  22 avec PhpWiki ou PHP comme par exemple la librairie GD pour les
  23 graphiques.
  24
  25 PhpWiki supporte les plugins depuis 1.3.x
  26
  27 ~Les plugins Wiki permettent à chacun d'ajouter un nouveau type de contenu
  28 dynamique (ou autre fonctionnalité) aux pages wiki avec PhpWiki. Par exemple,
  29 dans ce wiki, les DernièresModifs, RétroLiens, PagesSemblables et la plupart
  30 des autres pages indexées sont toutes implémentées en utilisant les plugins.
  31
  32 À plus ou moins court terme, l'ancien style phpwiki [[URLMagiquesPhpWiki]] sera
  33 remplacé par des plugins également.
  34
  35 == Exemple
  36
  37 Habituellement, on appelle un plugin en écrivant quelque chose comme ceci :
  38
  39 {{{
  40 <<BackLinks>>
  41 }}}
  42
  43 dans une page wiki classique. Cet exemple particulier génère une liste des
  44 pages qui sont liées à la page courante. Ici on a :
  45
  46 <<BackLinks>>
  47
  48 (C'est intéressant pour les pages Catégorie ou Sujets. Vous pouvez l'utiliser
  49 pour en obtenir une liste automatique)
  50
  51 == Détails
  52
  53 Les plugins peuvent être utilisés avec une liste d'arguments. Il existe
  54 quatre moyens pour spécifier leur valeur. Dans l'ordre de priorité :
  55
  56 # L'appel du plugin peut spécifier la valeur d'un argument comme ceci :
  57   {{{
  58   <<BackLinks page=OtherPage>>
  59   }}}
  60
  61 # L'arguement peut être spécifié via l'argument d'une requête HTTP. Ceci ne
  62   devrait pas se produire (ce n'est pas permis) à moins que l'argument soit
  63   mentionné dans l'appel du plugin :
  64
  65   {{{
  66   <<BackLinks page>>
  67   }}}
  68
  69 # Valeurs par défaut spécifiées dans l'appel du plugin :
  70
  71   {{{
  72   <<BackLinks page||=OtherPage>>
  73   }}}
  74
  75 # Le plugin remplace les valeurs par défaut pour chaque argument utilisé
  76   par des arguments d'URL comme ceci :
  77   {{{
  78     BackLinks?page=ThisPage&sortby=-mtime
  79   }}}
  80   (Le plugin RétroLiens utilise la page courante comme valeur par défaut
  81   pour l'argument ''page'')
  82
  83 == Il y a quatre types de base pour les plugins :
  84
  85 Tous les plugins viennent de la classe PluginWiki étendant la méthode run
  86 qui retourne un objet arbre des objets HTML, et doivent réagir sur chaque
  87 arguments fournit depuis une ~WikiPage (voir les arguments plus loin) ou
  88 passé par l'URL (arguments GET et POST définit via '||=').
  89
  90   *plugin-form* est utilisé pour afficher une boîte input type=text box
  91    comme argument par défaut.
  92
  93 {{{
  94 <<PluginName [args...]>>
  95 }}}
  96
  97 {{{
  98 <?plugin-form PluginName [args...] ?>
  99 }}}
 100
 101 == Plugins existants :
 102
 103 Voir [[GestionDesPlugins]] pour la liste actuelle. La plupart des plugins ont leur
 104 propre page de documentation avec le mot *Plugin* ajouté.
 105
 106 -----
 107
 108 Pages dans cette catégorie :
 109
 110 <<BackLinks page=[pagename] noheader=1>>
 111
 112 * RechercheEnTexteIntégral : ChercherUnePage
 113 * RechercheParTitre : PagesSemblables (match_head, match_tail).
 114
 115 <noinclude>
 116 ----
 117 [[DocumentationDePhpWiki]] [[CatégoriePluginWiki]]
 118 </noinclude>