We probeerden dezelfde tekstaanwijzingen te gebruiken die op de Wikipedia worden gebruikt, welke afkomstig is van UseModWiki. Er zijn een aantal verschillen in Wiki systemen, maar de meeste zijn zeer vergelijkbaar met deze, en het heeft zichzelf bij ons reeds bewezen.
Een lege regel scheidt paragrafen, en er zijn nog wat andere aanwijzingen om secties, opsommingslijsten, links, bestandsnamen, enz te maken.
=Introductie|intro= |
maakt een nieuwe sectie aan op het hoogste niveau. Zie het pipe teken gevolgd door "intro"? Veel aanwijzingen voorzien in een "id", en dit is de wijze waarop je erin voorziet. Voor secties zal het id de naam zijn van het uitvoerbestand (intro.html in het eerste voorbeeld), of de html "tag" gebruikt voor links binnen het document.
==Hoe werkt het?|how-does-it-work== |
maakt een sectie op het tweede niveau aan, en
===Waarom zou ik het gebruiken?|why?=== |
maakt een sectie aan op het derde niveau.
#één #twee #drie /# |
De "#" prefix geeft aan een genummerde lijst te maken. De genummerde lijst gaat verder tot aan het einde van de huidige sectie, of totdat het een regel tegenkomt met slechts "/#", waarmee de lijst wordt afgesloten. Na het openen van een andere "#" lijst, zal de nummering weer bij "1" beginnen.
Het bovenstaande blok zal er in het uiteindelijke document zo uit komen te zien:
één
twee
drie
Gebruik de vierkante haken om links te identificeren, zoals in:
[[http://www.linuxdoc.org|Linux Documentatie Project]] |
In dit geval is de tekst na het pipe teken geen id, maar de "titel" van de link.
Er zijn twee speciale namespaces die je kunt gebruiken naast de standaard "http:" en "mailto:" namespaces die je waarschijnlijk reeds kent. De eerste is de "ldp:" namespace. Bekijk de volgende link eens:
[[ldp:Distributions-HOWTO]] |
Wanneer je gebruikt maakt van de namespace "ldp:" zal WikiText het document dat je hebt benoemd opzoeken in de LDP-database en er een link naar genereren.
Noot: we werken nog steeds aan het invoeren van de juiste "naam" in alle databaserecords, dus slechts een paar werken. Maar maak je geen zorgen. Laat ons gewoon weten als je een link wilt gebruiken die nog niet correct is en we zullen het onmiddellijk corrigeren.
De tweede speciale namespace is de "wiki:" namespace. Het zal een link genereren naar het artikel in de Wikipedia, een open source encyclopedie project. We hopen een aantal van de meest van toepassing zijnde artikelen uit de Wikipedia direct op de LDP te linken. Wikipedia heeft heel veel geweldige artikelen over aan computer gerelateerde onderwerpen. Niet het soort informatie die we bij de LDP verzorgen, maar wel wat onze documenten zeer goed zou aanvullen. Er staan bijvoorbeeld artikelen in over virtueel geheugen, besturingssystemen, enzovoort. Thans gaat je link naar de live Wikipedia site. Mogelijk zal het naar een mirror op onze site gaan, maar met een link naar de "echte" site.
De volgende links gaan naar artikelen genaamd "Operating system" en "Linux kernel" in de Wikipedia:
[[wiki:Operating system]] [[wiki:Linux kernel]] |
Wikipedia is een geweldige bron voor alle Net-gebruikers. Zowel de software die ze gebruiken als de inhoud is open source.
Bestandsnamen kun je aangeven door ze tussen dubbele aanhalingstekens te plaatsen, net als http en andere links. Of je kunt de "file" namespace specificeren:
[[/etc/apache/httpd.conf]] [[file:/etc/apache/httpd.conf]] |
Voor beide manieren zal het worden weergegeven als: /etc/apache/httpd.conf.
Je kunt bepaalde woorden benadrukken, door ze te omsluiten tussen drie (3) enkele aanhalingstekens, zoals in:
'''Wauw!''' |
Dat zal worden weergeven als: Wauw!
Je kunt vraag en antwoord-sets creëren als je een FAQ aan het schrijven bent, of een FAQ sectie in je document hebt. Gebruik gewoon "Q:" en "A:" als de eerste tekens op een nieuwe regel en de QandASet tags zullen automatisch worden aangemaakt.
Q: Wat als je iets wilt met DocBook dat niet door WikiText wordt ondersteund? A: Mu. |
En zo wordt het voorbeeld weergegeven. Precies voor de eerste vraag verschijnt een lijst met vragen. In het voorbeeld ziet dit er wat raar uit, aangezien er slechts één vraag staat en het precies twee keer wordt weergegeven. Als je echter aan de Linux-FAQ werkt, ziet het er echt fraai uit.
Er is geen DocBook structuur die niet door WikiText wordt ondersteund. Waarom? Omdat wanneer er geen WikiText voor is, je gewoon de benodigde tags direct in het document zal plaatsen, en ze zullen gewoon werken.
Er zijn een paar "speciale" tags die niet tot de inline DocBook behoren, maar secties structureren, waaronder de "programlisting" en "screen" tags. Je moet onthouden dat geen van de WikeText functies binnen deze tags zal werken. Je wilt toch niet dat je commentaarregels in je voorbeeldcode wordt geconverteerd naar genummerde lijsten, nietwaar?
# dit is commentaar # het is GEEN genummerde lijst! |