PureWiki - Documentation Universelle pour PureBasic

Dräc · Message par **Dräc** » mar. 09/août/2005 23:47

Bonjour à tous,

J’ai pu remarquer que nombreux étaient ceux qui avez des remarques constructives et des envies sur la documentation officielle :
- partie non traduite
- manque de précisions
- plus d’exemples
- manque de clarté
- manque de liens entre les pages… etc…

Or, actuellement un projet de documentation en ligne pour PureBasic est en développement.
Son nom : PureWiki.

Il est hébergé par André l’administrateur de PureArea connu de tous.

La première particularité de ce projet est de permettre à chacun, selon son temps, ses envies, ses domaines de compétences… de participer !
En effet, chacun peut apporter sa brique à l’édifice en modifiant directement les pages.

Pour réaliser cela, le systeme Wiki à été retenu.
De nombreux sites l’utilisent et vous le connaissez certainement depuis plus longtemps que moi.

L’autre particularité du projet PureWiki est qu’il regroupe les trois communautés majeures de PureBasic : Anglophone, Allemande, Francophone.
C’est à dire que les pages sont écrites indépendamment en anglais, en allemand ou en francais.
Ce sont les liens entre les pages qui donnent une logique aux documents.
On peut le voir comme étant trois documentations différentes et indépendantes, plus ou moins étoffés selon la participation de chaque communauté et dont des passerelles sont jetée entre les différentes versions.

Si dans l’idéal, on imagine constituer une même documentation traduite dans toutes les langages, dans la pratique cela n’est pas directement réalisable.

Aussi, il faut bien comprendre que chaque communauté est libre de faire ce que bon lui semble de ses pages.

Pour démarrer le projet et partir sur des éléments concrets, un sommaire commun à été dressé.

Cela a le mérite de proposer une base commune, du moins au départ : car tout est modifiable.
Aussi, si une partie s’avérait non correcte, perfectible, trop floue ou autre, chacun peut la modifier sans chercher à forcement « consulter » les autres communautés. A l’inverse, une page ajoutée par une communauté n’a pas l’obligation d’être traduite. Cependant, si vous la trouvez intéressante, vous pouvez le faire et lier ainsi un peu plus les différentes documentations entre-elles…

Pour exemple, personnellement j’ai rédigé les parties 2 et 3 de l’actuel sommaire, en francais et en anglais.
Je les ai liées ensembles et la communauté allemande en a traduit quelques-unes.

Lisez les et si une information est incorrecte, corrigez-la!
Si la logique est trop compliquée et que vous avez plus simple, alors très bien : discutez-en, proposez car les modifications sont tjrs possibles, par vous ou par un autre.

Si vous êtes intéressé par écrire certaines pages, allez y, d’autant que le projet est à ses débuts.

Bref, que dire de mieux que la liberté est totale, du moment qu’elle fait progresser le projet…
J’espère vous avoir donné envies et que vous participerez selon vos penchants à offrir à tous une documentation riche et complète.

Le systeme Wiki :
Quelques lignes rapides pour introduire le Wiki:
Le systeme Wiki, permet l’édition en ligne de pages web. Tout le monde peut contribuer au contenue des pages.
Ainsi, un projet peut facilement s’étoffer grâce à la contribution éparse de tous.

Pour cela, une page Wiki est au moins divisée en deux :
Un onglet pour visualiser la page
Un onglet pour l’éditer la page

D’autres onglets existent pour permettre de gérer les modifications afin que chacun puisse suivre l’historique des changements.
Avec un peu d’entraînement, on s’habitue vite.

Le système d’édition se veut assez simple.
Ainsi, pour ajouter une page : il suffit d’appeler le nom de la page dans la barre de son navigateur comme si elle existait.
La page vous est alors proposée en mode édition (pour la créer effectivement)

Pour créer un lien dans une page il suffit de taper le titre de la page visée par le lien entre doubles crochets
Ex : [[titre]]

