Nieuw artikel aanmaken

From MakerSpace Leiden
Jump to: navigation, search

Hoi!
In dit artikel staan wat pointers voor het aanmaken van een nieuw artikel op de MSL wiki.
Het zijn geen vaste regels, maar richtlijnen, zodat de wiki niet teveel een bende wordt.


De pagina aanmaken

Hier struikelen mensen nog wel eens over: waar zit de knop 'nieuw artikel aanmaken' eigenlijk?
Simpel: het is de URL! Alles wat je achter wiki.makerspaceleiden.nl/mediawiki/index.php/ plakt, verandert automatisch in een landingspagina met de knop 'nieuw artikel aanmaken'.
Bijvoorbeeld: wiki.makerspaceleiden.nl/mediawiki/index.php/Neusfluitje.


Wiki-'code' en formatteren

  • Voorbeelden? Pak een random of groot artikel erbij!
  • Cheat-sheet kan je o.a. hier vinden.
  • De categorie Zandbak kan je toevoegen aan je artikel om aan te geven dat het nog een opzetje of kladversie is.
  • Wil je een lege regel in je artikel hebben? Plaats dan twee lege regels in de code:


  • Wil je dat je zin...
...op de volgende regel doorgaat? Plaats dan <br /> aan het eind van je regel.
  • Foto's kan je via 'upload file' (onder de zoekbalk, links op de website) uploaden en dan linken aan je artikel.
For the love of god: upload geen 3000 x 4000-pixel foto's, tenzij dat écht nodig is... Dit is op de mailinglist al een enorm probleem!


Sjablonen en categorieën

  • Deze sjablonen zijn belangrijk. Kijk welke van toepassing zijn:
    • Veiligheid
    • Herrie
    • Stofproductie
    • Gasgebruik


  • Dan heb je nog de minder belangrijke sjablonen:
    • Heeft het gereedschap imperial (dus niet metrische bouten/moeren? Of past het gereedschap alleen op engelse/amerikaanse maten?
    • Is het fragiel of een gevoelig meetinstrument?
    • Zijn er kosten aan het gebruik verbonden?
    • Is het gereedschap uitgeleend?


  • En als laatst de categorieën:
    • Tools. Gaat je artikel over een machine of gereedschap? Plaats 'm dan hieronder. Stok/voorraad mag in de subcategorie Stock.
    • Howto's. Is het een stappenplan dat niet direct gelinkt is aan een machine of gereedschap? Die kan hier.
    • Algemeen. Waarschijnlijk past je artikel hieronder als-ie niet in de bovenste twee past. Deze categorie is voor het 'reilen en zeilen' van de space.


Onder de categorie Tools vallen veel subcategorieën; je mag je artikel bij meerdere onderbrengen, zoals bijvoorbeeld 'metaal' en 'perslucht' voor een pneumatisch slijpwiel.

Onderwerpen en volgorde

Maak je artikel 'oprolbaar': hoe belangrijker de info, hoe hoger op de pagina. Dit is een goede volgorde:

  • Veiligheidssjablonen en safety sheet
    • Apart aangeven welk materiaal / gebruik de machine niet voor bedoeld is (maar wel zo lijkt)
  • Andere belangrijke labels: imperial / fragiel / gebruikskosten / bruikleen
  • Huidige status / huidige manco's. Onder andere:
    • de locatie van het gereedschap
    • materialen waar het gereedschap wel/niet mee overweg kan (evt. kans op schade)
  • Korte beschrijving en aanwezige accesoires
  • Gebruiksinstructies van het gereedschap
    • Denk ook even aan onderhoud- en schoonmaakinstructies
  • Lijst met onderhoudstaken / todolist
    • Waar kan je reserve-onderdelen halen?
  • Geschiedenis, notities en overige


Wat hoort niet in een artikel?

Om de boel opgeruimd te houden. :)

  • Privégegevens. De wiki is openbaar en wordt dus door bots / paparazzi bezocht. Die weten alle mailadressen, telefoonnummers, woonadressen, profielfoto's en je favoriete merk ondergoed genadeloos te vinden.
  • Handleidingen/documentatie (in pdf-vorm): als attachment aan het artikel, eventueel met een icoontje om gemakkelijk te vinden. Linken naar een website met het document is een sure-fire way om het document kwijt te raken na een paar maanden.
  • Code: plaatsen op de github-pagina en daaraan linken. Dit maakt de code toegankelijk en beter aanpasbaar. Installatiescriptjes en dergelijke plaatsen onder het kopje 'handleiding gebruik'.
  • Logs en dergelijke: als attachment aan een artikel.
  • Grote Foto's: thumbnails in het artikel, volledige grootte als gelinkt attachment.


Vertaalbare artikelen

Nederlands is de standaardtaal van de wiki, maar omdat er veel internationale Makers zijn, is een vertaling van artikelen handig.
De wiki kan automatisch speciale vertaalversies van je artikel maken. Je zult zelf de tekst moeten vertalen (no free lunch; Google translate maakt het wel heel goedkoop), maar je wordt hierbij geholpen doordat het artikel in stukken wordt opgedeeld.


De procedure:

  1. Allereerst moet het artikel zoveel mogelijk afgeschreven zijn. Als de brontekst kort na het vertalen opeens verandert, moet de vertaler opnieuw aan het werk, wat niet leuk is.
  2. Hierna moet het artikel gemerkt worden. Je plaatst twee tags in het artikel:
    • <languages/>. Met deze tag wordt een aanklikbare lijst gemaakt van alle talen waarin het artikel is vertaald.
    • <translate> tekstteksttekst </translate>. Hiermee omwikkel je de stukken tekst die vertaald moeten worden.
  3. Het systeem gaat vervolgens aan de slag met de pagina en deelt het op in segmenten.
    Omdat dit automatisch is, kan je met de hand deze segmenten nog herindelen. De segmenten zijn genummerd en zien er in de bron uit als <!--T:nummer-->
  4. De groep segmenten vormen een op zichzelf staand 'ding' waar het systeem de vertaalde pagina's uit genereert. Je hebt in totaal dan de volgende artikelen:
    • Het originele artikel waar de tags en segmentcodes aan toe zijn gevoegd.
    • Een vertaalde versie in een andere taal. Herkenbaar door de taalcode ('/en' of '/fr') achter de URL.
    • Een onvertaalde versie met de bijbehorende taalcode erachter ('/nl'); deze pagina is zoals het origneel, maar dan zonder de toegevoegde tags en segmentcodes.
  5. Vervolgens kan je de segmenten apart vertalen en houdt het systeem bij wanneer een wijziging in het originele document is gemaakt.


Zie hier voor wat voorbeelden.
En hier voor het uitgebreide verhaal.