Informatie voor webmasters

Inleiding

De technologieën en programma's die gebruikt worden voor het onderhouden van de FSFE-webpagina's, zouden goed bekend moeten zijn bij veel ontwikkelaars en auteurs, en kunnen zeker interessant zijn voor diegenen die ze nog niet ontdekten.

Vertalers en occasionele vrijwilligers komen hoogst waarschijnlijk alleen in contact met

• Savannah -- voor CVS (zie verder) diensten en toegangcontroles.
• XHTML -- de basis waarvan elke 5 minuten de statische pagina's gemaakt worden.
• Concurrent Version System (CVS) -- voor coördinatie en synchronisatie.

Vrijwilligers die zich verder willen engageren in het onderhoud zouden ook ervaring moeten hebben met

• Perl -- voor het maken van de scripts die instaan voor het onderhoud en aanmaken van de pagina's.
• Apache -- onze webserver.

Hoe worden de webpagina's gecreëerd?

De webpagina's van www.fsfeurope.org worden beheerd als een verzameling van XML files. Alle vijf minuten genereert de webserver automatisch de HTML pagina's van de XML files. Vanzelfsprekend gebeuren al de aanpassingen van de pagina's in de XML files, de HTML wordt nooit direct veranderd.

De naam van elke webpagina bij www.fsfeurope.org heeft dezelfde structuur, "paginanaam.taal.html" (taalis de 2-letter iso-639 code voor de gebruikte taal, zoals "en" voor Engels of "nl" voor Nederlands). De naam van de basisfiles heeft de structuur, "paginanaam.taal.xhtml".
Sommige pagina's hebben een dynamisch deel: buiten het vaste tekstgedeelte van de .xhtml file, wordt informatie toegevoegd van verschillende .xml files. Telkens als zo'n pagina gebouwd wordt, gebruikt het systeem de vertaalde .xml files. Als er geen vertaalde versies bestaan van die .xml files, gebruikt het systeem de Engelse versies. Door deze werkwijze kan het gebeuren dat deze pagina's slechts gedeeltelijk vertaald zijn. Voorbeelden van zo'n pagina's zijn vaak de startpagina, de nieuwspagina en de evenementenpagina.

Registreren bij savannah

De basisfiles voor de webpagina´s wqorden bewaard op Savannah, een server die onderdak vindt bij de Free Software Foundation, onze zusterorganisatie in Noord-Amerika. Als u onze bestanden wil bewerken, dan moet je je registreren op de server.

Een nieuwe gebruiker registreren.

volg deze link om een nieuwe gebruiker te registreren. Kies een loginnaam, een paswoord. Geef je echte naam en een e-mailadres. Klik dan op de knop "Submit".

Daarna krijg je een e-mail van savannah. Om je registratie af te ronden, moet je de URL die daar vermeld staat openen. Inschrijvingen die niet binnen de twee dagen bevestigd zijn, worden verwijderd.

Na de bevestiging van je inschrijving, kan je jezelf aanmelden bij https://savannah.gnu.org met je login en je paswoord.

Aanmaken van een SSH key

Het paswoord kan je gebruiken om in te loggen in het webportaal van Savannah, als je toegang wil krijgen tot de CVS, dan moet je een SSH key registreren. Dat moet gebeuren vanop elke computer waarmee je de CVS wil gebruiken.

Om een SSH key te maken en te registreren, volg de instructies van de savannah FAQ.

Lid worden van het FSFE project.

Er zijn veel projecten die onderdak vinden bij Savannah, en toegang tot het project wordt toegestaan per project. Als je toegang wil krijgen tot de basisfiles van de FSFE webpagina's, dan moet je lid worden van het FSFE project.

Kies "Group Membership" in de bovenste tabs. Hier plaats je "FSFE" in de zoekbox van "Request for Inclusion", vink de checkbox aan van FSF Europe, en geef wat uitleg.

De beheerders van het FSFE project krijgen dan een mail met jouw verzoek en uitleg, zij kunnen jouw lidmaatschap bij het project goedkeuren. Daarna zie je "FSF Europe" bij de tab "Groups I'm Contributer of", nadat je bent ingelogd bij savannah.

Het CVS archief de eerste keer installeren

Ten eerste moet je ervoor zorgen dat je ~/.bashrc file de volgende lijn bevat
export CVS_RSH=ssh
Creëer dan een map voor het archief en voer in deze map de volgende code uit
$ cvs -z3 -d username@cvs.savannah.gnu.org:/web/fsfe co .
Nu wordt er gevraagd naar je SSH paszin. Vul die in en bevestig. Als alles goed gaat, heb je nu een lokale kopie van het archief.

Werken met het archief

Nadat je het archief een eerste keer kopieerde, moet je steeds
$ cvs update -d
uitvoeren in deze map, voordat je aan een specifieke file begint te werken.

