Views
Guidelines (Nederlands)
N.B.: deze richtlijnen zijn vertaalt met het oog op het schrijven van Nederlandse vertalingen van pagina's. Als je nieuwe Engelstalige pagina's wilt maken, kijk naar de officiële Guidelines.
Alle geregistreerde gebruikers (van het forum) kunnen deze wiki aanpassen. Om het allemaal consistent te houden wordt er verzocht deze richtlijnen te volgen. Als je denkt dat de richtlijnen aangepast moeten worden, of meer informatie moeten bevatten, schroom niet om contact op te nemen met Bartbes.
Doel
De hoofddoelen van deze wiki zijn als volgt:
- Om de LÖVE API te documenteren en tutorials aan te bieden.
- Om invormatie aan te bieden over spellen en bibliotheken die LÖVE gebruiken.
Dat gezegd hebbend, het is absoluut toegestaan om informatie over andere dingen toe te voegen die ver buiten die categorieën vallen.
Als je grote veranderingen in deze wiki wilt aanbrengen, zoals een nieuwe structuur voor ingebouwde types wilt neerleggen, bijvoorbeeld; doe het niet. Je moet eerst met Rude praten (in het Engels), anders is er een grote kans dat je aanpassingen toch maar worden teruggedraaid.
Naamconflicten
Om teveel URLs met (haakjes) te voorkomen, moeten documentatiepagina's simpele titels hebben zonder prefixen of suffixen. De logische uitzondering hierop is natuurlijk dat vertaalde pagina's altijd op _(Nederlands) (of _(Русский), afhankelijk van de taal) moeten eindigen. Bijvoorbeeld, naar het type Image kan extern verwezen worden als http://love2d.org/wiki/Image. Voor de Nederlandse versie is het noodzakelijk om naar Image (Nederlands) als http://love2d.org/wiki/Image_(Nederlands) te verwijzen.
Dit kan soms leiden tot naamconflicten, in welk geval de documentatiepagina altijd wint. Als je een spel genaamd Awesome maakt, en LÖVE later een type Awesome krijgt (die mogelijkheid kunnen we niet geheel uitsluiten), dan zal je spel moeten verhuizen naar een andere pagina.
Stijl
Als je praat over types in LÖVE zelf, link ernaar (naar de vertaalde pagina, als het kan). Bijvoorbeeld: “een Image is een object dat op het scherm kan worden weergegeven”.
Wanneer je het over variabeles en code hebt binnen in een normale zin, gebruik de <code>-tag om de leeservaring te verbeteren. Bijvoorbeeld: “als je foo en bar optelt, is het resultaat foobar.”
Documentatie
Documentatiepagina's moeten allemaal dezelfde structuur volgen om de documentatie bruikbaar te maken.
Alle documentatiepagina's moeteen een semantische link naar hun ouder hebben in de Zie ook-sectie. Zonder die link zal het niet verschijnen in de automatische lijsten die op de wiki voorkomen. Een semantische link voor een functie, type, of enum voeg je als volgt toe voor love.audio:
[[parent::love.audio (Nederlands)]]
Alle documentatiepagina's moeten ook een semantische, lijst-vriendelijke, beschrijving hebben. Dat doe je door het volgende onderaan de pagina neer te zetten:
{{#set:Description=Tekent een [[Image (Nederlands)|Image]] op het scherm.}}
Modules
De volgende koppen met niveau-2 zijn toegestaan, maar ze moeten alleen worden gebruikt als ze iets bevatten:
- Types
- Functies
- Enums
- Nota Bene
- Voorbeelden
- Zie Ook
Alle modules moeten geassocieerd zijn met Category:Modules.
Types
De volgende koppen met niveau-2 zijn toegestaan, maar nogmaals: als ze leeg zijn, laat ze weg:
- Functies
- Enums
- Supertypes
- Subtypes
- Nota Bene
- Voorbeelden
- Zie Ook
Alle modules moeten geassocieerd zijn met Category:Types.
Functies
Voor functies zijn alle koppen vereist, behalve Nota Bene, Voorbeelden en Zie Ook. Dat betekent dat als een functie niets teruggeeft, dat expliciet in de documentatie moet staat. Hetzelfde geldt voor argumenten.
Vergelijkbaar is het ook nodig te noemen als er geen constructorfunctie bestaat voor een bepaald type (zoals Contact).
De secties onder het kopje functie moeten in niveau-3-koppen, de rest in niveau-2-koppen.
- Constructor
- Functie
- Samenvatting
- Argumenten
- Geeft Terug
- Nota Bene
- Voorbeelden
- Zie Ook
Als een functie overloads heeft (dus meerdere mogelijkheden om de argumentenlijst in te vullen), herhaal de 'Functie'-kop voor elke overload. Dit is niet nodig voor optionele argumenten aan het einde van de rij; geef daar gewoon de standaardwaarde tussen haakjes.
Argumenten en teruggegeven waarden moeten weergegeven worden als een definitielijst, gebruik makend van Template:param.
Alle functies moeten geassocieerd zijn met Category:Functions.
Enums
Deze koppen zijn toegestaan voor enums:
- Constanten
- Nota Bene
- Zie Ook
De constanten moeten beschreven worden in een definitielijst.
Alle enums moeten geassocieerd zijn met Category:Enums.
Spellen
Voor spellen kan je je eigen structuur kiezen, maar je moet altijd wat semantische eigenschappen toevoegen aan de pagina, zodat het correct in de lijst van spellen komt te staan:
{{#set:Name=NoGame}} (Moet hetzelfde zijn als de titel van de pagina)
{{#set:Author=User:Rude}}
{{#set:Genre=Wat voor soort spel het is}}
{{#set:LOVE Version=0.6.1}}
{{#set:Description=Een korte beschrijving van je spel.}}
{{#set:Screenshot=File:ScreenshotURL.png}}
Screenshots zullen automatisch aangepast worden om in een hokje van 161x100 pixels te passen.
Stop je spel ook in Category:Games om het automatisch op de gamespagina te laten verschijnen. Om je spel in de juiste categorie te stoppen, voeg dit toe aan het einde van de pagina:
[[Category:Games]]
Het is ook aanbevolen om screenshots van je spel toe te voegen.
Bibliotheken
Geen strikte regels, maar net als bij spellen moet je deze semantische eigenschappen toevoegen:
{{#set:LOVE Version=0.6.1}}
{{#set:Description=Een korte beschrijving van je bibliotheek.}}
Stop je bibliotheek in Category:Libraries om het automatisch op de bibliothekenpagina te laten verschijnen. Voeg deze regel daarvoor aan het einde van de pagina:
[[Category:Libraries]]
