Avant-propos : Les pages de documentation Wiki représentent la ressource la plus pérenne de LinuxMAO. Elles sont le fruit de nombreuses contributions par de nombreuses personnes sur de nombreuses années et ont, de ce fait, une valeur inestimable. Essayer de trouver mieux sur le web ! 😉 L'édition sur notre site (en TikiWiki) est très facile et très rapide. Tout le monde peut participer et c'est comme ça que s'est construit ce site depuis le début. Pensez également à respecter les consignes de la charte de bonne conduite du site.

Pour débuter

Mais puisqu'on vous dit que c'est simple !

Toutes les pages de documentation Wiki (à de très rares exceptions près) peuvent être modifiées - éditées - corrigées - améliorées ou bien créées par toute personne inscrite et connectée. Si ça n'est pas votre cas, vous pouvez aller lire ceci. Si c'est le cas, sachez que les pages wiki sont des pages qui évoluent en fonction du temps et des versions des logiciels. Il est extrêmement simple de modifier une page et il vous suffit de connaître trois ou quatre conventions, que nous allons voir dans cette page, pour démarrer tranquillement. Si vous vous trompez et cassez quelque chose, Tikiwiki (le moteur de LinuxMAO) permettra aux administrateurs généraux de revenir en arrière donc vous pouvez vous lancer sans risque ! (Si vous avez fait, ou avez peur d'avoir fait une conn^C, une bêtise, venez en parler dans le forum "Le site : philosophie, organisation, problèmes, ...".)




Vous verrez dans ces pages :

• des symboles de chapitre : !, !! et _!!!_ qui correspondent à des chapitres (ou titres si vous préférez) de niveau 1, 2 ou 3,
• des symboles de puces : *, ** et *** qui correspondent à des marges de niveau 1, 2 ou 3,
• des symboles pour le gras, le souligné, ... etc
• des codes bizarres avec des nom d'images, vous pouvez charger une copie d'écran en bas de la page, une par une. Elle sera insérée à l'endroit du curseur.
  
  Et plein d'autres trucs de mises en page mais c'est tout pour l'instant ! 😉 Ces autres conventions, nous allons les voir plus bas dans cette page et aussi dans la page d'édition experte, mais au début ne vous en souciez pas, quelqu'un passera derrière vous pour améliorer la mise en page et peu à peu vous vous améliorerez. Merci d'écrire dans les pages wiki ! 😎

Le bac à sable

Si vous souhaitez vous entraîner à la rédaction de pages Wiki, expérimenter la syntaxe TikiWiki sans risque, vous pouvez utiliser le bac à sable prévu à cet effet (utilisez ensuite le bouton "aperçu" pour visualiser le résultat). Le bac à sable est une page spéciale de TikiWiki qui n'est pas sauvegardée très longtemps.



Création

Si vous souhaitez créer une page qui n'existe donc pas encore, rendez-vous ici !

Les conseils

Voici 5 conseils essentiels pour bien débuter :

1. Utiliser les raccourcis de mise en page.
2. En mode modification, vous verrez en bas de la page un lien appelé aide Wiki qui vous donnera de l'aide en français.
3. Utilisez le bouton Aperçu pour contrôler le rendu de vos modifications.
4. Sauvegarder votre travail avant validation : par mesure de précaution, lorsque vous éditez une page et surtout si votre modification à pris du temps à écrire, sauvegarder votre modification chez vous (dans un fichier texte par exemple) avant de l'enregistrer sur le site. En effet, il se peut que votre session sur le site ai expirée et que vous soyez déconnecté sans même le savoir ... Rappelez-vous que plus on travaille longtemps, plus il y a de mal-chances que sa session se ferme, et c'est vraiment très TRÈS TRÈS frustrant de voir son travail s'envoler ... Comme pour les doigts dans les prises électriques lorsqu'on est enfant, vous voilà prévenu, mais comme beaucoup d'entre nous, vous ferez certainement l'erreur au moins une fois ...🙄
5. Juste avant de valider votre contribution, remplissez au moins les cases concernant votre nom et le résumé de la modification que vous avez apportée car cela permet d'effectuer un suivi des pages et de savoir qui à modifier quoi afin de discuter entre nous des futures modifications des pages.

Syntaxe basique

À de très rares exceptions, TikiWiki fonctionne avec du langage balisé. C'est à dire qu'on va prendre un bout de texte et qu'on va dire à TikiWiki de lui appliquer un traitement en y mettant une balise d'ouverture au début et une balise de fermeture à la fin sur ce principe : (balise d'ouverture) mon texte (balise de fermeture).

Par exemple pour du gras, la balise est représentée par 2 underscores : __.

• Le code : __mon texte que je veux le mettre en gras, lui__.
• Le rendu : mon texte que je veux le mettre en gras, lui.

Vous pouvez taper les codes à la main ou bien, à votre choix, utiliser les raccourcis disponibles.

Gras, italique, souligné, en couleur, ...

Voici quelques exemples qui vous donneront des idées !








Vous pouvez combiner ces signes, pour faire du gras italique en rouge par exemple :

Les titres / les niveaux

Les titres commencent par un point d'exclamation, puis les sous-titres par deux points d'exclamation, on peut descendre de niveau en ajoutant autant de points d'exclamation que l'on souhaite, par exemple :


Ne numérotez pas vos paragraphes car si quelqu'un veut insérer un paragraphe, il n'aura pas forcément envie de tout re-numéroter. Si vous tenez à ce que vos paragraphes soient numérotés, faites suivre les points d'exclamation par un dièse (#).

Les listes et leurs puces

Pour les puces, il faut utiliser la balise * (étoile) et elle se comporte exactement de la même manière que la balise ! de titre. Ainsi :

Comment insérer une image ?

Ante scriptum : Toutes les images de LinuxMAO sont stockées dans un unique répertoire. Pensez à donner un nom à votre image qui évitera qu'elle soit écrasée par une autre contribution.
Typiquement : LeNomDuLogiciel_Utilité_VotreSurnom.png qui donnera par exemple : Hydrogen_ZoomMenu_Olinuxx.png.

Quand vous êtes en édition sur une page, tout en bas, il y a un truc qui s'appelle : Envoyer une image. Il suffit de cliquer sur Choisissez un fichier et d'aller chercher votre image sur votre périphérique, la bonne balise est automatiquement ajoutée à l'emplacement du curseur.

Si vous voulez en mettre une deuxième, cliquez sur Ajouter une image encore en dessous avant d'aller chercher votre deuxième image.

Profitez-en pour compléter le code d'origine comme suit : {img src="img/wiki_up/IMAGE" width=500 desc="TEXTE" align=center link="img/wiki_up/IMAGE"} avec :

• width = la taille d'affichage souhaitée,
• desc = une légende pour l'image.
• align= left, align=center ou align=right pour l'alignement horizontal

Vous pourrez aussi aller voir quelques fonctionnalités plus avancées concernant les images et également le chapitre : "Comment faire une belle image en seulement quelques clics ?" dans la charte documentaire.

Tables des matières

La balise {maketoc} insère automatiquement une table des matières construites à partir des balises "!" trouvées dans la page. Vous pouvez en trouver un exemple en haut de cette page. À noter que la table des matières produit des liens précis vous permettant de lier vers certaine partie des pages. Elle est disponible en raccourci en cliquant sur l'étoile orange.

Échapper à la mise en forme automatique de tikiwiki - Caractères spéciaux

Cette astuce est indiquée dans l'aide intégrée de TikiWiki, mais étant très utile, rappelons-la ici malgré tout ...

Si, sur une page, vous avec besoin d'utiliser le texte qui correspond à une balise, celle-ci sera interprétée ce qui posera des problèmes de mise en page. Pour empêcher TikiWiki d'interpréter le texte, il est utile d'utiliser les balises ~np~ et ~/np~. Le texte est alors affiché tel quel.

Insérer des liens

Un lien est dit interne s'il pointe vers une page qui fait partie de LinuxMao.org et externe s'il pointe vers un site en dehors.

Lien interne

La syntaxe de LinuxMAO autorise une façon facile de faire des liens de pages internes. Plutôt que de copier entièrement le lien de la page, vous pouvez placer son nom entre double-parenthèses comme ceci : ((linuxsampler)), ce qui donnera à la lecture : linuxsampler. Ceci est mieux car :

• ça va plus vite à écrire et c'est plus lisible dans le code de la page qu'un lien du genre :  http://www.linuxmao.org/tikiwiki/tiki-index.php?page=principes%20rapides%20de%20la%20MAO%20sous%20GNU%20Linux,

• ça crée un lien relatif plutôt qu'un absolu et les liens relatifs, c'est bien (tm) car :
  • ça permet de conserver l'utilité des liens si on utilise une copie de LinuxMAO (pendant les présentations MAO par exemple ou sur un ordinateur n'ayant pas accès au réseau),
  • si LinuxMAO change de nom un jour (pour s'ouvrir à un truc genre openMAO ou openMusic par exemple quand Jack et Ardour tourneront sous Mac et Windows aussi bien que sous Linux), les liens seront conservés.

Que faut-il mettre entre parenthèses ?

Pour le savoir, il suffit de regarder la barre d'adresse de votre navigateur.

Par exemple, la page "noob_principe_MAO_jack" se trouve à l'adresse suivante :

• Copy to clipboard

  http://www.linuxmao.org/tikiwiki/tiki-index.php?page=principe_MAO_jack

Pour créer un lien sur cette page interne, il faut recopier tout ce qui se trouve derrière le signe "=" et le mettre entre double-parenthèses. On écrira donc ((noob_principe_MAO_jack)).



N'hésitez pas à aller voir la page des conseils d'édition, version expert, pour plus d'infos et plus d'exemples tordus sur l'utilisation et la rédaction de liens. Ca se passe par ici !

Lien externe

Il vous suffit de mettre le lien entre crochets comme ceci :

• code : [http://jackaudio.org/]
• rendu : http://jackaudio.org/

Notez que vous disposer d'un raccourci.



A noter également une petite astuce concernant les caractères [ et ]. Les crochets utilisés seuls ne posent pas de problème mais lorsqu'on associe un crochet ouvrant à un crochet fermant, cet ensemble est systématiquement interprété comme un lien. Pour éviter cette interprétation et plutôt que d'utiliser les balise ~np~~/np~ pour échapper à la mise en forme, il suffit de doubler le premier crochet.

À noter

Licence

Sauf mention contraire le contenu du site est placé sous la licence libre Creative Commons "paternité - partage des conditions initiales à l'identique" (CC-BY-SA). Les exceptions peuvent être, par exemple, les traductions de documentations ayant d'autres licences libres, et héritant de celles-ci en tant que modification de l'originale.

Pages verrouillées

Certaines pages sont verrouillées à l'édition et ne peuvent être éditées que par les administrateurs (ou utilisateurs pour les pages d'utilisateurs) de LinuxMAO. Il s'agit des pages spéciales du site : les pages de fonctionnement présentes dans le bloc vert du haut de cette page (exceptée la page du brouillon de l'édito), la page d'accueil, la pageB, la page licence, les pages d'utilisateurs. Si vous le souhaitez, il vous suffit d'être inscrit et connecté pour pouvoir y laisser des commentaires).

Divers

Le plus important reste le contenu !
Hé ! vous ! Oui ! vous là ! Ne vous prenez pas la tête non plus sur la mise en page si c'est pas votre truc ! 🙄
Pssst ... vous ! non, pas vous, l'autre vous ! Si c'est votre truc à vous, pourquoi ne pas l'aider à mettre en page ? 😉



Si vous cherchez des fonctionnalités d'édition avancées, vous pouvez allez voir sur la page dédiée. Il y a aussi une page explicative pour la création d'une nouvelle page







Si vous vous posez une question à propos de ceci, rendez-vous dans le forum : "Le site : philosophie, organisation, problèmes, ..." afin de discuter ensemble. 😉

D'autre part, cette page est verrouillée à l'écriture et est modifiable uniquement par les administrateurs de LinuxMAO. Si vous pensez que quelque chose devrait y figurer ou bien, si quelque chose n'est pas clair et que ça mérite ré-écriture ou alors, si vous voyez une faute, ou que-sais-je-encore, ... etc, vous pouvez laisser un commentaire en bas de la page.