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:

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

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:

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.

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.