Réalisation de la documentation

From The Document Foundation Wiki
Jump to: navigation, search

Contenu

Ci-dessous les projets de documentation en cours :

  • les documents d'installation,
  • la Foire Aux Questions (FAQ),
  • les tutoriels,
  • les exemples de macro,
  • les vidéos,
  • les guides officiels.

Hormis les vidéos, qui sont référencées dans la liste d'écoute francophone du canal TDF YouTube, et certains documents d'installation, ces documentations pour l'utilisateur sont disponibles sur le wiki.

Cette page du wiki est dédiée aux contributeurs à ces différents supports. Elle oriente vers les règles à suivre et les ressources disponibles.

La liste de diffusion doc@fr.libreoffice.org est à votre disposition pour toutes questions concernant la rédaction de documentation pour LibreOffice.

Associée à cette liste cette page se veut un outil de travail collaboratif entre les membres du projet.

Comment contribuer à la documentation

Documentations figurant sur le wiki

Vous pouvez les maintenir à jour, les modifier ou les étendre en respectant ces quelques règles. Pour la création de nouvelles pages qui seraient la traduction de pages anglaises, vous devez respecter les règles du wiki multilingue.

Les documents d'installation

Cette documentation se trouve sur le site francophone pour ce qui concerne GNU/Linux et Macintosh et sur le wiki pour Windows.

  • Les modifications ou compléments à apporter sur le site peuvent être proposés via la liste de diffusion.
  • Les pages de wiki peuvent être modifiées en suivant les règles rappelées ci-dessus.

La Foire Aux Questions (FAQ)

Ces pages vous expliquent comment créer un nouvel article. La FAQ anglophone reprenant l'essentiel des pages francophones, l'idéal serait d'y répercuter les modifications (la numérotation est en principe la même). Il est aussi possible de demander cette opération sur la liste de diffusion.

Les tutoriels

Il s'agit de pages du wiki portant sur des actions ou fonctions expliquées pas à pas. Mêmes remarques que pour la FAQ quant aux règles à suivre et à la cohérence avec la partie anglophone.

Les exemples de macro

Également des pages de wiki suivant les mêmes règles de mise à jour. Ne pas oublier l'éventuelle répercussion de modification dans les fichiers exemples.

Les vidéos

  • Règle N°1 : Tout le monde est fortement invité à y participer, que ce soit à la réalisation, à la relecture des scénarios (voir plus bas) ou à la suggestion de contenu, etc. :-)
  • Règle N°2 : Consulter la liste des vidéos déjà mises en ligne pour éviter les doublons
  • Règle N°3 : Il n'y a pas de critère spécifique pour l'intégration d'une vidéo sur le canal TDF, autres que les implicites quant au contenu ou la forme...
  • Règle N°4 : La proposition d'intégration d'une vidéo se fait via la liste de diffusion
  • Règle N°5 : Inscrire dans les listes ci-dessous les vidéos prévues ou en cours de réalisation pour éviter les doublons et éventuellement prévoir un planning entre nous.

Logiciels de screencast

Pas de recommandation particulière. L'offre diffère selon le système d'exploitation. Il en existe des gratuits. Prendre la précaution de rechercher si le logiciel n'est pas signalé comme installant éventuellement des virus ou autres malwares. Certains logiciels permettent de capturer le son. D'autres permettent de mixer "après coup" du son avec les images. Il est aussi possible de faire des vidéos "muettes" en les rendant plus explicites par incrustation d'annotations.

Ressources

  • Le Centre d'aide YouTube
  • Les vidéos... expliquant comment poster des vidéos (votre moteur de recherche habituel)

Conseils & Retours d'expérience (quelques questions à se poser ou points à anticiper)

  • Tout l'écran ou une région : prendre une région, une partie d'écran permet d'enregistrer la vidéo en disposant du texte affiché à l'écran ; enregistrer l'écran entier évite de se poser la question du bon rapport entre hauteur et largeur de la zone (16:9) . Lors du téléchargement de la vidéo sur YouTube une adaptation sera faite qui générera éventuellement des bandes noires à gauche et à droite si le rapport n'est pas optimal.
  • Le "cadre" : privilégier un environnement centré sur le contenu et le plus proche d'une configuration standard (barres d'outils affichées, visibilité de données personnelles, zones d'écran hors sujets, etc.).
  • Scénario (voir aussi plus bas). Disposer du texte de la vidéo avant de réaliser cette dernière en facilite la réalisation (limite notamment les hésitations, permet de prévoir les enchaînements sous la forme "afficher ceci", "sélection de ça", etc.).
  • Durée
