summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/latex/skb/user-guide/repository/getting-started/rebuild.tex
blob: 584868a1883b8f7647a8f6ad7b4bc52ef375a6cc (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
\skbheading{Rebuild the \SKB~from Source}

The \SKB~class and style files as well as the documentation
can be rebuild from its sources very easily. The class and style
files are part of the documented \LaTeX sources in the file
\skbem[code]{source/skb.dtx} and the \LaTeX installer (\skbem[code]{source/skb.ins})
provides all necessary instructions. Simply follow the steps shown in the first part of
\opt{text}{the following example}\opt{note}{this slide}. All you have to
do then is to copy the files created to your \LaTeX~distribution.

\opt{text}{
  \lstinputlisting[style=generic,language=TeX]{\skbfileroot{examples/rebuild}}
}

The \SKB~documentation comes in several different ways. The file \skbem[code]{source/skb.dtx}
contains the documented source while the files in \skbem[code]{doc/user-guide} can be used
to generate the User Guide without source documentation, the \SKB~presentation (animated
and not animated) and the lecture notes for the presentation.

When processing the file \skbem[code]{source/skb.dtx}, the User Guide will automatically be
included in the generated PDF if it is found in either of the directories 
\skbem[code]{source/../doc/user-guide} (when using the \SKB~original distribution)
or \skbem[code]{source/../doc/latex/skb/user-guide} (when the \SKB~is already installed with 
your \LaTeX distribution).

The second part of \opt{text}{the example above}\opt{note}{this slide} shows how to generate the complete
\SKB~documentation. Please note that the sequence is partially important, for instance the 
file \skbem[code]{ug-slides-noanim} must be processed before the file \skbem[code]{ug-slides-notes}.

Please note that the \SKB~documentation is heavily using the \SKB~macros, so you will
need to have the style and class files installed before you can rebuild the documentation.