Användning av HTML på Debians webbsidor

Denna sida är fortfarande ett utkast.

Förord

Denna sida är skapad för att hjälp redigerare och översättare att skapa väl-taggade sidor. Den innehåller tips om hur man använder taggar och hur man skapar nya sidor och gör dom enklare att översätta.

Allmäna tips

För nya sidor och översättningar hittar du här en lista på allmänna tips

använd inte långa rader
wml-filer och andra filer skall ha rader som får plats i ett normalt terminalfönster. Det är lättare att editera i vi, mer sökbart och lättare att översätta. Det är även viktigt efter CVS är rad-orienterat och det är svårare att lösa konflikter i långa rader.
håll taggar på separata rader om möjligt
De flera HTML-taggar kan hållas på separata rader. Några av dessa är <div>, <p>, <table>, <ul>. För att göra saker enklare för översättare bör du hålla alla taggar som kan användas på detta sätt på separata rader. Annars kan översättare ta bort taggar av misstag och missa att återställa dessa efter deras översättning.
Använd inte mellanslag eller radbrytningar i inline-taggar
Några taggar ger ett mellanslag om dom hålls på separata rader. En av dessa är <q>-taggen för små citat eller hänvisningar. Du kan endast separera dessa kompletta med innehållet i en rad. Annars så kan det uppkomma ett mellanslag mellan innehållet och taggen i HTML-sidan. Mellan ord i dessa taggar kan du ha hur många nyrader eller mellanslag som du vill.

Förkortningar och akronymer

För förkortningar och akronymer bör HTML-taggen <acronym> användas. Det finns två orsaker till att <abbr>-taggen inte rekommenderas: Först å främst så stöds den inte av alla webbläsare, och för det andra så finns det inkonsekventa definitioner om vad en förkortning är, och vad en akronym är.

En akronym kan läggas till sidan med följande syntax: <acronym lang="språkkod" title="Fullständig definition av akronymen">AKRONYM</acronym>. Titeln innehåller de kompletta uttalade orden. Om akronymen byggs av de första bokstäverna i ord så bör dessa bokstäver vara stora i titeln. Språk-attributet krävs endast om akronymen eller förkortningen är på ett främmande språk.

Det finns redan en uppsättning av vanliga förkortningar inkluderade i wml-mallarna som kan användas i din sida, men du måste lägga till en rad för att använda acronyms i wml-filen. Exempelvis så är wml-taggen för DD <acronym_DD />.

Citat och hänvisningar

Det finns flera regler för vad ett citat är för olika språk. Om du har ett kort inline-citat så måste du använda <q>-taggen. Renderingen av innehållet hanteras av CSS. <q>-taggar kan inte ha mellanslag eller radbrytning mellan den öppnande eller stängande taggen och innehållet i taggen.

För längre citat så används taggen <blockquote>. En <blockquote> innesluter en eller flera paragrafer med text, som markeras med <p>. Vänligen använd inte <blockquote>-taggar för att centrera block med text som inte är citat. Blockcitat används exklusivt för citat, och kommer att renderas av språkspecifik CSS-kod i framtiden.

Det finns även en <cite>-tagg i HTML. <cite>-taggen används inte för själva citattexten, utan används för källan till ett citat. Detta kan vara personen som citatet är från och används som ett attribut till en <blockquote> som URL.

Programnamn och kod

För programnamn och datorkod finns taggen <code>. Webbläsare känner vanligtvis till hur den skall visa kod och programnamn, men renderingen kan även ändras med hjälp av CSS. Det är inte någon bra idé att använda <tt> istället, eftersom detta inte säger något om innehållet.

Prover på utdata från en dator

För utdata på en datorskärm så finns det en speciell tagg med namnet <samp>. Om du har ett större block med datorutdata så bör du även ta en titt på CSS-filen, om det finns en speciell klass för det.

Tangentbordsindata

Om det finns exempel där användaren måste mata in något på tangentbordet så används taggen <kbd> för användarindatan. Se även kapitlet om variabler för information om hur du taggar variabelutdatan.

Variabler

Ibland är det nödvändigt att framhäva en variabel inmatning så som en speciell IP-adress eller användarnamnet som måste ges i en programanrop på kommandoraden. För dessa variabla inmatningar används taggen <var>.

Förformatterat innehåll

Taggen <pre> används endast för förformatterad text. Radlängd, mellanslag och andra saker kommer att behållas. Givetvis kan denna tagg innehålla de flesta av de övriga HTML-taggarna.

Bilder

Om det finns bilder i sidan så finns det ingen anledning att lägga till den ogiltiga egenskapen border=0. Om möjligt skall bildstorleken och en alt-egenskap läggas till. Storleken läggs till av wml om den inte finns, men detta gör att kompileringen tar längre tid. Taggen alt bör innehålla något som beskriver bildens innehåll för personer som besöker sidan med lynx eller blinda besökare.