Stijlgids

Doorverwijzing naar:

• Help

De stijlgids geeft aanwijzingen om de leesbaarheid van de teksten te bevorderen en dient om de eenheid in stijl en opmaak zo veel mogelijk op een lijn te krijgen. Heb je opmerkingen over deze stijlgids of aanvullingen, stuur dan een e-mail naar pvader@hz.nl.

Stijl

Hieronder vind je een aantal aanwijzingen om te komen tot een eenheid in stijl van de pagina's:

• De tekst wordt opgedeeld in paragrafen. Wanneer je een nieuwe paragraaf begint hangt af van de tekst en laten we dus over aan de redacteuren. Het is moeilijk om daar universele richtlijnen voor te geven. In de wiki-tekst is een paragraaf alleen zichtbaar door in de invoer een witregel in te lassen; je geeft dus tweemaal een 'enter' om een nieuwe paragraaf te beginnen.
• Een alinea is een teksteenheid met een kopje erboven en kan uit verschillende paragrafen bestaan. In principe moet een alinea als een zelfstandige tekst te begrijpen zijn.
• Kopjes beginnen met een hoofdletter en de rest van de eventuele woorden van een kopje schrijf je met kleine letters.
• Cursief gebruiken we bij namen van rapporten, boeken, (tv-)programma's en dergelijke. Een vreemd woord, bijvoorbeeld uit een andere taal schrijf je de eerste keer cursief, bijvoorbeeld met een verklaring; daarna schrijf je het woord normaal.
• Wees zuinig met het gebruik van vet in de tekst.
• Gebruik linklabels die de achterliggende informatie identificeren, in plaats van labels als ‘klik hier’ of ‘deze pagina’. (Webrichtlijn 2.4.9)
• Probeer de link altijd aan het einde van de zin te plaatsen, zodat de lezer de zin pas aan het einde ‘verlaat’.
• Gebruik bij Engelstalige tekst de Brits-Engelse spelling, niet de Amerikaanse.
• Dubbele aanhalingstekens gebruikten we bij letterlijke citaten van personen of citaten uit rapporten of boeken.
• Enkele aanhalingstekens gebruiken we om een woord te accentueren. Wees hier echter voorzichtig mee: te veel accenten geeft een lelijk woordbeeld. Zie ook onder cursief hierboven.
• Gebruik een echte apostrof – ’ – en echte aanhalingstekens – “ ” – en – ‘ ’ – in plaats van – ' – en – " (typemachine-typografie).

Leesbaarheid teksten

Hieronder staat een aantal punten die de leesbaarheid van de tekst bevorderen.

• Maak niet al te lange zinnen. Hoe meer woorden een zin bevat, des te moeilijker de zin is te lezen. Een eenvoudige zin heeft ongeveer tien woorden; een moeilijke zin meer dan 25. Alleen korte zinnen gebruiken is niet prettig leesbaar, wissel daarom lange en korte zinnen af.
• Vermijd waar mogelijk jargon. Waarom moeilijk doen als het ook makkelijk gezegd kan worden?
• Stop niet te veel informatie in een zin.
• Geen afkortingen gebruiken in de tekst.
• Maak zinnen met een rechte woordvolgorde: onderwerp, gezegde, lijdend voorwerp. Dus niet: Boeken had hij duizenden in zijn bezit. Maar: Hij had duizenden boeken in zijn bezit.
• Vermijd de lijdende vorm en gebruik de bedrijvende vorm. Dus niet: De dijk wordt door het projectteam ontworpen. Maar: Het projectteam ontwerpt de dijk.
• Vermijd bij voorkeur het woordje ‘men’. Vervang men door een meer specifieke beschrijving van het onderwerp.
• Vermijd tangconstructies.
• Hulpwerkwoorden als zullen en kunnen maken een zin moeilijker leesbaar. Als je ze weglaat, gaat de betekenis van de zin vaak niet verloren.

Aantrekkelijkheid van de teksten

Deze punten helpen je om een tekst aantrekkelijker te maken:

• Wissel langere zinnen en kortere zinnen af in de tekst. De tekst krijgt dan een meer dynamisch karakter en wordt daardoor beter leesbaar en aantrekkelijker.
• Breng afwisseling aan in het soort zinnen, zoals mededelingen, vragen, beschrijvingen.
• Vermijd ambtelijke taal en stijf taalgebruik, zoals thans, welke (in de betekenis van die, niettegenstaande, nochtans).
• Zoek naar synoniemen als woorden zich gaan herhalen.
• Gebruik beeldspraak.

Spellingsfouten vermijden

Ten slotte nog een aantal aanwijzingen om tot een (bijna) foutloze tekst te komen:

