Travail sur la documentation

Tout ce qui est lié au développement du logiciel
Post Reply
User avatar
Jmgr
Admin
Posts: 1641
Joined: 07 Dec 2005, 15:45
Contact:

Travail sur la documentation

Post by Jmgr »

Je sens sur ce forum les "frémissements" de la future version Actiona 3.9.0 !... Est-ce que je peux espérer ce développement pour cette version ?? Et pourrais-tu en scoop de ce post (...) déjà annoncer une date prévisionnelle de sortie ?
Le développement avance pas mal en ce moment, c'est vrai. Cela dit, j'ai une deadline au boulot samedi soir et donc pas trop de temps libre d'ici là. Je ne peux pas donner de garantie, ça ne m'a pas l'air d'être compliqué, mais il peut toujours y avoir des problèmes cachés. Je regarde ça à la première occasion.
En tout cas, pour ce développement, je peux me charger de la documentation. Je sais que ce n'est pas la partie la plus intéressante mais ce serait ma contribution... Je ne suis peut-être pas aussi perfectionniste que toi, mais bon si tu n'as plus qu'à effectuer une relecture...
La documentation pour cette fonctionnalité là c'est assez simple : il suffit d'ajouter un paramètre dans quelques pages décrivant des actions.
La difficulté réside plus dans la création de pages décrivant une nouvelle action (comme celle qui envoie des e-mails par exemple) car cela nécessite de lire le code en C++ pour pouvoir récupérer la liste des paramètres, la liste des fonctions d'un objet Javascript, etc. Donc pas vraiment faisable par un non-développeur.

Non par contre, ce qui aiderait bien (mais ce n'est pas spécialement lié à la version 3.9), ça serait de faire une passe sur toutes les actions et les objets du code pour corriger les fautes d'orthographe et vérifier qu'il n'y a pas d'oublis (fonction manquante par exemple) par rapport à la version anglaise. En fait la version anglaise est généralement rédigée par moi-même, mais pour la version française il y a eu beaucoup de contributeurs différents, ce qui fait qu'il y a parfois des fautes et/ou des parties non traduites. Ce qui ne veut pas dire que les parties en anglais ne comportent pas de fautes, mais probablement moins :p C'est un gros travail, c'est pour ça que pour l'instant pas mal de pages sont en chantier : en général les contributeurs abandonnent au bout d'un moment :/

Sinon, il y a aussi le tutoriel "actions" en français, également rédigé par un contributeur qui a disparu depuis. Il est incomplet, comporte pas mal de fautes de français et n'est pas traduit en anglais.

Et pour finir, le tutoriel "code" de Violette, qui est excellent, mais uniquement disponible en français. Violette : penses-tu rédiger également une version anglaise ensuite ?
"My software never has bugs. It just develops random features."

Violette
Posts: 119
Joined: 10 Aug 2014, 17:42

Re: Code pour insérer un message d'aide sur l'icône "?"

Post by Violette »

Euh, très franchement même je comprends bien l'anglais, je l'écrit/parle très mal, et outre les fautes d'orthographes qui elles peuvent ce corriger sans trop de soucis, il y a les fautes de syntaxes, conjugaisons... Je voit pas trop comment faire pour éviter le syndrome google trad :x

Tara42
Posts: 40
Joined: 16 Jul 2014, 21:54

Re: Code pour insérer un message d'aide sur l'icône "?"

Post by Tara42 »

Non par contre, ce qui aiderait bien (mais ce n'est pas spécialement lié à la version 3.9), ça serait de faire une passe sur toutes les actions et les objets du code pour corriger les fautes d'orthographe et vérifier qu'il n'y a pas d'oublis (fonction manquante par exemple) par rapport à la version anglaise. En fait la version anglaise est généralement rédigée par moi-même, mais pour la version française il y a eu beaucoup de contributeurs différents, ce qui fait qu'il y a parfois des fautes et/ou des parties non traduites. Ce qui ne veut pas dire que les parties en anglais ne comportent pas de fautes, mais probablement moins :p C'est un gros travail, c'est pour ça que pour l'instant pas mal de pages sont en chantier : en général les contributeurs abandonnent au bout d'un moment :/
Je veux bien essayer d'apporter ma contribution sur ce point en particulier... Néanmoins, j'ai un boulot qui me prend facilement une dizaine d'heures par jour, ce qui ne me laisse que peu de temps pour les autres activités ! :( Mais ce sont les petits ruisseaux qui font les grandes rivières, n'est-ce pas ?!... :D

Je n'ai plus qu'à m'inscrire sur le wiki... Allez, je vais commencer ce week-end ! S'il faut suivre une procédure ou une méthodologie particulière, merci Jmgr de me l'indiquer ! :roll:

User avatar
Jmgr
Admin
Posts: 1641
Joined: 07 Dec 2005, 15:45
Contact:

Re: Code pour insérer un message d'aide sur l'icône "?"

Post by Jmgr »

Exactement, d'ailleurs c'est aussi pour ça qu'Actiona est un logiciel libre et que la documentation est un wiki : pour que tout le monde puisse y participer. (la seule page verrouillée c'est la page d'accueil car elle contient les liens de téléchargement).
Je n'ai plus qu'à m'inscrire sur le wiki... Allez, je vais commencer ce week-end ! S'il faut suivre une procédure ou une méthodologie particulière, merci Jmgr de me l'indiquer ! :roll:
Une méthodologie pour s'inscrire ? Non non, juste remplir les différents champs du questionnaire :mrgreen:

Plus sérieusement, dis moi ce qui t'intéresse le plus et je te donnerai plus de détails. Pour les traductions par exemple il est important de ne pas traduire (vers le français par exemple) certains éléments comme le nom des objets Javascript, les mots-clefs dans les exemples de code (this, function), etc.
"My software never has bugs. It just develops random features."

francois
Posts: 350
Joined: 18 Oct 2010, 10:33
Location: France

Re: Code pour insérer un message d'aide sur l'icône "?"

Post by francois »

Bonjour,

Pour rester dans le fil de la discussion, sur le site wiki je propose de :

1) rechercher d'éventuelles fautes d'orthographe dans la version française,
2) signaler ce qui n'est pas à jour dans la version française relativement à la version anglaise.

