Info HOWTO's (bokkie@nl.linux.org)
----------------------------------

Bij het zelf schrijven van een (mini-) HOWTO, kun je gebruik maken van
een van de templates die ook in deze directory te vinden zijn. Onder de
tree 'HOWTO' zijn diverse documenten te vinden die meer info verstrekken
over het gebruik van DocBook en LinuxDoc SGML/XML.

Bij het vertalen haal je de oorspronkelijke sgml-versie op van het 
document en gaat dat vertalen. Kijk in het document van welk copyright
de auteur gebruik maakt, voor het geval je eerst toestemming moet hebben
van de auteur om het te mogen vertalen. Een oorspronkelijk sgml/xml
bestand kun je ophalen vanaf http://www.tldp.org of mij vragen of
ik het voor je in de subdir nldoc/work plaats.

Als je klaar bent met je document, voeg je de meta-gegevens van je 
document toe aan de DATABASE-file direct onder nldoc/. 
In de intern/DATABASE-README is beknopt weergegeven waar de verschillende 
velden voor staan.

Wijzig de naam van een vertaalde HOWTO altijd als volgt:
mv <originele-naam>.sgml <originele-naam>-NL.sgml

Hierna doe je een commit van zowel de DATABASE-file als je document.

Wanneer je een document hebt met afbeeldingen of voorbeeldscripts, of
de broncode bestaat uit meerdere bestanden, dan plaats je die in een
aparte subdirectory met als directorynaam de naam van het bronbestand,
uiteraard exclusief de extensie en inclusief de toevoeging -NL als 
dit laatste van toepassing is (dus bij vertalingen). De bijbehorende
voorbeeldscripts en/of images worden dan meeverpakt in een tar.gz
archief (sgml en html formaat).

Als je perse wilt dat evt scripts en/of images ook als aparte tarball 
beschikbaar zijn voor gebruikers, plaats de bestanden dan onder een subdir
van MISC. Deze subdir zal als 1 tarball worden gedistribueerd. 
Deze komt dan in http://nl.linux.org/doc/MISC/source/ en 
in ftp://ftp.nl.linux.org/pub/MISC/source. Maak het de gebruikers
makkelijk en geef deze tarball bijvoorkeur de naam van de HOWTO
waar deze afbeeldingen en/of voorbeeldbestanden bijhoren met
bijvoorbeeld een extra toevoeging, zoiets als 'examples' of 'images' o.i.d.

Plaats bij een vertaling de source (meestal de Engelstalige variant) 
alsjeblieft in de tree 'en', dit vergemakkelijkt namelijk later
het updaten van het bestand als er een nieuwe versie uit is. In plaats
van het weer helemaal vertalen of regel voor regel nalopen van het
bestand is het handiger een 'diff' toe te passen, tussen de oude
en nieuwe versie en met de verkregen verschillen het Nederlandstalige 
document aan te passen. Doe dit alsjeblieft pas nadat je het volledig
vertaald hebt. Je kunt het altijd 'tijdelijk' parkeren in de subdir
'work'.

Het is van belang dat je je aan de bestaande directorystructuur houdt,
want bij elke commit wordt een script gestart. Dit script controleert
op de syntax, de directory's enz en bij geconstateerde fouten wordt
dit in een mail gemeld die wordt geretourneerd naar de lijst 'nldoc'. 
Commits die fouten bevatten
worden niet in de webspace of ftp-space geplaatst. Meestal zal in het
betreffende bericht dat daarop volgt dan staan aangegeven welke fout
werd aangetroffen en kun je dit alsnog corrigeren. Alle bestanden
buiten de bestaande directorystructuur vallen 'buiten de boot'. In
het bestand nlhowto/README kun je nagaan welke directory's sowieso
niet worden meegenomen. Je kunt de directory 'work' gebruiken om
tijdelijk je werk in op te slaan zonder dat dit zichtbaar wordt
voor de 'buitenwereld', als je dat wilt, kun je hier tevens subdirs
onder aanmaken, om bv aan te geven dat dit jouw 'persoonlijke'
werkdirectory is.

HOWTO's worden gemirrord (of liever gezegd 'geresynced' door de LDP.
Deze documenten komen dus in de verschillende distributies en op
CD-ROM terecht. De Nederlandstalige HOWTO's zijn te vinden op:

ftp://metalab.unc.edu/pub/Linux/docs/translations/nl/





