Casiwiki

Logiciel de collaboration documentaire ouverte

Principes de base


Une commande est un raccourçis qui permet d'aller chercher dynamiquement des informations dans la base de donnée et les présenter de manière homogène.

Il existe trois moyens d'executer une commande: par la barre d'adresse, pour une commande temporaire, dans la partie commune pour qu'elle soit exécutée pour toutes les pages, dans le contenu d'une page, pour qu'elle s'exécute a chaque fois que l'on affiche cette page.

Utilisation à la volée


La manière la plus simple de faire appel a une commande est de les éxécuter directement dans la barre d'adresse de votre navigateur:

Utilisation dans les pages


Les commandes peuvent également être utilisées dans n'importe quelle page. Elles doivent alors être entourées par des doubles accolades ouvrantes et fermantes lorsqu'elles sont exécutées au sein d'une page: {{::nomdelacommande}}.

Syntaxe avançée

Elle se compose potentiellement de trois partie:
  1. le tag d'une page
  2. le format de sortie
  3. une ou plusieurs méthodes

Exemple de ce que l'on peut faire avec une commande:
  • Afficher les fichiers joints à une page donnée
  • Afficher le résumé d'une page
  • Lister les commentaires pour tout le site

Le tag et l'arborescence

  • La commande la plus simple ne contient qu'un tag: {{Home}} va simplement afficher le contenu formatté de la page home, sans ajouts particuliers.
  • Quand le tag n'est pas indiqué, il est compris comme étant équivalent a celui dans le contexte duquel la commande est effectuée. Sur cette page, {{::config=base_url}} sera compris comme {{Documentation/Utilisateurs/Commandes::config=base_url}}
  • Si vous souhaitez que le tag soit relatif à la page courante et non pas celle ou la commande est inscrite (par exemple pour dans un menu afficher les fichiers joints de la page courante (indiquée dans l'url), utilisez le symbole * à la place du tag: {{*::config=base_url}}

Vous pouvez également indiquer que le tag doit s'adapter aux contexte de l'arborescence. Par exemple pour signaler que vous souhaitez que la page affichée soit propres à l'endroit ou vous vous trouvez, si elle existe.


{{untruc/*/menu}} signifie:
Afficher untruc/NomDeLaPageCourante/menu

{{</menu}} signifie:
Afficher NomDeLaPageCourante/menu
sinon afficher menu

{{>/menu}} signifie:
Afficher menu si elle existe
sinon afficher NomDeLaPageCourante/menu

{{menu/>}} signifie:
Afficher menu si elle existe
sinon afficher menu/NomDeLaPageCourante

{{menu/<}} signifie:
Afficher menu/NomDeLaPageCourante si elle existe
sinon afficher menu


Les actions

  • Certaines commandes ne contiennent qu'une méthode: {{::config=base_url}} va simplement appeller la méthode config, et donc afficher le contenu de la variable base_url, peut importe sur qu'elle page je me trouve.

La liste des méthodes existantes est indiquées par la commande help
 Ajouter un commentaire