Documentatie/Calc-functies/Richtlijnen

    From The Document Foundation Wiki
    This page is a translated version of the page Documentation/Calc Functions/Guidelines and the translation is 100% complete.
    Other languages:


    Richtlijnen

    Om te zorgen dat de wiki-pagina's voor het beschrijven van de Calc-functies goed worden aangemaakt en bijgewerkt, geven we wat richtlijnen en praktische punten waar je op moet letten.

    Samenvatting

    Hier komt een korte samenvatting van de functie.

    Syntaxis

    • Hier geven we aan wat de structuur (format) van de functie is.
    • Als er optionele parameters zijn, dan worden ze aangegeven met vierkante haken [ ] een voorbeeld,
      SAMENG.RENTE(Uitgifte; EersteRente; Aankoopdatum; Termijn; [Nominale waarde]; Frequency[; Basis])
    • Indien een argument alleen nodig is als er een eerder argument is ingevuld, dan worden de vierkante haken genest, bijvoorbeeld:
      STDEV(Getal 1 [; Getal 2 [; … [; Getal 255]]])
    • Maak de argumenten vet. Door overal deze en dezelfde opmaak te kiezen vallen de argumenten goed op.

    Retourneert

    • Hier beschrijven welk type door de functie wordt teruggegeven.
    • Het geeft aan wat de functie is van de meegegeven argumenten (parameters).
    • De teruggegeven waarde kan een getal, tekst, een logische waarde, ... zijn.
    • Er kan ook worden aangegeven welke waarden worden teruggegeven, of een bereik.
    • Bijvoorbeeld: de functie CHI.KWADRAAT,
      Retourneert een reëel getal in het bereik [0,1] dat de rechterkant waarschijnlijkheid van de chi-kwadraatverdeling is.

    Argumenten

    • Hier wordt elke argument toegelicht.
    • Wat is het bereik van de invoer per argument, wat is het type ervan.
    • Beschrijf alle grensgevallen en mogelijke fouten die kunnen optreden.

    Aanvullende details

    • Hier wordt informatie weergegeven die niet goed bij een van de vorige punten gegeven kon worden.
    • Als een afbeelding of grafiek nuttig is als toelichting bij de uitleg van de functie, plaats die dan hier. Voorbeeld:
      Functie SINH
      OF
      Functie TAN
    • Hier kan een formule staan die zorgt voor de implementatie van de functie. Bij de functie CHI.KWADRAAT heeft de volgende vergelijking:
      Chidist.png
    • Hier kun je een link naar Wikipedia plaatsen voor de mensen die nog meer informatie over de functie willen hebben.
    • Hier kun je ook instructies geven over het gebruiken van bepaalde functionaliteit zoals het gebruik van jokertekens (wildcards) en reguliere expressies, ...
    • Hier kun je waarschuwing of een aandachtspunt zetten voor de gebruiker. Hiervoor zijn er drie sjablonen.
      Warning.svg

      Waarschuwing:
      Pas op, denk aan ...

      Note pin.svg

      NB:
      Hier komt iets waar de gebruiker op met letten bij het gebruik van de functie

      Tip.svg

      Hint:
      Een hint...

    • In het geval dat er geen extra details zijn om te vermelden, staat er in dit gedeelte "Geen".

    Voorbeelden

    • Dit is de plaats voor wat voorbeelden van de aanroep van de functie.
    • Geef ook voorbeelden van de fouten die kunnen optreden door verkeerde invoer.
    • Plaats deze voorbeelden in een tabel om het overzichtelijk te maken.
    Formule Beschrijving Retourneert
    =STDEV(3; 4; 5; 6; 2; 3; 1) Berekent de standaardafwijking 1,71824938596845
    =STDEV(3; 4; −5; 6,05; 2; 3; −1,5) Berekent de standaardafwijking 3,71472295961175
    =STDEV(3; "alpha"; −5; 6,05; 2; 3; −1,5) De functie geeft een foutmelding, want elk argument moet een getal zijn Fout:504
    =STDEV(A1:A5)

    De cellen A1:A5 bevatten de waarden 1,2,3,4,5

    Berekent de standaardafwijking van de gegevens die met een referentie naar meerdere cellen is doorgegeven. 1,58113883008419
    =STDEV(3) De functie geeft een foutmelding, bij deze functie zijn minstens twee argumenten nodig #DELING.DOOR.0!
    • Voeg een tabel toe als je in een voorbeeld naar cellen verwijst. Voorbeeld:
       =VERT.ZOEKEN("Charlie"; A1:E4; 3; ONWAAR())
    
    A B C D
    1 Avery Hazel Jack William
    2 Carter Grayson James Scarlett
    3 Charlie Harper Lily Jackson
    4 Ella Julian Lillian Mason

    Gerelateerde LibreOffice-functies

    • * Hier plaatsen we een link naar alle functies die gerelateerd zijn aan de behandelde functie. Een overzicht welke functies met een bepaalde functie vergelijkbaar is staat in het gedeelte ODF. Een link is dan als volgt (bijv. voor de functie ACCRINTM):

    [[Special:MyLanguage/Documentation/Calc_Functions/ACCRINTM|{{Calc_fn_name|ACCRINTM|{{PAGELANGUAGE}}}}]]

    ODF standaard

    • Hier geven een link naar de tegenhanger van de functie in ODF (OpenDocumentFormat).
    • De link staat hier en kan worden toegevoegd met:

    Section 6.14.5, part 2

    • Zorg ervoor je het Section number goed overneemt.
    • Geef met "Geen" aan als er geen tegenhanger van de functie is.

    Gerelateerde (of gelijkwaardige) Excel-functies

    • Geef met "Geen" aan als er geen zeer vergelijkbare, gelijkwaardige of nauw verwante Excel-functie is.

    Tips

    Referenties

    Copyright

    • Als je tekst, een afbeelding of een formule toevoegt zorg er dan voor dat je ze niet overneemt van een andere bron als MS Excel documentation, Google Sheets docs, enz.

    Afbeeldingen, grafieken en formules

    • Als je afbeeldingen en grafieken maakt om toe te voegen bij de beschrijving van een Calc-functie, maak dat een iets wat uit Calc komt! Gebruik een bibliotheek om zaken te visualiseren zoals in Python: Matplotlib.
    • Gebruik bij een formule een schermafdruk van ODF of maak een afbeelding van een formule aan met gebruik van een JavaScript applicatie, Latex of een andere applicatie die een afbeelding in het formaat png/jpg/jpeg maakt.
    • Zorg dat een in de bestandsnaam van de afbeelding de naam van de functie voorkomt, er ook een thumb formaat is en dat ze gecentreerd zijn. (Zie hierboven grafiek SINH)
    • Zorg dat er bij afbeeldingen van een formule aan een none formaat is. (Zie hierboven CHI.KWADRAAT).
    • Neem geen plaatjes van bronnen buiten LibreOffice over als er mogelijk copyright op die afbeelding rust.