[v4] Corrections & Améliorations de la doc FR

comtois · Message par **comtois** » jeu. 06/avr./2006 18:19

Problèmes dans l'aide FR

Fait : OpenWindow()
Fait : ListIconGadget()

Fait : La partie "Options des structures"
Fait : La partie "Procédures"
Fait : Thèmes Divers\"Handles et Nombres"
Fait : "Bases numériques"
Fait : "Liens Internet Utiles"

Gras fait , manque traduction : 'ide_externaltools.html

Mot clé de DocMaker, faut modifier le source : Ajouter un "e" à "Syntax"

Fait : "Handles and Numbers" (handles.html)
Fait : "Port Numbers" (portnumbers.html)
Fait : "PureBasic Visual Designer" (visual_designer.html)
Fait : "Windows Message Handling" (winmessages.html)

Pour winmessages.html, il n'y a pas d'accès direct , ce soir je vais ajouter un lien en direct juste après "Identifiants (Handles) et numéros"
Et je vais reprendre les liens de la page liens utiles. et quand ça sera fait , je mettrai une nouvelle version à disposition.

[EDIT]
RegisLG : Remplacer OS=ALL par OS=Tous (comtois: nécessite un update de docmaker ?) , Euh c'est fait , où est-ce que tu vois des ALL ??

RegisLG · Message par **RegisLG** » jeu. 06/avr./2006 19:01

comtois a écrit :Gras fait , manque traduction : 'ide_externaltools.html

J'étais en train de la faire justement, je mets le lien sur la page 1.

comtois a écrit :RegisLG : Remplacer OS=ALL par OS=Tous (comtois: nécessite un update de docmaker ?) , Euh c'est fait , où est-ce que tu vois des ALL ??

Bah en fait, je l'ai remis depuis que tu avais dit ça :

Comtois a écrit :RegisLG , il a fallu que je revienne en arrière, j'ai remplacé les Tous par les All.

J'avais mis ça :
Citation:
@SupportedOS Tous

Mais ça ne veut rien dire pour DocMaker. il faut garder le
Citation:
@SupportedOS All

Et Fred devrait changer le source de DocMaker. Donc à suivre

Mais si c'est bon on pourra le virer, j'attends le nouveau chm

comtois · Message par **comtois** » jeu. 06/avr./2006 19:52

Le nouveau chm est disponible.
PureBasic.chm

Pour le ALL c'était déjà fait dans le dernier chm , et même dans l'aide jointe à la beta 9.
Donc normalement tu devrais déjà pouvoir le vérifier chez toi

Fait : ide_externaltools.html
je n'ai pas tout relu , j'ai juste remplacé %EXECUTABLE qui était en anglais et ajouté LIGNEDEBUTxCOLONNEDEBUTxLIGNEFINxCOLONNEFIN.

S'il y avait autre chose à reprendre dans ce fichier, dis le moi.
Quand tu touches à un mot , ou quelques mots sur une page qui existe déjà en français , souligne les mots ou change la couleur que je les repère plus facilement

RegisLG · Message par **RegisLG** » jeu. 06/avr./2006 20:19

Pour les liens internet j'avais changé plusieurs choses :
francisé le libellé des sites quand c'est possible
corrigé les URLs incorrectes
amélioré la présentation

Pour Outils externes, il y a beaucoup de changements, car j'ai vérifier les noms des options, ajoutés les trucs manquants, reformulé certain phrases.

Le problème c'est qu'il y tellement de changements que si je dois faire un changelog de tout, ça risque d'être long.
Par exemple rien qu'entre la version actuelle d'OpenWindow et celle de mon site il y a déjà ces petites différences:

Code : Tout sélectionner

OpenWindow()
Syntaxe : remplacer "[Options" par "[, Options"
Description :
remplacer '#BarreOutils' par '#Fenetre'
ajouter un s à "nécessaire"
ajouter retour ligne <br> après 'Resultat'
remplacer "fenêtre en cours" par "fenêtre active"
corriger "quelle fenetre" par "quelle fenêtre"

Voilà ma méthode de travail :
je prends ton dernier PureBasic.chm que je décompile (avec chmunpacker), ça me donne un dossier dans lequel j'ai l'arborescence 2DDrawing, AudioCD etc.. avec les différents chapitres de chaque bibliothèque au format html.
Je traduit/corrige directement ces fichiers html et je les mets à disposition.

