Documentation/CollateralFiles/nl

    From The Document Foundation Wiki
    This page is a translated version of the page Documentation/CollateralFiles and the translation is 36% complete.
    Other languages:

    Wat is een 'collateraal' bestand?

    'Collaterale' bestanden

    Het nieuwe Help-systeem van LibreOffice heeft het reeds bestaande element <object> dat het mogelijk maakt om objecten toe te voegen aan HTML-helppagina's. Objecten kunnen ingesloten of externe video's, audio en ook bestanden met specifieke MIME-typen zijn.

    Vanaf LibreOffice 6.1 heeft het helpsysteem ondersteuning voor secundaire bestanden om de gebruiker te helpen bij het begrijpen van de tekstuele beschrijving van de huidige pagina.

    Wat deze bestanden NIET zijn

    De collaterale bestanden zijn niet bedoeld om de tekstuele beschrijving van een functie te vervangen of overbodig te maken. Een ondersteunend bestand over de goniometrische functies van Calc zal bijvoorbeeld de helppagina over goniometrische functies niet vervangen. Een collaterale bestand op draaitabellen ook niet.

    Het bestand mag niet worden gebruikt als alternatief voor een encyclopedische tekst over een object. Het heeft geen zin om een calculusboek te gebruiken om de COS-goniometrische functie uit te leggen. Het Help-systeem verwacht van de gebruiker dat hij zijn kennis in de juiste leerboeken haalt en geeft eenvoudige voorbeelden die fungeren als snelle herinneringen of die de syntaxis van de werkende functie laten zien.

    Hoe dien ik een nieuw collateraal bestand in bij LibreOffice Help?

    Uw hulp is natuurlijk welkom.

    Als u een nieuw hulpbestand wilt aanleveren op een specifieke helppagina, opent u een ticket in ons Bugzilla-systeem en voegt u uw bestand toe.

    Het proces:

    1. Zorg ervoor dat u alle inloggegevens heeft om een bug in onze bugzilla te openen. Als dit niet het geval is, volg dan de instructies op deze wikipagina.
    2. Open een nieuwe bug met de volgende instellingen:
      Component: Documentation
      Version: unspecified
      Samenvatting: Voer een samenvatting in. Bijvoorbeeld: [COLLATERAL_FILES] Bestand voor helppagina over functie XYZ
      Beschrijving: beschrijf het doel van het bestand en geef zoveel mogelijk details. Als u de helppagina weet waar het bestand thuishoort, dan is het nog beter. U kunt de helppagina aanleveren door de link van de pagina in de online help aan te geven. Bijvoorbeeld https://help.libreoffice.org/latest/en-US/text/scalc/01/04060101.html
    3. Bijlagen: Voeg uw bestand toe aan het Bugzilla-rapport
    4. BELANGRIJK: vul 117613 in het veld Blocks: in (dit koppelt u uw bijdrage aan de metabug).
    5. Verzend het bugrapport.

    Dat is alles.

    Note pin.svg

    NB:
    Collaterale bestanden zijn niet beschikbaar in de offline help package.

    Regels voor aanmaak collateraal bestand

    "KISS" : Keep It Simple, Stupid.

    Well, sort of.

    The Help system must help the user. Sounds obvious but there is no point in inserting a complicated collateral file when the intention is to explain simple concept. For example, a Chart collateral file must not have a data series with hundreds of data points, nor must it display fancy coloring of the chart elements.

    Try to create a file with a minimal amount of text inside. Sometimes it is not possible, but some tricks will reduce the workload for translation:

    1. Keep the file small
    2. Unless otherwise justified, always provide Open Document Formats (ISO-IEC 26300), such as *.odt, *.ods, *.odp, *.odg, *.odf, *.odb.
    3. In Calc functions, you can use the =FORMULA(<ref>) to get the localized name of the function.
    4. Also in Calc, if a function belongs to a category of functions, consider one single file with many examples (see 1 above). For example, database functions DSUM, DCOUNT, DMAX, etc... can belong to one collateral file only.
    5. Do not create files with macros. Even with safe macros, the security warnings can bring troubles to the user.
    6. Do not use complicated styling, unless absolutely necessary
    7. Avoid files with external references, external links (they may create issues with corporate firewalls, etc.)
    8. There is no point in providing many files on the same subject. Improve the existing one.

    Subjects for adding collateral files

    Calc

    • Database functions DSUM, DMAX, DCOUNT, etc. The help pages already have a textual example that can used in a collateral file.
    • Statistical functions (provide a small but significant data sample with usage of statistical functions)
    • Financial functions
    • Goal seek
    • Solver
    • Multiple operations
    • Scenarios

    Writer

    • Indexes
    • Table of contents
    • Using page styles (landscape/portrait)
    • Styles

    Impress

    • Slide transitions
    • Object animations

    Draw

    • Layers
    • Objects
    • Dimension lines
    • Lighting objects
    • Distribution

    Base

    • Sample database

    Math

    • Sample equations

    Translation

    Some countries require the supply of help text and components of the software to be in one or more of the official languages. This requires the translation of the collateral file, when it applies.

    The default and fall-back language is en-US.

    Note pin.svg

    NB:
    The source files are located in the tickets listed below.

    Calc

    • file imtrigon.ods for complex trigonometric functions: tdf#117579
    • file trigon.ods for trigonometric functions: tdf#117592
    • file pivot.ods pivot tables and charts: tdf#117593

    Writer

    Impress

    Draw

    Base

    Math

    Uploading files to master branch

    Uploading of files will be carried out through gerrit.