Tracks:Schrijfregels

From Tracks
Jump to navigation Jump to search
This page contains changes which are not marked for translation.

Voor meer info over wikisyntax, bekijk de cheat sheet op Wikipedia.

Categorieën

Geef aan alle pagina's een categorie, maar doe dit enkel wanneer de tekst definitief is. Wanneer je een categorie toekent, zal de tekst verschijnen op de website

Syntax

  • [[Categorie:Naam categorie]]
  • Best practice is om dat steeds onderaan de pagina te doen. Op die manier gaat de pagina dus behoren tot de categorie die je toekent.
  • Pagina’s kunnen tot meerdere categorieën behoren (bv. tot een cluster en tot “Primaire tools”).
  • Indien er een hiërarchie in categorieën is, link je steeds naar de meest specifieke categorie.
  • Wanneer je in een tekst wil linken naar een categoriepagina (bv. omdat daar de algemene intro van een cluster staat), gebruik je een extra dubbele punt aan het begin. [[:Categorie:1. Visie|algemene introtekst Visie]] wordt bijvoorbeeld algemene introtekst Visie.

Overzicht

Volgende categorieën bestaan:

  • [[Categorie:Nieuws]] voor nieuwsitems
  • [[Categorie:Praktijkvoorbeelden]] voor praktijkvoorbeelden
  • [[Categorie:Partnerorganisaties]] voor partnerorganisaties
  • Tevens bestaan er verschillende subcategorieën voor tools. Geef aan iedere tool de categorie van zijn topic. Indien het een vette tool is, geef je via [[Categorie:Primaire Tools]] aan dat de tool in de overzicht op de homepagina moet verschijnen. Je kan de vette tools vinden in dit document

Titels en koppen

Wanneer je een pagina aanmaakt, geef je geen hoofdtitel meer aan je artikel. Mediawiki zal namelijk automatisch de paginanaam als titel gebruiken. Deze hoofdtitel krijgt door Mediawiki een heading of niveau 1.

Probeer de tekst zoveel mogelijk te structuren door met ondertitels te werken. Geef titels steeds een kop. Dit maakt de tekst toegankelijker en eenvoudiger voor mensen die screen readers gebruiken. Maak dus geen titel door een stuk tekst in vet te zetten.

De volgorde van titels en ondertitels is belangrijk en werkt als volgt:

niveau html wiki syntax opmerkingen
1 <h1></h1> = Hoofdtitel = wordt automatisch door Mediawiki gecreëerd
2 <h2></h2> == Titel onder hoofdtitel ==
3 <h3></h3> === De volgende ondertitel ===
etc... ... ...

Teksten

Het is het mogelijk om een stuk tekst uit te lichten (voorbeeld). Gebruik hiervoor het blockquote element. Een voorbeeld: <blockquote>Dit is tekst die uitgelicht moet worden.</blockquote>

Auteursvermeldingen worden toegevoegd op het einde van de tekst (voor de categorie) en in cursief. Dit werd zo afgesproken met Plutonian.

Tips van designer Sarah om de langere artikels aangenamer te maken voor de lezer:

  • kortere alinea's gebruiken waar mogelijk;
  • tekst vet/cursief zetten om bepaalde keywords te highlighten;
  • lopende tekst afwisselen met opsommingen, beelmateriaal, tussentitels, quotes,...

Links

Interne links

Alle glossariumtermen uit de TRACKS-website werden geïmporteerd en kunnen via interne links in teksten gebruikt worden. Je vindt alle glossariumtermen hier.

  • Interne links in wikisyntax gebeurt steeds door twee paar rechte haken ([[ ]]) te gebruiken.
  • Je kan een interne link achter een label steken door de paginanaam en het label te scheiden met een pipe (|): [[Paginanaam|Label]]. [[Jobstudent werkt op archief bij KVS|Praktijkvoorbeeld bij KVS]] wordt bijvoorbeeld Praktijkvoorbeeld bij KVS.
  • Als je een besstandspagina achter een label wil steken, moet je een dubbelpunt toevoegen. Zo wordt [[:Bestand:20140403_Vernietigingslijst_Tristero.xlsx|beknopte lijst]] beknopte lijst. Als je die dubbele punt vergeet (dus: [[Bestand:20140403_Vernietigingslijst_Tristero.xlsx|beknopte lijst]]) krijg je Bestand:20140403 Vernietigingslijst Tristero.xlsx
  • Wanneer paginanaam en label identiek zijn, volstaat [[Paginanaam]]. [[Jobstudent werkt op archief bij KVS]] wordt bijvoorbeeld Jobstudent werkt op archief bij KVS.
  • Wanneer je in de tekst wil linken naar een categoriepagina zonder de pagina die je bewerkt aan die categorie toe te kennen gebruik je een extra dubbele punt: [[:Category:Partnerorganisaties|TRACKS-partnerorganisaties]] wordt dan TRACKS-partnerorganisaties.

