Nieuwe wiki pagina aanmaken: verschil tussen versies
Regel 40: | Regel 40: | ||
Onder de categorie Tools vallen veel subcategorieën; je mag je artikel bij meerdere onderbrengen, zoals bijvoorbeeld 'metaal' en 'perslucht' voor een pneumatisch slijpwiel. | 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: | ||
+ | * Veiligheidszaken en safety sheet | ||
+ | * Imperial / fragiel / gebruikskosten | ||
+ | * Huidige status / huidige manco's | ||
+ | * Korte beschrijving | ||
+ | * Handleiding voor het gebruik | ||
+ | * Onderhoud / todolist | ||
+ | * Geschiedenis etc. | ||
+ | |||
+ | |||
+ | == Wat hoort niet in een artikel? == | ||
+ | Om de boel opgeruimd te houden. :) | ||
+ | * 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. |
Versie van 23 mrt 2020 om 18:58
Hoi! Op deze pagina 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.
Inhoud
Wiki-'code' en formatteren
- Voorbeelden? Pak een random of groot artikel erbij!
- Cheat-sheet kan je o.a. hier vinden.
- 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 metrische bouten/moeren?
- 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 pagina over een machine of gereedschap? Plaats 'm dan hieronder.
- Howto's. Is het een stappenplan dat niet direct gelinkt is aan een machine of gereedschap? Die kan hier.
- Space-infra. Waarschijnlijk past je pagina 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:
- Veiligheidszaken en safety sheet
- Imperial / fragiel / gebruikskosten
- Huidige status / huidige manco's
- Korte beschrijving
- Handleiding voor het gebruik
- Onderhoud / todolist
- Geschiedenis etc.
Wat hoort niet in een artikel?
Om de boel opgeruimd te houden. :)
- 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.