From Aïkido ASPTT de Troyes

Main: HelpFr

PmWiki est un système de type wiki pour la création et l'entretien collectif de sites Internet.

Les pages PmWiki ont le même aspect et fonctionnent comme des pages Internet ordinaires, sauf qu'elles possèdent un lien pour « Éditer » ce qui permet de modifier ou d'ajouter facilement des pages à un site, en utilisant les règles d'édition de base (tout comme le fait le site http://fr.wikipedia.org)

Basé sur PmWiki, ce système contient déjà quelques extensions les plus pratiques et une syntaxe simplifiée.

La page d'accueil et le code mis à jour sont à cette adresse :

http://pmwiki-efo.googlecode.com

Présentation

L'édition des pages peut être réalisée par plusieurs auteurs. Pour éditer une page, cliquez simplement sur "Éditer" qui existe quelque part dans la page, habituellement dans l'en-tête ou le pied de page. Quelques pages peuvent être protégées par mot de passe, en fonction de la politique de sécurité, mais beaucoup de sites permettent la libre édition de pages.

Le mot de passe par défaut de cette version du wiki est "pmwiki". Il est conseillé de le modifier par la suite, après installation (voir plus bas).

Lorsque vous éditez une page, vous voyez les balises qui décrivent le contenu de la page. Le rendu final, avec le formatage choisi, ne s'affiche que lorsque la page en enregistrée.

Règles d'édition

Les règles de base pour le balisage de la page sont très simples :

• Mettez une ligne vide entre chaque paragraphe.
• Pour créer une liste d'éléments, commencez chaque ligne avec - pour une liste avec des puces ou + pour une liste numérotée.
• Pour faire des titres de sections, entourez ce titre par des =, par exemple == titre d'importance principale == ou === titre d'importance secondaire == .
• Pour mettre en valeur du texte, procédez ainsi : //texte// pour la mise en italique ou **texte** pour la mise en gras.
• Pour créer un lien vers une autre page, entourez son nom par des crochets doubles ; par exemple [[nouvelle page]] crée un lien vers cette page. Un lien vers une page inexistante? est affiché de façon différente, pour inviter d'autres à créer la page.
• Pour faire un lien vers un autre site, tapez directement son adresse, comme http://www.unsite.fr
  • Et pour faire un lien sur une portion de texte existante, c'est [description du site http://www.site.com]
• Pour faire un lien vers un fichier local, par exemple se trouvant dans le dossier /docs à la racine de l'installation de pmwiki, c'est :

