Formát článků

3. 11. 2002 | Leoš Literák | Novinky | 8901×

Aktualizované informace o tom, v jakém formátu zasílat články.

Úvod

Články na AbcLinuxu.cz je nutné vydávat ve standardizovaném tvaru. Proč? Hlavním důvodem je konzistence vzhledu. Pokud by každý článek vypadal jinak, čtenáři by byli zmateni a nevytvořili si určité stereotypy. Navíc standardizace umožní dopřednou kompatibilitu. Pouhou změnou CSS je možné upravit vzhled všech článků.

Kódování

Veškeré články musí být zasílány v některém ze standardních kódování. Tj. Latin2 (ISO-8859-2) nebo Unicode (UTF-8) - preferujeme však UTF-8, protože v tom také na portálu vyjdou. Dávejte si také pozor na některé rádoby chytré editory, které nahrazují znaky s diakritikou HTML entitami. Například č. Články pište rovnou s diakritikou - pokud ji budete dosazovat později, nasekáte spoustu chyb.

Formát

Text pište v HTML podle níže specifikovaného formátu (nikoliv však HTML kód zapsaný v rámci jiného formátu, např.: OpenOffice.org (.sxw, .odt) nebo PDF - výsledkem nechť je .html soubor, který lze otevřít ve webovém prohlížeči). Všechny tagy a jejich atributy by měly používat malá písmenka. Například <P> je špatně, správně je <p> - je to přehlednější a stejně bychom to před vydáním sami převedli. Mezi blokové elementy (nadpisy (h2, h3), odstavce (p) či seznamy (ul, ol, dl)) dávejte prázdné řádky. Zlepšuje to čitelnost zdrojového kódu. Nezasílejte HTML generované z OpenOffice.org či Wordu, vypadá příšerně.

Nadpisy

Název článku uzavřete do libovolného blokového elementu. Nezáleží na tom, jaký zvolíte. Stejně jej umístíme do zvláštního políčka v redakčním systému a v článku se zobrazí podle aktuální šablony. Podobné pravidlo platí pro perex.

Text čleňte do kapitol, před kterými jsou nadpisy. Zlepšuje to čitelnost i přehlednost článku. Nadpisy první úrovně ukládejte do tagu h2, podkapitoly do h3

Odstavce

Všechny odstavce uzavřete do tagu p. Odstavce by neměly být příliš dlouhé. Odstavec, který má více než deset řádků, se špatně čte a vyžaduje příliš velké soustředění od čtenářů. Proto se nebojte odstavce rozdělit. K tomu se ale nepoužívá tag br! Raději jej vůbec nepoužívejte! Obecně platí, že tam, kde byste chtěli dát BR, je lepší začít nový odstavec.

Citace kódu či výpisů

Z důvody lepší přehlednosti uzavírejte názvy souborů a proměnných do tagu code. Dávejte si pozor na některé znaky, které mají v HTML speciální význam. Například místo < pište <, > nahraďte > a & zase &.

Pokud chcete ukázat výpis programu či konfiguračního souboru, použijte tag pre. Při použití tagu pre se, pokud možno, vyvarujte řádků delších 75 znaků.

Obrázky

Obrázky jsou vždy vítány. Maximální šířka obrázku začleňovaného do článku je 550 pixelů. Pokud máte širší, netrapte se - vytvoříme vám z něj náhled. Obrázek v textu by neměl mít více než 25 kB a celkem by neměly mít začleněné obrázky více než 80-100 kB. Musíme přeci jen myslet na čtenáře používající pomalou linku či dial-up. Na obrázky, které nebudou přímo na stránce, se omezení nekladou. Ještě něco: Pozor na autorská práva!

Screenshoty vytvářejte zásadně ve formátu PNG, tedy s příponou .png.

Příklad

<p>Jaderné HOWTO</p>

<p>Tento článek obsahuje návod na zprovoznění
nukleární elektrárny.</p>

<h2>Úvod</h2>

<p>Nebaví vás kupovat od monopolního dodavatele elektřinu?
Poradíme vám, jak si za pomocí Linuxu postavit doma jadernou
elektrárnu.</p>

<h2>Postup</h2>

<p>Co k tomu budete potřebovat? Libovolný počítač s Linuxem
a generátor OOPS. Nejprve rozeberme konfiguraci jádra.</p>

<h3>Jádro</h3>

<p>Pro získání energie z linuxového jádra je třeba
mít správně nakonfigurovaný soubor 
<code>/boot/vmlinuz.</code>. Proto je nutné zkompilovat
jádro:</p>

<pre>
make clean
make config
make dep
make zImage
</pre>

<h3>Instalace</h3>

<p>Zkopírujte soubor <code>vmlinuz</code>
do adresáře <code>/boot</code>. Nezapomeňte
zavolat <code>lilo</code>.</p>

<h2>Generování energie</h2>

<p>Po přebootování jsme připraveni generovat energii.
Stačí najít nějakou chybu, která způsobí OOPS. Při jeho vzniku
se z jádra uvolní spousta energie.</p>

Závěr

Předem děkujeme, že se budete řídit těmito pravidly. Ulehčíte nám práci při správě AbcLinuxu.cz. Díky!

       

Komentáře