Le 1) est quand même un peu rébarbatif , je ferai cela 1/2 heure à 3/4 heure par jour. Comme je ne ferai que des 'minor change', je présume qu'il n'est pas nécessaire de signaler les modifs.
Pour le 2), simplement signaler ? ou carrément faire la mise à niveau ?

Concernant la présente demande d'aide, je conseille également le tutoriel "code" de Violette.


Francois.

User avatar
Jmgr
Admin
Posts: 1641
Joined: 07 Dec 2005, 15:45
Contact:

Re: Code pour insérer un message d'aide sur l'icône "?"

Post by Jmgr »

Activer "minor change" ça veut dire que les personnes s'étant inscrites pour recevoir un e-mail lorsqu'une page est modifiée ne le recevront pas, et que le flux RSS ne sera pas modifié. Je pense que s'il ne s'agit de d'une correction de fautes alors "minor change" me semble être approprié, mais ce n'est pas très grave non plus s'il a été omis (ça peut être un peu pénible d'avoir à cocher la case systématiquement).
Pour le 2), une étape intermédiaire pourrait être de copier/coller les parties manquantes de l'anglais vers le français, sans forcément faire la traduction. Quitte à refaire une passe ensuite pour traduire ce qui ne l'a pas été.
"My software never has bugs. It just develops random features."

Tara42
Posts: 40
Joined: 16 Jul 2014, 21:54

Re: Code pour insérer un message d'aide sur l'icône "?"

Post by Tara42 »

Je viens donc de m'inscrire sur le wiki !... :P
Sinon, il y a aussi le tutoriel "actions" en français, également rédigé par un contributeur qui a disparu depuis. Il est incomplet, comporte pas mal de fautes de français et n'est pas traduit en anglais.
Pour ne pas être en doublon sur la proposition de François, je vais corriger et compléter le tutoriel "actions" en français. :wink:

On verra ensuite pour la traduction...

User avatar
Jmgr
Admin
Posts: 1641
Joined: 07 Dec 2005, 15:45
Contact:

Re: Code pour insérer un message d'aide sur l'icône "?"

Post by Jmgr »

Super :)
"My software never has bugs. It just develops random features."

francois
Posts: 350
Joined: 18 Oct 2010, 10:33
Location: France

Re: Code pour insérer un message d'aide sur l'icône "?"

Post by francois »

Bonsoir,

Ok, je vais donc travailler sur le tutoriel 'code' en contribuant à mettre à niveau la version en français relativement à la version en anglais.
Je ferai donc comme l'a indiqué JMGR en faisant des copier/coller pour les parties manquantes de l'anglais vers le français.

En effet, si je lis correctement l'anglais ( dans le boulot, la doc. informatique était en anglais), mon niveau en écriture n'est pas suffisant.

Quand j'aurais fini ( courant janvier j’espère), j'enverrai un message avec un classeur XLS.

Dans ce classeur XLS, les rubriques où une partie a été copiée de la version en anglais.

colonne 1 : la rubrique;
colonne 2 : (Pour aider à trouver) les 4/5 premiers mots de cette partie issue de la version en anglais.