• Schrijf je tekst in Word en gebruik daarvan de automatische spellingscontrole.
• Maak de tekst op in Word met de regels van de Wiki markup. Een verkorte versie van de Cheatsheet is de Wiki markup quick reference. Je hoeft daarna alleen nog maar de tekst te kopiëren en te plakken in de pagina.
• Doe niet mee aan de zogenaamde ‘Engelse ziekte’: samenstellingen schrijf je in het Nederlands aan elkaar. Onze Taal biedt een pagina met achtergrondinformatie over het fenomeen samenstelling.
• Aan elkaar of niet, gebruik van hoofdletters, leestekens… Als je het niet zeker weet zoek je het op. De website van Onze Taal biedt een uitstekende mogelijkheid om te zoeken naar taaladvies. Daarnaast biedt de Taalunie je de mogelijkheid om te zoeken in de Woordenlijst Nederlandse taal.

Speciale tekens en opmaak

Open deze pagina in de edit-modus om de onderliggende codes te zien.

• Niet onderstrepen: werkt verwarring in de hand, omdat verwijzingen ook onderstreept zijn en onderstrepen is een ouderwetse zogenaamde ‘typemachine-typografie’.
• Superscript schrijf je op deze manier: X²
• Subscript schrijf je zo: H₂O
• Een doorgestreepte tekst ziet er zo uit.

Zie voor meer voorbeelden van speciale opmaak de pagina Wikitext examples.

Tabellen

Gebruik voor een eenvoudige tabel de onderstaande opmaak. Je ziet de opmaak als je deze pagina opent in de 'edit' modus. Je kopieert dan de opmaak naar het Wordbestand waarin je de pagina aan het schrijven bent of rechtstreeks naar de op te maken Wikipagina. Een uitgebreide uitleg van over het maken van tabellen vind je onder andere hier.

Bijschrift bij de tabel

kopje 1	kopje 2	kopje 3
Celinhoud 1	celinhoud 2	celinhoud 3
enz.	enz.	enz.

Hieronder een voorbeeld van een meer ingewikkelde tabel, waarbij een aantal cellen zijn samengevoegd.

Table 1: A selection of characteristics that make invaders successful. All traits are valid for the Pacific oyster (from Troost, 2010)

Stage	Trait
Colonization	r-selected life history strategy: rapid growth, rapid sexual maturation, high fecundity
	Generalists: ability to colonize wide range of habitat types, broad diet, tolerance to wide range of environmental conditions
	Gregarious behavior
	Genetic variability and phenotypic plasticity
	Ability to recolonize after population crash
Establishment	Lack of natural enemies
	Ecosystem engineering
	Association with humans
	Repeated introductions
	Genetic variability and phenotypic plasticity
	Competitiveness
Natural range expansion	Traits of successful colonists (see above)
	Dispersability

Het beschrijven van achtergrondmateriaal (resources)

Informatiemateriaal zoals pdf, documenten, boeken, artikelen, websites, etc. worden resources genoemd. De inhoud van een resource wordt beschreven door middel van metadata (titel, auteur, uitgever, etc.). Dit doen we in de Wiki met ‘Resource Descriptions’. Bijvoorbeeld een boek kan worden beschreven door een Resource Description aan te maken. Zie http://77.169.186.211:20081/hzbwnature/wiki/index.php/Main_Page#Resource_descriptions voor de standaardmanier waarmee pagina's, en in dit geval Resource Descriptions, worden aangemaakt. Op dezelfde manier kunnen ook websites worden beschreven. In dit geval moet in het veld hyperlink de URL worden ingevoerd.

Files uploaden met resource description

Het is ook mogelijk om een Resource Description te hangen aan een file die ge-upload wordt of al ge-upload is. Iedere file krijgt een aparte Wiki-pagina bij het uploaden. Voor het toevoegen van de metadata, ga naar die pagina en voeg toe via een edit (bewerken):

[[Category:Resource Description]]

Bewaar (save) de pagina en vervolgens verschijnt een ‘edit with form’ (‘bewerken met formulier’) knop. Als je deze knop gebruikt zie je het formulier om de metadata toe te voegen. Voordat je de pagina bewaart, moet je de regel in de vrije tekstruimte verwijderen. Die heeft zijn doel gediend, namelijk de pagina te voorzien van een formulier waarmee een ‘edit with form’ mogelijk wordt gemaakt.

Invullen van Resource Description formulier

De metadata behorend bij een document is gebaseerd op Bibtex. Bibtex wordt meestal gebruikt in combinatie met het document-verwerkingsysteem Latex, waarmee documenten professioneel worden opgemaakt. Het is de standaard in de wetenschappelijke wereld. Bibtex maakt onderscheid in typen van documenten. Afhankelijk van het type, moeten sommige velden verplicht aanwezig zijn en een aantal optioneel. De velden staan per type gedefinieerd in Bibtex entry types.

In het Resource Description formulieer kan ook het soort content worden aangegeven:

• conceptual - level 1, DI (SKOS, thesaurus) van DIKW piramide;
• factual - level 2, DI;
• situational - level 1, KW (EM_ont, PQR in context);
• case - level 2, KW.