Als je nieuwe files aan het archief wil toevoegen moet je de volgende code uitvoeren
$ cvs add filename

Om bestanden naar de server te zenden, of het nu een nieuw bestand is, of de aangepaste versie van een bestaand bestand, voer dan de volgende code uit
$ cvs commit filename
een editorvenster zal dan openen, zo kan je wat uitleg geven bij je veranderingen.

Je kan een gedetailleerde handleiding downloaden op de CVS startpagina.

Als je op de hoogte wil blijven van alle veranderingen die worden doorgevoerd in het archief, kan je je inschrijven bij de CVS notification mailing list, dan krijg je een mail bij elke verandering aan het archief.

Verantwoord handelen bij schrijftoegang

Als je schrijftoegang hebt tot de webpagina's, schrijf je dan alsjeblieft ook in voor de Webmasters mailing list.

Houd alsjeblieft steeds in gedachte dat al je veranderingen direct worden doorgevoerd en zichtbaar worden, zonder enige tussenkomst van iemand anders. Daarom vragen we om enkele regels te respecteren wanneer je veranderingen of nieuwe files naar de server stuurt.

• De FSFE is verantwoordelijk voor de inhoud van haar webpagina's. Maak geen wijzigingen die de betekenis van de tekst veranderen zonder toestemming van een lid van het kernteam van de FSFE. (Dit is niet nodig voor vertalingen van bestaande documenten)

• Als je vertalingen doorstuurt, en je hebt de kans om ze door anderen te laten lezen, gebruik die mogelijkheid. Je kan de Translators mailing list vragen om iets na te lezen. Of je nu vertalingen maakt, of ze naleest, controleer steeds de spelling van de tekst, er zijn geautomatiseerde gereedschappen, zoals GNU aspell, ispell of een andere spellingcorrector. Als je bijvoorbeeld GNU aspell wil gebruiken op een Debian GNU/Linux systeem, installeer dan de paketten aspell en aspell-XX ("XX" is je taalcode), en voer dan de volgende code uit
  

  aspell -H -d language -c file.xhtml

  (Met "language" de naam van het woordenboek van je taal; de -d optie kan je achterwege laten als je UNIX locale dezelfde is als de taal van je woordenboek).

• Zorg ervoor dat al je files juiste XML code zijn. Er is een script tools/validate.pl genoemd, dat kan helpen om fouten te vinden in de markup. Slecht gevormde XML verbreekt het automatische proces voor het maken van de webpagina's, en blokkeert het updaten van de hele FSFE website. Als je vermoedt dat het automatisch proces verstoord is, kan je het logboek van de laatste poging hier bekijken.

  Het validate.pl script heeft de XML::LibXML Perl module nodig; als dit niet geïnstalleerd is op jouw systeem, kan je je files controleren met je favoriete gereedschap. Je kan bijvoorbeeld het xmllint programma gebruiken vanuit de console. Dit programma maakt deel uit van het libxml2 project (als je een Debian GNU/Linux systeem hebt, installeer het libxml2-utils pakket); je typt in de console

  xmllint --noout file.xhtml

  en je ziet de eventuele foutboodschappen.

• Kijk goed na of de codering van je file overeenkomt met de waarde die je aan het "encoding" attribuut geeft in de eerste regel van je file. Als je file bijvoorbeeld gecodeerd is als "iso-8859-1" (ook bekend als "latin-1" codering), dan zou de eerste regel van je file er als volgt moeten uitzien

  <?xml version="1.0" encoding="iso-8859-1"
            ?>

  Een andere geldige codering is de unicode, of UTF-8 codering. Als je de codering van een file wil veranderen kan je het standaard iconv programma gebruiken, zoals in het volgende voorbeeld (waar we een bestand van "latin1" codering naar "utf-8" codering omzetten):

  iconv -f LATIN1 -t UTF8 inputfile > outputfile

Probeer afspraken te maken met andere mensen die toegang hebben tot het CVS archief, zodat bijdragen van mensen zonder deze toegang, aan de CVS worden toegevoegd. Zorg dat die files door iemand werden nagelezen, en controleer de files, zoals je met je eigen files zou doen, voor je ze toevoegt.

Extra informatie

Aangezien de webpagina's van de FSFE een Europees/globaal deel hebben, maar ook een door de gebruikers bepaald lokaal deel, met informatie op landen-niveau, heeft de structuur van de CVS een zekere complexiteit die volledig verborgen wordt voor de gebruiker van de website.

Tenzij je alleen pagina's wil vertalen, kan je best de de pagina structural reference eens doornemen.

Er is ook een Texinfo documentatie file "Webmastering FSF Europe" geschreven door Jonas Öberg, die ook de implementatie schreef voor het automatisch genereren van de html-pagina's. U kan deze tekst best lezen, zo zal je beter begrijpen hoe je met de webpagina's moet werken.

To top