OpenSUSE stijlgids

De Engelstalige versie van dit artikel heeft aandacht nodig! De Engelstalige versie van dit artikel voldoet momenteel niet aan de standaard die op de openSUSE-wiki wordt verwacht. U bent van harte welkom om de Engelstalige versie van dit artikel te verbeteren. Voor meer informatie zie het wiki-team

Titel van artikelen

De naam van uw artikel is ook de kopregel. Maak deze helder en kort en gebruik gewone taal:

• Vermijdt, waar mogelijk, het gebruik van cryptische afkortingen, speciaal wanneer er een synoniem beschikbaar is met een vergelijkbare lengte.
• maak, vooral in het Nederlands, spaarzaam gebruik van hoofdletters en gebruik spaties (in titels) want Mediawiki software kan daar prima mee omgaan en dat maakt het ook beter leesbaar. Vergelijk VoordelenVanOpenOffice vs. "Voordelen van OpenOffice" of "Voordelen van open office". Met die hoofdletters is het onmogelijk om aan te geven of het onderwerp gaat over de OpenOffice serie programma's of over offices die openheid voor iedereen nastreven.
• Vermijdt het gebruik van de titel nog eens in de kop van de eerste paragraaf. Niemand heeft iets aan twee aaneengesloten regels die hetzelfde vertellen, zoals:

Voordelen van OpenOffice

Voordelen van OpenOffice

• Een soortgelijke fout is het herhalen van de titel in "Over" of "Introductie". Uit het volgende voorbeeld blijkt dat dit niet veel verschilt van gewoon herhalen:

Voordelen van OpenOffice

Introductie tot voordelen van OpenOffice

• Gebruik in de Engelse titels title-style capitalization [1]. In het Nederlands is dat niet gebruikelijk; niet doen dus.
• gebruik bij het vertalen van artikelen exact dezelfde titel als de Engelse versie. Verwijs altijd naar de Engelse titel en zet de Nederlandse titel na het rechte streepje binnen de dubbele rechte haken. [[English Title|Nederlandse titel]] . Na het aanmaken van het vertaalde artikel met de Engelse titel kan met Move de Nederlandse titel aangebracht worden; maak deze gelijk aan de Nederlandse titel in de verwijzing. Markeer de Engelse pagina als Watch. Dat maakt het gemakkelijk om wijzigingen in deze pagina's bij te houden door op de Engelse wiki in te loggen en dan op Volglijst te klikken. U krijgt dan een lijst met alle pagina's die recent gewijzigd zijn en daarbij gemarkeerd welke door u sinds de wijziging niet zijn bezocht. Dat is een aanwijzing om de overeenkomstige Nederlandse pagina bij te werken.

Titel van een sectie

• Deze kunnen langer zijn dan de titel van een artikel, maar denk wel aan de layout van de TOC (Inhoudsopgave). Deze wordt automatisch gegenereerd uit de kopjes waarbij een erg lange regel gevolgd door een korte niet erg helpt bij het lezen. Kies de titel van de sectie, indien mogelijk, een titel die rekening houdt met een nette layout van de inhoudsopgave.
• Het gebruik van hoofdletters is hetzelfde als bij de titels van de artikelen. Het eerste woord van de titel is een hoofdletter en verder alleen hoofdletters als de Nederlandse taalregels dat voorschrijven.

Kopjes

