Help:Wiki syntax and markup/nl

From FedoraProject

Jump to: navigation, search

Contents

Bewerken in Mediawiki

Note.png
Indien u hulp nodig hebt met syntax dat hier niet vermeld wordt, kijk dan op Mediawiki Help (Engels).

Basis Syntax

Wat u typt Hoe het er uit ziet
'''vet'''
vet
''schuin''
schuin
'''''vet en schuin'''''
vet en schuin
<code>Monospace text</code>
Monospace text

Opsomming

Wat u typt Hoe het er uit ziet
* Een opsommingsregel
* Nog een opsommingsregel
** Oh nee hè, weer een opsommingsregel!
  • Een opsommingsregel
  • Nog een opsommingsregel
    • en weer een opsommingsregel
# Een genummerde regel
# Nog een genummerde regel
## Sub regel
## Meer sub regels
# Derde genummerde regel
  1. Een genummerde regel
  2. Nog een genummerde regel
    1. Sub regel
    2. Meer sub regels
  3. Derde genummerde regel
* Een opsommingsregel...
*# Met een genummerde sub-regel
*# Meer genummerde sub-regels
* Terug naar de eerste niveau opsommingsregel
*# Meer genummerde regels
*#* met eigen opsommingsregel
  • Een opsommingsregel...
    1. Met een genummerde sub-regel
    2. Meer genummerde sub-regels
  • Terug naar de eerste niveau opsommingsregel
    1. Meer genummerde regels
      • met eigen opsommingsregel

Links

Wat u typt Hoe het er uit ziet
Bezoek [[DocsProject]] om meer te weten te komen over
Fedora's documentatie.
Bezoek DocsProject om meer te weten te komen over

Fedora's documentatie.

Ons [[Websites|websites team]] biedt vele
individuen die Fedora kunnen helpen.
Ons websites team biedt vele

individuen die Fedora kunnen helpen.