Deze indeling komt overeen met de vier kwadranten die we in EMM hanteren. Meer dan één optie mag worden gekozen.

SKOS-termen toevoegen

Belangrijk is iedere Resource Description te voorzien van de juiste SKOS-termen. Dat gebeurt in het veld ‘subject’ waar SKOS-concepten worden ingevoerd. De concepten worden gescheiden door een komma. Een vuistregel is tussen de twee en vijf SKOS-concepten op te nemen. De SKOS-concepten moeten zo specifiek mogelijk zijn. Met generieke termen schieten we niet veel op, die hoeven dan ook niet te worden opgenomen. Bijvoorbeeld, via de ‘broader than’-relatie weten we toch al dat een kleidijk ook een dijk en uiteindelijk een waterkering is. Het is belangrijk om dit consequent te doen, omdat we hiermee een kwalitatief hoogwaardige zoekmachine gaan maken (beter dan Google). Uiteindelijk krijgen we een zelflerend systeem dat automatisch nieuw informatiemateriaal kan voorzien van de juiste SKOS-concepten.

Refereren in de tekst

Met alle Resource Descriptions wordt in feite een database opgebouwd met literatuurbeschrijvingen. In wiki-pagina's kunnen we daarnaar refereren. Dat gebeurt via de ‘cite template’:

{{Cite|resource=File:CoE Projectplan Kennismanagement v20130620.docx |name=Projectplan|optional=pagina 2-4}} ziet er in de tekst uit als: Projectplan (pagina 2-4)

Zie http://77.169.186.211:20081/hzbwnature/wiki/index.php/Ontwikkelnotities#Notitie_8_februari_2014 voor wat voorbeelden. Het komt overeen met het aanleggen van links naar pagina’s zoals we dat tot nu toe hebben gedaan: [[File:CoE Projectplan Kennismanagement v20130620.docx|Projectplan]]. Het optional stuk wordt domweg toegevoegd, het heeft dus geen semantische betekenis. Op dezelfde manier kan worden gelinkt naar externe URL's:

{{External link|resource=Bigpicturelab|name=website van de Big Picture Lab}} ziet er in de tekst uit als: website van de Big Picture Lab

Ook dit komt overeen met de standaard manier van linken: [http://www.bigpicturelab.nl website van de Big Picture Lab].

Refereren naar een pagina in de Wiki

• Een verwijzing naar een andere pagina van de DeltaExpertise Wiki ziet er zo uit:

[[Wet Milieubeheer VN|Wet Milieubeheer]] met als effect: Wet Milieubeheer

Let op dat je hier naar de 'VN-pagina' moet verwijzen, om ervoor te zorgen dat de pagina zichtbaar en vindbaar is in de DeltaExpertise site.

Referentielijst

In een wiki-pagina kan vervolgens een referentielijst worden gegenereerd. Dat gebeurt via de template:

{{References}} heeft als effect:

Let op, dit is een voorlopige versie. Er zullen ongetwijfeld nog wat parameters worden toegevoegd. Gewone wiki-editors krijgen hier ook niets mee te maken, want onder water zullen referentielijsten op de juiste plekken worden toegevoegd.

Afbeeldingen

• Gebruik uitsluitend beeld waarvan zeker is dat dit auteursrechtelijk is toegestaan.
• Een afbeelding of foto voer je op de volgende manier in: in de alinea van de tekst die naar de afbeelding verwijst en het ziet er zo uit:
  

  Figuur 3.2: Golfhoogtereductie voor een griend van 80 meter.

Het voordeel van deze manier is dat je de grootte van de afbeelding kunt aangeven met behulp van het getal dat voor "px" (=aantal pixels) staat en dat je een onderschrift kunt toevoegen.

Alternatieve teksten

• Voorzie iedere afbeelding van een betekenisvolle of een lege alt-tekst. Dit om te zorgen dat visueel gehandicapten – maar ook zoekmachines – gebruik kunnen maken van de geboden informatie. (WCAG1.0 ijkpunt 1.1; Webrichtlijnen – Afbeeldingen en alternatieve tekst)
  

  Voorbeeld van een afbeelding met een alt-tekst, zie de wiki-markup.
• “Alt-teksten bij afbeeldingen die zelf het onderwerp van de pagina zijn beschrijven de inhoud van de afbeelding.” (Interdepartementale werkgroep Stijlgids, 2006)
• Voeg geen informatie aan de alt-tekst toe die de afbeelding zelf niet bevat, zoals de naam van een plaats of persoon, tenzij die algemeen bekend en dus visueel herkenbaar is, zoals de Eiffeltoren.
• “Afbeeldingen die geen extra informatie bevatten, krijgen een leeg alt-attribuut (alt=""). Dat voorkomt dat de bestandsnaam wordt getoond of voorgelezen.” (Interdepartementale werkgroep Stijlgids, 2006)