Externe links

  • Externe links worden toegevoegd door één paar rechte haken ([ ]) te gebruiken.
  • Net zoals bij interne links kan je een externe link achter een label steken. Bij een externe link gebruik je geen pipe (|): [url Verwijzingslabel]. [https://www.amvb.be website AMVB] wordt website AMVB.

Voetnoten

Een voetnoot voeg je toe door de voetnoottekst tussen <ref>-tags te plaatsen. De voetnoot zal dan onderaan de tekst verschijnen. Je hoeft hier verder niets mee te doen. Plutonian zorgt ervoor dat de voetnoten mooi op de webpagina's zullen verschijnen.

Voorbeeld: Trolololo<ref>Een woord dat we kennen sinds de [https://www.youtube.com/watch?v=sTSA_sWGM44 Trololo meme]</ref> wordt "Trolololo[1]".

Afbeeldingen en Bestanden

Op elke pagina minstens 1 afbeelding (die geen screenshot is) om pagina's te breken en previews van pagina's steeds mét afbeelding te visualiseren.

Uploaden

Afbeeldingen en bestanden kunnen op drie manieren ingevoerd worden:

  1. via Bestand uploaden (vind je in de zijbalk onder Hulpmiddelen: hiermee kan je één enkel bestand opladen. Je kan zowel een bestand opladen dat zich lokaal op je computer bevindt, als via een URL. Als je via een URL een bestand oplaadt, zal Mediawiki dit bestand downloaden en in de omgeving van de Mediawiki plaatsen.
  2. via de Upload wizard (vind je in de zijbalk onder Shortcuts: hiermee kan je verschillende bestanden in bulk opladen. Zoals de naam het zegt, verloopt het via een wizard waarmee je geholpen wordt om de juiste licentie etc. te kiezen. Het is ook mogelijk om bestanden van Flickr op te laden.
  3. via Wikimedia Commons: via deze optie hoeven geen mediabestanden opgeladen worden. Je kan gewoon bestanden hergebruiken die op Wikimedia Commons staan. Kan nuttig zijn als je gewoon een afbeelding ter illustratie nodig hebt.

Wanneer je bestanden oplaadt, kan je een aantal metadata meegeven:

  • Geef ALTIJD een licentie mee.
  • Geef de bestanden ook een korte beschrijving. Plutonian kan deze gebruiken als alt-tekst. Dit is een HTML-tag die ervoor zorgt dat mensen met visuele beperkingen een omschrijving hebben van wat er op de foto staat.

Gebruik in teksten

Afbeeldingen en bestanden integreer je in een tekst met volgende syntax: [[Bestand:mijnafbeelding.jpg]]. Om automatisch onderschriften bij foto's op te halen en de grootte op de front end te specifiëren gebruik je de syntax [[Bestand:mijnafbeelding.jpg|thumb]]. Wanneer je het onderschrift van een afbeelding toch wilt aanpassen gebruik je de syntax [[Bestand:mijnafbeelding.jpg|thumb|450px|test onderschrift]].

Als het bestand een afbeelding is, dan zal de afbeelding getoond worden. Is het een ander bestand, dan zal er een link naar de bestandspagina verschijnen. Voor bestanden kan je de regels van interne links volgen. Voor afbeeldingen heb je nog meer opties:

  • je kan kiezen om een afbeelding op de website te centreren, links of rechts uit te lijnen. Dat doe je door een class align-center (om te centreren), align-left (voor linkse uitlijning) of align-right (voor rechtse uitlijning) toe te voegen. Een voorbeeld: [[Bestand:Droid java versie.png|thumb|600px|class=align-left]]. Let op: Dit is enkel te zien op de website, niet op de Mediawiki.
  • je kan de afbeeldingen een breedte meegeven: [[Bestand:mijnafbeelding.jpg|thumb|400px]] zorgt voor een beeld met een breedte van 400 pixels
  • tevens kan je de hoogte van een beeld bepalen via [[Bestand:mijnafbeelding.jpg|thumb|x400px]]. Dit zorgt voor een beeldt met een hoogte van 400 pixels.
  • ook kan je de automatische caption of onderschrift overschrijven: [[Bestand:mijnafbeelding.jpg|thumb|x400px|mijn onderschrift]].
  • op de gebruikerspagina van Bart staan ook heel wat voorbeelden waarvan je de syntax kan bekijken als je op Bewerken klinkt.

Bovenstaande regels gelden enkel als je een individuele afbeelding wil tonen. Het is ook mogelijk om een gallerij van bestanden weer te geven. Hiervoor geldt onderstaande syntax:

<gallery>
Bestand:bestandsnaam.ext|mijn caption
Bestand:bestandsnaam.ext|mijn caption
{...}
</gallery>

Voorbeeld:

Ook hiervan vind je een voorbeeld op Gebruiker:Bart Magnus.

Voor bestanden die van Wikimedia Commons komen, geldt dezelfde syntax. Zo wordt [[Bestand:Wikipedia-Marker-commons.svg|50px]]: Wikipedia-Marker-commons.svg

Afbeelding in preview kiezen

Standaard wordt de eerste afbeelding op een pagina op de frontend als previewafbeelding gebruikt. Als dat niet de meest geschikte afbeelding is, kan je een andere afbeelding kiezen door er een class toe te voegen. Op die manier bepaal je zelf welke afbeelding als preview gebruikt moet worden:

|class=preview-image

Bijvoorbeeld:

[[Bestand:Disk Image Windows 4.png|Klik op dit icoontjeom het creëren van de disk image te starten.|class=preview-image]]

Video's van externe diensten

Externe diensten zijn o.m. YouTube en Vimeo. Om deze in te bedden op de Mediawiki wordt de extensie EmbedVideo gebruikt.

Video's integreer je met volgende syntax

{{#ev:service|URL}}

Voorbeeld:

{{#ev:youtube|https://www.youtube.com/watch?v=sTSA_sWGM44}} wordt:

Er zijn nog meer opmaakmogelijkheden. Consulteer hiervoor de pagina van EmbedVideo.

iframes

Het is mogelijk om in de Mediawiki iframes te embedden tussen html tags. Bv.:


Tabellen

Tabellen kun je maken in verschillende vormen. Het beste is om tabellen te gebruiken van het type "wikitable". Hieronder vind je een sjabloon dat je kunt kopiëren en aanpassen naar je noden in je eigen pagina.

Dit sjabloon is zeer standaard. Meer opmaakmogelijkheden vind je terug op de MediaWiki handleiding.

Kolom 1 Kolom 2 Kolom 3 Kolom 4
Rij 1, Kolom 1 Rij 1, Kolom 2 Rij 1, Kolom 3 Rij 1, Kolom 4
Rij 2, Kolom 1 Rij 2, Kolom 2 Rij 2, Kolom 3 Rij 2, Kolom 4
Rij 3, Kolom 1 Rij 3, Kolom 2 Rij 3, Kolom 3 Rij 3, Kolom 4
etc... ... ... ...

Vertalingen

Om een pagina te markeren voor vertaling, zet je heel de tekst tussen deze wikicode:

<languages /><translate> de te vertalen tekst </translate>

Vervolgens klik je op de link "Deze pagina voor vertaling markeren". Op de pagina waar je dan terecht moet het eerste vinkje aangevinkt staan. Onderaan deze pagina klik je op ok. De pagina is nu gemarkeerd voor vertaling. Bovenaan de gemarkeerde pagina zie je nu een link waar je kan beginnen met vertalen. Je kunt ervoor kiezen om de Nederlandse brontekst te kopiëren en die te vervangen door Engelse tekst. Zo kun je maximaal de markup van het Nederlandse origineel behouden. Ook voor afbeeldingen is dit handig, omdat je dan enkel eventueel het onderschrift moet veranderen.

De naar het Engels vertaalde pagina geef je de categorie [[Categorie:Praktijkvoorbeelden/en]] of [[Categorie:Tools/en]] mee.

De vertaalmodule maakt bij het vertalen ook een kopie aan met "/nl" aan het einde van de url. Die pagina mag je verwijderen. De originele Nederlandstalige pagina blijft dan bestaan. Het verwijderen kan even in beslag nemen en kan opgevolgd worden in het verwijderlogboek.

Organisatiepagina's

Enkel TRACKS-partnerorganisaties krijgen een pagina op de Mediawiki. Een organisatiepagina bestaat uit een beschrijvende tekst, een gewoon logo, een wit logo en moet steeds ondergebracht worden in de categorie Partnerorganisaties:

[[Categorie:Partnerorganisaties]]

We maken enkel organisatiepagina's aan voor de huidige organisatienamen. Oudere namen (bv. van voor fusies) kunnen wel in de teksten blijven staan, maar kunnen rechtstreeks doorlinken naar de corresponderende actuele organisatiepagina. Dit doe je bv. als volgt:

Dit praktijkvoorbeeld werd begeleid door [[Meemoo, Vlaams instituut voor het archief|PACKED vzw]]

wordt dan: "Dit praktijkvoorbeeld werd begeleid door PACKED vzw".



Vermelding auteurs

Onderaan de pagina vermeld je telkens de oorspronkelijke auteur(s) en de auteur(s) die de pagina's herwerkten. Daarbij vermeld je ook telkens de organisatie waar de auteur voor werkt(e) volgens de regels zoals hierboven opgenomen. We houden volgende structuur aan: Auteur(s): Naam (Organisatie), Naam (Organisatie), ...

  1. Een woord dat we kennen sinds de Trololo meme