Je pensais que tu pouvais directement faire un copier/coller des fichiers html mis à jour et ensuite recompacter le tout mais apparement ce n'est pas comme ça que tu procèdes.

Si tu peux m'expliquer les différentes étapes en partant de ton PureBasic.CHM =>décompilation en fichier zzzz =>recompilation, ça me permettrait de mieux comprendre comment se présente le fichier zzzz, et de te le proposer directement à ce format.

comtois · Message par **comtois** » jeu. 06/avr./2006 21:31

Pour les liens internet, c'est fait et intégré dans le fichier chm, tu as vu autre chose ?

Pour OpenWindow() , je ferai les modifs.

Si tu peux m'expliquer les différentes étapes

Ben, le mieux c'est d'avoir accès au cvs, et seul Fred peut te le donner.

Message par **Fred** » jeu. 06/avr./2006 22:06

Il y a un acces anonyme pour le cvs public (lecture seule). Seul Comtois a les droits en écriture, ce qui me parait suffisant pour l'instant (vu l'enorme boulot qu'il fait). Pour l'acces en anonymous:

le CVSROOT:
:pserver:anonymous@alphasnd.dyndns.org:/home/cvs/Public

le module: Documentation

Les fichiers sont au format docmaker. Je recommande TortoiseCVS pour acceder au CVS sous Windows, c'est le plus intégré.

LeCyb · Message par **LeCyb** » jeu. 06/avr./2006 22:19

Il y a aussi une erreur à propos de ImageGadget, voir ce post:
http://purebasic.hmt-forum.com/viewtopic.php?p=46549

Merci à comtois pour le taff

flaith · Message par **flaith** » jeu. 06/avr./2006 22:41

LeCyb a écrit :...Merci à comtois pour le taff

je dirais même plus, merci à Comtois et à Regis pour leur taff

RegisLG · Message par **RegisLG** » jeu. 06/avr./2006 23:41

@FRED MERCI ! J'ai installé TortoiseCVS et récupéré la doc, je comprends mieux le format maintenant

J'ai voulu tester la compilation avec docmaker en suivant les instructions du readme. Ca se passe presque parfaitement : arrivé à la phase du passage automatique à htmlworkshop, j'ai eu une fenetre de ligne de commandes affichant des erreurs qui s'est refermé en 1/100 de secondes. Le chm a quand même été crée.
Curieux, j'ai ouvert le 'PureBasic Help.hhp' crée par docmaker dans htmlworkshop et lancer une compilation, et là je vois les avertissements suivants :

Code : Tout sélectionner

Microsoft HTML Help Compiler 4.74.8702

Compiling c:\Documents and Settings\Administrateur\Bureau\test\PureBasic.chm

HHC1000: Note: AddElement.html : An empty HTML tag has been used.
HHC1000: Note: AddElement.html : An empty HTML tag has been used.
HHC1000: Note: DisASMCommand.html : An empty HTML tag has been used.
HHC1000: Note: FirstElement.html : An empty HTML tag has been used.
HHC1000: Note: FirstElement.html : An empty HTML tag has been used.
HHC1000: Note: GetDisASMString.html : An empty HTML tag has been used.
HHC1000: Note: Inkey.html : An empty HTML tag has been used.
HHC1000: Note: InsertElement.html : An empty HTML tag has been used.
HHC1000: Note: InsertElement.html : An empty HTML tag has been used.
HHC1000: Note: LastElement.html : An empty HTML tag has been used.
HHC1000: Note: LastElement.html : An empty HTML tag has been used.
HHC1000: Note: RawKey.html : An empty HTML tag has been used.
HHC1000: Note: SetGadgetItemData.html : An empty HTML tag has been used.
HHC1000: Note: SetGadgetItemData.html : An empty HTML tag has been used.
HHC1000: Note: if_endif.html : An empty HTML tag has been used.
HHC1000: Note: general_rules.html : An empty HTML tag has been used.
HHC1000: Note: macros.html : An empty HTML tag has been used.
HHC1000: Note: macros.html : An empty HTML tag has been used.

Compile time: 0 minutes, 3 seconds
986	Topics
7,065	Local links
52	Internet links
204	Graphics

A quoi sont-ils dus ? (les sources html générés par docmaker sont incorrects ?)

@Comtois j'ai aussi le même problème que tu as eu : les codes exemples ne sont pas intégrés, comment l'as tu résolu ?

