Ajout de fichiers complémentaires dans l'aide

From The Document Foundation Wiki
Jump to: navigation, search

Qu'est-ce qu'un fichier complémentaire ?

Fichiers complémentaires

Le nouveau système d'aide de LibreOffice a activé l'élément <object> qui permet d'ouvrir des objets dans la page d'aide HTML. Les objets peuvent être des vidéos intégrées ou externes, de l'audio, et aussi des fichiers avec des types MIME spécifiques.

À partir de LibreOffice 6.1 et au-delà, le système d'aide prend désormais en charge les fichiers multi-média pour aider l'utilisateur à comprendre la description textuelle de la page en cours.

Im-jabber.svg

Note:
Les fichiers complémentaires ne sont pas disponibles dans le package d'aide hors connexion

Ce que les fichiers complémentaires ne sont PAS

Ces fichiers ne sont pas destinés à remplacer ou à rendre obsolète la description textuelle d'une fonctionnalité. Par exemple, un fichier sur les fonctions trigonométriques de Calc ne remplacera pas la page d'aide sur la fonction trigonométrique. De la même manière, un fichier sur les tableaux croisés dynamiques ne remplacera pas la page d'aide.

Un fichier complémentaire ne doit pas non plus être une alternative à un texte encyclopédique sur une fonctionnalité. Il est inutile d'utiliser un livre de calcul pour expliquer la fonction trigonométrique COS. Le système d'aide s'attend à ce que l'utilisateur trouve ses connaissances dans les manuels appropriés et fournisse des exemples simples pour un rappel de la fonction ou sa syntaxe.

Comment soumettre un nouveau fichier complémentaire à l'aide de LibreOffice?

Votre aide est bienvenue, bien sûr. Si vous souhaitez fournir un nouveau fichier complémentaire à une page d'aide spécifique, veuillez ouvrir un ticket dans notre système bugzilla et joindre votre fichier.

Voici le processus:

  1. Assurez-vous d'avoir toutes les informations d'identification pour ouvrir un bug dans notre bugzilla. Si ce n'est pas le cas, veuillez suivre les instructions dans cette page du wiki.
  2. Ouvrez un nouveau bug avec les paramètres suivants :
  • Composant: Documentation
  • Version: 'unspecified'
  • Summary: Entrez un résumé. Par exemple, [COLLATERAL_FILES] File for help page on feature XYZ
  • Description: Décrivez le but du fichier complémentaire et donnez autant de détails que possible. Si vous connaissez la page d'aide à laquelle le fichier appartient, alors c'est encore mieux. Vous pouvez fournir la page d'aide en indiquant le lien de la page dans l'aide en ligne. Par exemple, [https://help.libreoffice.org/6.1/en-US/text/scalc/01/04060101.html]
  1. Attachments: Joignez votre fichier à bugzilla
  2. IMPORTANT: entrez 117613 dans le champ Blocks: (ceci reliera votre contribution au métabug).
  3. Soumettez votre rapport de bogue.

C'est tout.

Règles pour la création de fichiers complémentaires

"KISS" : Keep It Simple, Stupid.

Eh bien, en quelque sorte ne compliquez pas les choses...

Le système d'aide doit aider l'utilisateur. Cela semble évident, mais il n'y a pas de raison d'insérer un fichier compliqué lorsque l'intention est d'expliquer un concept simple. Par exemple, un fichier complémentaire sur les graphiques ne doit pas avoir une série de données avec des centaines de points de données, ni afficher des couleurs fantaisistes.

Essayez de créer un fichier avec le texte minimal à l'intérieur. Parfois, ce ne sera pas possible, mais certaines astuces réduiront la charge de travail pour la traduction :

  1. Garder le fichier petit
  2. Sauf indication contraire, fournissez toujours des formats de document ouverts (ISO-IEC 26300), tels que *.odt, *.ods, *.odp, *.odg, *.odf, *.odb.
  3. Dans les fonctions Calc, vous pouvez utiliser '= FORMULE (<ref>)' pour obtenir le nom localisé de la fonction.
  4. Toujours dans Calc, si une fonction appartient à une catégorie de fonctions, considérez un seul fichier avec de nombreux exemples (voir le point 1 ci-dessus). Par exemple, les fonctions de base de données DSUM, DCOUNT, DMAX, etc. peuvent appartenir à un seul fichier complémentaire.
  5. Ne créez pas de fichiers avec des macros. Même avec des macros sécurisées, les avertissements de sécurité peuvent causer des problèmes à l'utilisateur.
  6. Ne pas utiliser de style compliqué, sauf si c'est absolument nécessaire.
  7. Évitez les fichiers avec des références externes, des liens externes (qui peuvent créer des problèmes avec les pare-feu d'entreprise, etc.).
  8. Il ne sert à rien de fournir plusieurs fichiers sur le même sujet. Améliorer l'existant.

Sujets pour l'ajout de fichiers complémentaires

Calc

  • Les fonctions de base de données DSUM, DMAX, DCOUNT, etc. Les pages d'aide ont déjà un exemple textuel que peut illustrer un fichier complémentaire.
  • Fonctions statistiques (fournir un échantillon de données petit mais significatif avec l'utilisation des fonctions statistiques)
  • Fonctions financières
  • Objectif recherché
  • Solveur
  • Opérations multiples
  • Scénarios
  • (plus)

Writer

  • Index,
  • Table des matières
  • Utilisation des styles de page (paysage / portrait)
  • Styles
  • (plus)

Impress

  • Transitions de diapositives
  • Animations d'objets
  • (plus)

Draw

  • Couches
  • Objets
  • lignes de cote
  • Éclairage d'objets
  • Distribution
  • (plus)

Base

  • Exemple de base de données
  • (plus)

Math

  • Exemples d'équations
  • (plus)

Traduction

Certains pays exigent que le texte d'aide et les composants du logiciel soient dans l'une des langues (officielles) du pays. Cela nécessite alors la traduction du fichier.

La langue par défaut et de secours est en-US.

Im-jabber.svg

Note:
Les fichiers sources sont situés dans les tickets listés ci-dessous.

Calc

  • imtrigon.ods fonctions trigonometriques complexes : tdf#117579
  • trigon.ods fonctions trigonometriques : tdf#117592
  • pivot.ods tables et graphiques dynamiques : tdf#117593

Writer Files

Impress Files

Draw Files

Base Files

Math Files

Téléchargement des fichiers sur la branche master

Le téléchargement des fichiers sera effectué à travers gerrit.