summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/latex/csbulletin/csbulletin.tex
blob: 2350f4829fdd9b83815dcd2251131d8481500635 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
%% $Id: csbulletin.tex 30 2008-08-05 20:03:02Z zw $
\input utf8-t1 % text is in UTF8, requires encTeX
% for ISO-8859-2: %& --translate-file=il2-t1.tcx
% for CP-1250:    %& --translate-file=cp1250t1.tcx
% for CP-852:     %& --translate-file=cp852t1.tcx
\documentclass{csbulletin}
% No optional packages needed
% Macros
\DeclareRobustCommand\version{\unskip~v.\,1.0}
\let\pkg\textsc

% Hack for hyperref
\mubytein 0
\usepackage[pdftitle=LaTeX\ Class\ for\ CSTUG\ Bulletin, pdfauthor=Zdenek\ Wagner,
            pdfkeywords=CSTUG\ Bulletin,bookmarks=false]{hyperref}

% section numbering
\setcounter{secnumdepth}{2}

\begin{document}
\title{Styl pro Zpravodaj Československého sdružení uživatelů \TeX{}u,\version}
\EnglishTitle{\LaTeX\ Class for \CSTUG\ Bulletin,\version}
\author{Zdeněk Wagner}
\podpis{Zdeněk Wagner\\\url{http://bulletin.cstug.cz}}
\maketitle

\begin{abstract}
Tento dokument popisuje třídu pro psaní článků do Zpravodaje Československého sdružení uživatelů
\TeX{}u. Dokument je určen zejména pro české a slovenské autory, proto je psán česky. Je psán 
ve stylu pro Zpravodaj, autoři se tedy mohou podívat přímo do zdrojového kódu tohoto manuálu a
napsat svůj článek obdobně.
\end{abstract}

\section{English introduction}
\begin{otherlanguage}{english}
This manual describes the \LaTeX\ class used for articles for the Bulletin of the Czechoslovak
\TeX\ Users Group (\cstug). Since it is asumed that its audience will will be mainly the Czech and
Slovak users, the manual is written in Czech. We do publish articles in other languages
occasionally. In such a case you can prepare the article just in the standard \pkg{article} class.
The \pkg{csbulletin} class is modelled after it with just a few modifications. You can also look
into the source text of this manual. It is written intentionally using the \pkg{csbulletin} class.
You can therefore write your article according to it.
\end{otherlanguage}

\section{Úvod}
Od roku 2008 je styl pro Zpravodaj Československého sdružení uživatelů \TeX{}u implementován jako
třída (class). Makra jsou psána tak, aby hlavní soubor dokázal načíst celý článek včetně příkazů
\cmd{documentclass} a případných \cmd{usepackage}. Třída \pkg{csbulletin} je odvozena ze standardní
třídy \pkg{article}. Je přidáno pouze několik maker. Tento manuál tedy lze spíše chápat jako
instrukce pro autory.

\section{Použité balíčky}
Prosím, uvědomte si, že celý Zpravodaj se zpracovává pdflatexem jako jeden dokument. Používejte
proto pouze balíčky, které skutečně v dokumentu potřebujete. Dávejte přednost vlastnímu
jednoduchému makru před komplikovaným balíčkem, který může způsobit kolizi s balíčky potřebnými pro
jiné články. Tím nechceme autory odrazovat od používání balíčků v nezbytných případech, jen je
vhodné, aby autoři uvážili, zda nelze problém řešit jednoduššími prostředky.

Třída \pkg{csbulletin} nějaké balíčky načítá automaticky. Jejich seznam je uveden v následujících
podsekcích.

\subsection{Povinné balíčky}
Balíčky, uvedené v následujícím seznamu, se načítají vždy. Musíte je tedy mít instalovány.

\begin{itemize}
\item Balíček \pkg{csbulacronym} definuje běžné akronymy robustním způsobem pomocí \cmd{DeclareRobustCommand} a
některé speciální akronymy, jako je např. makro \cmd{cstug} pro \cstug. Soubor je dodáván společně s
třídou \pkg{csbulletin}. Definice se používají i mimo Zpravodaj, proto jsou v samostatném souboru.

\item \pkg{fontenc} s parametrem T1

\item \pkg{lmodern}

\item \pkg{ifpdf}

\item \pkg{mflogo}

\item \pkg{babel}, viz kapitola~\ref{babel}.
\end{itemize}

\subsection{Nepovinné balíčky}
Některé balíčky jsou využívány v redakci při sazbě finální verze Zpravodaje, ale pro pracovní verzi
článku nejsou nezbytné. Jejich instalace na počítači autorů tedy není vyžadována. Třída jejich
přítomnost detekuje a načte je, pokud jsou v počítači přítomny.

\begin{itemize}
\item \pkg{microtype}

\item \pkg{array}

\item \pkg{fancyvrb}

\item \pkg{verbatim}

\item \pkg{encxvlna} je program \pkg{vlna} implementovaný v enc\TeX u. Jeho účelem je doplnění
vlnek za neslabičné předložky přímo při \TeX ování. Balíček bude načten pouze v případě, že máte
enc\TeX\ aktivován.
\end{itemize}

\subsection{Babel}\label{babel}
Třída \pkg{csbulletin} vyžaduje \pkg{babel} s moduly pro češtinu a slovenštinu ve verzi~3.2 nebo
novější. Tato verze je distribuována na \TeX Live~2008, ale dělení slov funguje pouze v
kódování~T1. Pokud máte starší verzi těchto modulů, bude \LaTeX\ hlásit chybu na dvou příkazech
\cmd{languageattribute}. Chyby odstraníte použitím parametru \texttt{oldcsbabel} v hranatých
závorkách v příkazu \cmd{documentclass}.

\section{Začátek souboru}
Prvním příkazem souboru, kde lze (viz sekce~\ref{babel}) použít nepovinný parametr, je:

\medskip
\verb;\documentclass{csbulletin};
\medskip

Pak můžete načíst nezbytné balíčky, definovat vlastní makra a prostředí. Všechny definice budou
lokální pro váš článek, nemusíte se proto obávat kolizí s články jiných autorů.

Implicitním jazykem pro Zpravodaj je čeština. Pokud je článek psán v jiném jazyce, vložte hned za
\cmd{begin\{document\}} přepínač \cmd{selectlanguage} se správným jazykem.

Název článku zapište do makra \cmd{title}, jména autorů do makra \cmd{author} a anglický název do
makra \cmd{EnglishTitle}. Nepovinně můžete použít makro \cmd{podpis}, jehož parametr se objeví
kurzívou na konci článku. Poté použijte makro \cmd{maketitle}.

Abstrakt článku v jazyce článku zapište v prostředí \texttt{abstract}. Ve výjimečných případech lze
abstrakt vynechat.

Na konci článku uveďte anglický souhrn v prostředí \texttt{summary}. Anglický název bude vzat z
příkazu \cmd{EnglishTitle}, přepnutí jazyka se též provede automaticky. Anglický souhrn nemusí být
přesným překladem abstraktu.

Redakce se postará o jazykovou korekturu anglického souhrnu. V případě, že jej autor nedodá,
postará se o překlad redakce.

\section{Číslování kapitol}
Implicitně nejsou kapitoly ve Zpravodaji číslovány. Složitější články jsou však bez číslování
nepřehledné. Číslování zapnete vložením kladné hodnoty do čítače \texttt{secnumdepth}. V tomto
manuálu je před \verb;\begin{document}; použit příkaz \verb;\setcounter{secnumdepth}{2};.

\section{Návěští}
V třídě \pkg{csbulletin} jsou předefinována makra \cmd{label}, \cmd{ref} a \cmd{pageref} tak, aby
jejich názvy byly pro každý článek unikátní. Nemusíte se proto bát kolize s články jiných autorů.

\section{Tabulky a obrázky}
Článek ve Zpravodaji nezačíná vždy na nové stránce. Nekoncipujte tudíž stránky absolutně. Všechny
tabulky a obrázky musí být v plovoucích prostředích. Musí mít název v makru \cmd{caption} a
případně symbolický název definovaný v makru \cmd{label}.

\section{Reference}
Styl pro Zpravodaj zatím není připraven pro použití \BibTeX{}u, ale v budoucích verzích se s tím
počítá. Pravděpodobně bude pro potřeby Zpravodaje upraven balíček \pkg{chapterbib}.

\section{Chyby}
Třída \pkg{csbulletin} nemá žádné známé zjevné chyby. Jisté konflikty i se způsobem řešení jsou
zmíněny v dokumentaci balíčku \pkg{encxvlna} a nejsou zcela dořešeny kolize při použití v OS/2. V
každém případě je třeba si uvědomit, že třída samotná pracuje na hranicích možností \LaTeX{}u.
Použití různých balíčků může vést k dalším problémům. Redakce se bude snažit o vyřešení všech
nahlášených potíží.

\section{Licence}
Balíček může být používán a šířen podle \LaTeX\ Project Public License verze~1.3 nebo novější, jejíž
text najdete v souboru \texttt{LICENSE.txt} v adresáři \texttt{doc}, nebo na
\url{http://www.latex-project.org/lppl.txt}

\begin{summary}
The package provides the class for articles for the \cstug\ Bulletin (Zpravodaj Československého
sdružení uživatelů \TeX u). You can see the structure of a document by looking to the source file
of this manual. The package can be used and distributed according to the \LaTeX\ Project Public
License.
\end{summary}

\end{document}