Pour tous : j'ai remis à jour la liste des choses à faire, et ajouté la traduction correcte pour ImageGadget().

comtois · Message par **comtois** » ven. 07/avr./2006 6:12

ImageGadget()
Je préfère attendre la correction de la doc anglaise, c'est la référence, si elle tarde trop je ferai la modif

Fait : OpenWindow()

Remplacer Manuel par Manuel de référence dans le sommaire
Je ne sais pas comment faire.

Sommaire (reference.html)
Comme ce n'est pas dans l'aide anglaise je le ferai en dernier, il y a encore quelques pages à relire avant

Fait : Informations Supplémentaires\Base numériques (binary.html)

Informations Supplémentaires\Liens Internet utiles (links.html)
Tu as regardé le dernier chm ? je ne vois rien d'anormal.

Ajouter des liens vers des sites FR
Dans PureArea.net au chapitre Links , il y a tous les liens des sites dédiés à PureBasic y compris l'ensemble des sites français connus d'Andre.
S'il en manque peut-être qu'il faut les signaler à Andre ?
Je pourrais ajouter une phrase dans l'aide française pour indiquer que pour trouver plus de sites dédiés il faut consulter les liens de PureArea.net ?

Fait : "Windows Message Handling" (winmessages.html)

Modifier les exemples pour qu'ils soient compatibles v4
Je laisse Fred le faire, comme les sources sont communes à toutes les docs je ne voudrais pas faire de boulettes:)
Je préfère me concentrer sur la doc française pour l'instant.
Mais si tu en vois d'autres comme ça, ajoute les à la liste.

Pour ton problème de liens avec les exemples , regarde si tu peux ajouter le module Sources.

[EDIT]
Il faut que tu saches qu'à chaque validation avec TorToiseCVS, il y a un mail envoyé à chaque membre de l'équipe de PB.
Aussi pour éviter de les bombarder de mails, je préfère regrouper les modifs, c'est pourquoi tu ne peux pas encore récupérer les modifs indiquées plus haut , elles sont faites sur mon disque dur , et je les enverrai ce soir quand j'en aurai fait d'autres.

RegisLG · Message par **RegisLG** » ven. 07/avr./2006 12:47

comtois a écrit :ImageGadget()
Je préfère attendre la correction de la doc anglaise, c'est la référence, si elle tarde trop je ferai la modif

En fait, la doc anglaise est à jour dans la mesure où elle ne parle pas des paramètres largeur/hauteur, alors que la doc FR induit en erreur. C'est pourquoi j'ai corrigé la trad en me basant sur la doc en Anglais et sa structure. Je pourrais éventuellement mettre ça au format cvs pour que tu puisses faire un copier/coller.

comtois a écrit :Remplacer Manuel par Manuel de référence dans le sommaire
Je ne sais pas comment faire.

Sommaire (reference.html)
Comme ce n'est pas dans l'aide anglaise je le ferai en dernier, il y a encore quelques pages à relire avant

J'ai cherché aussi, de toute manière ce n'est qu'une suggestion, je trouvais juste ça plus logique car toutes les entrées ont un titre en haut de page.

comtois a écrit :Fait : Informations Supplémentaires\Base numériques (binary.html)

Merci !

comtois a écrit :Informations Supplémentaires\Liens Internet utiles (links.html)
Tu as regardé le dernier chm ? je ne vois rien d'anormal.

Oui j'ai le dernier PureBasic.chm, quand je re-vérifie, c'est toujours à partir de la version que tu as annoncée sur le forum (dont la date figure sur la page 1) en esperant qu'il n'y ait pas de silent update, sinon ca ne sert plus a rien de centraliser

et donc :

- Traduire ainsi les 3 premiers libellés des liens (qui sont restés en Anglais) :
Forum officiel Anglais
Forum Allemand
Forum Français
- Modifier le lien html concernant "Lethal Judgement" qui doit maintenant pointer sur http://www.bgames.org/

comtois a écrit :Ajouter des liens vers des sites FR
Dans PureArea.net au chapitre Links , il y a tous les liens des sites dédiés à PureBasic y compris l'ensemble des sites français connus d'Andre.
S'il en manque peut-être qu'il faut les signaler à Andre ?
Je pourrais ajouter une phrase dans l'aide française pour indiquer que pour trouver plus de sites dédiés il faut consulter les liens de PureArea.net ?

