Hur www.debian.org skapas
- Utseende & känsla
- Sources
- Scripts
- Generating the Website
- How to help
- Hur du inte hjälper till... (FAQ)
Utseende & känsla
Debians webbplats är en samling av mappar och filer som placerats
i /org/www.debian.org/www
på www-master.debian.org.
De flesta sidorna är statiska HTML-filer. De innehåller inte dynamiska element
som CGI eller PHP-skript, eftersom webbplatsen speglas.
Debians webbplats använder Website Meta Language
(WML) för att generera HTML-sidor
inklusive sidhuvuden och sidfötter, innehållsförteckningar, osv.
Även om en .wml
-fil kan se ut som HTML vid en första anblick är HTML bara
en av typerna av extra information som kan användas i WML. Du kan även använda dig av
Perl-kod i en sida och tack vare detta göra nästan vad som helst.
Efter att WML är klar med att köra sina olika filter över en fil är det slutgiltiga resultatet äkta HTML. Observera dock att WML endast kontrollerar (och ibland automagiskt korrigerar) grundläggande riktighet i din HTML-kod. Du bör installera weblint och/eller tidy för att kontrollera din HTML-kod.
Alla som arbetar med ett stort antal sidor borde installera WML så att
de kan testa och vara säkra på att resultatet är det de önskar.
Om du använder Debian kan du väldigt enkelt installera
wml
-paketet.
Läs sidorna om att använda WML för ytterligare
information.
Källkod
Vi använder oss av Git för att lagra Debians webbplats källkod. Versionshanteringssystemet tillåter oss att spåra alla förändringar och vi kan se vem som skickade in vad och när, och till och med varför. Git erbjuder ett säkert sätt att kontrollera samtidig redigering av källkodsfiler av flera författare - en avgörande uppgift för Debians webbteam eftersom vi har många medlemmar.
Här följer bakgrundsinformation om hur källkoden struktureras:
- Den översta katalogen i Git-förrådet, webwml, innehåller kataloger som
namnges efter språket webbplatsen översätts till, två makefiler och flera
skript.
Översättningskatalogens namn bör vara på engelska och skrivas med små
bokstäver (t.ex
german
, inteDeutsch
). - Den viktigaste av de två makefilerna är
Makefile.common
, vilken, som namnet antyder, innehåller några gemensamma regler som appliceras genom att inkludera denna i fil i andra makefiler. - Alla underkataloger för de olika språken innehåller också Makefiler,
olika
.wml
-källkodsfiler, och ytterligare underkataoger. Alla fil- och mappnamn följer ett särskilt mönster, så att alla länkar fungerar för de översatta filerna. Några mappar innehåller också.wmlrc
-konfigurationsfiler med ytterligare kommandon och inställningar för WML. - Mappen
webwml/english/template
innhåller speciella WML-filer som fungerar som mallar. Dessa kan refereras från alla andra filer genom#use
-kommandot.
Vänligen notera: För att ändringar i mallarna skall propagera till filerna som använder
dem har makefilerna beroenden på dem.
Eftersom en stor majoritet av filerna använder template
-mallen,
den allmänna beroendet, så de använder följande rad på toppen av filen:
#use wml::debian::template
Det finns självklart undantag till denna regel.
Skript
Skripten är huvudsakligen skrivna i skalspråket eller Perl. En del av dem är fristående medan några är integrerade i WML-källfilerna.
- webmaster-team/cron:
Detta Git-förråd innehåller alla skript som används för att uppdatera Debians
webbplats, t.ex. källkoden för ombyggnadsskripten för
www-master
. - webmaster-team/packages:
Detta Git-förråd innehåller källkoden för ombyggnadsskriptenen för
packages.debian.org
.
Generera webbplatsen
WML, mallar, skal- eller Perlskript är alltihop ingredienser som du kommer att behöva för att generera Debians webbplats:
- Majoriteten genereras med hjälp av WML (från Gitförrådet).
- Dokumnetationen genereras med antingen DocBook XML (
ddp
Gitförråd) - The documentation is generated with either DocBook XML (
ddp
Git repository) eller med cron-skript från motsvarande Debianpaket. - Några delar av webbplatsen genereras med skript från andra källor, exempelvis sidorna för sändlistornas prenumeration / säga upp prenumeration.
En automatisk uppdatering (från Gitförrådet eller andra käller till webbträdet) körs sex gånger per dag. Utöver detta kör vi följande kontroller på hela webbplatsen:
De aktuella byggloggarna för webbplatsen kan hittas på https://www-master.debian.org/build-logs/.
Om du vill bidra till webbplatsen, redigera inte filer
i www/
-mappen direkt eller lägg till nya filer. Kontakta istället
webbteamet först.
Hur du hjälper till
Vi uppmuntrar alla att hjälpa till med webbplatsen. Om du har värdefull information relaterad till Debian som du tycker saknas, var vänlig hör av dig - Vi kommmer att se till att det inkluderas. Ta även en titt på ovan nämnda byggloggar och kolla om du har några förslag på hur man kan fixa något problem.
Vi söker även efter folk som kan hjälpa till med designen (grafik, layout, osv.). Om du talar engelska flytande, var vänlig korrekturläs våra sidor och rapporera fel. Om du talar ett annat språk kan du vilja hjälpa till att översätta existerande sidor eller hjälpa till med att rätta fel i redan översatta sidor. I båda fall, var vänlig ta en titt på listan för översättningssamordnare och kontakta den ansvarige personen. För ytterligare information, vänligen ta en titt på vår sida för översättare.
Hur du inte hjälper till... (FAQ)
[F] Jag vill lägga till tuff webbfunktion på Debians webbplats, får jag det?
[S] Nej. Vi vill att www.debian.org ska vara så åtkomlig som möjligt., so
- inga webbläsarspecifika "tillägg",
- inget beroende endast på bilder. Bilder kan användas för att klargöra, men informationen på www.debian.org måste vara tillgänglig via en textbaserad webbläsare såsom Lynx.
[F] Jag har en bra idé som jag vill bidra med. Skulle ni kunna foo eller bar på www.debian.org's HTTP-server?
[S] Nej. Vi vill göra det så lätt som möjligt för administratörer att spegla www.debian.org, så inga speciella HTTPD-funktioner, är ni snälla. Nej, inte ens SSI (Server Side Includes). Ett undantag har gjorts för innehållsförhandling, eftersom det är det enda robusta sättet att tillhandahålla flera språk på.