DjO: 17oct2004 propose
FormatageWikini comme nouvelle page des règles de formatage.
On m'a demandé ce qui clochait avec la page actuelle, alors voici ma réponse
- Je suis désolé de répondre ici bien tard. (Je ferai mes commentaires en plusieurs morceaux, c'est long...). "Mieux vaut tard que jamais"... -- CharlesNepote
J'ai
cloné ici la page actuelle des Règles de formatage et l'ai commenté
Le contenu original est en noir et
mes commentaires sont en bleu. Dans un des nombreux WiKis? que j'ai visités, on présentait la page des règles de formatage comme la page la plus visitée : c'est donc dire que ça vaut la peine de la dorloter, de la reviser, de l'analyser de l'évaluer, et de l'améliorer, afin qu'elle soit tout à fait clair, pour tous.
- Note que ton usage du HTML rend la lecture des pages difficile lorsqu'on les édite. Je suggère que tu abandonnes cette pratique, au moins sur wikini.net où tu es presque le seul à en faire usage. De même pour l'utilisation des séparateurs horizontaux, bien trop nombreux. Merci. -- CharlesNepote
Les règles de formatage avec Wakka diffèrent légèrement des autres Wikis. (Voir par exemple
, le premier Wiki connu.)
- Premièrement, bien sûr le papa de WikiNi est Wakka, mais nous sommes dans un WiKi mu par un moteur WikiNi, n'est-ce pas ? Par exemple, MeatBall? est aussi le fils de papa Wakka, mais ils ont leurs propres règles de formatage. Il convient donc de parler des règles de formatage avec WikiNi, plutôt qu'avec Wakka ?
- Deuxièment, une erreur de syntaxe : Les règles de formatage ne diffèrent pas des autres WiKis, elles diffèrent des règles de formatage des autres WiKis.
- Troisièmement, quand on clique le lien vers WikiWikiWeb, on nous dit dans cette p@ge que le HTML n'est pas possible ; dans mon cas, j'ai transposé ça à WikiNi pendant six mois !
- Très juste. Cette introduction est d'ailleurs inutile. Je propose de la supprimer carrément. -- CharlesNepote
Tout texte placé entre deux guillemets doubles - " - est présenté tel que.
- présenté tel queL, pas tel que !
- entre deux guillemets doubles est inexact ! "Ceci est entre deux guillemets doubles" : il convient donc de plutôt dire entre deux paires de guillemets doubles. N'est-ce pas ?
- Très juste. Ce texte me parait cependant mal placé en introduction et devrait plutôt se situer en fin de parcours. -- CharlesNepote
Vous pouvez effectuer vos propres test dans le
BacASable : c'est un endroit fait pour ça.
- C'est l'endroit fait pour ça
Règles de base :
- **Texte en gras !** ---> Texte en gras !
- //Texte en italique.// ---> Texte en italique.
- Texte __souligné__ ! ---> Texte souligné !
- Texte @@barré@@ ! ---> Texte barré !
- ##texte à espacement fixe## ---> texte à espacement fixe
- %%code%%
- %%(php) code PHP%%
- %%(delphi) code delphi/pascal%%
- Les cinq premiers items sont parfaits ensemble, car ils gèrent tous le formatage de texte, sauf que trois suivants ne sont pas pour M. TLM
- Qui plus est, qu'est ce qui dit à un nouvel arrivant que les deux paires de "%" vont créer une fenêtre, laquelle est surtout utilisée par les spécialistes pour écrire des codes. QU'est-ce que cet item fait avec des items qui formatent la police ? Comme deux paires de "%" créent une fenêtre, mais pas dans les versions 1... de WikiNi, j'ai cru bon de placer cet item dans la section des tableaux, avec une note pour la version 1...
Empêcher le formatage du texte :
- Pour empêcher que Wikini n'interprète les balises de formatage de texte qu'il reconnait, encadrer le texte par une paire de guillemets doubles. Par __exemple__, ce **texte** @@contient@@ des %%balises%% reconnue par Wikini qui ne sont //pas// interprétée car il est encadré par une paire de **guillemets double** comme __vous__ pouvez vous en apercevoir :)
- Voyez-vous l'Énorme erreur dans le § précédent, qui plus est, vu les 8 règles regroupées ensemble plus haut ? En effet, on y a mis le mot balises entre deux paires de "%". Or donc, dans WikiNi 0.4.1 (interwiki) cela créerait une fenêtre contenant le mot balises... Ce n'est donc pas un très bon exemple...concret : ça porte à confusion, car ça suggère que "%" formate le texte, ce qui n'est pas le cas...
- Deux autres utilisations :
- écrire directement du HTML dans le wikini - par exemple pour les tableaux... ;-) - vu que ce qui est renvoyé est tout de même interprété par le moteur de rendu de Mozilla
- Le premier problème du titre Empêcher le formatage... Quelle sorte de formatage ? HTML WikiNi, Wakka ? Le deuxième problème du titre, c'est qu'il ne s'applique pas du tout au paragraphe précédent, lequel ne parle pas d'empêcher le formatage, mais plutôt de permettre le formatage, HTML. N'est-ce pas ?
- Ensuite, l'autre paragraphe obscur qui est géré par le titre empêcher le formatage et qui suit mon Bouton HTML concerne les logs et les scripts shell ; comme c'est plutôt spécialisé et que j'avoue n'y rien comprendre, je l'ai mis à la toute fin avec une demande d'éclaircissement pour M. TLM
Il est beau
mon bouton, non ?
Liens forcés :
- [[http://www.mon-site.org]]
- [[http://www.mon-site.org Mon-site]]
- [[P2P]]
- [[P2P Page sur le P2P]]
- [[toto@example.org]]
- [[toto@example.org Adresse de toto]]
DjO estime que ceci est plus clair
Liens forcés internes (à une autre p@ge du
WiKi)
Liens forcés externes :
Liens forcés courriel :
Liens interwiki :
Pour que ça fonctionne, on doit respecter la casse (les majuscules) dans le NomDuWiki .
La liste des Wiki qui se trouve dans le fichier interwiki.conf ne contient pas que des Wikis...
-
DjO: Autant faire des liens externes et éliminer ce § ?
«
Liens interwiki :
- [[NomDuWiki:nomPage]] exemple WikiNi:LienInterWiki (interwiki)
- Note : il est important de respecter la casse (les majuscules) dans le NomDuWiki sans quoi cela ne fonctionnera pas.
- Note : la liste des Wiki se trouve dans le fichier interwiki.conf et ne contient pas que des Wiki d'ailleurs... ;-)
Ici,
DjO ai mis les gros titres à la base, mais surtout, à chaque ligne, j'ai précisé le nombre de "-", parce que dans Netscape Navigator 4.8 et autres 4s, je présume, on ne peut voir le # de -, parce que les tirets ne sont pas séparés.
En-têtes :
- ====== En-tête énorme ======
En-tête énorme
- ===== En-tête très gros =====
En-tête très gros
- ==== En-tête gros ====
En-tête gros
- === En-tête normal ===
En-tête normal
- == Petit en-tête ==
Petit en-tête
Séparateur horizontal : il suffit de taper au moins 4 "-", au dela de 4 tirets c'est le meme effet.
Exemple : ----
Séparateur horizontal, comme la ligne précédente. {§ : WikiNi 0.4.1 (interwiki)}
Il suffit de taper au moins 4 "-"; au delà de 4 tirets, c'est le même effet.
Exemple :
Comme ces 4 tirets ---- sont entre deux paires de guillemets doubles, on les voit;
néanmoins, à la ligne suivante, ils ne sont pas entre deux paires de guillemets doubles.
- Il est intéressant de noter que dans un WiKi de la version WikiNi 0.1.1.0.3 (interwiki) l'explication précédente ne "fonctionne pas", parce que dans cette version, que quatre tirets d'affilée soient ou non à l'intérieur de deux paires de guillemets doubles, ils créent un séparateur horizontal.
- Pour la version 0.1.1.0.3, on peut donc dire:
Séparateur horizontal, comme la ligne précédente. {§ : WikiNi 0.1.1.0.3 (interwiki)}
Il suffit de taper au moins 4 "-"; au delà de 4 tirets, c'est le même effet.
Exemple :
Comme ces 4 tirets - - - - ont un espace entre eux, on les voit;
néanmoins, à la ligne suivante, ils n'ont pas d'espace entre eux.
- Les versions 0.1.x sont pleines de trous de sécurité et ne sont plus supportées. Il faut donc virer ces explications. Je pense que l'explication sur ces notions doit se résoudre au strict minimum. Le BacASable est là pour tester... -- CharlesNepote
Retour de ligne forcé :
j'espère avoir mieux explicité comment utiliser les trois "-".
Retour de ligne forcé :
Ce § en violet est entre deux paires de guillemets doubles, mais pas le suivant. Quand on est pas entre deux paires de guillemets doubles --- et qu'à l'édition, on écrit trois tirets d'affilée, comme ceux-ci, --- dans la page publiée, il y aura un changement de ligne, --- comme vous pouvez le voir.
Quand on est pas entre deux paires de guillemets doubles
et qu'à l'édition, on écrit trois tirets d'affilée, comme ceux-ci,
dans la page publiée, il y aura un changement de ligne,
comme vous pouvez le voir.
- Même remarque que ci-dessus. D'ailleurs je ne vois pas bien l'utilité des 3 tirets... Ne pourrait-on les virer ? -- CharlesNepote
- Un premier problème des règles des listes, c'est qu'on commence en recommandant d’utiliser la touche TAB, même si on finit en disant que ça ne marche pas pour Mozilla.
- Il apparaît qu'il conviendrait donc de premièrement recommander d'utiliser les espaces, et d'éléminer la touche TAB et l'instruction de ne pas mélanger les deux, espaces et tabs, et aussi d'indiquer combien d'espaces font quoi, ou ne font pas.
- Un autre problème, c'est qu'on n'indique pas comment ça fonctionne et il n'y a rien comme un exemple pour aider à comprendre :
L'indentation de textes se fait avec la touche "TAB". Vous pouvez aussi créer des listes à puces ou numérotées :
- - liste à puce
- 1) liste numérotée (chiffres arabes)
- A) liste numérotée (capitales alphabétiques)
- a) liste numérotée (minuscules alphabétiques)
- i) liste numérotée (chiffres romains)
Vous pouvez également indenter du texte en utilisant des caractères espace au lieu de la touche "TAB", les exemples ci dessus restent valables mais attention à ne pas mélanger des "TAB" et des espaces dans la même énumération.
- - liste à puce
- 1) liste numérotée (chiffres arabes)
- A) liste numérotée (capitales alphabétiques)
- a) liste numérotée (minuscules alphabétiques)
- i) liste numérotée (chiffres romains)
DjO estime que ce qui suit est beaucoup plus clair pour quelqu'un qui se familiarise avec WikiNi.
-Liste à puces
Sauter un espace en début de ligne, écrire un - puis votre item; ainsi de suite, à chaque item.
- liste à puces item #1
- liste à puces item #2
- liste à puces item #3
- Liste à puces : un espace en début de ligne, suivi d'un -
- Liste à puces : deux espaces en début de ligne, suivi d'un -
- Liste à puces : un espace en début de ligne, suivi d'un -
- Liste à puces : deux espaces en début de ligne, suivi d'un -
- Liste à puces : trois espaces en début de ligne, suivi d'un -
- Liste à puces : quatre espaces en début de ligne, suivi d'un -
- Liste à puces : deux espaces en début de ligne, suivi d'un -
a) Liste numérotée (minuscules alphabétiques)
Sauter un espace en début de ligne, (ré)écrire a) puis votre item.
- liste à minuscules alphabétiques; item #1
- liste à minuscules alphabétiques; item #2
- liste à minuscules alphabétiques; item #3
A) Liste numérotée (capitales alphabétiques)
Sauter un espace en début de ligne, (ré)écrire A) puis votre item.
- liste à capitales alphabétiques; item #1
- liste à capitales alphabétiques; item #2
- liste à capitales alphabétiques; item #3
1) Liste numérotée (chiffres arabes)
Sauter un espace en début de ligne, (ré)écrire 1) puis votre item.
- liste à chiffres arabes; item #1
- liste à chiffres arabes; item #2
- liste à chiffres arabes; item #3
i) Liste numérotée (chiffres romains)
Sauter un espace en début de ligne, (ré)écrire i) puis votre item.
- liste à chiffres romains; item #1
- liste à chiffres romains; item #2
- liste à chiffres romains; item #3
- liste à chiffres romains; item #4
- liste à chiffres romains; item #5
- Personnellement, je trouve ça beaucoup trop long. -- CharlesNepote
InclureUneImage
est un lien qui mène à une discussion assez abondante, dans laquelle l'un(e) risque de se perdre, avant de trouver la réponse.
DjO estime que la réponse peut ressembler à ceci :
Insérer une im@ge
- En premier lieu, l'im@ge doit être sur le Web dans un esp@ce qui permet qu'on la télécharge ailleurs que dans la p@ce dans laquelle elle se trouve ; par exemple, on ne peut pas appliquer la recette qui suit avec une im@ge qui se trouve dans un esp@ce gratuit fourni par Yahoo!, car Yahoo! économise ainsi sur la bande passante de ses serveurs Web.
- En second lieu, éthiquement parlant, encore à cause de la bande passante, on ne devrait pas se connecter à une im@ge sans avoir la permission du "propriétaire" de l'esp@ce Web dans lequel elle se trouve ; un compromis pourrait être de faire de cette im@ge un lien vers l'esp@ce dans laquelle elle se trouve, mais idéalement avec la permission du propriétaire de l'esp@ce Web.
- En troisième lieu, voici la recette :
L'adresse URL de la première im@ge est : http://www.djo.ca/w01blue.gif
Dans un WikiNi, il faut écrire l'@dresse, entre deux paires de parenthèses [ et ]
- ou soit avec le http:// et aussi un texte dit alternatif :
- [[http://www.djo.ca/w01red.gif WikiNi]] =
- Oui, sur le principe. Beaucoup trop long sur la forme. -- CharlesNepote
Voir le site de
GillesJobin qui a ajouté la surbrillance par ~~ et les 3 couleurs de base par #V# #R# #B#
a été transformé à
Surlignage
Pour ce qui est des listes, le formatage WikiNi est plus simple que le HTML; néanmoins, pour ce qui est du surlignage, le HTML sort-il gagnant ? voir DjO. Certains WiKis? WikiNi, comme celui de GillesJobin ont été adapté et permettent le surlignage en jaune par ~~ et, les 3 couleurs de base, par #V# #R# #B#. , mais ça ne fonctionne pas dans ce WiKi-ci.
- La surbrillance est un vrai sujet dont on peut discuter. Attention, sur les clavier en France, l'usage de ~~ n'est pas très évident... -- CharlesNepote
Tableaux; notes
J'ai aussi rajouté une section tableau dont ce lien
pour savoir comment configurer les tableaux par encodage WikiNi :
Ensuite, j'ai suivi avec une explication des deux paires de "%" et de la fenêtre qu'elles créent, ce qui somme somme toute n'est finalement pas fait dans ReglesDeFormatage...
Je termine avec les tableaux par HTML et fournit un code tout cuit pour insérer un tableau bleu.
Je n'entre pas dans ce qui suit et je crois que ça devrait être archivée, mais pas dans la nouvelle page de règles de formatage FormatageWikini ?
Discussion des améliorations proposées par DjO
Gobalement, la page
FormatageWikini me paraît plus claire et plus complète que
ReglesDeFormatage, aux petits bémols suivants :
- ne pas mettre en avant le HTML, c'est un usage détourné de la possibilité de ne pas interpréter le texte par WikiNI (=afin d'éviter les mises en forme non souhaitées)
- enlever les séparateurs horizontaux (la plupart) pour avoir une page plus lisible
- ne parler que de la version en cours de WikiNi (ce qui était en 0.1.1.0.3 d'actualité n'est plus intéressant aujourd'hui, tout comme ce qui se faisait pour wakka)
- je verrais l'ordre suivant pour les sections :
- Règles de base du formatage
- En-têtes
- Liste
- liens
- images
- utilisation spécialisée de WikiNi : affichage de code, logs (avec le <pre> du HTML), ...
- tableau (ce n'est actuellement pas une fonctionnalité de WikiNi)
- pour le HTML ce serait plutôt sur une autre page vers laquelle faire un lien (en donnant les explications que tu as faites pour conserver la cohérence d'affichage de WikiNi et en précisant comment ne pas avoir à y faire appel en passant par du CSS qui permet de modifier l'affichage des sémantiques de base existantes)
voilà c'est un début --
BenoitAudouard 20041017
Merci
DjO pour toutes ces remarques dont beaucoup sont fort justes et très bien vues. J'ai tenu compte de beaucoup d'entres elles et abouti à une proposition mixant plusieurs de nos points de vue. J'ai tâché de faire le plus court et le plus sobre possible pour ne pas assommer le lecteur qui découvre
WikiNi. Je préfère lui donner cette impression de simplicité qui conduit effectivement l'usage de
WikiNi. Qu'en pensez-vous ? J'y pense, on pourrait peut-être faire deux pages distinctes :
- les ReglesDeFormatage, version concise
- les ReglesDeFormatageDetaillees?, version plus verbeuse
--
CharlesNepote
DjO: J'ai effectué la révision complète de
FormatageWikini, en tenant compte de la rétroaction de
BenoitAudouard
En premier lieu
- ne pas mettre en avant le HTML, c'est un usage détourné de la possibilité de ne pas interpréter le texte par WikiNI (=afin d'éviter les mises en forme non souhaitées)
- J'affirme à la première phrase que l'encodage HTML y est impossible, même si bien sûr je parle de WikiWikiWeb, puis j'indique comment suspendre le formatage WikiNi...
- J'ai enlevé les séparateurs horizontaux (la plupart) pour avoir une page plus lisible.
- Je ne mentionne plus les mentions antérieures de WikiNi.
J'ai suivi l'ordre suggéré
- Règles de base du formatage
- En-têtes
- Liste
- liens
- images
- utilisation spécialisée de WikiNi :
- fenêtre avec "%"
- affichage de code, logs (avec le <pre> du HTML), ...
- Finalement, je parle de ce que l'on ne peut pas faire, pour l'instant, avec un WikiNi cru
- Le surlignage : lien vers développeur
- Les tableaux : lien vers développeur
- Les deux étant possibles par HTML ; brève explication
- Bouton HTML, pour le HTML sur une autre page.
Renvois