Pour PureWiki, comme différentes communautés interviennent, une convention a été adoptée pour référencer une page.
Il s’agit de mettre le code de la langue (fr pour francais) suivit du titre de la page, comme le montre l’exemple :
Ex : [[fr:titre]]

Si la page n’existe pas, le lien apparaît en rouge. En cliquant sur le lien vous pouvez la crée.

Ecrire le contenu d’une page rappelle beaucoup l’HTML, mais en plus simple.
Le HTLM est d’ailleurs tout à fait compris par le langage Wiki.

Bref, inspirez-vous des pages déjà existantes, elles sont là aussi pour vous permettre de se familiariser.
Une documentation existe expliquant bien mieux tout cela.
http://fr.wikipedia.org/wiki/Wikip%C3%A ... p%C3%A9dia

Dernières choses sur PureWiki : Pour pouvoir modifier des pages, on n’est pas forcé de s’inscrire.
Cependant pour s’inscrire sur le projet de documentation PureWiki, le lien est en haut à droite de la page principale

La page principale en francais est à l’adresse suivante :
http://www.purearea.net/pb/english/pure ... Principale

Pour l’instant, sur la partie gauche de l’écran, les liens ne pointent que les pages en anglais.
Petite astuce : en haut de la page principale en anglais (Main Page) un lien existe pour se diriger vers celle en francais.

Fred a donné son accord pour exploiter la doc officielle !
Cela représente une bonne base dans la rédaction !

A noter aussi qu’un espace réservé existe regroupant les membres du projet PureWiki.
Je trouve cela pas forcement adapté pour ce projet communautaire.