Bonne idée ! Je pensais que les liens FR seraient ajoutés directement dans la page liens internet, mais cette solution est aussi efficace.

comtois a écrit :Fait : "Windows Message Handling" (winmessages.html)

Merci !

comtois a écrit :Modifier les exemples pour qu'ils soient compatibles v4
Je laisse Fred le faire, comme les sources sont communes à toutes les docs je ne voudrais pas faire de boulettes:)
Je préfère me concentrer sur la doc française pour l'instant.
Mais si tu en vois d'autres comme ça, ajoute les à la liste.

Pas de problème, j'ajouterai. A propos des exemples, j'aimerai savoir pourquoi il y en a qui sont directement intégré à la page de manuel et d'autres qui ont droit à un fichier à part (dans le manuel un lien pointe sur le fichier pb) ?

comtois a écrit :Pour ton problème de liens avec les exemples , regarde si tu peux ajouter le module Sources.

Merci je vais voir ça.

comtois a écrit :[EDIT]Il faut que tu saches qu'à chaque validation avec TorToiseCVS, il y a un mail envoyé à chaque membre de l'équipe de PB.
Aussi pour éviter de les bombarder de mails, je préfère regrouper les modifs, c'est pourquoi tu ne peux pas encore récupérer les modifs indiquées plus haut , elles sont faites sur mon disque dur , et je les enverrai ce soir quand j'en aurai fait d'autres.

Oui, je comprends bien le principe des cvs, je ferai mon updating quand tu auras fait ton committing

Pour info : je retire les "problèmes corrigés" de la liste en page 1, dès la nouvelle publication d'un nouveau chm, donc c'est normal que la liste contiennent des choses que tu as corrigées entre temps. Nous sommes bien d'accord

Par contre, si quelque chose de nouveau est signalé, je l'ajoute à la liste dès que je peux pour synthétiser.

RegisLG · Message par **RegisLG** » ven. 07/avr./2006 17:59

EUREKA ! J'ai trouvé ce qui provoque les erreurs "An empty HTML tag has been used", il s'agit de la séquence de caractères <> dans les fichiers html générés par DocMaker. Il suffit de remplacer dans les fichiers html cette séquence par son équivalent <> pour ne plus avoir de problèmes.

Bizarrement dans certains cas le <> ne provoque pas de warning de la part d'html workshop (par exemple pour le fichier : inkey.html qui est généré à partir de console.txt.

Alors 2 solutions :
1) taper la séquence <> dans les textes des cvs, ce qui me parait assez pénible.
2) ou modifier docmaker pour qu'il génère la bonne séquence

Pour les exemples, je confirme : c'est bien le module sources qu'il faut aussi récupérer, merci Comtois.

comtois · Message par **comtois** » ven. 07/avr./2006 20:21

RegisLG a écrit :EUREKA ! J'ai trouvé ce qui provoque les erreurs "An empty HTML tag has been used", il s'agit de la séquence de caractères <> dans les fichiers html générés par DocMaker.

hé hé tu es tenace

Bon j'ai actualisé le cvs tu peux télécharger

Le nouveau chm est en ligne , toujours à la même adresse :
http://perso.wanadoo.fr/comtois/Doc/PureBasic.chm

Fait : Formules mathématiques ( il reste à ajouter un exemple par section)
Fait : Correction de la page Liens internet utiles

Et je ne sais plus quoi , des bricoles , par ci par là .
Plus tout ce qui a déjà été signalé plus haut.

[EDIT]

A propos des exemples, j'aimerai savoir pourquoi il y en a qui sont directement intégré à la page de manuel et d'autres qui ont droit à un fichier à part (dans le manuel un lien pointe sur le fichier pb) ?

Je ne suis pas sûr, mais je dirais que le fichier .pb sert à illustrer plusieurs fonctions d'une bibliothèque, alors que les exemples dans la doc servent à illustrer une seule fonction.

comtois · Message par **comtois** » ven. 07/avr./2006 20:57

Je le mets ici pour mémoire, à voir si ça ne casse pas la mise en page, mais ça serait bien de mettre @Example à la place des 'Exemple'
Comme c'est un mot clé , Exemple sera automatiquement en gras.

Message par **Fred** » ven. 07/avr./2006 21:52

Je regarde rapidement passer les mails de commits qui défilent, et c'est vraiment du beau boulot, merci !