[fichier pdf local://../../docs/pmwiki-efo.pdf]

Ce qui donne : fichier pdf

Il faut rajouter le ../../ pour remonter de 2 niveaux dans l'arborescence si dans local/config.php on a $EnablePathInfo = 1; (par défaut dans cette version du wiki)

Sinon c'est [fichier pdf local://docs/pmwiki-efo.pdf]

Mais le plus simple, est d'utiliser la fonction d'attachement de fichiers (voir plus bas)

De façon générale, vous pouvez également sélectionner votre texte à formater, et utiliser la barre d'outil pour vous aider dans la rédaction.

• Pour rajouter une table des matières, rajoutez à l'emplacement souhaité le code (:*toc:)
• Attacher un fichier :
  1. Soit rajouter la syntaxe Attach:fichier.ext lors de l'édition de la page (si besoin avec l'icône du trombone dans la barre d'outils), et cliquer sur le lien qui apparaît, et conduit vers la page d'ajout de fichier. L'extension doit être présente pour que le fichier soit correctement utilisable ensuite.
  2. Soit rajouter ?action=upload à la fin de la page actuelle (par exemple HelpFr?action=upload).
• galerie d'images (utilisant la recette "mini" :

rajouter Mini:liste de fichiers image.jpg etc

par exemple : Mini:image_sample01.jpg,image_sample02.png deviendra : image_sample01.jpg Δ image_sample02.png Δ

les images peuvent être mises en place soit en les copiant dans le dossier uploads, soit en les téléchargeant individuellement avec la méthode du dessus.

Syntaxe complète

• **gras** : gras
• //italique// : italique
• __soulignage__ : soulignage
• --barré-- : barré
• = titre = (à différents niveaux, on a ainsi == titre 2 ==, === titre 3 === etc)
• - liste
• + liste numérotée
• ``code``
• % commentaire (ce qui suivra le % ne sera pas affiché)
• [http://www.site.org/image.jpg] :
• [lien vers un site http://www.site.com] : lien vers un site
• | tableau | cellule 2 | cellule 3 | : fonctionne, à condition d'avoir un nombre pair de |

table	cellule 2	cellule 3
table	cellule 2	cellule 3

table	cellule 2	cellule 3	cellule 4
table	cellule 2	cellule 3	cellule 4

• Visitez le site de txt2tags pour apprendre la syntaxe ou utilisez les boutons pour une mise en forme rapide.

(inclus depuis HelpFrQuickReference)

Extension de la syntaxe, basée sur textallion

Cette extension, optionnelle, permet de rajouter des effets de texte non disponibles dans la version de base de txt2tags.

voir http://code.google.com/p/textallion/ pour le site de textallion

• {//..} : Saut de ligne. Si vous préférez, vous pouvez également utiliser la syntaxe propre à pmwiki : \\ ou sauter 2 lignes pour passer une ligne à l'affichage.

Par exemple pour séparer ce paragraphe
Et celui-ci.

• { ~~ } texte ou image à centrer {/~~ } . Si vous préférez, vous pouvez également utiliser la syntaxe propre à pmwiki : %center%

pour des images :

pour du texte :

• Image incluse dans du texte, image à gauche (équivalent de %lfloat% dans pmwiki) :

Attach:image.png{~~~~}
Paragraphe incluant l'image

Attach:favicon.png Δ Lorem ipsum dolor sit amet, consectetur adipiscing elit. Donec a diam lectus. Sed sit amet ipsum mauris. Maecenas congue ligula ac quam viverra nec consectetur ante hendrerit. Donec et mollis dolor. Praesent et diam eget libero egestas mattis sit amet vitae augue.

et le reste ici...

• Image incluse dans du texte, image à droite (équivalent de %rfloat% dans pmwiki) :

{~~~~}Attach:image.png
Paragraphe incluant l'image

Attach:favicon.png Δ Lorem ipsum dolor sit amet, consectetur adipiscing elit. Donec a diam lectus. Sed sit amet ipsum mauris. Maecenas congue ligula ac quam viverra nec consectetur ante hendrerit. Donec et mollis dolor. Praesent et diam eget libero egestas mattis sit amet vitae augue.

et le reste ici...

Description et avantages du système

• Txt2tags est un générateur de documents qui utilise un langage à balises simplifié. En utilisant la syntaxe de txt2tags dans un wiki, il est aisé de recopier les balises dans un fichier texte et de l'exporter ensuite vers la multitude de formats supportés par txt2tags : html, pdf (via LaTeX), mediawiki, google code wiki etc.

Vous pouvez ainsi retrouver cette documentation dans ce fichier pdf, réalisé avec le convertisseur textallion ou sur le wiki google code du projet.

• PmWiki est un moteur de wiki léger ne nécessitant pas de base de données relationnelle type MySQL : toutes les informations sont stockées dans de simples fichiers textes, et seul PHP est nécessaire.

Il est facilement extensible via un système de modules externes ("cookbooks"). Il utilise sa propre syntaxe wiki, mais il est possible d'utiliser la syntaxe de txt2tags à l'intérieur de PmWiki !

• Ceci est donc une version modifiée de PmWiki incluant :
  • la syntaxe et les icônes d'édition pour txt2tags
  • le moteur de blog BlogIt.
  • l'encodage UTF-8 par défaut
  • un thème plus agréable que celui d'origine + un thème pour mobile
  • le moteur de galerie mini
• Quelques avantages :
  • validation W3C
  • pas de base de données relationnelle à installer et administrer (pas de mysql etc)
  • mise à jour simplifiée (juste à copier l'archive de la nouvelle version de pmwiki sur le serveur)
  • moteur de recherche intégré
  • édition rapide des pages, création rapide de nouvelles pages. L'organisation et l'édition se font en visualisant le site au lieu de passer par une interface spécifique (backoffice).
  • flux RSS pour suivre les nouveautés
  • relativement peu de fichiers à installer en comparaison d'autres logiciels CMS (moins de 600 fichiers, moins de 5 Mo)

Adaptations pour txt2tags

La syntaxe txt2tags est simple et facile à retenir : http://www.pmwiki.org/wiki/Cookbook/Txt2tags

En outre, des icônes spécifiques permettent d'aider à la mise en page.

Blog It

BlogIt est une recette pour rajouter un moteur de blog à pmwiki. Vous pouvez le désactiver, si vous ne l'utilisez pas, dans le fichier local/config.php.

Le seul petit problème par rapport à l'original, est du fait de la syntaxe txt2tags, ça provoque une erreur dans le lien pour éditer les entrées de blog depuis le récapitulatif. Aussi il faut éditer les entrées de blog dans le menu sur le côté (sidebar).

Encodage UTF-8

Par défaut, l'encodage de la version francophone de PmWiki est ISO-8859-1. Cette présente version propose l'encodage UTF-8, plus adapté aux serveurs sous Unix.

• http://www.pmwiki.org/wiki/Cookbook/French

Autres fonctionnalités propres à PmWiki

Redirections

Il suffit d'ajouter (:redirect Main/NewPage quiet=0:) pour rediriger une page vers une autre, comme sur cet exemple : HelpSampleRedirect.

Attention si vous indiquez quiet=1, vous ne pourrez plus éditer la page en cliquant dessus (le lien de redirection disparaîtra), il faudrait entrer l'URL à éditer à la main, dans la barre d'URL du navigateur, par exemple HelpSampleRedirect?action=edit

Pour en savoir plus, se référer à l'aide officielle : PageDirectives

inclusion de pages

Pour inclure une page dans une autre, il suffit d'écrire (:include Main/PageAInclure:) pour fusionner la seconde page dans la première.

C'est pratique pour inclure par exemple une page de nouvelles, comme ici :

Pour en savoir plus, se référer à l'aide officielle : IncludeOtherPages

Attributs spécifiques à certaines pages

Pour modifier les droits en lecture / écriture sur une page spécifique, outrepassant les droits définis dans le fichier local/config.php, il suffit de rajouter ?action=attr à la fin de l'adresse de la page à modifier. Par exemple HelpFr?action=attr.

Pour en savoir plus, se référer à l'aide officielle : Passwords

Formulaire

Voir cet exemple (visible uniquement sur le wiki) : HelpFormSample

Réseaux sociaux

Voir cet exemple (visible uniquement sur le wiki) : HelpSocialNetworks.

Thèmes

Le thème par défaut est basé sur Enlighten.

• http://www.pmwiki.org/wiki/Cookbook/Enlighten

Pour modifier le thème utilisé, il suffit de le signaler dans le fichier local/config.php : décommentez le thème choisi, ou éditez le thème existant.

Notez bien : pour éviter de charger de trop nombreux fichiers sur le serveur, certains thèmes, qui se trouvent dans le dossier pub/skins, ont été compressés, veuillez les dézipper avant utilisant.

Licenses

• PmWiki and txt2tags are GPLv2. This set-up is GPLv3, unless otherwise noted.
• http://www.pmwiki.org/wiki/Cookbook/Marinee is MIT/GPL license.
• http://www.pmwiki.org/wiki/Cookbook/Enlighten is CC-BY-SA license.
• Mobile version based on: http://www.pmwiki.org/wiki/Cookbook/IPMWikiSkin by Moolder

Installation

• Copiez le contenu du dossier pmwiki-efo sur votre serveur, via ftp. Assurez-vous que le dossier wiki.d est en mode de lecture / écriture complet (chmod 777).

Nous vous renvoyons à la page d'accueil générale de l'installation de PmWiki par rapport à ce processus.

• Éditez le fichier local/config.php pour modifier les mots de passe par défaut et pour adapter pmwiki à vos besoins (rajout de cookbooks, comportement etc.)

Si possible, au lieu de php4, veuillez utiliser php5, PmWiki fonctionne mieux avec ce dernier

Les fichiers et dossiers utiles de PmWiki

• pmwiki.php Le moteur principal de pmwiki
• local/ contient les fichiers de configuration
• cookbook/ contient les recettes et extensions personnelles
• docs/ documentation d'instructions et de licences, exemples...
• pub/ les fichiers publics (accessibles et visibles par tous, photos, thèmes etc)
  • pub/css/ fichiers de style CSS
  • pub/guiedit/ icônes pour la syntaxe pmwiki
  • pub/t2tguiedit/ icônes pour la syntaxe txt2tags
  • pub/skins/ fichiers de thèmes pour l'apparence générale du wiki
• scripts/ scripts qui font partie de l'installation de base de PmWiki
• wikilib.d/ pages par défaut de PmWiki. Si vous éditez un de ces fichiers depuis pmwiki, la copie modifiée se trouvera dans wiki.d, pas dans ce répertoire qui reste immuable.
• wiki.d/ vos pages modifiée.