Les rubriques (cf la 1ere page dans wiki relative au code) :

Core (composants de base)

Global
Actionaz
Console
Execution
Script
Stdio
Window
Point
Rect
. . .

JMGR, peut-être serait-il bien que je commence cela juste après que tu aies livré la 3.9.
A toi de voir.

Francois.

User avatar
Jmgr
Admin
Posts: 1641
Joined: 07 Dec 2005, 15:45
Contact:

Re: Travail sur la documentation

Post by Jmgr »

Tu peux peut-être juste insérer un mot-clef aux endroits où tu as copié-collé du contenu, par exemple [TODO:Translate]. Ça sera peut-être un peu moins laborieux que de faire des entrées dans un fichier, non ? Et puis ça permettra également à d'autres personnes de traduire au fur et à mesure de ta progression.
JMGR, peut-être serait-il bien que je commence cela juste après que tu aies livré la 3.9.
A toi de voir.
Je pense que je vais attendre la sortie de Qt 5.4 avant de publier la prochaine version. Qt 5.4 est prévue pour début décembre.Elle permet de faire des programmes qui fonctionnent sur Windows XP ou plus, et qui ne nécessitent pas d'avoir installé des pilotes de carte graphique récents, contrairement à la version 5.3 qui impose de faire un choix entre les deux options (et d'avoir deux installeurs...).
Pourquoi veux-tu attendre la prochaine version ? De toute façon la documentation est uniquement en ligne.
"My software never has bugs. It just develops random features."

francois
Posts: 350
Joined: 18 Oct 2010, 10:33
Location: France

Re: Travail sur la documentation

Post by francois »

Si la doc. est uniquement en ligne, no pb .

Je commence dès demain (pour la partie code) en utilisant ce que tu as indiqué : [TODO:Translate]

Francois

francois
Posts: 350
Joined: 18 Oct 2010, 10:33
Location: France

Re: Travail sur la documentation

Post by francois »

Finalement, ce n'était pas si long que cela.

J'ai passé en revue toutes les rubriques pour la partie code.
Il y en a 4 ou 5 où j'ai donc importé la partie en anglais avec [TODO:Translate] en mot-clé.

Il y avait une grande différence entre les 2 docs uniquement pour 'image'.

Francois.

Tara42
Posts: 40
Joined: 16 Jul 2014, 21:54

Re: Travail sur la documentation

Post by Tara42 »

Sinon, il y a aussi le tutoriel "actions" en français, également rédigé par un contributeur qui a disparu depuis. Il est incomplet, comporte pas mal de fautes de français et n'est pas traduit en anglais.
J'ai corrigé les trois premiers tutoriaux existants (principalement des fautes de français) et j'ai proposé au niveau du sommaire d'autres tutoriaux sur lesquels je vais commencer à travailler (le premier sur les branchements et les boucles était déjà proposé mais n'avait pas été rédigé).

Liste des tutoriaux

Je vais m'inspirer de mes propres scripts pour réaliser ces tutoriaux mais comme je n'ai pas beaucoup de temps libre, cela risque d'être long !... :roll:

User avatar
Jmgr
Admin
Posts: 1641
Joined: 07 Dec 2005, 15:45
Contact:

Re: Travail sur la documentation

Post by Jmgr »

francois wrote:Finalement, ce n'était pas si long que cela.

J'ai passé en revue toutes les rubriques pour la partie code.
Il y en a 4 ou 5 où j'ai donc importé la partie en anglais avec [TODO:Translate] en mot-clé.

Il y avait une grande différence entre les 2 docs uniquement pour 'image'.

Francois.
Super ! Oui, je crois que la/les personnes qui ont commencé la traduction n'ont pas copié-collé la page entière mais ont ajouté des bouts au fur et à mesure, ce qui est une mauvaise idée... Du coup, content que ça soit réparé :)
Tara wrote:
Sinon, il y a aussi le tutoriel "actions" en français, également rédigé par un contributeur qui a disparu depuis. Il est incomplet, comporte pas mal de fautes de français et n'est pas traduit en anglais.
J'ai corrigé les trois premiers tutoriaux existants (principalement des fautes de français) et j'ai proposé au niveau du sommaire d'autres tutoriaux sur lesquels je vais commencer à travailler (le premier sur les branchements et les boucles était déjà proposé mais n'avait pas été rédigé).

Liste des tutoriaux

Je vais m'inspirer de mes propres scripts pour réaliser ces tutoriaux mais comme je n'ai pas beaucoup de temps libre, cela risque d'être long !... :roll:
Impeccable, j'ai hâte de voir ça :)
"My software never has bugs. It just develops random features."

Post Reply