- předchozí článek - následující článek - obsah - úvodní stránka -

Linuxové noviny 10/98

Jak psát články do LN?

Pavel Janík ml., 3. října 1998

V poslední době se mi množí dotazy na to, jak psát články do Linuxových novin a jak je formátovat. Autoři těchto dotazů mi chtějí ušetřit práci s formátováním a já jsem jim za to vděčný, ale doposud jedinou mojí odpovědí na tento dotaz byl odkaz na zdrojové texty Linuxových novin a doporučení porovnat jejich syntaxi se skutečným vzhledem článku ve formátu PDF. Bohužel jsem si (zatím) nedokázal najít čas na to, abych napsal tento článek, a tak si jej můžete přečíst až nyní.

Od tohoto článku si slibuji, že převážná většina nových článků napsaných pro Linuxové noviny bude v níže popsaném formátu, a to mi umožní další tvůrčí činnost a tím pádem snad i kvalitnější a rozsáhlejší Linuxové noviny.

Čím jsou Linuxové noviny sázeny?

Tak tedy začněme. Linuxové noviny se v současné době zpracovávají programem pdfTeX, jehož autorem je Han The Thanh thanh@informatics.muni.cz. Tento program jako vstup předpokládá speciální formátovaný text, který je doplněn tzv. značkami (tagy). Tyto značky programu říkají, jakým způsobem má formátovat text do výstupního souboru.

Každý dokument může mít svůj vlastní jazyk těchto značek. Linuxové noviny mají také svůj. A tento jazyk si nyní popíšeme na příkladech.

Kostra článku

Jak jistě víte, Linuxové noviny jsou složeny z jednotlivých článků (v tomto čísle např. články Měsíc v comp.os.linux.announce, Mutt - perspektivní nástupce elmu apod.). Každý článek se skládá z úvodní části, která obsahuje nadpis, jméno autora a datum vzniku článku, dále z vlastního textu a případných odkazů v článku. Některé články jsou navíc doplněny o obrázky nebo výpisy.

Každý článek ve zdrojovém textu Linuxových novin vypadá přibližně takto:

\section{Jak psát články do LN?}
\label{jakpsatdoln}

% autor článku včetně data jeho vytvoření
% (data vytvoření článku,
% nikoli autora)
\autor{Pavel Janík ml., 3. října 1998}

... vlastní text článku ...

\KC

LaTeXistům pookřálo srdce :-) Ano, vypadá to jako LaTeX, chová se to jako LaTeX, ale LaTeX to není. Na výpisu vidíme, že struktura je velice jednoduchá. Článek začíná značkou \section, jejíž parametr je text, který se objeví ve výsledném souboru (tedy ve formátu PDF) jako nadpis odstavce. Dále následuje volitelná značka label, která je použita při referencích na daný článek. To nám například v úvodním článku Úvodem, aneb mám angínu umožní odkázat se na názvy jiných článků a také ve formátu PDF umožní po kliknutí na zvýrazněný text se přímo dostat na odkazovaný článek (příklad vidíte zde, stačí kliknout na slovo Úvodem, aneb mám angínu). Odkaz na daný článek z jiného článku může v našem případě vypadat následovně:

Více informací najdete v článku \ref{jakpsatdoln}.

Značka \autor je opět velice jednoduchá, celý její text je uveden ihned pod názvem článku. Formát tohoto parametru je Jméno Příjmení, den. měsíc rok.

K vlastnímu textu článku a jeho formátování se dostaneme později. Poslední značkou související s celým článkem je značka \KC, která zajistí jednak vysázení malého čtverečku za koncem každého článku a také vysází seznam odkazů v rámečku.

Nyní tedy víme, jakým způsobem vytvořit kostru článku, a zbývá článek pouze napsat. Ale to pro vás jistě nebude problém.

Vlastní text článku

Formátování vlastního textu článku je velice jednoduché. Základní typ písma je shodný s fontem, kterým je napsáno slovo Linux v této větě (pro znalce písem: jedná se o Type 1 font s názvem News 701 Roman společnosti Bitstream). V počítačové literatuře se poměrně často vyskytují názvy souborů, adresářů a programů a bylo by vhodně nějak tyto názvy oddělit od normálního textu. Jistě se lépe čte např. věta: "Emacs je lepší než vi." než "Vi je lepší než Emacs." :-) Slovo vi v první větě bylo napsáno jiným fontem (Computer Modern cmrtt). Docílili jsme toho následujícím zápisem:

\uv{{\tt Emacs} je lepší než {\tt vi}.}

Jak vidíte, použili jsme krásné české uvozovky, které se zapíší tak, že text, který chceme mít v uvozovkách uzavřeme jako parametr značky \uv.

Ale každý počítačový text potřebuje i jiný typ písma než jen strojové (typewriter). Někdy je potřeba něco zvýraznit (např. v minulé větě jsem chtěl zvýraznit slovo typewriter, a tak jsem do zdrojového textu napsal \emph{typewriter} a výsledek je opravdu zvýrazněné slovo typewriter).

To ještě opravdu není všechno - zkuste se vžít do situace Michala Fadljeviče, který píše seriál Začínáme s Emacsem: II. Jistě si dovedete představit, jak by se jeho článek četl, kdyby např. napsal: "pomocí sekvence C-x C-c". Bylo by to opravdu velice nepřehledné. Proto Michal do svého článku napsal: pomocí sekvence \key{C-x} \key{C-c} a výsledný text byl: "pomocí sekvence C-x C-c", tedy klávesy, které je nutno stisknout pro ukončení editoru Emacs, byly zvýrazněny rámečkem.

Pokud budete chtít v PDF verzi odkázat na nějaké místo na Internetu, použijete velice jednoduché makro:

\citeurl{Popiska pro odkaz
	v rámečku}{http://tady.je.nějaké.url}

Makro \citeurl je velice inteligentní a pokud text v odkazu nezačíná řetězcem http://, ftp:// nebo mailto:, text odkazu se nezvýrazní.

Málem bych zapomněl na velice důležitou věc - totiž na výčty. Jejich použití je naprosto totožné s LaTeXem. Tohoto výčtu

  • Linux
  • Linux
  • ...
  • Windows

docílíme příkazy

\begin{itemize}
  \item Linux
  \item Linux
  \item \ldots
  \item Windows
\end{itemize}

Pokud bychom chtěli číslovat, stačí pouze místo prostředí itemize použít prostředí enumerate. Jednoduché jako LaTeX.

Protože Linuxové noviny jsou živý dokument, je možno vždy doplnit nějaké nové zajímavé makro, které bude potřeba. Doufám, že vás tento článek nenudil... *


- předchozí článek - následující článek - obsah - úvodní stránka -