Par défaut, YouTube ne permet pas de mettre en ligne des vidéos dépassant 15 minutes (cette limite peut être dépassée, voir le centre d'aide). Il ne semble pas pertinent a priori de dépasser cette limite si on souhaite que la vidéo soit visionnée en entier...
  • Tags
Les tags sont des mots clés descriptifs que l'on peut ajouter aux vidéos afin d'aider à leur recherche. Inclure les mots clés généraux et d'autres plus indicatifs du contenu. Exemples : LibreOffice, Calc, Scénario, Writer, Index, etc.
  • Formats
La liste des formats compatibles est accessible ici
Télécharger un fichier .avi prendra potentiellement beaucoup de temps. Il est conseillé de convertir (ou de créer directement), par exemple au format MP4.
  • Retouche. YouTube permet de retoucher ses vidéos, notamment pour d'ajouter des inscrustations (annotations, cadre de remarque, liens).

Vidéos réalisées

Vidéos en cours de réalisation

Générales

  • Mise à jour de "Comment obtenir de l'aide" (mise à jour du site)
  • xx

Calc

  • xx

Writer

  • xx

Vidéos prévues

Générales

Calc

  • xx

Writer

  • .

Relecture de "scénario"

En vue d'une relecture collaborative les contributeurs qui le souhaitent peuvent déposer sur le wiki le scénario prévu pour une future vidéo. Pour cela, importer le fichier ODF sur le wiki. Le format ODF permet l'insertion de commentaires et le mode révision.

Renseigner ensuite la liste suivante sous la forme :

Module, Sujet - Fichier - Statut (à relire, en cours de relecture, relu, finalisé), signature utilisateur incluant date & heure.

Pour que le wiki insère pour vous cette signature tapez ~~~~. Ces 4 tildes seront remplacés lors de l'enregistrement de la page.

Compléter la liste sous cet exemple :

Les guides officiels

Utilisant un certain nombre de ressources leur réalisation se fait en deux étapes : travail collaboratif d'écriture-relecture puis ajout des documents finalisés dans la documentation de l'utilisateur.

Si vous souhaitez traduire un document anglais ou construire un nouveau document, il est recommandé d'indiquer sur cette page les étapes importantes de votre projet et d'y déposer les documents afin que les autres contributeurs puissent le relire. Il est également important de le signaler sur la liste de diffusion doc@fr.libreoffice.org.

Ressources

La liste de discussion doc@fr.libreoffice.org est à votre disposition pour toutes questions concernant la rédaction de documentation pour LibreOffice.

La page en anglais dispose de modèles et de ressources.

Les ressources traduites en français :

Pages de couverture des différents guides

LibO 3.5

LibO 3.6 Au format SVG (traduction de la version allemande) :

LibO 4.0 Au format ODT (version, module, titre, sous-titre et pied de page modifiables) :

Modèles

Le modèle utilisé par la version anglaise source, résulte d'un long historique et n'est pas un "modèle" du genre : tous les styles prédéfinis (Titre, corps de texte, etc.) ont été personnalisés. Ainsi, lors de l'utilisation de ce fichier avec une interface dans une autre langue, les noms des styles ne sont pas traduits. Par ailleurs, l'intervention sur la documentation exige un apprentissage spécifique et les raccourcis clavier habituels ne sont pas utilisables. Ceci devient critique lorsque l'on souhaite exporter vers d'autres formats, comme expliqué dans les spécifications d'un nouveau modèle pour la version 4 de LibreOffice : LibreOffice v4.0 Template

Un travail a démarré pour proposer un modèle suivant la même charte graphique, mais utilisant les noms des styles prédéfinis équivalents. Ce n'est qu'un début :

Concernant les styles, dans les grandes lignes, la conversion respecte les orientations des spécifications "LibreOffice v4.0 Template" sans lever les questions en suspend, notamment, pour les styles dans les tableaux. Il faudrait prendre une décision sur tous les styles utilisés dans les tableaux en tenant compte des contraintes de la conversion vers le format ePUB.

Cependant, la séquence des styles "Start - début", "Cont. - suite" et "End - fin" a été conservée, car c'est un avantage de LibreOffice. L'idéal serait que ces styles soient attribués automatiquement par la fonction styles conditionnels, mais il faudrait probablement de nouveaux développements. Que faut-il faire ?

Le mode de codification des listes a été conservé : un style de paragraphe par niveau faisant appel à une séquence de styles de liste par niveau. A valider en vue de conversions ?

La page de garde en SVG n'a pas été reprise. La page de garde élaborée automatiquement à partir des métadonnées du document semble préférable. Il reste à mettre au point le détail de l'usage des métadonnées, notamment des métadonnées par défaut pour éviter de créer des "Propriétés personnalisées" qui remplaceraient les propriétés par défaut, bien exploitées par les systèmes d'exploitation et les outils d'indexation.

Ce travail n'étant pas spécifique au français, il serait préférable que les décisions soient prises au niveau de la communauté.

Travail sur les modèles

Propositions et démarches pour la mise au point du modèle et les programmes de conversion

Exemples de chapitres convertis au nouveau format Documents convertis, permettant de ne juger que la forme du document et le résultat de cette conversion

Travaux en cours sur les guides ODFAuthors

Les sources à jour en anglais sont disponibles sur le wiki anglais.

Guide du débutant
Débutant 3.5
Débutant 4.0
Débutant 5.0
Débutant 5.1
Débutant 5.2
Guide Writer
Writer 3.6
Writer 4.0
Guide Calc
Calc 3.x


Chapitres Version 3.5 Version 3.6
1     Introduction à Calc ODT ODT
2     Entrer, modifier et formater des données ODT ODT
3     Créer des diagrammes et des graphiques ODT ODT
4     Utiliser les styles et les modèles dans Calc ODT ODT
5     Utiliser des éléments graphiques dans Calc ODT ODT
6     Imprimer, exporter et envoyer par e-mail ODT ODT
7     Formules et fonctions ODT ODT
8     Utiliser la table de pilote ODT ODT
9     Analyse des données ODT ODT
10     Lier les données de Calc ODT ODT
11     Partager et réviser des documents ODT ODT
12     Macros Calc ODT ODT
13     Calc en tant que base de données simplifiée ODT ODT
14     Paramétrer et personnaliser Calc ODT ODT
A     Raccourcis clavier ODT ODT
B     Fonctions Calc ODT ODT
C     Codes erreurs Calc ODT ODT
Calc 4.0
Calc 4.1
Guide Impress
  • Traduit sur le wiki OOo à porter sur LibO par Sophi sur le wiki
Impress 3.5
Impress 3.6
Impress 4.0
Guide Draw
Draw 4.0
Draw 4.1
Guide Math
Math 3.5
Les guides officiels traduits (de l'allemand)

Traduction en français du livre de Bruce Byfield "Designing with LibreOffice"

Titre provisoire : Créez vos documents avec LibreOffice

Les chapitres peuvent se trouver dans les états suivants :

  • à faire : la traduction n'est pas faite ; personne ne travaille dessus
  • traduction + id : la traduction est en cours par l'utilisateur id (id du wiki) (ex : traduction jfnif)
  • document de travail : la première traduction est faite, une relecture peut avoir lieu
  • relecture + id : une relecture est en cours par l'utilisateur id
  • relu N : le chapitre a été relu N fois. Actualisez N pour indiquer le rang de relecture (ex : un chapitre a été relu 1 fois -- état "relu 1" --, vous le relisez à nouveau, passez à "relu 2")

Idéalement 3 relectures au moins seront nécessaires, par trois relecteurs différents.

  • prêt : le chapitre est prêt pour publication.

Les modifications des chapitres traduits se font en mode modification (Édition > Modifications > Enregistrer).

Si un chapitre est en traduction ou relecture, merci de ne pas interférer et d'attendre son retour à disposition (états "document de travail" ou "relu N").

Lorsque vous réintroduisez un chapitre après traduction ou relecture, veillez à mettre à jour l'information d'état.

N'oubliez pas d'ajouter votre nom à la liste des traducteurs, en bas de ce chapitre du wiki.

Le document File:Recommandations v0.odt est à consulter avant tout travail sur les chapitres.


Chapitre Description EN version FR version État
(Modèle) modèle de chapitre File:Designing-with-libreoffice.ott File:Designing-with-libreoffice FR v0.ott document de travail
Front Cover 1ère de couverture File:Front-cover.odt [[File:]] à faire
Title page Grand titre File:Title-page.odt File:Title-page FR v0.odt document de travail
Dedication Dedicace File:Dedication.odt File:Dedication FR v0.odt document de travail
Copyright Copyright File:Front-matter.odt File:Front-matter FR v0.odt document de travail
Chapitre 1 Introduction File:Chapter1-introduction.odt File:Chapter1-introduction FR v1.odt Relu 2 par Philippe CLEMENT 2016-04-30T13:37:59 (UTC) - Document disponible à la relecture -
Chapitre 2 Going in style File:Chapter2-going-in-style.odt File:Chapter2-going-in-style FR v1.odt

File:02 notes jfn+vmalep v1.odt

Relu 2 par Philippe CLEMENT - Document disponible à la relecture -
Chapitre 3 Recycling with templates File:Chapter3-recycling-with-templates.odt File:Chapter3-recycling-with-templates FR v0.odt

File:03 notes jfn v0.odt

Relu 1 par Philippe CLEMENT 2016-05-01T18:43:28 (UTC) - document disponible à la relecture - (+ notes de lecture)
Chapitre 4 Fonts, color and the magic number File:Chapter4-fonts-color-and-the-magic number.odt File:Chapter4-fonts-color-and-the-magic number FR v0.odt Relu 1 par Philippe CLEMENT - Document disponible à la relecture -
Chapitre 5 Spacing on all sides File:Chapter5-spacing-on-all-sides.odt

File:Chapter5-spacing-on-all-sides v1 vmalep.odt

File:Chapter5-spacing-on-all-sides FR v1.odt Document de travail
Chapitre 6 Text tools and traps File:Chapter6-text-tools-and-traps.odt File:Chapter6-text-tools-and-traps FR V0.odt Document de travail
Chapitre 7 Positionning and automating text File:Chapter7-positioning-and-automating-text.odt File:Chapter7-positioning-and-automating-text FR v0.odt document de travail
Chapitre 8 Styling the page File:Chapter8-styling-the-page.odt [[File:]] traduction jfnif
Chapitre 9 Getting in the frame File:Chapter9-getting-in-the-frame.odt [[File:]] à faire
Chapitre 10 Structured prose list and tables File:Chapter10-structured-prose-lists-and-tables.odt [[File:]] à faire
Chapitre 11 Style features and long documents File:Chapter11-styled-features-and-long-documents.odt [[File:]] à faire
Chapitre 12 Designing and delivering slide shows File:Chapter12-designing-and-delivering-slide-shows.odt [[File:]] à faire
Chapitre 13 Designing drawing content File:Chapter13-designing-drawing-content.odt [[File:]] à faire
Chapitre 14 Drawing object styles and charts File:Chapter14-drawing-object-styles-and-charts.odt [[File:]] à faire
Chapitre 15 Designing spreadsheets File:Chapter15-designing-spreadsheets.odt [[File:]] traduction jfnif
Chapitre 16 Putting it all together File:Chapter16-putting-it-all-together.odt File:Chapter16-putting-it-all-together FR v0.odt Relecture par Philippe CLEMENT 2016-05-04T18:06:38 (UTC)
Annexe A Downloading LibreOffice File:Appendixa-downloading-libreoffice.odt File:Appendixa-downloading-libreoffice FR v0.odt document de travail
Annexe B Learning mode about typography File:Appendixb-learning-more-about-typography.odt File:Appendixb-learning-more-about-typography FR v0.odt document de travail
Annexe C Where to get free fonts File:Appendixc-where-to-get-free-fonts.odt File:Appendixc-where-to-get-free-fonts FR v0.odt document de travail
Annexe D Free fonts equivalent for standard fonts File:Appendixd-free-font-equivalents-for-standard-fonts.odt File:Appendixd-free-font-equivalents-for-standard-fonts FR v0.odt document de travail
Back cover 4e de couverture File:Back-cover.odt [[File:]] à faire


Liste des traducteurs (cette liste permettra d'alimenter un paragraphe dans le document traduit ; voir File:Front-matter FR v0.odt) :

  • Jean-François Nifenecker
  • Pierre van Male
  • (ajoutez votre nom)