locale/fr/pgsrc/Aide%2FPluginWiki

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