• Gebruik de = (kop) markering en niet de ''' (bold) markering om een kop te maken. Op deze manier wordt de inhoudsopgave automatisch gegenereerd vanuit de koppen, dat helpt de lezer om direct naar de interessante sectie te gaan.
• Start met een dubbel is-teken == niet met een enkele =.

Let op: een enkel is-teken produceert dezelfde tekstgrootte als de titel van het artikel en dat is geen gebruikelijke schrijfstijl.

Voorbeeld:

 ==kop 1==
 ===onderkop 1.1===
 ===onderkop 1.2===
 ==kop 2==
 ===onderkop 2.2===
 ====onderkop 2.2.1====
 =====onderkop 2.2.1.1=====

• Bij een lange tekst van een sectie is het beter deze verder onder te verdelen met ondertitels.
• In Engelse tekst gebruikt u title-style capitalization voor de koppen in het Nederlands niet.

Gebruik Mediawiki opmaak

Hoewel het mogelijk is HTML-opmaak te gebruiken, maakt het gebruik van MediaWiki opmaak uw tekst gemakkelijker leesbaar en gemakkelijker te wijzigen.

Kijk eens op MediaWiki editing help (Engels) om te vernemen welke opmaakhulpmiddelen er zijn. U kunt ook naar de broncode van een paar artikelen kijken en vergeet niet de nieuwe mogelijkheden beschreven in Skin Management.

Voorbeelden: Bestandsnamen en shell-commando's

• Als een bestandsnaam onderdeel van de tekst is gebruik dan fixed font, broncode:

<tt>fixed font</tt>

• Voor een lange lijst kunt u gepaard <pre> en </pre> gebruiken.

Commentaar

Gebruik de discussie-pagina van een artikel voor uw commentaar. Vervuil de tekst van het artikel niet.

Als u wilt communiceren met andere editors dan kunt commentaar onzichtbaar maken voor de gewone lezer van het artikel. U moet de tekst die alleen bestemd is voor andere editors tussen deze tags <!-- --> zetten.

Voorbeeld:

 hello <!--This is a comment.--> world

wordt weergegeven als:

hello world

Werk in uitvoering

De openSUSE wiki is een werk in uitvoering. Commentaar "Under construction", "niet klaar" etc. in deze context, zou zelden gebruikt moeten worden en alleen in het geval dat het belangrijk is aan de lezer te laten weten dat dit nog niet alle informatie is. Voor die gelegenheid is er het sjabloon Expand

In de Nederlandse versie van de wiki is er vertaalwerk te doen waarvoor het sjabloon {{Vertalen}} is gemaakt en de rubriek Te vertalen. Dit gaat meestal om pagina's die gedeeltelijk vertaald zijn. Als er voor een pagina alleen verwijzing is naar de Engelse pagina en u wilt deze graag vertaald hebben dan kunt u het sjabloon Vertalen op die pagina aanbrengen. Hopelijk is er dan iemand die de vertaling doet.

Syntax:

        {{Expand}}

        {{Vertalen}}

Sjablonen

Kijk op de lijst met sjablonen voor enkele veel gezochte sjablonen.

Voor de lezer is het meestal niet zinvol om koppen en tabellen te zien die verder leeg zijn, maar soms is het te accepteren als het bedoeld is als sjabloon voor verdere bewerking.

Artikelgrootte

De manier om in een wiki te suggereren dat iemand een artikel zou moeten maken is door een koppeling te maken naar zo'n nog niet bestaand artikel in een bestaande tekst. Als er tenminste twee koppelingen zijn naar hetzelfde niet bestaande artikel dan verschijnt deze op Gewenste pagina's. Niet alles is werkelijk gewenst, maar gezond verstand en uw deskundigheid vertellen u wat uit deze lijst te kiezen. Hetzelfde geldt voor willekeurig geblaat met irrelevante inhoud. Als u een populair artikel wilt maken maak het dan kort en men zal dat meer lezen vanwege de gewenste informatie. Kijk op Artikelmaken (Engels) op Wikipedia.

Koppelingen versus kopiëren van inhoud

Er zijn twee manieren om de inhoud van andere artikelen in te voegen:

• Maak een koppeling naar een webpagina die relevant is in uw tekst. Het is minder werk en u hoeft geen aandacht te besteden aan het bijwerken. Het is altijd bij de tijd, maar dat kan uw artikel ook benadelen als:
  • het externe artikel naar een andere URL (dode koppeling) verhuisd of
  • de inhoud zodanig wijzigt dat het niet meer de juiste verwijzing is die het eens was.
• Kopieer de relevante inhoud uit het externe artikel. Als u dit gebruikt om er zeker van de te zijn dat de inhoud niet wijzigt, verzeker u er dan van dat u de inhoud mag kopiëren (Copyright).