Opgelet: Het is mogelijk dat deze pagina verouderd is ten opzichte van het origineel. Als u ons wil helpen met vertalingen of andere zaken, kan u informatie vinden op deze pagina.

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 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:

XHTML -- de basis voor onze webpagina's.
Subversion -- het versiebeheersysteem voor de basisbestanden van onze webpagina´s.
Trac -- voor het toegangsbeheer, het opvolgen van problemen en aanverwante diensten.

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 fsfe.org worden beheerd als een verzameling van XML-bestanden. Alle tien minuten genereert de webserver automatisch de HTML pagina's van de XML-bestanden. Vanzelfsprekend gebeuren al de aanpassingen van de pagina's in de XML-bestanden, de HTML wordt nooit direct veranderd.

De naam van elke webpagina bij fsfe.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 basisbestanden heeft de structuur, paginanaam.taal.xhtml.

Sommige pagina's hebben een dynamisch deel: buiten het vaste tekstgedeelte van het xhtml-bestand, wordt informatie toegevoegd van verschillende .xml-bestanden. Telkens als zo'n pagina gebouwd wordt, gebruikt het systeem de vertaalde .xml-bestanden. Als er geen vertaalde versies bestaan van die .xml-bestanden, 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.

Toegang krijgen tot de basisbestanden

De basisbestanden voor de webpagina´s worden bewaard in het fsfe-web subversion repository op onze subversionserver. Andere diensten zijn beschikbaar via het gekoppelde trac beheersysteem.

Volg de instructies om toegang te krijgen tot deze hulpmiddelen:

Als u een Fellow van de FSFE bent, heeft u al toegang tot de subversionserver en het trac beheersysteem. Gebruik uw Fellowship gebruikernaam en paswoord.
Als u rechten wil krijgen om bestanden te veranderen op de subversionserver en de tracwiki schrijf naar system-hackers@fsfeurope.org.
Andere personen kunnen zich laten registreren als gast via het webformulier op https://trac.fsfe.org/fsfe-web/register. Onmiddellijk na uw registratie hebt u leesrechten op de subversionserver en kan u inloggen op de tracwiki (de gebruikernaam die u kiest zal de prefix guest- krijgen). De beheerder van de subversionserver krijgt een melding van uw verzoek en zal u zo vlug als mogelijk schrijftoegang geven.

Een lokale werkkopij van het subversionarchief installeren

