Open trebmuh opened 5 years ago
Oui par contre Qt, non-encombré de Webkit, il s'agit d'un sous-ensemble de HTML. Alors il sera plus sage faire une intégration petit à petit, plutôt qu'un document complet tel qu'il est réalisé à l'aide d'un navigateur web.
Quelle serait la nature et la longueur du document ? celui-ci doit-il être construit de manière structurée ? (section, paragraphe, ...)
Comment est-il présenté à l'utilisateur ?
J'ai dans l'idée, le même principe que le manuel embarqué dans Hydrogen par exemple.
Oui HTML ça peut convenir. Voir aussi Qt Help, qui s'avère plus pratique pour naviguer la doc si celle-ci est bien fournie.
Manuel de l'utilisateur embarqué 80d438004dc4b0db776a6bc40ed836dcedd8ee90
Le manuel en HTML se situe dans docs/manual
.
Il est accessible depuis Aide
> Manuel de l'utilisateur
.
Je me disais que j'allais démarrer le boulot de construction du manuel pour Frontières. Question : le manuel est-il embarqué dans le binaire, ou bien c'est une ressource posée dans /usr/share/Frontieres ?
À première vue, ça semble être la 2ème option, mais j'aimerai vérifier avant de commencer le travail. L'idée étant que si c'est un dans le binaire, il me faut recompiler à chaque fois pour voir si les modifications sont justes et ne cassent pas tout, alors que si c'est dans un fichier partagé dans /usr/share/Frontieres, ça ira plus vite pour moi car je n'aurai pas besoin de recompiler.
Est-ce que tu pourrais me fournir un document source en asciidoctor ? ou autre générateur de documentation
Je ne connais pas, mais je peux regarder ça. Au passage, je vais avoir 2 semaines bien charrette à partir du 6, je ne sais pas si j'aurai le temps avant ça. Sinon, rendez vous dans la dernière semaine d'avril.
exemple ici, avec lequel tu as déjà fait connaissance il y a quelque temps. Il faudra retravailler la feuille de style sans doute après mais c'est assez secondaire. https://github.com/jpcima/ADLplug/blob/master/docs/manual/fr/
ça fait pas mal de fois que la question de la documentation revient sur le tapis, et je pourrais commencer à m'y mettre si j'avais la moindre idée des outils et formats à utiliser. des idées à me suggérer ?
Wahou, ça fait déjà un an ! Navré, j'ai pas eu/trouvé de temps pour ça. J'ai dit @damarusama de venir ici pour sa demande. (Édition : mauvais clic de ma part ci-dessous :rofl:)
oui, j'ai vu ça, il a créé une issue, puis l'a fermée
@olof29 peut etre on commence avec le wiki sur github pour la documentation? On peut aussi mettre a jour le readme avec un peu d'information comme la section control sur cette page:
https://github.com/linuxmao-org/Frontieres/blob/develop/README.txt
@damarusama j'avais commencé à étiquetter des fils concernant l'ajout de fonctionnalité. Il y a donc dans ces fils des choses nouvelles par rapport à Borderlands.
de plus, je tiens à jour un fichier changelog au fur et à mesure de mes ajouts
Un truc qui serait bien aussi serait de lui créer une page sur linuxmao.org . Ça lui donnerait un peu de visibilité.
@jpcima disait sur IRC qu'un fichier en format HTML serait OK