Néanmoins, sachez que tout le monde peut prétendre à y faire partie en adressant son adresse e-mail à GedB (personne qui a initié ce truc : http://forums.purebasic.com/english/vie ... 1&start=30 ).
J’y suis inscrit, Fred aussi,
Pour ma part, je voulais suivre de prés les évènements. Cela m’a permis entre autre de contribuer à obtenir une version francaise de PureWiki.
Cependant, je crois qu’il ne faut pas attacher grande importance à ceci. Il ne se passe pas grand chose et le but de ce regroupement était de faciliter le démarrage du projet.

André, par son implication dans PureBasic est le garant d’un projet sein et serin.
Il héberge PureWiki, mais tous les efforts que mettra la communauté est considéré public.

Voilou…

comtois · Message par **comtois** » dim. 14/août/2005 10:28

ça va être cool quand tout le monde s'y mettra

Que dirais-tu d' écrire en commun une moulinette pour convertir la doc au format wiki ?
ça permettrait de mettre en ligne plus facilement les docs française ,anglaise et allemande.

Anonyme2 · Message par **Anonyme2** » dim. 14/août/2005 11:04

Question

C'est uniquement consultable en ligne ?
Si oui c'est pas le bon plan, enfin pour moi.
Pour le reste c'est interessant

Dräc · Message par **Dräc** » dim. 14/août/2005 13:02

comtois a écrit :ça va être cool quand tout le monde s'y mettra

Oui et c’est pour cela que je parle de ce projet dès maintenant !

comtois a écrit :Que dirais-tu d' écrire en commun une moulinette pour convertir la doc au format wiki ?
ça permettrait de mettre en ligne plus facilement les docs française ,anglaise et allemande.

Je travaille sur un outil/librairie qui devrait permettre de faciliter grandement ce genre de travail!
Il réalise l’analyse syntaxique d’un code source à partir de la description de la grammaire du langage (celle du HTML, du C etc…).
L’outil est donc général et permet de faire toute sorte de traduction.

Il est déjà opérationnel et je suis en train de compléter les commandes utilisateur.
Un peu de patience donc si cette solution vous intéresse…

Denis a écrit :C'est uniquement consultable en ligne ?

Pour te répondre Denis, voici la vision d’André sur le but du projet PureWiki:

“Main goal of this project is to have a proper online documentation and
give all PureBasic users the possibility to learn from the basics to
more advanced functions.

But I would also like to see improvements at the real PB manual
(purebasic.chm in PB package) based on this project.”

Donc, PureWiki sera d’abord une doc en ligne. Normal!
Cependant, elle devrait servir par la suite de support afin d’améliorer le manuel officiel de PureBasic.
Sous quelle forme exactement? S’agit-il de modifier le manuel lui-même ou d’inclure une doc complémentaire lors du téléchargement, ce n’est pas encore clair.

Mais le projet étant publique, on peut tout à fait imaginer sortir une version .chm.

Néanmoins, toutes modifications ne pourront se faire autrement qu’en ligne.

jerexgrz · Message par **jerexgrz** » lun. 15/août/2005 10:08

Vraiment interessant ca !

Crystal Noir · Message par **Crystal Noir** » mar. 11/oct./2005 13:06

moi ca m'interesse bien ce projet, mais je dois dire que je pige que dalle à l'édition et aux conventions lol

Pierre · Message par **Pierre** » mar. 11/oct./2005 16:43

moi jtrouve que c'est une super idée le Purewiki ^^

Dräc · Message par **Dräc** » mar. 11/oct./2005 21:39

Crystal Noir a écrit :moi ca m'interesse bien ce projet, mais je dois dire que je pige que dalle à l'édition et aux conventions lol

Quelqu’un capable de faire un site comme 2Dev, je ne le crois pas une seconde… flémard

Crystal Noir · Message par **Crystal Noir** » mer. 12/oct./2005 8:29

Non non c'est vrai, c'est vrai que coder en php sur 2Dev ne m'a pas posé de pb. Cela dit sur les Wiki toutes ces conventions, j'pige que dalle lol.

Tiens une idée comme ca, pourquoi dans la partie en bas, pour les tutos, au lieu d'avoir "liste des tutos", on pourrait pas mettre directement des tutos justement ? yen a pleins sur ce forum....

Dräc · Message par **Dräc** » mer. 12/oct./2005 20:10

En fait c’est un lien vers une page contenant les tutoriaux, eux-mêmes décris par la suite.
C’est simplement pour ne pas alourdir le sommaire.

Tu peux voir ceci sur les pages anglais.

L’idée est de trouver des tutoriaux divers, traitant d’un sujet ciblé. Soit il est directement complet (ex : celui de comtois sur GCN), soit le sujet est ouvert et se complète au fur et à mesure des apportes de chacun…
L’avantage c’est que l’on peut remanier les textes pour inclure plus naturellement les évolutions.

Récupérer des tutos du forum est donc une bonne idée. Il suffit de se lancer…

Dräc · Message par **Dräc** » jeu. 03/nov./2005 20:38

comtois a écrit :ça va être cool quand tout le monde s'y mettra

Que dirais-tu d' écrire en commun une moulinette pour convertir la doc au format wiki ?
ça permettrait de mettre en ligne plus facilement les docs française ,anglaise et allemande.

Voila, c'est fait: André vient de traduire le manuel PureBasic en Wiki.
La version francaise est ici.
http://www.purearea.net/pb/download/Pur ... sionFR.zip

Pour ceux que cela intéresse de participer, c’est un bon moyen de débuter en intégrant ces pages sur le site.

Frenchy Pilou · Message par **Frenchy Pilou** » jeu. 03/nov./2005 21:49

Un truc que j'ai jamais compris dans ce système "Open", c'est, qu'est-ce qui empèche une âme mal intentionnée de tout effacer si cela lui chante ?

Heis Spiter · Message par **Heis Spiter** » jeu. 03/nov./2005 23:12

Rien

Dräc · Message par **Dräc** » ven. 04/nov./2005 0:03

Pas tout a fait. Toutes les modifs sont tracées, donc on peut revenir en arrière et puis on peut imaginer obliger les gens à etre enregistré pour effectuer des modifs ( ce qui n’est pas le cas pour PureWiki)