Op de subversionserver staan twee archieven voor de FSFE-website. Het SVN "trunk" archief wordt gebruikt om de "officiële" versie (http://fsfe.org) van de website te bouwen. Het "test" archief wordt gebruikt om de "test" versie (http://test.fsfe.org) te bouwen.

Voor alledaagse taken zoals het toevoegen van nieuwsberichten, het vertalen van webpagina's of zelfs voor kleine aanpassingen aan de website volstaat een kopij van het trunkarchief:

svn --username YOURNAME co https://svn.fsfe.org/fsfe-web/trunk

Als u grotere veranderingen aan de website wil maken of mee nieuwe functies wil ontwikkelen of debuggen kan u best ook een kopij van het testarchief downloaden:

svn --username YOURNAME co https://svn.fsfe.org/fsfe-web/branches/test

Houd er rekening mee dat een werkkopij ongeveer 160Mb inneemt. Als u van plan bent om slechts aan bepaalde delen van de website te werken kan u kopijen downloaden van de mappen die u interesseren.

Werken met het archief

Nadat u het archief een eerste keer kopiëerde, moet u steeds

$ svn update

uitvoeren voordat u aan een specifiek bestand begint te werken.

Als u een nieuw bestand of een nieuwe map aan het archief wil toevoegen moet u de volgende code uitvoeren:

$ svn add bestandsnaam

Om bestanden naar de server te zenden, of het nu een nieuw bestand is, of de aangepaste versie van een bestaand bestand, voert u de volgende code uit

$ svn commit bestandsnaam

je standaardeditor zal een venster openen waarin je een korte beschrijving kan geven van de veranderingen die je doorstuurt.

In een subversion archief moet de optie trefwoordvervangen voor elk bestand individueel ingesteld worden. Wij maken gebruik van trefwoorden in onze .xml en .xhtml bestanden (bijvoorbeeld het $Author$ trefwoord in de voettekst van onze pagina's). U kan trefwoordvervanging automatisch instellen voor deze bestanden door volgende tekst in uw ~/.subversion/config bestand op te nemen:

	enable-auto-props = yes
	
	[auto-props]
	*.xml = svn:keywords=Date Author Id Revision;svn:mime-type=text/xml;svn:eol-style=native
	*.xhtml = svn:keywords=Date Author Id Revision;svn:mime-type=text/xhtml;svn:eol-style=native

Als u gewoon bent met CVS te werken zal U makkelijk de overstap naar SVN kunnen maken. Zoals u reeds kon zien zijn de basiscommando's vergelijkbaar. Als u hier wat meer over wil leren kan u een overzicht bekijken van de verschillen tussen CVS en SVN via Subversion for CVS Users of een korte referentiepagina raadplegen die CVS-commando's vergelijkt met SVN-commando's in de CVS to SVN Crossover Guide.

U kan een gedetailleerde handleiding downloaden op de Subversion book pagina (wij gebruiken de 1.5 versie van SVN).

Coördinatie van de werkzaamheden

Het werk aan de website wordt in de eerste plaats gecoördineerd via de mailinglist voor webmasters

De fsfe-web trac interface voorziet in enkele handige hulpmiddelen: een webbrowser voor het SVN-archief, een opvolgsysteem voor problemen en een wiki.

Als u op de hoogte wil blijven van alle veranderingen die worden doorgevoerd in het archief, kan u zich inschrijven bij de commit notification mailinglist, dan krijgt u een mail bij elke verandering aan het archief.

Verantwoord handelen bij schrijftoegang

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

Houd alsjeblieft steeds in gedachten dat al uw veranderingen direct worden doorgevoerd en zichtbaar worden, zonder enige tussenkomst van iemand anders. Daarom vragen we u om enkele regels te respecteren wanneer u 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 u vertalingen doorstuurt, en u hebt de kans om ze door anderen te laten lezen, gebruik die mogelijkheid. U kan de Translators mailing list vragen om iets na te lezen. Of u 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 u bijvoorbeeld GNU aspell wil gebruiken op een Debian GNU/Linux systeem, installeer dan de pakketten aspell en aspell-XX ("XX" is uw taalcode), en voer dan de volgende code uit

aspell -H -d language -c file.xhtml

Waar "language" de naam is van het woordenboek van uw taal; de -d optie kan u achterwege laten als uw UNIX locale dezelfde is als de taal van je woordenboek.
Zorg ervoor dat al uw bestanden een juiste XML-code hebben. De subversionserver controleert standaard de XML-syntaxis van bestanden met een .xml- en .xhtml-extensie en zal geen bestanden aanvaarden die niet voldoen. U kan uw bestanden zelf controleren vooraleer u ze aanbiedt.

Er is een script /trunc/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 u vermoedt dat het automatisch proces verstoord is, kan u het logboek van de laatste poging bekijken op onze statuspagina's.

Het validate.pl script heeft de XML::LibXML Perl module nodig; als dit niet geïnstalleerd is op uw systeem, kan u uw bestanden controleren met uw favoriete gereedschap. U kan bijvoorbeeld het xmllint programma gebruiken vanuit de console. Dit programma maakt deel uit van het libxml2 project

Als u een Debian GNU/Linux systeem hebt, installeer het libxml2-utils pakket; u typt in de console

xmllint --noout file.xhtml

waar file het bestand is dat u wil controleren. Eventuele fouten krijgt uw in de console te zien.
Kijk goed na of de codering van uw bestand overeenkomt met de waarde die u aan het "encoding" attribuut geeft in de eerste regel van uw bestand. Als uw bestand bijvoorbeeld gecodeerd is als "iso-8859-1" (ook bekend als "latin-1" codering), dan zou de eerste regel van uw bestand 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 u de codering van een file wil veranderen kan u 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 SVN-archief, zodat bijdragen van mensen zonder deze toegang eventueel na proeflezen aan het kunnen toegevoegd worden. Controleer de files, zoals u met uw eigen files zou doen, voor u 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 u alleen pagina's wil vertalen, kan u best de pagina structural reference eens doornemen.

Er is ook een Texinfo documentatiebestand 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 u beter begrijpen hoe u met de webpagina's moet werken.

To top

Zoeken