Lees [[Artwork#Join]] over hoe je aan te sluiten bij het Art Team.
Lees Artwork#Join over hoe je aan te sluiten bij het Art Team.
[[The weather in London]] is een
pagina die nog niet bestaat.
The weather in London is een pagina die nog niet bestaat.
http://fedoraproject.org/
http://fedoraproject.org/
Hier zijn enkele sites:
[http://www.deviantart.com]
[http://www.flickr.com]
Hier zijn enkele sites: [1] [2]
[http://fedoraproject.org Onze home page]
staat vol met interessante informatie.
Onze home page staat vol met interessante informatie.
Gebruik een ':' in de link om te linken
naar een [[:Image:Growth_wide.jpg|afbeelding]].
Gebruik een ':' in de link om te linken

naar een afbeelding.

De [[:Category:Documentation]] somt alle 
documentatie voor de eindgebruiker op.
De Category:Documentation somt alle

documentatie voor de eindgebruiker op.

De [[Category:Documentation]] link plaatst
deze pagina in de opgesomde categorie; de link
verschijnt automatisch onderaan de pagina en niet binnenin de pagina.
De [[Category:Documentation]] link plaatst

deze pagina in de opgesomde categorie; de link verschijnt automatisch onderaan de pagina en niet binnenin de pagina.

Note.png
Er zijn twee manieren om de Category links te gebruiken
Vergewis u ervan dat de ':' voor het woord 'Category' staat indien de bedoeling is dat verwezen moet worden naar een categorie pagina. Laat de ':' weg indien de pagina geacht dient te worden bij die categorie te behoren. Bekijk bovenstaande voorbeelden goed.

Tabellen

Tabellen dienen spaarzaam te worden gebruikt en uitsluitend indien noodzakelijk.

Voor meer gevorderde tabellengebruik, lees Mediawiki.org's page on tables (Engels).

Wat u wilt Hoe u het krijgt
Begin een tabel
{|
Tabel Kop
! kolom 1 !! Kolom 2 !! Kolom 3
Nieuwe rij
|-
Tabel rij
| Cel 1 || Cel 2 || Cel 3
Eindig een tabel
|}

IRC Logs

IRC logs kunnen hetzij worden ingesloten met <pre> tags, hetzij converteerd in MediaWiki pipe-tables met irclog2html en Ian's MediaWiki patch for irclog2html.

Structuur van een Wiki Pagina

Deze sectie beschrijft de meest voorkomende structuur van een wiki pagina. Volg deze richtlijnen voor elke wiki pagina. Er zijn aanvullende regels die gebruikt worden voor officiele Fedora documentatie; behandeld in DocsProject/WritingUsingTheWiki ; die regels zijn alleen noodzakelijk voor inhoud waarbij bij het schrijven de procedures van de Fedora Documentation Project moeten worden gevolgd. Pagina's als sjablonen en die met standaard inhoud, bedoeld om in andere pagina's te worden opgenomen, kunnen een andere structuur hebben.

Note.png
Kop 1 (h1) wordt afgeraden in opmaak
De kop 1 wordt gedefinieerd door de pagina titel. Bij het maken van nieuwe of bij het verplaatsen van pagina's, her-nest of herstructureer de pagina dusdanig dat er alleen nog maar kop 2 en lager in voorkomen.
  • De titel van een pagina is een kop van het eerste niveau. Deze wordt automagisch gecreëerd via de pagina titel.
  • Secties ontstaan door isgelijktekens in paren:
== Kop 2 ==
=== Kop 3 ===
==== Kop 4 ====
===== En doe dit niet, 5 niveaus nesting betekent dat je een nieuwe pagina of drie nodig hebt=====
  • Een inhoudsopgave wordt automatisch gegenereerd op het moment dat de pagina groot genoeg geworden is.
  • Ankers naar secties worden automatisch gegenereerd, met specifieke symbolen op de plek van leestekens en spaties.
Deze pagina ==> Deze_pagina
Dit, dat, en de andere pagina ==> Dit%2C_dat%2C_en_de_andere_pagina


Idea.png
U kunt .2C gebruiken in plaats van %2C voor ankers
De vervanging van '.' voor '%' werkt voor ankers aan een specifieke sectie.

Snelle Tips

Dit was de basis van wat u dient te weten als u deze Wiki wilt bewerken.

Note.png
Voor meer informatie
betreffende het optekenen van documentatie op de Wiki leze men Writing Wiki Documentation (in Engels).


Leer aan de hand van voorbeelden

Eén van de betere manieren om te leren hoe je de wiki kan bewerken is het bekijken van code van bestaande pagina's. Dat is heel eenvoudig te doen:

  1. Vind een pagina waarvan u de bron zou willen zien
  2. Klik boven aan pagina op de tab bewerken als u ingelogd bent of de tab view source indien u dat niet bent.

De wiki toont u de brontekst van die pagina. Dit is erg waardevol als u sommige slimme truukjes van eerdere wiki bewerkers wilt leren en overnemen. Deze truukjes zijn echt waardevol omdat zij u in staat stellen niet vaak voorkomende, interessante, krachtige dingen te doen waarvan u niet dacht dat die mogelijk waren. Bekijkt u bijvoorbeeld eens de Hoofdpagina van de Fedora wiki (liefst niets veranderen).

Aantekeningen, Tips, en Andere Admonitions

Deze staan allen samen bekend onder de naam 'admonitions', en worden gebruikt in DocBook. Om een paragraaf het uiterlijk te geven van een admonition, gebruikt u de speciale admonition sjabloon. Een korte titel en een wat langere beschrijving als paragraaf verdient de voorkeur.

Wat u typt Wat u ziet
{{admon/note|Een titel|Hier staat meer informatie 
over deze tip, met informatie dat meer inzicht 
geeft in de informatieve titel van de initiële 
inleiding.}}
Note.png
Een titel
Hier staat meer informatie over deze tip, met informatie dat meer inzicht geeft in de informatieve titel van de initiële inleiding.

Dit zijn de standaard types admonition:

Wat u typt Wat u ziet
{{admon/note|Dit is een aantekening|Informatieve 
paragraaf welke vertelt wat er aan de hand is.}}
Note.png
Dit is een aantekening
Informatieve paragraaf welke vertelt wat er aan de hand is.
{{admon/tip|Dit is een tip|Informatieve paragraaf
welke vertelt hoe met een bepaalde situatie 
omgegaan kan worden.}}
Idea.png
Dit is een tip
Informatieve paragraaf welke vertelt hoe met een bepaalde situatie omgegaan kan worden.
{{admon/important|Dit is belangrijk|Informatieve 
paragraaf met dringend advies.}}
Important.png
Dit is belangrijk
Informatieve paragraaf met dringend advies
{{admon/caution|Dit betekent opgepast|Informatieve 
paragraaf welke wijst op gevaar of risico.}}
Stop (medium size).png
Dit betekent opgepast
Informatieve paragraaf welke wijst op gevaar of risico.
{{admon/warning|Dit is een waarschuwing|Informatieve
paragraaf met duidelijke waarschuwing.}}
Warning (medium size).png
Dit is een waarschuwing
Informatieve paragraaf met duidelijke waarschuwing.


Admonitions Voorbeelden

Voorbeelden van context waarbinnen deze admonitions worden gebruikt:

Note.png
Afgronden kunnen heel diep zijn
Wikipedia kan dit bevestigen.
Idea.png
Niet te dicht bij de rand van de afgrond komen is een manier om er niet in te vallen
Voor meer informatie, lees de HoeOverleefIkWandelenMetMijnVrouw(1) man pagina.
Important.png
Houd uw kinderen weg bij de rand van de afgrond
Kinderen rennen van hot naar her en hebben daardoor de neiging in afgronden te vallen. U doet er goed aan hun hand vast te houden. Of juist niet.
Stop (medium size).png
U komt steeds dichter bij de rand van de afgrond
Zoals eerder vermeld kunnen afgronden heel diep zijn. Er in vallen wordt afgeraden.
Warning (medium size).png
U staat op het punt in de afgrond te vallen
Maak u zo snel mogelijk in de juiste richting uit de voeten. Even denken voordat u gaat rennen dus.

Lees de Fedora Documentation Guide voor beschrijvingen van admonition types: http://docs.fedoraproject.org/documentation-guide/en_US/sn-xml-admon.html

Opmaak van Technische Termen

Gebruik de code (<code></code>) opmaak om namen van applicaties, bestanden, mappen, softwarepaketten, gebruikersaccounts en andere woorden met een speciale technische betekenis te markeren. Dit zal deze begrippen laten zien in monospace.

Gebruik twee enkele quotes (''[name of menu]'') om namen van menu items en andere elementen van een grafische interface te markeren. Dit vertoont de markeerde woorden in italic.

Term Opmaak Opmaak voorbeeld
Namen van GUI applicaties
 '''vet gedrukt''' 
Firefox
Bestanden, mappen
 <code>inline code tags</code> 
/usr/bin/firefox
Software pakketten
 <code>pakket naam</code> 
firefox-1.2.3
Gebruikersaccounts
 <code>gebruikersnaam</code> 
gebruikersnaam
Andere woorden met een specifieke technische betekenis
 <code>technische term</code> 
... de klasse org.fedora.someJava.classname ...
Grafische menus en menu-onderdelen
 ''Menu naam'' 
Applicaties > Internet > Firefox Web Browser
Andere GUI of WebUI interface elementen
 ''twee single-ticks'' 
... klik de Verzend knop ...
Inline commando's en daemons
 <code>commando -optie</code> <code>daemon</code>
grep httpd om de PIDs van lopende httpd processen te zien.
Stukken code, configuratie bestanden, etc.
 <pre>witruimte behouden< /pre> 
   witruimte
    is hier
  behouden
Inline stukken van code, configuratie bestanden, etc.
 <code> set() /path/to/org/dev108/classname </code> 
... Pas vervolgens de variabelen voor set() in /path/to/org/dev108/classname aan ...
Eerste term, glossy term
 ''term'' 
... Firefox is een voorbeeld van een grafische gebruikersinterface ofwel GGI.
Toetsaanslagen
 '''[Toets]''' 
Druk op [Enter] ...

Mooi voorbeeld:

Het <code>thunderbird</code> pakket installeert de '''Mozilla Thunderbird'''
e-mail applicatie. Om '''Thunderbird''' te starten, selecteer:
  ''Applicatie > Internet > Thunderbird Email''.

geeft als resultaat:

Het thunderbird pakket installeert de Mozilla Thunderbird e-mail applicatie. Om Thunderbird te starten, selecteer: Applicatie > Internet > Thunderbird Email.

Notatie van Voorbeelden van Computeropdrachten

Voorbeelden van opdrachten zijn één of meerdere opdrachten die los van de tekst waarin zij worden uitgelegd worden opgeschreven. Gebruik geen prompt-symbolen of andere informatie betreffende machinenaam, gebruiker, mappen etc (hetgeen informatie is uit de $PS1 variabelen).

Omvat elke opdracht met <pre></pre> tags:

<pre>
su -c "yum install geweldige-applicatie"
</pre>

Voer het <code>root</code>-wachtwoord in wanneer erom wordt gevraagd.

Wat oplevert:

su -c "yum install geweldige-applicatie"

Voer het root-wachtwoord in wanneer erom wordt gevraagd.


Note.png
Opdracht Voorbeelden en Root
Veel opdrachten vereisen root privileges. De lezer dient niet op zijn systeem te zijn ingelogd als root, daarom dient u ofwel su -c ofwel su - aan te geven wanneer er sprake is van opdrachten die root privileges vereisen.

Indien de opdracht elementen in zich heeft die moeten worden gequote, dient nesting te gebeuren met enkele aanhalingstekens omgeven door één paar dubbele aanhalingstekens, dus zo:

su -c "command -o 'Enige tekst' -file 'Hier ook wat tekst' foo/bar"

If you need to have a series of commands or su -c is not responding as expected, have the user switch to root and warn the user to return to a normal user shell afterward.

Indien een aantal opdrachten achter elkaar als root gegeven dient te worden of su -c reageert niet als verwacht, zorg dan dat de gebruiker wisselt naar root en waarschuw de gebruiker naar de gebruikersshell terug te keren als hij klaar is. Terugkeren kan door exit te typen of op [Ctrl] + [d] te drukken.

su -
Wachtwoord:
service food stop
cp /etc/foo.d/foo.conf /etc/foo.d/foo.conf.backup
vi /etc/foo.d/foo.conf
food --test-config
...
service food start
exit

Voorbeeld van opdracht-output

Wanneer het voorbeeld een opdracht toont tezamen met de output naar het scherm, mag u een opdrachtprompt laten zien ter onderscheiding van opdracht en output.

$ su -c "ls -l /root"
Wachtwoord: 
total 148
-rw------- 1 root root  1961 2007-09-21 02:46 anaconda-ks.cfg
-rw-r--r-- 1 root root 46725 2007-09-21 02:46 install.log
-rw-r--r-- 1 root root  6079 2007-09-21 02:42 install.log.syslog
-rw-r--r-- 1 root root  3699 2008-07-28 17:24 scsrun.log
-rw-r--r-- 1 root root 45038 2008-01-10 10:21 upgrade.log
-rw-r--r-- 1 root root  1317 2008-01-10 10:20 upgrade.log.syslog

Probeer het zelf eens uit

Probeer nieuwe dingen in de Fedora Wiki Sandbox . Het is ook een goede plek om kleine voorbeelden te aanschouwen.