Bijdragen met betrekking tot Nederlandstalige Linux-Documentatie zijn van harte welkom. Als je een auteur, vertaler of website-builder een bijdrage wilt sturen, hetzij door het leveren van kritiek, aanvullingen en/of opmerkingen enz., stuur deze dan naar nldoc@nl.linux.org of builders@nl.linux.org voor de Nederlandstalige versies en naar de oorspronkelijke auteur die bovenaan het document staat genoemd voor de anderstalige documenten.
Houd je in alle gevallen alsjeblieft aan de netiquette. Als je deze niet kent, lees dan eerst de
http://nl.linux.org/doc/HOWTO/Quoting-HOWTO-NL
eens door, alvorens je iets post in de nieuwsgroepen of mail stuurt naar één van de auteurs, vertalers of website-builders. Nogmaals, je hebt te maken met vrijwilligers die hun vrije tijd geven om je te kunnen helpen. (en uiteraard ook om er van elkaar meer van te leren;-))
Om je bijdrage in onze DATABASE te verwerken, als een link naar je homepage of als document dat bij nl.linux.org wordt aangeleverd en dus ook voor download en meestal in diverse formaten beschikbaar zal zijn, hebben we de volgende informatie nodig:
Titel van het document;
Naam van de auteur;
Naam van de vertaler;
Versienummer;
Datum;
De url (bv nl.linux.org/doc/HOWTO);
Korte samenvattting van de inhoud van het document;
Het e-mailadres van de auteur;
Het e-mailadres van de vertaler;
Documentatiesoort (HOWTO, mini-HOWTO, FAQ/VVV, artikel, webpagina, handleiding, tutorial of boek);
Categorie waarin het document thuishoort:
| 1 | algemeen | Algemene documenten (niet Linux specifiek) | 2 | distributies | Distributie specifieke documenten. | 3 | document structuur | LinuxDoc/DocBook DTD SGML, LaTeX e.d. | 4 | emulator | Dosemu, Wine etc.. | 5 | kernel | Kernel (compilen, kerneld, modprobe etc...) | 6 | netwerk | Netwerken en het configureren van netwerk services | 7 | installatie | Installatie van Linux (naast andere Operating Syst | 8 | ISP | Het configureren van Linux voor bepaalde Internet | 9 | spellen | Games, configuratie installatie tips etc.. | 10 | configuratie | Algemene configuratie documenten. | 11 | mail | Mail configuratie (sendmail + m4, procmail, exim e | 12 | news | Newsconfiguratie. | 13 | X Window System | Over het X Window systeem (X11) | 14 | systeem | systeemtaken zoals diskquota,printen hardware inst | 15 | geluid | Soundcards, MIDI e.d. | 16 | applicaties | Over verschillende Unix applicaties | 17 | beginners | Informatie voor beginnende gebruikers | 18 | programmeren | Programmeren onder Linux |
Als laatste kun je ook wat sleutelwoorden opgeven, wat gebruikers mogelijk in zouden kunnen tikken als zoekargument wanneer ze op zoek zijn naar bepaalde informatie.
Vooral voor categorie nr. 17 kunnen we nog wel wat documentatie gebruiken;-) Leuk zou zijn als hier ook wat meer stap voor stap handleidingen voor zouden zijn voorzien van afbeeldingen.
Het zou prettig zijn als je deze informatie zelf aan kunt leveren, aangezien dat de builders tijd scheelt bij het verwerken van de gegevens. Alle informatie is dus niet noodzakelijk, we stellen het gewoon op prijs als je de van toepassing zijnde gegevens gewoon zelf aanlevert. Wil je echt actief mee doen met het team van nl.linux.org en/of met een aantal mensen samenwerken aan een deel van de site, stuur dan alsjeblieft een mailtje naar builders@nl.linux.org voor een CVS-account en geef daarin aan waar je graag aan mee wilt werken of misschien zelfs wel leuke ideeën hebt voor de site.
Om op plezierige wijze met meerdere mensen aan de verschillende documenten te kunnen werken, maken we bij nl.linux.org gebruik van CVS. CVS is een systeem waarbij het mogelijk is een (werk)kopie van de bestanden naar je lokale systeem over te halen om ze op je lokale harddisk te bewerken. Deze bestanden zijn onder het beheer van een package (CVS) geplaatst, waardoor je de mogelijkheid hebt offline aan de documenten te werken. De opslagplaats (repository genaamd, welke gewoon bestaat uit één of meer (sub)-directory's) bevindt zich op de server en de bestanden in deze (sub-)directory('s) worden vanaf je eigen werkkopie bijgewerkt als je de daarvoor van toepassing zijnde CVS-opdrachten geeft (bij geen continue verbinding nadat je een verbinding gemaakt hebt met de server via een Internet-verbinding). Een (sub-)directorystructuur in deze repository wordt een module genoemd (dit is dus een deel van het geheel). Iedere module heeft een naam toegewezen gekregen die niet noodzakelijkerwijs gelijk hoeft te zijn aan de naam van de betreffende (sub-)directory('s) waarin de van toepassing zijnde bestanden zijn opgeslagen. Door middel van een CVS-opdracht met als argument de naam van de opgegeven module heb je dus de mogelijkheid slechts aan een deel van de site mee te werken.
Het valt buiten het kader van deze HOWTO het gebruik van dit package te bespreken, wil je echter meer informatie, dan vind je die in ieder geval in de volgende documenten:
Als je fouten (typo's, niet werkende hyperlinks, onjuiste vertalingen e.d) tegenkomt in de documenten dan wordt het bijzonder gewaardeerd als je dit meldt bij de betreffende auteur/vertaler. In de meeste gevallen vind je het betreffende e-mailadres bovenaan het document. Houd alsjeblieft in de gaten dat het gezien de copyrights waaronder een document valt, voor een vertaler niet mogelijk is om de inhoud van een document radicaal te gaan veranderen. Aan een vertaler is het dus verstandiger om alleen typfoutjes, of andere fouten die te maken hebben met de Nederlandse taal door te geven. Voor overige voorkomende fouten/opmerkingen/suggesties kun je dan contact opnemen met de auteur. Voor de vertaalde documenten geldt ook hier dat je bericht in dat geval dan vaak in de Engelse taal zal moeten zijn.
Als je dit wilt, kun je bijdragen aanleveren via email. Neem in dat geval alsjeblieft even contact op met de auteur van deze HOWTO, via bokkie@nl.linux.org of één van de overige builders van nl.linux.org via builders@nl.linux.org. Lever je documentatie bijvoorkeur aan in SGML-formaat volgens de linuxdoc of DocBook DTD, of XML volgens de DocBook DTD of als je dit om wat voor reden dan ook niet kunt, in ASCII-formaat en lever dan de extra gegevens aan, zover deze nog niet in je document staan vermeld zoals eerder beschreven. Lever meerdere bronbestanden alsjeblieft aan in een tar-archief, bijvoorkeur gecomprimeerd met gzip. Het is namelijk niet altijd mogelijk er direct mee aan de slag te gaan en in dat geval is het makkelijker als slechts een enkel bestand wordt aangeleverd zodat niet een deel van de gegevens zoek kan raken. Een voordeel van het aanleveren van de door jou geschreven documentatie is dat deze zo mogelijk zal moeten omgezet in verschillende formaten en behalve op de officiële Linux Documentatie website en ftpsite ook beschikbaar zal komen op de cd-roms van de grotere distributies.
Een aangeleverd ASCII-document wordt naar wens omgezet in SGML of XML. Bij het aanleveren van een bijgewerkte versie door de auteur wordt dan wel verondersteld dat je de eerder aangemaakte sgml-versie hebt aangepast. Aangeleverde documenten zullen zo mogelijk tevens voor download en in diverse formaten beschikbaar worden gesteld. Spelfouten die tijdens deze omzetting worden geconstateerd zullen zo mogelijk worden gecorrigeerd. Als auteur/vertaler ben je er zelf verantwoordelijk voor dat de nieuwste versie van je document op de site staat. Uiteraard worden doorgegeven nieuwe versies zo snel mogelijk geplaatst.
Advies: vergeet het copyright niet in geval van een zelfgeschreven document!
Denk er alsjeblieft goed over na als je van plan bent documentatie in HTML-formaat te schrijven, aangezien dit heel lastig is bij te werken. Om namelijk zover als maar mogelijk is HTML-compliant te zijn, maken we geen gebruik van speciale programma's om HTML/SGML documenten aan te maken, maar doen dit met de hand in een editor, ter voorkoming van rommelige en overbodige codes die kant-en-klare programma's vaak in het bestand plaatsen. Een bestand éénmalig voor je omzetten naar SGML of XML is niet zo'n probleem, je loopt echter het risico dat je op weerstand stuit als je hetzelfde document maar dan bijgewerkt in een ander dan het SGML-of XML-formaat aanlevert, wat voor de tweede keer naar SGML moet worden omgezet.
SGML-en XML-documenten kunnen tenminste nog op behoorlijke wijze worden omgezet naar andere formaten, wat helaas niet evenzo voor HTML-documenten geldt. Wil je het document dat je hebt geproduceerd later nog eens bijwerken, dan is het heel lastig als je slechts een HTML document als bronbestand hebt. Het zou jammer zijn van al je werk, als het nadat het klaar is, toch nog gewenst is als het in meerdere/andere formaten verschijnt. Bovendien is het makkelijker om bijvoorbeeld een ASCII-bestand zonder overbodige codes om te zetten naar SGML dan een HTML-bestand waarin dus al flink wat codes staan, die moeten dan immers allemaal worden verwijderd.
Beginners denken vaak dat zij nog niet voldoende weten om een document te kunnen schrijven of schrikken misschien terug van de vele termen waarmee een Linux-goeroe zo af en toe eens strooit, maar willen eigenlijk wel graag een bijdrage leveren. Als je tot deze groep behoort, maak je dan geen zorgen om onkunde over SGML, CVS of welke termen hier in deze HOWTO dan ook genoemd zijn, waar je nog niet bekend mee bent: Ook hulp van beginners is heel welkom. We zouden op nl.linux.org ook graag documenten zien met meer afbeeldingen die een beginner juist op weg kunnen helpen of die gebruikers die zich liever met de grafische omgeving onder Linux bezighouden. Dus als je iets gelukt is om te configureren, bereid bent het in de vorm van documentatie te gieten omdat je denkt dat het van nut kan zijn voor andere (beginnende) gebruikers, laat ons dit dan alsjeblieft weten zodat we of een link op de site kunnen plaatsen naar je eigen homepage of je bijdrage aan de Linux-gemeenschap wellicht ergens op de site kunnen plaatsen. De auteur is altijd bereid om je op weg te helpen als je jezelf de beginselen van CVS en eventueel SGML eigen wilt maken om mee te kunnen werken aan de (documentatiesectie van de) site.
Als je voordat de documenten in de index zullen worden geplaatst, bereid bent om als proeflezer te fungeren, zou ik het prettig vinden als je een berichtje bij me achterliet. De bedoeling hiervan is om van te voren zoveel mogelijk typfoutjes om niet lekker lopende zinnen eruit te halen. Enige kennis van de Nederlandse taal (en bijvoorkeur ook de Engelse taal) is dan dus zeer welkom!
Benodigde faciliteiten, zoals het hiervoor besproken CVS, waarvoor je een account nodig hebt, en de inschrijving op een daarvoor bestemde mailinglist, kun je aanvragen via builders@nl.linux.org. Ook beginnende Linux-gebruikers die liever (nog) onder Windows meehelpen, heten wij van harte welkom. Voor die mensen is er WinCVS, een naar Windows geporte versie van CVS.
Schroom alsjeblieft niet contact op te nemen met de auteur van dit document als je (nog) niet bekend bent met WinCVS/CVS en er alleen met de beschikbare documentatie niet uitkomt.