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