diff options
Diffstat (limited to 'Master/texmf-dist/doc/latex/skb/user-guide')
101 files changed, 2548 insertions, 0 deletions
diff --git a/Master/texmf-dist/doc/latex/skb/user-guide/examples/example-toc.tex b/Master/texmf-dist/doc/latex/skb/user-guide/examples/example-toc.tex new file mode 100644 index 00000000000..6271f80f48d --- /dev/null +++ b/Master/texmf-dist/doc/latex/skb/user-guide/examples/example-toc.tex @@ -0,0 +1,9 @@ +1 Introduction . . . . . . . . . . . . . . . . . . . . . 1 + 1.1 Data Encoding . . . . . . . . . . . . . . . . . . . 2 + 1.2 Message Formats . . . . . . . . . . . . . . . . . . 5 + 1.3 Protocols . . . . . . . . . . . . . . . . . . . . . 7 + 1.4 Protocol Services . . . . . . . . . . . . . . . . . 9 +2 General Inter-ORB Protocol . . . . . . . . . . . . . . 10 +3 Simple Network Management Protocol . . . . . . . . . . 13 +4 Common Management Information Protocol . . . . . . . . 15 +5 Hypertext Transport Protocol . . . . . . . . . . . . . 18
\ No newline at end of file diff --git a/Master/texmf-dist/doc/latex/skb/user-guide/examples/example.tex b/Master/texmf-dist/doc/latex/skb/user-guide/examples/example.tex new file mode 100644 index 00000000000..669f79202e8 --- /dev/null +++ b/Master/texmf-dist/doc/latex/skb/user-guide/examples/example.tex @@ -0,0 +1,28 @@ +\documentclass{skbarticle} + +\begin{document} + \author{Sven van der Meer} + \title{Protocols, Formats and Communication Services} + \maketitle + \tableofcontents* + \bigskip + + \skbinput[from=rep]{sota/protocols} + + \section{Introduction} + \skbinput[from=rep,level=subsection] + {sota/protocols/data_encoding} + \skbinput[from=rep,level=subsection] + {sota/protocols/message-formates} + \skbinput[from=rep,level=subsection] + {sota/protocols/protocols} + \skbinput[from=rep,level=subsection] + {sota/protocols/protocol-services} + + \skbinput[from=rep,level=section]{sdo/omg/corba-giop} + \skbinput[from=rep,level=section]{sdo/ietf/snmp-protocol} + \skbinput[from=rep,level=section]{sdo/itu/x700-cmip} + \skbinput[from=rep,level=section]{sdo/w3c/http} + +\end{document} +\endinput
\ No newline at end of file diff --git a/Master/texmf-dist/doc/latex/skb/user-guide/examples/figure-classic.tex b/Master/texmf-dist/doc/latex/skb/user-guide/examples/figure-classic.tex new file mode 100644 index 00000000000..5d7a4a7c63a --- /dev/null +++ b/Master/texmf-dist/doc/latex/skb/user-guide/examples/figure-classic.tex @@ -0,0 +1,5 @@ +\begin{figure}\begin{center} + \resizebox{\textwidth}{!}{ + \includegraphics[width=\textwidth]{../figures/myfig}} + \caption{My Figure}\label{myfig} +\end{center}\end{figure}
\ No newline at end of file diff --git a/Master/texmf-dist/doc/latex/skb/user-guide/examples/listings.tex b/Master/texmf-dist/doc/latex/skb/user-guide/examples/listings.tex new file mode 100644 index 00000000000..cd198fe3616 --- /dev/null +++ b/Master/texmf-dist/doc/latex/skb/user-guide/examples/listings.tex @@ -0,0 +1,4 @@ +\lstinputlisting[style=generic,language=TeX]{example} +\lstinputlisting[style=generic]{\skbfileroot{example-toc} +\lstinputlisting[style=beamer-example]{example} +\lstinputlisting[style=beamer-exampleLN]{example}
\ No newline at end of file diff --git a/Master/texmf-dist/doc/latex/skb/user-guide/examples/optional-text.tex b/Master/texmf-dist/doc/latex/skb/user-guide/examples/optional-text.tex new file mode 100644 index 00000000000..6f935a3f6bf --- /dev/null +++ b/Master/texmf-dist/doc/latex/skb/user-guide/examples/optional-text.tex @@ -0,0 +1,7 @@ +\opt{text}{The following example}\opt{note}{This slide}% + shows some examples for optional text (optional package) + +\begin{skbmodememoir}Only with memoir\end{skbmodememoir} + +\opt{anim}{\skbfigure[multiinclude=+-]{myfigure}} +\opt{noanim}{\skbfigure[width=\textwidth]{myfigure}}
\ No newline at end of file diff --git a/Master/texmf-dist/doc/latex/skb/user-guide/examples/paths.tex b/Master/texmf-dist/doc/latex/skb/user-guide/examples/paths.tex new file mode 100644 index 00000000000..51694d60977 --- /dev/null +++ b/Master/texmf-dist/doc/latex/skb/user-guide/examples/paths.tex @@ -0,0 +1,2 @@ +\skbfileroot{examples/skbem} +\skbfilfig{dirtree/complete}
\ No newline at end of file diff --git a/Master/texmf-dist/doc/latex/skb/user-guide/examples/rebuild.tex b/Master/texmf-dist/doc/latex/skb/user-guide/examples/rebuild.tex new file mode 100644 index 00000000000..9202df41abe --- /dev/null +++ b/Master/texmf-dist/doc/latex/skb/user-guide/examples/rebuild.tex @@ -0,0 +1,14 @@ +#Rebuild Class and Style files +$cd run; latex ../source/skb.ins +-> creates: skb.cfg, skb.sty, skbarticle.cls, skbbook.cls, + skbbeamer.cls, skblncsbeamer.cls and skblncsppt.cls + +#Rebuild Documentation +$cd doc +$pdflatex ../source/skb.dtx # repeat twice +$pdflatex user-guide/user-guide # repeat twice +$pdflatex user-guide/ug-slides-anim # repeat twice +$pdflatex user-guide/ug-slides-noanim # repeat twice +$pdflatex user-guide/ug-slides-notes # repeat twice + +# remove all files except the PDFs for cleanup
\ No newline at end of file diff --git a/Master/texmf-dist/doc/latex/skb/user-guide/examples/skbconfig.tex b/Master/texmf-dist/doc/latex/skb/user-guide/examples/skbconfig.tex new file mode 100644 index 00000000000..e460dc01d50 --- /dev/null +++ b/Master/texmf-dist/doc/latex/skb/user-guide/examples/skbconfig.tex @@ -0,0 +1,14 @@ +%default content of skb.cfg +\skbconfig[ + root=/doc,fig=figures,sli=slides + acr=database/latex,acrfile=acronym, + bib=database/bibtex,bibfile=bibliograhpy, + rep=repository,pub=publish +]{skb.cfg} + +%using relative path for root and no directory structure +\skbconfig[ + root=./,rep=,pub=,fig=,sli=, + acr=,acrfile=acronym, + bib=,bibfile=bibliograhpy +]{myfile.tex}
\ No newline at end of file diff --git a/Master/texmf-dist/doc/latex/skb/user-guide/examples/skbem.tex b/Master/texmf-dist/doc/latex/skb/user-guide/examples/skbem.tex new file mode 100644 index 00000000000..5eabfb7bde8 --- /dev/null +++ b/Master/texmf-dist/doc/latex/skb/user-guide/examples/skbem.tex @@ -0,0 +1,5 @@ +Use \cmd{\skbem} to produce \skbem[bold]{bold}, +\skbem[italic]{italic} or \skbem[code]{type writer} text. + +The example above shows the macro \skbem[code]{skbem} with +the option \skbem[italic]{bold} and \skbem[bold]{italic}.
\ No newline at end of file diff --git a/Master/texmf-dist/doc/latex/skb/user-guide/examples/skbfigure.tex b/Master/texmf-dist/doc/latex/skb/user-guide/examples/skbfigure.tex new file mode 100644 index 00000000000..ea069b15285 --- /dev/null +++ b/Master/texmf-dist/doc/latex/skb/user-guide/examples/skbfigure.tex @@ -0,0 +1,5 @@ +\skbfigure{myfig} +\skbfigure[figure,center]{myfig} +\skbfigure[figure,center,width=\textwidth]{myfig} +\skbfigure[figure,center, + caption=My Figure,label=myfig]{myfig}
\ No newline at end of file diff --git a/Master/texmf-dist/doc/latex/skb/user-guide/examples/skbheading.tex b/Master/texmf-dist/doc/latex/skb/user-guide/examples/skbheading.tex new file mode 100644 index 00000000000..cdf4d6c6eb4 --- /dev/null +++ b/Master/texmf-dist/doc/latex/skb/user-guide/examples/skbheading.tex @@ -0,0 +1 @@ +\skbheading{My Heading}
\ No newline at end of file diff --git a/Master/texmf-dist/doc/latex/skb/user-guide/examples/skbinput.tex b/Master/texmf-dist/doc/latex/skb/user-guide/examples/skbinput.tex new file mode 100644 index 00000000000..7de3b3e4f8c --- /dev/null +++ b/Master/texmf-dist/doc/latex/skb/user-guide/examples/skbinput.tex @@ -0,0 +1,6 @@ +\skbinput{myfile} +\skbinput[from=rep]{myfile} +\skbinput[from=pub]{myfile} +\skbinput[level=chapter]{myfile} +\skbinput[from=pub,level=chapter]{myfile} +\skbinput[from=pub]{test/myfile}
\ No newline at end of file diff --git a/Master/texmf-dist/doc/latex/skb/user-guide/examples/skbslide.tex b/Master/texmf-dist/doc/latex/skb/user-guide/examples/skbslide.tex new file mode 100644 index 00000000000..9ca2d0ac239 --- /dev/null +++ b/Master/texmf-dist/doc/latex/skb/user-guide/examples/skbslide.tex @@ -0,0 +1,7 @@ +\skbslide{myslides/slide1}{} +\skbslide{myslides/slide2}{}\clearpage +\skbslide[annotate]{myslides/slide3}{} +\skbslide[annotate,notefrom=rep] + {myslides/theme1}{text/theme1} +\skbslide[annotate,notefrom=rep,slidefrom=rep] + {text/theme2}{text/theme2}
\ No newline at end of file diff --git a/Master/texmf-dist/doc/latex/skb/user-guide/examples/skbslidecite.tex b/Master/texmf-dist/doc/latex/skb/user-guide/examples/skbslidecite.tex new file mode 100644 index 00000000000..e23a2c75105 --- /dev/null +++ b/Master/texmf-dist/doc/latex/skb/user-guide/examples/skbslidecite.tex @@ -0,0 +1,2 @@ +\skbslidecite{Slide}{\cite{tanenbaum-andrew:book:2003}} +\skbslidecite{Notes}{\cite{standard:IETF:RFC:1155}}
\ No newline at end of file diff --git a/Master/texmf-dist/doc/latex/skb/user-guide/examples/used-options.tex b/Master/texmf-dist/doc/latex/skb/user-guide/examples/used-options.tex new file mode 100644 index 00000000000..13a6fa3f828 --- /dev/null +++ b/Master/texmf-dist/doc/latex/skb/user-guide/examples/used-options.tex @@ -0,0 +1,21 @@ +Package skb Warning: Options last changed by: skb-presentation +(skb) Change log: +(skb) - root = skb.sty, ug-slides-noanim.tex +(skb) - acr = skb.sty +(skb) - acrfile = skb.sty +(skb) - bib = skb.sty +(skb) - bibfile = skb.sty +(skb) - rep = skb.sty +(skb) - pub = skb.sty, ug-slides-noanim.tex +(skb) - fig = skb.sty +(skb) - sli = skb.sty, skb-presentation +(skb) Last set Path/File Options: +(skb) - file root = user-guide/ +(skb) - path root = user-guide +(skb) - file acr = user-guide/database/latex/acronym +(skb) - file bib = user-guide/database/bibtex/bibliography +(skb) - path bib = user-guide/database/bibtex +(skb) - path rep = user-guide/repository/ +(skb) - path pub = user-guide// +(skb) - path fig = user-guide/figures/ +(skb) - path sli = user-guide/slides/ .
\ No newline at end of file diff --git a/Master/texmf-dist/doc/latex/skb/user-guide/figures/dirtree/baf.tex b/Master/texmf-dist/doc/latex/skb/user-guide/figures/dirtree/baf.tex new file mode 100644 index 00000000000..373d9fd4049 --- /dev/null +++ b/Master/texmf-dist/doc/latex/skb/user-guide/figures/dirtree/baf.tex @@ -0,0 +1,11 @@ + \dirtree{%^^A + .1 [root]\DTcomment{for instance $/doc$}. + .2 database\DTcomment{folder for all sorts of data for the repository}. + .3 latex\DTcomment{data in \LaTeX, such as our acronyms}. + .3 bibtex\DTcomment{{\scshape Bib\TeX} database}. + .3 [...]. + .2 figures\DTcomment{folder for figures, my sources are SVG \& PDF}. + .3 [...]. + .2 repository\DTcomment{folder for the text files}. + .3 [...]. + } diff --git a/Master/texmf-dist/doc/latex/skb/user-guide/figures/dirtree/complete.tex b/Master/texmf-dist/doc/latex/skb/user-guide/figures/dirtree/complete.tex new file mode 100644 index 00000000000..7f23c6ccd54 --- /dev/null +++ b/Master/texmf-dist/doc/latex/skb/user-guide/figures/dirtree/complete.tex @@ -0,0 +1,13 @@ + \dirtree{%^^A + .1 [your repository root]\DTcomment{path to your repository, like $/dev/documents$}. + .2 database\DTcomment{folder for all sorts of data for the repository}. + .3 latex\DTcomment{this is were \LaTeX data will be collected, such as our acronyms}. + .3 bibtex\DTcomment{folder for all {\scshape Bib\TeX} reference files}. + .2 figures\DTcomment{folder for figures, my sources are SVG \& PDF}. + .2 publish\DTcomment{folder for published documents}. + .3 articles\DTcomment{...such as articles}. + .3 books\DTcomment{...or books}. + .3 lecture\_notes\DTcomment{...or lecture notes for computer science}. + .3 presentations\DTcomment{...or general presentations}. + .2 repository\DTcomment{folder for the text content}. + }
\ No newline at end of file diff --git a/Master/texmf-dist/doc/latex/skb/user-guide/figures/dirtree/publish-art.tex b/Master/texmf-dist/doc/latex/skb/user-guide/figures/dirtree/publish-art.tex new file mode 100644 index 00000000000..1986838d376 --- /dev/null +++ b/Master/texmf-dist/doc/latex/skb/user-guide/figures/dirtree/publish-art.tex @@ -0,0 +1,10 @@ + \dirtree{%^^A + .1 articles\DTcomment{our articles}. + .2 naming.tex\DTcomment{the file creating an article on naming}. + .2 object-models.tex\DTcomment{the file creating an article on object-models}. + .2 protocols.tex\DTcomment{the file creating an article on protocols}. + .2 tex\DTcomment{a folder containing the tex files that include our content}. + .3 naming.tex\DTcomment{the file including all content for naming}. + .3 object-models.tex\DTcomment{the file including all content for object-models}. + .3 protocols.tex\DTcomment{the file including all content for protocols}. + } diff --git a/Master/texmf-dist/doc/latex/skb/user-guide/figures/dirtree/publish.tex b/Master/texmf-dist/doc/latex/skb/user-guide/figures/dirtree/publish.tex new file mode 100644 index 00000000000..d2c1d93d7d1 --- /dev/null +++ b/Master/texmf-dist/doc/latex/skb/user-guide/figures/dirtree/publish.tex @@ -0,0 +1,11 @@ + \dirtree{%^^A + .1 [your repository root]\DTcomment{path to your repository, like $/dev/documents$}. + .2 [...]. + .2 publish\DTcomment{folder for published documents}. + .3 articles\DTcomment{...such as articles}. + .3 books\DTcomment{...or books}. + .3 lecture\_notes\DTcomment{...or lecture notes for computer science}. + .3 presentations\DTcomment{...or general presentations}. + .3 [...]. + .2 [...]. + } diff --git a/Master/texmf-dist/doc/latex/skb/user-guide/figures/dirtree/repository.tex b/Master/texmf-dist/doc/latex/skb/user-guide/figures/dirtree/repository.tex new file mode 100644 index 00000000000..c172413eb6d --- /dev/null +++ b/Master/texmf-dist/doc/latex/skb/user-guide/figures/dirtree/repository.tex @@ -0,0 +1,18 @@ + \dirtree{%^^A + .1 [repository]\DTcomment{the Repository Folder}. + .2 sdo\DTcomment{the folder with our SDO files}. + .3 omg\DTcomment{files for OMG 'stuff'}. + .4 corba-idl.tex\DTcomment{The CORBA IDL language}. + .4 omg-mda.tex\DTcomment{The OMG Model-driven Architecture}. + .4 [...]. + .3 ieee\DTcomment{files for IEEE 'stuff'}. + .4 802-1.tex\DTcomment{The IEEE LAN concept}. + .4 ethernet.tex\DTcomment{The Ethernet protocol}. + .4 [...]. + .3 ietf\DTcomment{files for IETF 'stuff'}. + .4 dns.tex\DTcomment{The DNS protocol}. + .4 uri.tex\DTcomment{The URI specifications}. + .4 [...]. + .3 [...]. + .2 [...]. + }
\ No newline at end of file diff --git a/Master/texmf-dist/doc/latex/skb/user-guide/figures/dirtree/skb-distribution.tex b/Master/texmf-dist/doc/latex/skb/user-guide/figures/dirtree/skb-distribution.tex new file mode 100644 index 00000000000..b8df82fa63a --- /dev/null +++ b/Master/texmf-dist/doc/latex/skb/user-guide/figures/dirtree/skb-distribution.tex @@ -0,0 +1,15 @@ + \dirtree{%^^A + .1 [start folder]. + .2 doc\DTcomment{The generated PDFs and User Guide Sources}. + .3 [user-guide]\DTcomment{Sources for the User Guide}. + .3 skb.pdf\DTcomment{The generated Documentation}. + .3 skb-guide.pdf\DTcomment{The User Guide only}. + .2 run\DTcomment{The generated Class and Style Files}. + .3 skb.cfg\DTcomment{The global Configuration File}. + .3 skb.sty\DTcomment{The Style File}. + .3 *.cls\DTcomment{The Class Files}. + .2 source\DTcomment{The Source files}. + .3 skb.dtx\DTcomment{Documented \LaTeX Source File}. + .3 skb.ins\DTcomment{The \LaTeX Installer File}. + .3 *.txt\DTcomment{Manifest, Licence, Todo List and History as plain Text}. + }
\ No newline at end of file diff --git a/Master/texmf-dist/doc/latex/skb/user-guide/repository/abstract.tex b/Master/texmf-dist/doc/latex/skb/user-guide/repository/abstract.tex new file mode 100644 index 00000000000..7496897d5a4 --- /dev/null +++ b/Master/texmf-dist/doc/latex/skb/user-guide/repository/abstract.tex @@ -0,0 +1,10 @@ +This package provides macros that help to build a repository for +long living documents. It focuses on structure and re-use of text, code, +figures etc. The basic concept is to first separate structure from content +(i.e. text about a topic from the structure it is presented by) and then +separating the content from the actual published document, thus enabling +easy re-use of text blocks in different publications (i.e. text about a +protocol in a short article about this protocol as well as in a book about +many protocols); all without constantly copying or changing text. As a side +effect, using the document classes provided, it hides a lot of LaTeX from +someone who just wants to write articles and books.
\ No newline at end of file diff --git a/Master/texmf-dist/doc/latex/skb/user-guide/repository/applicability.tex b/Master/texmf-dist/doc/latex/skb/user-guide/repository/applicability.tex new file mode 100644 index 00000000000..dc61e31d43d --- /dev/null +++ b/Master/texmf-dist/doc/latex/skb/user-guide/repository/applicability.tex @@ -0,0 +1,28 @@ +\skbheading{Applicability and Side Effects} + +The \SKB~can help you if +\begin{skbnotelist} + \item You have too many concepts and ideas spread over too many places. + \item You want to re-organise all of your 'stuff'. + \item You plan a 'personal' repository or a well-maintained document base for a single purpose. + It will be difficult to use the \SKB~for a widely distributed repository that is not + well-maintained, since there are side effects that might run out of control. +\end{skbnotelist} + +The \SKB~has side effects which might cause problems +\begin{skbnotelist} + \item Separating contents from structure (see below) means that the contents needs to be + almost context-free. Since we can assemble any contents into 'anything' (a book, an article, ...) + we need to write self-contained text. That can be very difficult and lead to documents that do not give the + reader the impression of a consitent and coherent story. However, carefully writing can avoid that problem, + and I am sure you are carefull writer already \smiley. + \item Changes in the repository will potentially effect multiple documents. These changes + are not necessarily intended or wanted. I.e. if an article, a book and a beamer + presentation access the same source code example, a change here might have a negative + effect on the beamer presentation. Similarly, if text is changed it might have a negative + effect on lecture notes or annotated beamer slides. + \item Versioning the repository (text and figures) is very difficult. + \item Cross-references need to be used carefully, since a repository file cannot assume that + the master document uses the (other) file referenced. The \SKB~provides no solution for this + at the moment (though I have some ideas). +\end{skbnotelist}
\ No newline at end of file diff --git a/Master/texmf-dist/doc/latex/skb/user-guide/repository/example-article.tex b/Master/texmf-dist/doc/latex/skb/user-guide/repository/example-article.tex new file mode 100644 index 00000000000..3ca3eb0c633 --- /dev/null +++ b/Master/texmf-dist/doc/latex/skb/user-guide/repository/example-article.tex @@ -0,0 +1,32 @@ +\skbheading{A Simple Article} + +Take the article that describes the state of the art in protocols. Remember, we +have all the contents for that in our \skbem[code]{repository} directory. +We go the directory that has the published articles +\skbem[code]{published/articles} and create a new file say +\skbem[code]{protocols.tex} \opt{note}{as shown on this slide and the following two slides}. + +\opt{text}{\lstinputlisting[style=generic,language=TeX]{\skbfileroot{examples/example}}} + +The article uses the class \skbem[code]{skbarticle}. That class will load the \SKB~package and +the memoir class and do all settings we need. It prepares the title page and +prints the table of contents like any other \LaTeX article. The it uses \cmd{\skbinput} +to load files from the repository. The first one is loaded without requesting a level. +In other words, there is some text right at the beginning of our article, without +any special heading, like an abstract. + +Then we do start the section 'Introduction' and collect a few files with their heading +categorised as sub-sections. Reading the directory and file names, we can already guess +what the introduction will be doing: it introduces general protocol concepts with regard +to data encoding, protocol message formats, protocols themselves and protocol services. +The last block loads four files with headings categorised as sections. +Using the directory names, we see that the remaining article +describes the protocols GIOP defined by the OMG, SNMP by the IETF, CMIP by +the ITU-T and finally HTTP by the W3C. + +Finally, we load acronyms and bebliography and finishing the article. +This example will create a table of contents similar to this: + +\lstinputlisting[style=generic]{\skbfileroot{examples/example-toc}} + +Job done. Now we can use \LaTeX~or PDF-\LaTeX~to compile our article. diff --git a/Master/texmf-dist/doc/latex/skb/user-guide/repository/getting-started/config-cmd.tex b/Master/texmf-dist/doc/latex/skb/user-guide/repository/getting-started/config-cmd.tex new file mode 100644 index 00000000000..cda9c27a98a --- /dev/null +++ b/Master/texmf-dist/doc/latex/skb/user-guide/repository/getting-started/config-cmd.tex @@ -0,0 +1,19 @@ +The macro \cmd{\skbconfig} requires one argument, which describes where the configuration has +been changed. This is helpful in combination with the macro \cmd{\skboptionsused} to trace configuration +settings. For instance, in the files \skbem[code]{skb.cfg} and \skbem[code]{skblocal.cfg} we +should use the respective filename. When changing configuration settings elsewhere, some other descriptive +text should be useful. + +\opt{text}{ + The following code shows the example for \cmd{skbconfig}. The first one is the defailt content + of the file \skbem[code]{skb.cfg}. It basically sets all possible configuration options to their default value. + \lstinputlisting[style=generic,language=TeX]{\skbfileroot{examples/skbconfig}} +} + +If you want to change the configuration settings for a single document without any directory structure, +overwriting all default settings (from \skbem[code]{skb.sty}, \skbem[code]{skb.cfg} and \skbem[code]{skblocal.cfg} +and using the current relative path, you can use the second examle +\opt{text}{shown above}\opt{note}{shown in this slide}. + +To trace the configuration settings, you can use \cmd{\skboptionsused}. +\opt{text}{Please see \#\#\# for details on this macro.}
\ No newline at end of file diff --git a/Master/texmf-dist/doc/latex/skb/user-guide/repository/getting-started/config-opt-table.tex b/Master/texmf-dist/doc/latex/skb/user-guide/repository/getting-started/config-opt-table.tex new file mode 100644 index 00000000000..555ddf42b2a --- /dev/null +++ b/Master/texmf-dist/doc/latex/skb/user-guide/repository/getting-started/config-opt-table.tex @@ -0,0 +1,26 @@ + \skbem[code]{root} & Sets the root path of the \SKB. Everything that the \SKB~ + processes should be located below the root. + & \skbem[code]{/doc} \\ + \midrule + \skbem[code]{pub} & Sets the path for the published documents. + & \skbem[code]{publish} \\ + \midrule + \skbem[code]{rep} & Sets the path for the repository documents. + & \skbem[code]{/repository} \\ + \midrule + \skbem[code]{fig} & Sets the path for figures. + & \skbem[code]{/figures} \\ + \midrule + \skbem[code]{sli} & Sets the path for the slides. + & \skbem[code]{/transparencies} \\ + \midrule + \skbem[code]{acr}, + \skbem[code]{acrfile} & The \SKB uses the \skbem[code]{acronym} package and these two macros + dtail the directory (\skbem[code]{acr}) and the file (\skbem[code]{acrfile}) + where the acronyms can be found. + & acr: \skbem[code]{database/latex} acrfile: \skbem[code]{acronym} \\ + \midrule + \skbem[code]{bib}, + \skbem[code]{bibfile} & These two macros detail the directory (\skbem[code]{bib}) and the main file + (\skbem[code]{bibfile}) where bibliographic information (\BibTeX~database) can be found. + & bib: \skbem[code]{database/bibtex} bibfile: \skbem[code]{bibliography} \\
\ No newline at end of file diff --git a/Master/texmf-dist/doc/latex/skb/user-guide/repository/getting-started/config-opt.tex b/Master/texmf-dist/doc/latex/skb/user-guide/repository/getting-started/config-opt.tex new file mode 100644 index 00000000000..ad96f653629 --- /dev/null +++ b/Master/texmf-dist/doc/latex/skb/user-guide/repository/getting-started/config-opt.tex @@ -0,0 +1,40 @@ +\DescribeMacro{\skbconfig} +There are multiple options to configure the \SKB. The following list +contains all possible options starting with the least significant. That +means that the higher priority settings, which overwrite other settings, +will be listed at the bottom. +\begin{itemize} + \item Change the file \skbem[code]{skb.sty} in your \LaTeX + distribution. This might require administrator (root) + privileges. This option, while possible, is not recommended. + \item Change the file \skbem[code]{skb.cfg} in your \LaTeX + distribution. This might require administrator (root) + privileges. This option is suitable for a system wide + configuration, say on your own computer or laptop. + \item Create a file \skbem[code]{skblocal.cfg} in your personal + \LaTeX style/template directory. This will be the most + convenient way to configure the \SKB. Note: you might need + to refresh the file database of your \LaTeX distribution. + \item Use \cmd{\skbconfig} in your documents. +\end{itemize} + +If you chose option 1 we assume you know what you are doing. In case you +chose options 2-3, you can use the macro \cmd{\skbconfig} to do the configuration +for you. The macro comes with options for all possible settings of the \SKB. +\opt{text}{\autoref{tab:skbconfig:options}}\opt{note}{This slide} describes all options and shows their default value. +Please note that the \SKB~can currently not handle inputs from directories outside the root hierarchy. However, one can +call \cmd{\skbconfig} anytime to change the root directory, but be carefull with potential side effects!. + +\opt{text}{ + \begin{table}[ht!] + \caption{Options for skbconfig} + \label{tab:skbconfig:options} + \begin{tabular*}{\textwidth}{ >{\small}p{.1\textwidth} >{\small}p{.65\textwidth} >{\small}p{.15\textwidth}} + \toprule + \textbf{Option} & \textbf{Description} & \textbf{Default} \\ + \midrule + \skbinput[from=rep]{getting-started/config-opt-table} + \bottomrule + \end{tabular*} + \end{table} +} diff --git a/Master/texmf-dist/doc/latex/skb/user-guide/repository/getting-started/config.tex b/Master/texmf-dist/doc/latex/skb/user-guide/repository/getting-started/config.tex new file mode 100644 index 00000000000..f0b468e519a --- /dev/null +++ b/Master/texmf-dist/doc/latex/skb/user-guide/repository/getting-started/config.tex @@ -0,0 +1,6 @@ +\skbheading{Confguration: skbconfig}\label{macro:skbconfig} + +\opt{text}{ + \skbinput[from=rep]{getting-started/config-opt} + \skbinput[from=rep]{getting-started/config-cmd} +}
\ No newline at end of file diff --git a/Master/texmf-dist/doc/latex/skb/user-guide/repository/getting-started/distribution.tex b/Master/texmf-dist/doc/latex/skb/user-guide/repository/getting-started/distribution.tex new file mode 100644 index 00000000000..334a4c4f0a3 --- /dev/null +++ b/Master/texmf-dist/doc/latex/skb/user-guide/repository/getting-started/distribution.tex @@ -0,0 +1,17 @@ +\skbheading{The \SKB~Distribution} + +The \SKB~distribution that one can download from SourceForge or CTAN (CTAN coming soon) +contains the source files for the \SKB, the generated classes and styles, the generated +documentation and the source files for the user guide. +\opt{text}{The following example}\opt{note}{This slide} shows the structure and content of the \SKB~distribution. + +\opt{text}{ + \begin{longtable}{|>{}p{0.945\textwidth} >{}p{1pt}|} + \hline + \rowcolor[gray]{.9} + \skbinput[from=fig]{dirtree/skb-distribution} + & \\ + \hline + \end{longtable} + \addtocounter{table}{-1} +} diff --git a/Master/texmf-dist/doc/latex/skb/user-guide/repository/getting-started/folders.tex b/Master/texmf-dist/doc/latex/skb/user-guide/repository/getting-started/folders.tex new file mode 100644 index 00000000000..be8dc9a7d19 --- /dev/null +++ b/Master/texmf-dist/doc/latex/skb/user-guide/repository/getting-started/folders.tex @@ -0,0 +1,45 @@ +\skbheading{Creating a Directory Structure} + +The real power (and possibly madness) of the \SKB~comes with the separation of +different parts of a document into different directory structures. For the user guide, +we assume the \opt{text}{following} general directory structure% +\opt{note}{shown in this slide}% +. + +\opt{text}{ + \begin{longtable}{|>{}p{0.945\textwidth} >{}p{1pt}|} + \hline + \rowcolor[gray]{.9} + \skbinput[from=fig]{dirtree/complete} + & \\ + \hline + \end{longtable} +} + +To create this structure, go to the directory were you want to put all your +documents, say \skbem[code]{/doc}. Now create the folders \skbem[code]{database}, +\skbem[code]{figures}, \skbem[code]{publish} and \skbem[code]{repository} and the +respective sub-folders as shown \opt{text}{above.}\opt{note}{in this slide.} Finally, configure the +\SKB~by either editing one of the configuration files or adding the following line +to all of your published documents (and of course change the text \skbem[code]{myfile.tex} +to something that tells you about the location of the configuration change): + +\begin{lstlisting}[style=generic,language=TeX] +\skbconfig[root=/doc, + acr=database/latex,acrfile=acronym, + bib=database/bibtex,bibfile=bibliograhpy, + rep=repository,pub=publish, + fig=figures,sli=slides + ]{myfile.tex} +\end{lstlisting} + +The directory structures for the publish folder and the repository folder reflect different +views to your document base. The publish folder contains documents that are published for a +reason (i.e. articles, books, presentations, white papers, work in progress) while the +repository folder contains content, most likely structured following a content-specific +categorisation. The choice of how the directory structure looks like is yours, and of course +you could also have multiple document directories with completely different structures, for instance +one for computer science publications and one for a gardening book. The \SKB~does not set any +limit, since it can be configured very flexibly to your needs +\opt{text}{(please see \autoref{macro:skbconfig} for more details)}% +. diff --git a/Master/texmf-dist/doc/latex/skb/user-guide/repository/getting-started/installation.tex b/Master/texmf-dist/doc/latex/skb/user-guide/repository/getting-started/installation.tex new file mode 100644 index 00000000000..b16b6468c6f --- /dev/null +++ b/Master/texmf-dist/doc/latex/skb/user-guide/repository/getting-started/installation.tex @@ -0,0 +1,34 @@ +\skbheading{Installation} + +There are two ways to install the \SKB. The first option is have it +automatically installed by your \LaTeX~distribution using \TeX Life +or the CTAN archive\footnote{Note: This option is not yet supported, +since the \SKB~has not yet been submitted to CTAN.}. The second option +is a manual installation doing the following steps: +\begin{skbnoteenum} + \item Go to your \LaTeX~distribution to the folder \skbem[code]{tex/latex}. + \item Create a folder \skbem[code]{skb}. + \item Copy all files from the directory \skbem[code]{run} of this package to the + newly created folder \skbem[code]{tex/latex/skb}. + \item Update the filename database of your \LaTeX~distibution. Please see the + manual or help files of your \LaTeX~distribution for details. +\end{skbnoteenum} + +\noindent If you want copy the source and documentation files as well, then do the +following steps. We start with the documentation: +\begin{skbnoteenum} + \item Go to your \LaTeX~distribution to the folder \skbem[code]{doc/latex}. + \item Create a folder \skbem[code]{skb}. + \item Copy all files from the directory \skbem[code]{doc} of this package to the + newly created folder \skbem[code]{doc/latex/skb}. +\end{skbnoteenum} + +\noindent And now the source files of the \SKB: +\begin{skbnoteenum} + \item Go to your \LaTeX~distribution to the folder \skbem[code]{source/latex}. + \item Create a folder \skbem[code]{skb}. + \item Copy all files and directories from the directory \skbem[code]{source} of this package to the + newly created folder \skbem[code]{source/latex/skb}. +\end{skbnoteenum} + +Now you have installed the \SKB~and you are ready to use it.
\ No newline at end of file diff --git a/Master/texmf-dist/doc/latex/skb/user-guide/repository/getting-started/rebuild.tex b/Master/texmf-dist/doc/latex/skb/user-guide/repository/getting-started/rebuild.tex new file mode 100644 index 00000000000..584868a1883 --- /dev/null +++ b/Master/texmf-dist/doc/latex/skb/user-guide/repository/getting-started/rebuild.tex @@ -0,0 +1,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.
\ No newline at end of file diff --git a/Master/texmf-dist/doc/latex/skb/user-guide/repository/getting-started/start.tex b/Master/texmf-dist/doc/latex/skb/user-guide/repository/getting-started/start.tex new file mode 100644 index 00000000000..01695a58b34 --- /dev/null +++ b/Master/texmf-dist/doc/latex/skb/user-guide/repository/getting-started/start.tex @@ -0,0 +1 @@ +\skbheading{Getting Started}
\ No newline at end of file diff --git a/Master/texmf-dist/doc/latex/skb/user-guide/repository/getting-started/used-options.tex b/Master/texmf-dist/doc/latex/skb/user-guide/repository/getting-started/used-options.tex new file mode 100644 index 00000000000..40860cde825 --- /dev/null +++ b/Master/texmf-dist/doc/latex/skb/user-guide/repository/getting-started/used-options.tex @@ -0,0 +1,23 @@ +\skbheading{Confguration: View Options Used}\label{macro:skboptionsused} + +\DescribeMacro{\skboptionsused} +This macro will print out a warning including the currently used configuration +information and the change list for each of them. For example, if the configuration +for \skbem[code]{root} has not been changed the output for \skbem[code]{root} will be + +\skbem[code]{- root [skb.sty]: /doc} + +but if the configuration for \skbem[code]{fig} has been changed using +\cmd{\skbconfig} to \skbem[code]{graphics} the output for \skbem[code]{root} will be + +\skbem[code]{- fib [skb.sty, skbconfig]: graphics} + +This macro is automatically called at the end of processing. + +When creating the documentation for the \SKB~by running \skbem[code]{pdflatex skb.dtx}, +the following output will be created: +\lstinputlisting[style=generic]{\skbfileroot{examples/used-options}} + +The change log shows that all configuration options have been set by \skbem[code]{skb.sty} and later +by \skbem[code]{skb.cfg}. Furthermore, the configuration option \skbem[code]{root} has +been changed by \skbem[code]{skb.dtx}.
\ No newline at end of file diff --git a/Master/texmf-dist/doc/latex/skb/user-guide/repository/intent.tex b/Master/texmf-dist/doc/latex/skb/user-guide/repository/intent.tex new file mode 100644 index 00000000000..08717f75151 --- /dev/null +++ b/Master/texmf-dist/doc/latex/skb/user-guide/repository/intent.tex @@ -0,0 +1,11 @@ +\skbheading{The Intent} + +Provide a \LaTeX package that helps to create and maintain a repository for long-living documents. It's +probably not usefull for some short-term articles, however, I learned that most of my short term articles +eventually become part of my long-term documents. Here you go. The repository should allow for easy access +to 'stuff': text blocks, senteces, paragraphs, sections, complete chapters. But also to figures, code +sniplets, examples, etc. And I do want to limit the amount of repetition of information. For example, if +I use a certain example in an article I might want to use the same (identical) example in a book or a +presentation or lecture notes. If I only copy the example I have to maintain several sources, and over time +I will not remember which of them is normative. As a side effect, I also want to optimise document creation +and limit the \LaTeX or document class specific code in my documents.
\ No newline at end of file diff --git a/Master/texmf-dist/doc/latex/skb/user-guide/repository/manual/acr-bib.tex b/Master/texmf-dist/doc/latex/skb/user-guide/repository/manual/acr-bib.tex new file mode 100644 index 00000000000..337183cad4f --- /dev/null +++ b/Master/texmf-dist/doc/latex/skb/user-guide/repository/manual/acr-bib.tex @@ -0,0 +1,10 @@ +\skbheading{Loading Acronyms and Bibliographic Information} + +\DescribeMacro{\skbacronyms} +\DescribeMacro{\skbbibtex} +These two macros can be used to load the acronym database (\cmd{\skbacronyms}) and the references +(\cmd{\skbbibtex}). Both macros behave identical: they use \cmd{\InputIfFileExists} to check whether +the acronym or bibtex file exists. If so, they simply input the file. If not, they use \cmd{\PackageError} to +throw an error with a help message, showing the requested database file to input. +One should use \cmd{\skbacronyms} at the place in the document were the list of acronyms should +be printed and \cmd{\skbbibtex} at the beginning of the document to load the bibliographic information. diff --git a/Master/texmf-dist/doc/latex/skb/user-guide/repository/manual/figures.tex b/Master/texmf-dist/doc/latex/skb/user-guide/repository/manual/figures.tex new file mode 100644 index 00000000000..bb1f52fd001 --- /dev/null +++ b/Master/texmf-dist/doc/latex/skb/user-guide/repository/manual/figures.tex @@ -0,0 +1,56 @@ +\skbheading{Figures} + +\DescribeMacro{\skbfigure} +The classic way to add figures to your document is to have a PDF or PNG or JPG +file ready, include it using \cmd{\includegraphics} while putting it into a box +to resize it (i.e. to the width of the text in your document), putting this +very box into a figure environment so that \LaTeX~can process list of figures etc. +and of course adding lable and caption to it.% +\opt{text}{% + Here is some \LaTeX~example, which also uses the center environment: + \lstinputlisting[style=generic,language=TeX]{\skbfileroot{examples/figure-classic}} +}% +\opt{note}{The first block of this slide show a \LaTeX~example, which also uses the +center environment.}% + +With the \SKB~macro \cmd{\skbfigure} things become a little bit simplier. +takes a number of options and one argument.% +\opt{text}{The following code}\opt{note}{The second block on this slide} +shows a number of examples for using this macro. + +\lstinputlisting[style=genericLN,language=TeX]{\skbfileroot{examples/skbfigure}} + +Let's start with the easy usage, simply using the one argument to load a figure, +as shown in line 1. +This call will simply use \cmd{\includegraphics} and \cmd{\resizebox} to load the figure +\skbem[code]{myfig} from the figure directory, so we do not need to say +\skbem[code]{../figures} anymore. To use the figure and the center environment, we simply +add two options requesting exactly that, as shown in line 2. +In other words, using the option \skbem[code]{figure} will put the \skbem[code]{myfig} in +a figure environment and using the option \skbem[code]{center} will center the figure. + +Similar for width and height information. Say the figure should be rescaled to the width +of the text in your document you simply add width to the options, as shown in line 3 +Use \skbem[code]{height} for height or both options if required. Note that the width and +the hight are automatically applied to the \cmd{\resizebox} and \cmd{\includegraphics}. +You can also add caption and label information using the respective options (lines 4 and 5). +Now we will have the same result as the classi \LaTeX~example. You can also add the +required position for your figure, if using the figure environment applying the option +\skbem[code]{position} with the usual paramters, including \skbem[code]{H} from the float +environment. + +\opt{text}{ + \begin{table}[ht!] + \caption{Options for skbfigure} + \label{tab:skbfigure:options} + \begin{tabular*}{\textwidth}{ >{\small}p{.2\textwidth} >{\small}p{.75\textwidth}} + \toprule + \textbf{Option} & \textbf{Description} \\ + \midrule + \skbinput[from=rep]{manual/skbfigure-opt-table} + \bottomrule + \end{tabular*} + \end{table} +} + +\opt{text}{\skbinput[from=rep]{manual/figures2}}
\ No newline at end of file diff --git a/Master/texmf-dist/doc/latex/skb/user-guide/repository/manual/figures2.tex b/Master/texmf-dist/doc/latex/skb/user-guide/repository/manual/figures2.tex new file mode 100644 index 00000000000..a67bd05fa5b --- /dev/null +++ b/Master/texmf-dist/doc/latex/skb/user-guide/repository/manual/figures2.tex @@ -0,0 +1,16 @@ +\opt{note}{\skbheading{Figures, Multiinclude}} + +The last option for the macro \cmd{\skbfigure} is called \skbem[code]{multiinclude}. +It can be used with the beamer package to realise animations by loading a series of +images and showing them in sequence with or without overlaying. If used, this +option will overwrite all other options resulting in a simple call to +\cmd{multiinclude} within a resised box. One can use all standard multiinclude +paramters with \cmd{\skbfigure}, just omit the enclosing brackets. For instance, if you +want to use multiinclude on the \skbem[code]{myfig} with the options \skbem[code]{<+->} call +\begin{lstlisting} + \skbfigure[multiinclude=+-]{myfig} +\end{lstlisting} + +The figure size will be automatically set to \cmd{\textwidth} and the height to \skbem[code]{!}. +The start of the multiinclude is fixed to be 0, the format is PDF. For more informatio on how to +use multiinclude please refer to mpmulti and beamer packages.
\ No newline at end of file diff --git a/Master/texmf-dist/doc/latex/skb/user-guide/repository/manual/headings-and-files.tex b/Master/texmf-dist/doc/latex/skb/user-guide/repository/manual/headings-and-files.tex new file mode 100644 index 00000000000..493786d965e --- /dev/null +++ b/Master/texmf-dist/doc/latex/skb/user-guide/repository/manual/headings-and-files.tex @@ -0,0 +1,70 @@ +\skbheading{Files and Headings} + +\DescribeMacro{\skbinput} +\DescribeMacro{\skbheading} +Just to remember: we have two different types of files in two +different directory structures. The repository folder stores the +content and the publish folder stores everything needed to produce +complete documents. For the content in the repository, we mark headings +with the macro \cmd{\skbheading}. This macro has no options and no arguments +and is simply called with the text for the heading, as shown in +\opt{text}{the following example.}\opt{note}{the first block on this slide.} + +\opt{text}{ + \lstinputlisting[style=generic,language=TeX]{\skbfileroot{examples/skbheading}} +} + +Leaving the argument empty will have the same effect as calling the original \LaTeX~ +macros directly with an empty argument. + +The association of a \LaTeX~document level with the heading is then defined +for the published documents (in the publish folder) using the macro \cmd{\skbinput}. +This macro provides a number of options and requires one argument. +\opt{text}{The follwing examples}\opt{note}{The second block on this slide} shows +a few use cases for \cmd{\skbinput}. +\opt{text}{For all possible options, please see \autoref{tab:skbinput:options}} + +\opt{text}{ + \lstinputlisting[style=genericLN,language=TeX]{\skbfileroot{examples/skbinput}} +} + +\opt{text}{ + \begin{table}[ht!] + \caption{Options for skbinput} + \label{tab:skbinput:options} + \begin{tabular*}{\textwidth}{ >{\small}p{.1\textwidth} >{\small}p{.40\textwidth} >{\small}p{.40\textwidth}} + \toprule + \textbf{Option} & \textbf{Description} & \textbf{Values} \\ + \midrule + \skbinput[from=rep]{manual/skbinput-opt-table} + \bottomrule + \end{tabular*} + \end{table} +} + +Let's start with the simpliest form, one argument only shown in line 1. +The macro will look for a file called myfile.tex in the root directory of the \SKB. +The file extension .tex is automatically added, and since we did not specify any +special directory the root directory is used instead. +If the file is not found, the macro will throw an error providing the full path and filename it +did try to load. + +Line 2 shows how we can load the file \skbem[code]{myfile.tex} from the repository folder. +As you can see, the option \skbem[code]{from} is supplied with the argument \skbem[code]{rep}, +which in fact directs the macro to look for \skbem[code]{myfile.tex} in the repository folder. +Should the file be located in the folder for published documents, we simply change the +\skbem[code]{from} option to \skbem[code]{pub} as shown in line 3. + +If \skbem[code]{from} is used and neither \skbem[code]{pub} nor \skbem[code]{rep} is given, the macro will trow an error. + +To associate a document level for the heading, we can use the option \skbem[code]{level} to define which +level we want. This option understands all standard document levels from the memoir package: book, part, +title, chapter, section, subsection and subsubsection. So, if we want to load myfile.tex as a chapter +we simple invoke \cmd{\skbinput} as shown in line 4 of the example. + +Since myfile.tex is part of the repository, +we combine the two options \skbem[code]{from} and \skbem[code]{level} (see line 5). +This call to \cmd{\input} will load \skbem[code]{myfile.tex} from the repository and use \cmd{\chapter} for +the heading found in that file. If \skbem[code]{myfile.tex} is in a sub folder, we simply add that sub folder to +the filename. An example is shown in line 6 assuming the the file is located in the repository sub-folder +examples. diff --git a/Master/texmf-dist/doc/latex/skb/user-guide/repository/manual/listing.tex b/Master/texmf-dist/doc/latex/skb/user-guide/repository/manual/listing.tex new file mode 100644 index 00000000000..8a801e4f6e1 --- /dev/null +++ b/Master/texmf-dist/doc/latex/skb/user-guide/repository/manual/listing.tex @@ -0,0 +1,18 @@ +\skbheading{Listings Styles and Support} + +The \SKB~comes with a few predefined styles for the listing package. +Most of them use type writer font in scriptsize, arrange a grey +box around the listing and set the keywords to Blue4. +\begin{skbnotelist} + \item generic -- for any generic listing without specifying a language and no line numbers. + \item genericLN -- same as generic, just with line number in the left side, which means allowing extra space left to the listing box. + \item gentab -- almost the same as generic, but without definitions for frame and numbers, which seem to collide with some table environments. + \item genericLNspecial -- same as genericLN, just with a lighter grey for the box. + \item beamer-example -- style designed for examples in beamer frames. + \item beamer-exampleLN -- same as beamer-example, just with line numbers on the left, which means allowing extra space left to the listing box. + \item javaCode -- generic style plus lanugage Java. +\end{skbnotelist} + +\DescribeMacro{\lstdefinestyle} +There is also one macro supported, which sets the listing style back to normal, i.e. after changing it in the text. Some macros +in the \SKB~ make use of this. All that \cmd{\lstdefinestyle} does is setting the basic style back to type writer font.
\ No newline at end of file diff --git a/Master/texmf-dist/doc/latex/skb/user-guide/repository/manual/lists.tex b/Master/texmf-dist/doc/latex/skb/user-guide/repository/manual/lists.tex new file mode 100644 index 00000000000..f138482750a --- /dev/null +++ b/Master/texmf-dist/doc/latex/skb/user-guide/repository/manual/lists.tex @@ -0,0 +1,39 @@ +\skbheading{Environments for lists and enumerates} + +\DescribeMacro{\skbnotelist} +\DescribeMacro{\skbnoteenum} +These two environments mimic the macro \cmd{\tightlists} from the memoir package. It might be +usefull when not using memoir to minimise the margin between items in lists (iemize) and enumerations +(enumerate). + +Both environments do the following: +\begin{skbnotelist} + \item Store current value of \cmd{\parskip} and \cmd{\itemsep}. + \item Set \cmd{\parskip} and \cmd{\itemsep} to \skbem[code]{0cm}. + \item Use the original environments (itemize for skbnotelist and enumerate for skbnoteenum) + \item Set \cmd{\parskip} and \cmd{\itemsep} back to thir original value. +\end{skbnotelist} + +Here is an example using first the classic list environment (itemize) and then the \SKB macro +\cmd{skbnotelist} +\footnote{For those who are interested, the `Lorem Ipsum' is the standard phrase commonly used since the 1500s.} +\footnote{The following examples might have no effect on annotated slides...} +: +\setlength{\parskip}{4.5pt} +\setlength{\itemsep}{4.5pt} +\begin{itemize} + \item Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. + \item Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. + \item Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. + \item Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. +\end{itemize} + +\noindent Now list with \cmd{\skbnotelist}: +\begin{skbnotelist} + \item Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. + \item Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. + \item Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. + \item Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. +\end{skbnotelist} + +Note: both macros will only change the margins of the memoir package is not loaded!
\ No newline at end of file diff --git a/Master/texmf-dist/doc/latex/skb/user-guide/repository/manual/manual.tex b/Master/texmf-dist/doc/latex/skb/user-guide/repository/manual/manual.tex new file mode 100644 index 00000000000..33bbbd28127 --- /dev/null +++ b/Master/texmf-dist/doc/latex/skb/user-guide/repository/manual/manual.tex @@ -0,0 +1,32 @@ +\skbheading{User Manual} + +The \SKB~provides macros that simplify file handling and hide some \LaTeX~ +code (i.e. for figures) from the user, thus helping everyone to focus on +the actual document one wants to write. There are a few macros, and they +can be catagorised as follows. +\begin{skbnotelist} + \item Files and Headings: \cmd{\skbinput} and \cmd{\skbheading} are used + to load files and manage the headings of documents, i.e. associating + a heading with a level in the document structure (section, subsection, etc.) + \item Figures: \cmd{\skbfigure} is your Swiss Army knife for loading figures and + graphics. + + + \item Path and filenames - these macros provide direct access to \SKB-managed + paths and filenames. + \item Input files - here we have a few macros that load .tex files, figures, slides and + slide annotations. + \item Emphasising text - some macros that deal with typesetting text in different ways to + emphasise that text from the surrounding paragraph. + \item List styles - \SKB~specific environments adding specific behaviour to lists and enumerate + environments. + \item Listings - basically a few pre-defined styles for using the listing environment. + \item PDF Info - some macros that help to set meta information in PDF documents. + \item Acronyms - some macros that help to load the acronym database and more. + \item \BibTeX - one macro that loads bibliographic information. +\end{skbnotelist} + +For the impatient, we start with a few examples. The first one shows how to use the \SKB~to +produce a simple article. The second one exmplains how the documentation for the \SKB~is +created using most of the \SKB~macros. Then we detail the usage of all the macros, following +the above introduced categorisation.
\ No newline at end of file diff --git a/Master/texmf-dist/doc/latex/skb/user-guide/repository/manual/optional-text.tex b/Master/texmf-dist/doc/latex/skb/user-guide/repository/manual/optional-text.tex new file mode 100644 index 00000000000..717d4273c58 --- /dev/null +++ b/Master/texmf-dist/doc/latex/skb/user-guide/repository/manual/optional-text.tex @@ -0,0 +1,27 @@ +\skbheading{Optional Text -- Versions and Optional} + +The \SKB~provides two means to include text and other \LaTeX commands on an otional +basis. They are pre-configured and will be automatically set/unset according to the +three main document types the \SKB~supports: +\begin{skbnotelist} + \item text -- is equivalent to any classic text document, for instance an article or a book. + \item slide -- is used to idenify slides, for instance beamer frames. + \item note -- is used to identify lecture notes or handouts, in essence annotated slides (frames). + \item anim -- for beamer frames, used for text with animation activated. + \item noanim -- for beamer frames, used for text with animation deactivated. + \item memoir -- used for documents that include the memoir package. +\end{skbnotelist} + +We use the packages versions and optional and support both. The main difference is that with versions +one has to use \cmd{\beging} and \cmd{\end} while with optional one can use more than one of the above +introduced types. The macros for provided for optional text are: +\begin{skbnotelist} + \item \cmd{\skbmodetext} and options using \skbem[code]{text} -- will be valid if neither beamer nor beamerarticle is loaded (normal text). + \item \cmd{\skbmodeslide} and options using \skbem[code]{slide} -- will be valid if the beamer package is loaded (slides). + \item \cmd{\skbmodenote} and options using \skbem[code]{note} -- will be valid if the beamerarticle package is loaded (annotated slides). + \item \cmd{\skbmodeanim} and options using \skbem[code]{anim} -- will be valid if the beamer package is loaded and the \SKB~is loaded with the argument \skbem[code]{beameranim} + \item \cmd{\skbmodenoanim} and options using \skbem[code]{noanim} -- will be valid if the beamer package is loaded and the \SKB~is loaded with the argument \skbem[code]{beamernoanim} + \item \cmd{\skbmodememoir} and options using \skbem[code]{memoir} -- will be valid if the memoir package is loaded +\end{skbnotelist} + +\opt{text}{The following code}\opt{note}{This slide} shows a few examples on how to use the optional text.
\ No newline at end of file diff --git a/Master/texmf-dist/doc/latex/skb/user-guide/repository/manual/path-commands.tex b/Master/texmf-dist/doc/latex/skb/user-guide/repository/manual/path-commands.tex new file mode 100644 index 00000000000..a17958229ad --- /dev/null +++ b/Master/texmf-dist/doc/latex/skb/user-guide/repository/manual/path-commands.tex @@ -0,0 +1,26 @@ +\skbheading{Path and File Names} + +\DescribeMacro{\skbfileroot} +\DescribeMacro{\skbpathroot} +\DescribeMacro{\skbfileacr} +\DescribeMacro{\skbfilebib} +\DescribeMacro{\skbpathbib} +\DescribeMacro{\skbfilerep} +\DescribeMacro{\skbfilepub} +\DescribeMacro{\skbfilefig} +\DescribeMacro{\skbfilesli} +The \SKB~provides a number of macros to directly create path and file names. Most of +these macros are actually used within the \SKB~, but they might also be useful for +users to access files without using the provided specialised macros (such as \cmd{\skbinput}. +The following macros are provided: +\begin{skbnotelist} + \item \cmd{\skbpathroot} -- returns the set root path of the \SKB~. + \item \cmd{\skbfileroot} -- returns the set root path and adds \skbem[code]{/#1}, i.e. the directory separator and the argument provided. + \item \cmd{\skbfileacr} -- returns the path (including root) and file name for the acronym database. + \item \cmd{\skbfilebib} -- returns the path (including root) and file name for the file that loads the reference database (\BibTeX). + \item \cmd{\skbpathbib} -- returns the path (including root) to the reference database. + \item \cmd{\skbfilerep} -- returns the path to the repository and adds \skbem[code]{/#1}, i.e. the directory separator and the argument provided. + \item \cmd{\skbfilepub} -- returns the path to the folder with the published documents and adds \skbem[code]{/#1}, i.e. the directory separator and the argument provided. + \item \cmd{\skbfilefig} -- returns the path to the figure folder and adds \skbem[code]{/#1}, i.e. the directory separator and the argument provided. + \item \cmd{\skbfilesli} -- returns the path to the slide folder and adds \skbem[code]{/#1}, i.e. the directory separator and the argument provided. +\end{skbnotelist} diff --git a/Master/texmf-dist/doc/latex/skb/user-guide/repository/manual/pdfinfo.tex b/Master/texmf-dist/doc/latex/skb/user-guide/repository/manual/pdfinfo.tex new file mode 100644 index 00000000000..ba6f8c7664f --- /dev/null +++ b/Master/texmf-dist/doc/latex/skb/user-guide/repository/manual/pdfinfo.tex @@ -0,0 +1,19 @@ +\skbheading{Macros for PDF Info} + +\DescribeMacro{\skbtitle} +The macro \cmd{\skbtitle} will set the title to be used for PDF info. The default for the title is an empty string. + +\DescribeMacro{\skbauthor} +The macro \cmd{\skbauthor} will set the author information to be used for PDF info. The default for the author is an empty string. + +\DescribeMacro{\skbsubject} +The macro \cmd{\skbsubject} will set the subject information to be used for PDF info. The default for the subject is an empty string. + +\DescribeMacro{\skbkeywords} +The macro \cmd{\skbkeywords} will set the keywords to be used for PDF info. The default for the keywords is an empty string. + +\DescribeMacro{\skbpdfinfo} +The macro \cmd{skbpdfinfo} will call the macro \cmd{\pdfinfo} to set the meta information +in the created PDF output file. The \SKB~automatically calls this macro just before finishing +the process of the main document, using the information provided by the above described macros. +Furthermore, the date of the PDF file will be set. diff --git a/Master/texmf-dist/doc/latex/skb/user-guide/repository/manual/skbem.tex b/Master/texmf-dist/doc/latex/skb/user-guide/repository/manual/skbem.tex new file mode 100644 index 00000000000..afa0697c461 --- /dev/null +++ b/Master/texmf-dist/doc/latex/skb/user-guide/repository/manual/skbem.tex @@ -0,0 +1,26 @@ +\skbheading{Emphasising Text} + +\DescribeMacro{\skbem} +Highlighting or emphasising text is an important aspect of many technical documents. One can use +\LaTeX macros directly to set text in italic or bold. This has the disadvantage that there is no +meaningful information given as on why that text is treated in a special way. Furthermore, when +the editor requires to change certain highlights, it will be very difficult to go through a large +document and figure out which text is to be changed. + +To prevent that from happening, one can use \LaTeX macros to actually distignguish between different +highlighted text. A simple start is provided by the \SKB. It is simply because, at the moment, it +only supports three different ways and no furhter meaningful information. But it is a start. + +The macro \cmd{\skbem} comes with three different options. The option \skbem[code]{bold} will set the +text given in the argument in bold face. Similar, the option \skbem[code]{italic} will set it italic. +Last not least, the option \skbem[code]{code} will use another \SKB~macro (\cmd{\skbcode}) for typesetting +the argument text. \opt{note}{This slide shows a few examples along with the resulting type setting}% +\opt{text}{The following code shows some examples for the macro: \lstinputlisting[style=generic,language=TeX]{\skbfileroot{examples/skbem}}}% +\opt{text}{And here the tinal type setting of that example: + +\skbinput{examples/skbem}}% + +\opt{note}{\skbheading{skbcode}} +\DescribeMacro{\skbcode} +This macro \cmd{\skbcode} is a facade for calling the macro \cmd{lstinline} from the listing package with a basic style that +uses type writer font (ttfamily).
\ No newline at end of file diff --git a/Master/texmf-dist/doc/latex/skb/user-guide/repository/manual/skbfigure-opt-table.tex b/Master/texmf-dist/doc/latex/skb/user-guide/repository/manual/skbfigure-opt-table.tex new file mode 100644 index 00000000000..a4d99c65d76 --- /dev/null +++ b/Master/texmf-dist/doc/latex/skb/user-guide/repository/manual/skbfigure-opt-table.tex @@ -0,0 +1,30 @@ + \skbem[code]{width} & Set the width to be used with \cmd{resizebox} and \cmd{includegraphics}. + \\ + + \midrule + \skbem[code]{height} & Set the height to be used with \cmd{resizebox} and \cmd{includegraphics}. + \\ + + \midrule + \skbem[code]{center} & Use center environment. + \\ + + \midrule + \skbem[code]{figure} & Use figure environment. + \\ + + \midrule + \skbem[code]{position} & The position to be used within figure environment. This option will be ignored if not combined with \skbem[code]{figure}. + \\ + + \midrule + \skbem[code]{caption} & The caption to be used. Ignored if the option \skbem[code]{figure} is not used. + \\ + + \midrule + \skbem[code]{label} & The label to be used. Ignored if the option \skbem[code]{figure} is not used. + \\ + + \midrule + \skbem[code]{multiinclide} & The label to be used. Ignored if the option \skbem[code]{figure} is not used. + \\
\ No newline at end of file diff --git a/Master/texmf-dist/doc/latex/skb/user-guide/repository/manual/skbinput-opt-table.tex b/Master/texmf-dist/doc/latex/skb/user-guide/repository/manual/skbinput-opt-table.tex new file mode 100644 index 00000000000..de145e818d2 --- /dev/null +++ b/Master/texmf-dist/doc/latex/skb/user-guide/repository/manual/skbinput-opt-table.tex @@ -0,0 +1,9 @@ + \skbem[code]{from} & Set the directory from where the file should be loaded. + & \skbem[code]{pub}, \skbem[code]{rep}, \skbem[code]{fig}, \skbem[code]{sli} + \\ + + \midrule + \skbem[code]{level} & Set the document level to be used for the next occurance of \cmd{\skbheading} + & \skbem[code]{book}, \skbem[code]{part}, \skbem[code]{title}, \skbem[code]{chapter}, + \skbem[code]{section}, \skbem[code]{subsection}, \skbem[code]{subsubsection} + \\ diff --git a/Master/texmf-dist/doc/latex/skb/user-guide/repository/manual/slides.tex b/Master/texmf-dist/doc/latex/skb/user-guide/repository/manual/slides.tex new file mode 100644 index 00000000000..28fd83db9dc --- /dev/null +++ b/Master/texmf-dist/doc/latex/skb/user-guide/repository/manual/slides.tex @@ -0,0 +1,34 @@ +\skbheading{Slides} + +\DescribeMacro{\skbslide} +This macro helps to create lecture notes (handouts) using PDF slides and \LaTeX~notes +without using the beamer package. The reason for adding this to the \SKB~ was to integrate +slides from sources outside the \LaTeX~universe (i.e. Microsoft Powerpoint). Some of my +presentations are done using Powerpoint, but for handouts I do prefer using \LaTeX~thus +benefiting from many of the automated features it provides (references, acronyms). As a nice +side effect, the output generated is scalable (assuming that the PDF sources of the slides +contain scalable images rather than bitmaps, which can be easily realised using for instance +Inkscape's EMF export within Microsoft Powerpoint slides). + +The macro \cmd{\skbslide} +provides all means to include PDF slides with or without annotations, annotations only and +it can load the annotations using different mechanisms. +The macro offers two options to set the input +path for the slides and the annotations: \skbem[code]{slidefrom} and \skbem[code]{notefrom}. +If \skbem[code]{slidefrom} is used, then the slide (PDF) file will be loaded from the requested path (\skbem[code]{sli}, \skbem[code]{rep} or \skbem[code]{pub}). +If \skbem[code]{notefrom} is used, then the annotation (TEX) file will be loaded from the requested path (\skbem[code]{sli}, \skbem[code]{rep} or \skbem[code]{pub}). +The default path for slides and annotations is the path for slides. + +The third option \skbem[code]{annotate} requests to load annotations. If not used, no annotations will be loaded. It can be used in +combination with the two arguments to automated loading annotations. + +The two arguments of this macro define the files for the slide and the annotation. They can be used as followes: +\begin{skbnotelist} + \item Argument 1 is the slide to be loaded. If a name if given, we load the PDF using \cmd{\inputgraphics} with width being \cmd{\textwidth}. If no + name is given, no slide will be loaded. + \item Argument 2 is the file with the annotations in combination with the option \skbem[code]{annotate}. If this option is not used then + no annotations will be loaded. If the option is used and no name is given, then the annotation is loaded from a file with the + same name as the slide plus the extension \skbem[code]{.tex}. If this option is used and a name is given then this file will be loaded. +\end{skbnotelist} + +\opt{text}{\skbinput[from=rep]{manual/slides2}}
\ No newline at end of file diff --git a/Master/texmf-dist/doc/latex/skb/user-guide/repository/manual/slides2.tex b/Master/texmf-dist/doc/latex/skb/user-guide/repository/manual/slides2.tex new file mode 100644 index 00000000000..d66933cea58 --- /dev/null +++ b/Master/texmf-dist/doc/latex/skb/user-guide/repository/manual/slides2.tex @@ -0,0 +1,29 @@ +This provides the following combinations for \cmd{\skbslide} +\begin{skbnotelist} + \item Slide only: argument 1 has the name for the PDF, argument 2 is empty + \item Annotation only: argument 1 is empty, argument 2 has the name for the TEX, option \skbem[code]{annotate} used + \item Slide with Annotation 1: argument 1 has the name for the PDF, argument 2 has the name for the TEX, option \skbem[code]{annotate} used + \item Slide with Annotation 2: argument 1 has the name for the PDF, argument is empty, option \skbem[code]{annotate} used + \item do nothing: leave both arguments empty +\end{skbnotelist} + +\opt{not}{This slide show a few examples.}% +\opt{text}{\noindent Some examples on how to use \cmd{\skbslide:} \lstinputlisting[style=genericLN,language=TeX]{\skbfileroot{examples/skbslide}}}% +In line 1 and 2 we load \skbem[code]{myslides/slide1.pdf} and \skbem[code]{myslides/slide2.pdf} +from the default directory without any annotations and clear the page after that. In line 3 we load \skbem[code]{myslides/slide2.pdf} and request this slide to +be annotated without giving a specific file name, thus loading \skbem[code]{myslides/slide3.tex}, both files from the default slides directory. +In lines 4\&5 we change the directory for the notes and request a particular file to be loaded, resulting in the slide loaded as \skbem[code]{myslides/theme1.pdf} from the +slides directory and the annotations loaded as \skbem[code]{text/theme1.tex} from the repository. Finally, in lines 6\&7 we change both folders to the repository, this loading +\skbem[code]{text/theme2.pdf} and \skbem[code]{text/theme2.tex} from the repository. + + +\opt{note}{\skbheading{Slides and Citations}} + +\DescribeMacro{\skbslidecite} +The macro \cmd{\skbslidecite} provides some simple means to add citations to annotated slides. +It takes two arguments, the first one for the type of citation and the second one for the actual citation. +\opt{text}{Here a simple example:}\opt{note}{This second block on this slide shows a simple example.} +\opt{text}{\lstinputlisting[style=genericLN,language=TeX]{\skbfileroot{examples/skbslidecite}}}% +The first line states that the slide contains material from a book of Tannenbaum and the second line +states that the annotation contains material from an IETF RFC standard documents (RFC 1155). Since this +macro is very simple, any content can be given for the two arguments.
\ No newline at end of file diff --git a/Master/texmf-dist/doc/latex/skb/user-guide/repository/separate/separate-cs.tex b/Master/texmf-dist/doc/latex/skb/user-guide/repository/separate/separate-cs.tex new file mode 100644 index 00000000000..69928632346 --- /dev/null +++ b/Master/texmf-dist/doc/latex/skb/user-guide/repository/separate/separate-cs.tex @@ -0,0 +1,40 @@ +\skbheading{Separate Content from Structure: the Repository Folder} + +Now, separating the structure from the content first. The structure of a +document (we stay with classic text documents like articles, books, etc. +for a while) is words in sentences in paragraphs in (sub-) sections in +chapters (if its a book, of not only sections)\footnote{One very +meticulous person might add 'characters' and mention that there are more +ways to think about a document's structure. But that person is not me. The +structure I used fits the purpose (as of now), if it doesn't anymore I +will look further.}. We collect sentences and paragraphs but separate them +from headings. \LaTeX is doing that already with the macros for chapters and +sections. We go one step further and provide a generic way to identify a +heading with the \SKB~macro \cmd{\setheading}. This allows to select the appropriate +\LaTeX heading level at a later stage having the context of that later stage in mind +(i.e. it might be a section in an article but a chapter in a book). Now we create +a structure for the resulting files in our repository, adding meaningful names to +the directories and files. Obviously the names of these folders should provide some +idea about the general characterisation of the files they contain. Example? Well, if you collect +information from Standard Defining Organisations (SDOs) the top folder +could be named \skbem[code]{sdo} and the sub-folders using the +respective SDO acronyms, such as \skbem[code]{omg} for the OMG and +\skbem[code]{ieee} for the IEEE and \skbem[code]{ietf} for the IETF. We put all this in +a folder named repository, making it explicit that here is were we find all our normative content. +\opt{text}{The following example}\opt{note}{This slide} shows how that looks like. + +\opt{text}{ + \begin{longtable}{|>{}p{0.945\textwidth} >{}p{1pt}|} + \hline + \rowcolor[gray]{.9} + \skbinput[from=fig]{dirtree/repository} + & \\ + \hline + \end{longtable} + \addtocounter{table}{-1} +} + +The result: we have a structure of files, containing our 'stuff', +integrated in a structure of folders that allows us to find it (the better +this structure the more helpful it is, and remember this is a 'personal' +repository, so your personal flavour is king).
\ No newline at end of file diff --git a/Master/texmf-dist/doc/latex/skb/user-guide/repository/separate/separate-final.tex b/Master/texmf-dist/doc/latex/skb/user-guide/repository/separate/separate-final.tex new file mode 100644 index 00000000000..caad6a5d4f9 --- /dev/null +++ b/Master/texmf-dist/doc/latex/skb/user-guide/repository/separate/separate-final.tex @@ -0,0 +1,11 @@ +\skbheading{The Final Directory Structure} + +As this is the final and complete root directory of our repository: +\begin{longtable}{|>{}p{0.945\textwidth} >{}p{1pt}|} + \hline + \rowcolor[gray]{.9} + \skbinput[from=fig]{dirtree/complete} + & \\ + \hline +\end{longtable} +\addtocounter{table}{-1}
\ No newline at end of file diff --git a/Master/texmf-dist/doc/latex/skb/user-guide/repository/separate/separate-parts-baf.tex b/Master/texmf-dist/doc/latex/skb/user-guide/repository/separate/separate-parts-baf.tex new file mode 100644 index 00000000000..68b70195a31 --- /dev/null +++ b/Master/texmf-dist/doc/latex/skb/user-guide/repository/separate/separate-parts-baf.tex @@ -0,0 +1,55 @@ +\skbheading{Bibliography, Acronyms and Figures} + +So the combination of \LaTeX and \BibTeX already helps us for this separation. +Using the acronym package, we can extend this to acronyms. Looking into the highly +common re-use of figures, we should look into this as well. Let's take the organisation +of bibliographic information as a template. I store them using \BibTeX and process them +with the biblatex package (but that is not critical for now). My \BibTeX database is in +a special folder (we can call it \skbem[code]{references} for the moment) and it uses +a file structure that helps me to find information. This structure is based on the \BibTeX +and biblatex classification, i.e. inproceedings, article, book, thesis, standard, etc. + +Now, I can do the same for figures: put them into a special folder (we can call it +\skbem[code]{figures} for the moment), which contains the source of the figures and the +generated formats I need for my documents (usually PDF, some PNG). Now I can reference these +figures from the repository as well as for other use cases, such as web publishing or +presentations\footnote{My figures are exclusively in SVG using inkscape (www.inkscape.org). +This has the advantage of a standardised, text-based format with many export options. All my +figures are in a single root folder, structured very similar to the +document folders created above, but separated from it. This makes re-use of figures very easy.}. + +Last not least, the \skbem[code]{acronym} package +allows for an automatic handling of acronyms, including list of acronyms. +It is very similar to {\scshape Bib\TeX} in that it will only show the +acronyms used in a document out of a (potentially large) database. + +One might also want to create other specific structures, such as for programming code. Dont' +stop yourself, it's easier to combine things later (if the separation is not effective) than +to separate things that are hugely integrated into each other. For one of my internal projects, +a parser generation environment based on ANTLR, I created a special folder for the EBNF specifications +along with railroad diagrams. Now I can use them in my book and my papers. + +Now we name the folders for the separated content. This is straight forward, although you might want +to use different names (don't worry, the skb supports that). We add to the already created repository +folder the things we need for figures (\skbem[code]{figures}) and combine acronyms and \BibTeX in a +folder called \skbem[code]{database}, separating the data from all other content~\footnote{Now, the +reason for the database folder and it's structure +is that the whole \SKB~contains more databases, all of which reside here. If you want to simply apply this +to \LaTeX documents you might want to use a different strutural approach.}.% +\opt{note}{This slide shows the resulting directory structure}% +\opt{text}{ + Now the directory structure looks like this: + \begin{longtable}{|>{}p{0.945\textwidth} >{}p{1pt}|} + \hline + \rowcolor[gray]{.9} + \skbinput[from=fig]{dirtree/baf} + & \\ + \hline + \end{longtable} + \addtocounter{table}{-1} +} + +What did we do so far? We did separate the different parts of our +documents. The more clinical you are, the better the result will be. But +please note: separate as much as you should, not as you could. If you +don't find a reason for separating 'stuff', then don't do it!
\ No newline at end of file diff --git a/Master/texmf-dist/doc/latex/skb/user-guide/repository/separate/separate-parts-pc.tex b/Master/texmf-dist/doc/latex/skb/user-guide/repository/separate/separate-parts-pc.tex new file mode 100644 index 00000000000..4e1119290ed --- /dev/null +++ b/Master/texmf-dist/doc/latex/skb/user-guide/repository/separate/separate-parts-pc.tex @@ -0,0 +1,44 @@ +\opt{text}{\skbheading{Publications and Content}} +\opt{note}{\skbheading{Publications and Content, Part II}} + +Here is were it might get slightly more complicated than in the first few +steps. And you might see already that the reason for that is separation! +We didn't finish the separation, we have to go one step further. And that +means to separate now the contents (with the references and acronyms and +figures) from the reason to publish a document. This last step of +separation is more conceptual, being focused on the \textit{why?} and +\textit{where?} and \textit{how?} we publish, rather than being focused on +the \textit{what?} we publish. + +So we do publish for many reasons: articles for research, project +proposals, reports, lecture notes, standard documents, annotated +presentations, sometimes even books. We publish for a specific purpose, in +a specific (soon historic) context, using the requested format (and style +sheets) and a particular structure of our document that fits the purpose. +That means we organise and structure our content every time according to +these constrains. Thus we need a new directory structure for that, since +we will not reuse that as often as our 'stuff' itself. Remember, we use +the skb macro \cmd{\skbheading} for headings, not the classical \LaTeX macros +like \cmd{\section}, so our files effectively do not contain much information +about their place in the structure, only that they claim one +\footnote{Currently experimental, but soon to be ready, there will be an extension +to the \cmd{\skbheading} macro that allows a little bit more information to be put +in the repository files. For the moment this is captured in the \cmd{\skbheadingduc} macro.}. +This comes in handy now, since all we have actually to do is to assign a document heading +level to every repository file we load. Let's create a folder for the published documents and +call it \skbem[code]{published} with a set of sub-folders that help us to understand the general +context of the publication.% +\opt{note}{My directory structure is shown in this slide}% +\opt{text}{ +My directory structure could look like this: + \begin{longtable}{|>{}p{0.945\textwidth} >{}p{1pt}|} + \hline + \rowcolor[gray]{.9} + \skbinput[from=fig]{dirtree/publish} + & \\ + \hline + \end{longtable} + \addtocounter{table}{-1} +} + +\opt{text}{\skbinput[from=rep]{separate/separate-parts-pc2}}
\ No newline at end of file diff --git a/Master/texmf-dist/doc/latex/skb/user-guide/repository/separate/separate-parts-pc2.tex b/Master/texmf-dist/doc/latex/skb/user-guide/repository/separate/separate-parts-pc2.tex new file mode 100644 index 00000000000..4835a3ae736 --- /dev/null +++ b/Master/texmf-dist/doc/latex/skb/user-guide/repository/separate/separate-parts-pc2.tex @@ -0,0 +1,39 @@ +\opt{note}{\skbheading{Publications and Content, Part II}} + +We could, and it usually makes sense to do so, go one step further in that +separation. This time within the documents in the \skbem[code]{published} +folder. The reason is the structure of \LaTeX~documents: they do need some +commands specific to \LaTeX, which we don't necessarily want to mix with the +commands that input our content (the files from repository). +So it would make sense to have another pair of documents here, one +containing all \LaTeX~commands needed to create a document, and one +containing all the commands that include our content. Say we have a few +articles for state of the art discussions on \textit{naming}, +\textit{object-models} and \textit{protocols}, we could create +\opt{text}{the following structure}\opt{note}{the structure shown in this slide} +for the \skbem[code]{article} folder% +\opt{text}{:% + \begin{longtable}{|>{}p{0.945\textwidth} >{}p{1pt}|} + \hline + \rowcolor[gray]{.9} + \skbinput[from=fig]{dirtree/publish-art} + & \\ + \hline + \end{longtable} + \addtocounter{table}{-1} +} + +Now everything is structured, thus simple again. If we are looking for content, we go to the +\skbem[code]{repository} directory and the directory names help us to find what +we are looking for. If we need a figure, we do the same at the \skbem[code]{figures} directory. +\skbem[code]{acronyms} and \skbem[code]{bibtex} help with the respective +other content. If we want a specific published document, we simply check the +\skbem[code]{published} directory and will have a look into a +\skbem[code]{tex} sub-directory to see what content is include how. + +Good news, the separation is finished! What have we done? We have +separated the contents from the structure by creating, created a separate directory structure for +figures, another one for bibliographic data, one for acronyms and finally a +complete directory structure for published documents. Content and title +form a pair, include figure, use acronyms and references and are combined +in the published documents. At this point we can start calling it document repository.
\ No newline at end of file diff --git a/Master/texmf-dist/doc/latex/skb/user-guide/repository/separate/separate-parts.tex b/Master/texmf-dist/doc/latex/skb/user-guide/repository/separate/separate-parts.tex new file mode 100644 index 00000000000..ab4323b99c9 --- /dev/null +++ b/Master/texmf-dist/doc/latex/skb/user-guide/repository/separate/separate-parts.tex @@ -0,0 +1,6 @@ +\skbheading{Separating different Parts of a Document} + +The next step is to separate the remaining parts of a document based +on their semantics. You are probably doing that already if you +maintain a database for bibliographic information and have many of +your articles using it. But we can and should do much more than that.
\ No newline at end of file diff --git a/Master/texmf-dist/doc/latex/skb/user-guide/repository/separate/separate.tex b/Master/texmf-dist/doc/latex/skb/user-guide/repository/separate/separate.tex new file mode 100644 index 00000000000..a74073972c7 --- /dev/null +++ b/Master/texmf-dist/doc/latex/skb/user-guide/repository/separate/separate.tex @@ -0,0 +1,21 @@ +\skbheading{The Concept: Separate Things} + +You already got the idea that separation is important, reading about published documents and +a normative repository. The basic idea is: think separation -- separate as much as you can, but +not more. I know that this sounds like a strange idea when the goal is a unified repository, but it is +essential. So we separate several concerns (taking a concept of distributed system design). So if we +want to facilitate re-usability, we have to: +\begin{skbnoteenum} + \item separate content of a document from its structure and + \item separate the different parts of a document. +\end{skbnoteenum} + +For the impatient: +\begin{skbnoteenum} + \item Separating content from structure means to identify small, coherent blocks of information, i.e. + text describing a certain aspect or an example, and put them separated into the repository folder. + \item Separating parts of a document means to separate the part that is important for publishing from + the part that is important for the content and put them into different places (one in the publish + folder and the other one in the repository older). It also means to build a separate repository + for figures, since they could be used in many different small blocks of information. +\end{skbnoteenum}
\ No newline at end of file diff --git a/Master/texmf-dist/doc/latex/skb/user-guide/repository/story/long.tex b/Master/texmf-dist/doc/latex/skb/user-guide/repository/story/long.tex new file mode 100644 index 00000000000..081a16dd14d --- /dev/null +++ b/Master/texmf-dist/doc/latex/skb/user-guide/repository/story/long.tex @@ -0,0 +1,31 @@ +\opt{text}{\skbheading{The Long Story}} +\opt{note}{\skbheading{The Long Story, Part I}} + +Over several years of writing documents (articles, books, reports, standards, research proposals) +ideas and concepts became distributed (actually a euphemism for 'hidden') within many many documents +(in all sorts of formats) located at many many locations (such as local file system, document management +system, subversion/perforce systems, web servers, email clients). The problems associated to this situation +are manifold: +\begin{skbnotelist} + \item Ideas/concepts are hidden, often un-accessible and, as I experienced, search tools are of limited help. + \item The documents are written in all sorts of formats or available only in (usually proprietary) binary + formats. Ever tried to open a document written in MS WinWord 6.0 with customised document + template in a newer version of the same programme? You know then what I am talking about. + \item Reusing the ideas/concepts, once found in a document and managed to open that very document, + usually involves huge amount of re-formatting. This will produce mistakes. Ever tried to + use a {\scshape Bib}\TeX) generated reference list, found in a PDF file in a new article? + I found better ways to spend my nights and weekends (yes, I am married and I have a garden). + \item Over time, it can become very difficult to distinguish between different versions of a + document, concept and/or idea. As it happens in real life, things move on even in computing + and the related sciences. Documents are written for a specific historic context, which might + but often will not appear in their abstract (or the name of the folder their are stored in). + \item The above issues do apply to figures and presentations as much as to the text part of + documents. Reorganising my documents/figures/presentations I did find way too many duplicates. + I have used too many graphic software packages in the past 10 years which don't exist + anymore, or which do not run on the latest version of my preferred operating system. Some of + the figures are only available in some sort of low-resolution bitmap, rendering them useless + even for a non-peer-reviewed article today (the original source got 'lost', in most cases + because someone removed the project folder after the project was terminated). +\end{skbnotelist} + +\opt{text}{\skbinput[from=rep]{story/long2}}
\ No newline at end of file diff --git a/Master/texmf-dist/doc/latex/skb/user-guide/repository/story/long2.tex b/Master/texmf-dist/doc/latex/skb/user-guide/repository/story/long2.tex new file mode 100644 index 00000000000..60ddd759ea2 --- /dev/null +++ b/Master/texmf-dist/doc/latex/skb/user-guide/repository/story/long2.tex @@ -0,0 +1,29 @@ +\opt{note}{\skbheading{The Long Story, Part II}} + +A solution is to create a unified document repository, then use +this repository as 'normative source' to create documents for specific +purposes while leaving the text blocks, headings, figures, presentations, +references, acronyms and all other reusable 'stuff' in the repository for +the next document which might (hopefully will) benefit from them. This can +(did it for me already) safe a lot of time, demands archiving (of +published documents, thus creating a traceable history), helps to keep +important information updated (without jeopardising any other work) and +prevents losing any 'stuff'. + +The repository needs a few rules, a (customisable) structure but beside +that only a bit of effort to be maintained. To give an example: while +writing the first version of this article (May 11, 2009), I have moved 4 +lecture notes, 2 presentations, 1 book chapter, 1 book (in writing), 1 +textbook (for students, with 4 chapters) and 4 articles from my 'mess' +into my repository. This involved some re-formatting (plus the occasional +re-drawing) to bring the original sources into the target formats. At the +same time I did develop the rules of my repository, the structure and the +(mostly \LaTeX) code (and re-wrote/structured/ruled most of them a few +times). I ended up with 1,314 files in 87 folders, which create 9 articles, 2 +books, 1 textbook, 3 lecture notes and this document (note: the number of +articles increased, because I could re-assemble 'stuff' for new uses, +spending some five minutes per one new article). I did remove roughly 100 +pages of text (take the classic Spring LNCS format and you get the point +of the number of characters) and some 40 figures (all duplicates). I did +find way too many errors in the original sources (most of which have been +created by 're-using' them earlier from even more-original-sources). diff --git a/Master/texmf-dist/doc/latex/skb/user-guide/repository/story/short.tex b/Master/texmf-dist/doc/latex/skb/user-guide/repository/story/short.tex new file mode 100644 index 00000000000..26824e29408 --- /dev/null +++ b/Master/texmf-dist/doc/latex/skb/user-guide/repository/story/short.tex @@ -0,0 +1,31 @@ +\skbheading{The Short Story} + +I have written papers, done a lot of presentations, provided some book chapters, +still working on a book, participated in many research proposals and projects, and +created tons of notes and figures. As of early 2009, most of that information was +distributed over the repositories of different projects and organisations I worked +for, in some document management systems, on several websites, databases, my preferred +email client (which changed twice), different computers and later even different +external hard drives and USB sticks. Looking for specific text or a particular figure +could easily end in a days work. Tools like desktop search engines can help to find +'stuff'. I used them, but if they found anything it was hard to maintain the context +it was written in and some formats or sources were out of reach for them. Even worse +with figures and the many versions some of them evolved in over time. After multiple +jobs and several years, all I had is kind of a very messy base of knowledge, well-hidden +somewhere, thus very difficult to locate and impossible to maintain. + +So I started early 2009 to re-organise my 'stuff'. At the same time, I did realise that +moving away from \LaTeX was part of the problem (and I thought using the other text +processor would help, it actually didn't, long-term). So \LaTeX became, again, the +text processor of choice, and with it the ability for a complete different approach +to organise my 'stuff'. This was the moment the \SKB~was created. \SKB~stands for Sven's +Knowledge Base. The \LaTeX package \skbem[code]{skb}, described in this article, forms part of a larger +software system that uses SQLite databases, a small PHP framework, Apache for HTML access +and recently also a Java port. + +My document repository uses the \skbem[code]{skb} package, so most of my documents are eventually +\LaTeX documents. I am saying eventually because I still use other tools (like Microsoft's Powerpoint), +but integrate their output in my repository. I do all my figures these days using Inkscape, so the source +is SVG and the output for \LaTeX documents PDF. For editing the text files I do flip between UE Studio +and LeD. Parts of the content (such as acronyms and bibliographic information) are maintained in SQLite +databases and exported to \LaTeX. This package now shows how I build my documents.
\ No newline at end of file diff --git a/Master/texmf-dist/doc/latex/skb/user-guide/repository/title.tex b/Master/texmf-dist/doc/latex/skb/user-guide/repository/title.tex new file mode 100644 index 00000000000..7adbfcdcd60 --- /dev/null +++ b/Master/texmf-dist/doc/latex/skb/user-guide/repository/title.tex @@ -0,0 +1 @@ +\skbheading{The \SKB User Guide}
\ No newline at end of file diff --git a/Master/texmf-dist/doc/latex/skb/user-guide/slides/about.tex b/Master/texmf-dist/doc/latex/skb/user-guide/slides/about.tex new file mode 100644 index 00000000000..bcd75140c72 --- /dev/null +++ b/Master/texmf-dist/doc/latex/skb/user-guide/slides/about.tex @@ -0,0 +1,17 @@ +\mode +<presentation> + +\begin{frame}{The \LaTeX~\SKB~Package} + \label{about} + + \skbinput[from=rep]{abstract} +\end{frame} + +\mode +<article> + +\resizebox{\textwidth}{!}{\includeslide{about}} +\bigskip + +\mode +<all> diff --git a/Master/texmf-dist/doc/latex/skb/user-guide/slides/applicability.tex b/Master/texmf-dist/doc/latex/skb/user-guide/slides/applicability.tex new file mode 100644 index 00000000000..aa398b04b2c --- /dev/null +++ b/Master/texmf-dist/doc/latex/skb/user-guide/slides/applicability.tex @@ -0,0 +1,35 @@ +\mode +<presentation> + +\begin{frame}{Applicability and Side Effects} + \label{applicability} + + The \SKB~can be helpful if you + \begin{itemize} + \item Need to organise large amount of 'stuf' + \item Want to reorganise `stuff' + \item Plan to maintain a personal repository + \end{itemize} + + The \SKB~has side effects (and cannot do coffee for you either) + \begin{itemize} + \item Separating content from structure makes content (almost) context-free + \item Changes in content effect (potentially) multiple documents of different type + \item Versioning and change logging becomes (almost) impossible + \item Your style of writing documents might need to change + \item Cross-references between parts of `stuff' need to be used carefully + \end{itemize} +\end{frame} + + +\mode +<article> + +\resizebox{\textwidth}{!}{\includeslide{applicability}} +\bigskip + +\skbinput[from=rep]{applicability} +\clearpage + +\mode +<all> diff --git a/Master/texmf-dist/doc/latex/skb/user-guide/slides/example-art-tex1.tex b/Master/texmf-dist/doc/latex/skb/user-guide/slides/example-art-tex1.tex new file mode 100644 index 00000000000..e620f1e6f4c --- /dev/null +++ b/Master/texmf-dist/doc/latex/skb/user-guide/slides/example-art-tex1.tex @@ -0,0 +1,24 @@ +\mode +<presentation> + +\begin{frame}{An Example Article -- \TeX~code} + \label{example:art:tex1} + + \begin{example}[start of the tex file] + \lstinputlisting[style=beamer-example,language=TeX,firstline=1,lastline=8]{\skbfileroot{examples/example}} + \end{example} +\end{frame} + + + + +\mode +<article> + +\resizebox{\textwidth}{!}{\includeslide{example:art:tex1}} +\bigskip + +\skbinput[from=rep]{example-article} + +\mode +<all> diff --git a/Master/texmf-dist/doc/latex/skb/user-guide/slides/example-art-tex2.tex b/Master/texmf-dist/doc/latex/skb/user-guide/slides/example-art-tex2.tex new file mode 100644 index 00000000000..7555a42d765 --- /dev/null +++ b/Master/texmf-dist/doc/latex/skb/user-guide/slides/example-art-tex2.tex @@ -0,0 +1,25 @@ +\mode +<presentation> + +\begin{frame}{An Example Article -- \TeX~code} + \label{example:art:tex2} + + \begin{example}[loading inital text] + \lstinputlisting[style=beamer-example,language=TeX,firstline=10,lastline=10]{\skbfileroot{examples/example}} + \end{example} + + \begin{example}[a section called Introduction] + \lstinputlisting[style=beamer-example,language=TeX,firstline=12,lastline=20]{\skbfileroot{examples/example}} + \end{example} + +\end{frame} + + +\mode +<article> + +\resizebox{\textwidth}{!}{\includeslide{example:art:tex2}} +\bigskip + +\mode +<all> diff --git a/Master/texmf-dist/doc/latex/skb/user-guide/slides/example-art-tex3.tex b/Master/texmf-dist/doc/latex/skb/user-guide/slides/example-art-tex3.tex new file mode 100644 index 00000000000..b9bbfbf8f22 --- /dev/null +++ b/Master/texmf-dist/doc/latex/skb/user-guide/slides/example-art-tex3.tex @@ -0,0 +1,25 @@ +\mode +<presentation> + +\begin{frame}{An Example Article -- \TeX~code} + \label{example:art:tex3} + + \begin{example}[more sections] + \lstinputlisting[style=beamer-example,language=TeX,firstline=22,lastline=25]{\skbfileroot{examples/example}} + \end{example} + + \begin{example}[finishing the tex file] + \lstinputlisting[style=beamer-example,language=TeX,firstline=27]{\skbfileroot{examples/example}} + \end{example} + +\end{frame} + + +\mode +<article> + +\resizebox{\textwidth}{!}{\includeslide{example:art:tex3}} +\bigskip + +\mode +<all> diff --git a/Master/texmf-dist/doc/latex/skb/user-guide/slides/example-art-toc.tex b/Master/texmf-dist/doc/latex/skb/user-guide/slides/example-art-toc.tex new file mode 100644 index 00000000000..40541cd0d51 --- /dev/null +++ b/Master/texmf-dist/doc/latex/skb/user-guide/slides/example-art-toc.tex @@ -0,0 +1,19 @@ +\mode +<presentation> + +\begin{frame}{An Example Article -- The produced TOC} + \label{example:art:tex:toc} + + \begin{example} + \lstinputlisting[style=beamer-example]{\skbfileroot{examples/example-toc}} + \end{example} +\end{frame} + +\mode +<article> + +\resizebox{\textwidth}{!}{\includeslide{example:art:tex:toc}} +\bigskip + +\mode +<all> diff --git a/Master/texmf-dist/doc/latex/skb/user-guide/slides/intent.tex b/Master/texmf-dist/doc/latex/skb/user-guide/slides/intent.tex new file mode 100644 index 00000000000..2a8fef21d16 --- /dev/null +++ b/Master/texmf-dist/doc/latex/skb/user-guide/slides/intent.tex @@ -0,0 +1,26 @@ +\mode +<presentation> + +\begin{frame}{The Intent} + \label{intent} + + \begin{itemize} + \item Maintain repository for Long-living Documents using \LaTeX + \item Provide easy access to `stuff': text, figures, code examples, ... + \item Reuse `stuff' rather than copy'n paste it all the time + \item Allow easy creation of different documents using the same `stuff' + \item Limit \LaTeX specific code, simplify the interface between User and \LaTeX + \end{itemize} +\end{frame} + +\mode +<article> + +\resizebox{\textwidth}{!}{\includeslide{intent}} +\bigskip + +\skbinput[from=rep]{intent} +\clearpage + +\mode +<all> diff --git a/Master/texmf-dist/doc/latex/skb/user-guide/slides/manual-acrbib.tex b/Master/texmf-dist/doc/latex/skb/user-guide/slides/manual-acrbib.tex new file mode 100644 index 00000000000..3ef30dc400c --- /dev/null +++ b/Master/texmf-dist/doc/latex/skb/user-guide/slides/manual-acrbib.tex @@ -0,0 +1,35 @@ +\mode +<presentation> + +\begin{frame}{Acronyms and References} + \label{manual:acrbib} + + Load Acronym Database + \begin{itemize} + \item \cmd{\skbacronyms} will load the Acronymnym Database + \item Should be called right at the place you want to have the list of acronyms printed + \end{itemize} + + \bigskip + + Load References + \begin{itemize} + \item \cmd{\skbbibtex} will load the reference list + \item Should be called before starting with the document + \end{itemize} + +\end{frame} + + +\mode +<article> + +\resizebox{\textwidth}{!}{\includeslide{manual:acrbib}} +\bigskip + +\skbinput[from=rep]{manual/acr-bib} + +\clearpage + +\mode +<all> diff --git a/Master/texmf-dist/doc/latex/skb/user-guide/slides/manual-figures-opt.tex b/Master/texmf-dist/doc/latex/skb/user-guide/slides/manual-figures-opt.tex new file mode 100644 index 00000000000..3f633837324 --- /dev/null +++ b/Master/texmf-dist/doc/latex/skb/user-guide/slides/manual-figures-opt.tex @@ -0,0 +1,25 @@ +\mode +<presentation> + +\begin{frame}{Options for skbfigure} + \label{manual:figures:opt} + + \begin{tabular*}{\textwidth}{ >{\scriptsize}p{.18\textwidth} >{\scriptsize}p{.75\textwidth}} + \skbinput[from=rep]{manual/skbfigure-opt-table} + \end{tabular*} + +\end{frame} + + +\mode +<article> + +\resizebox{\textwidth}{!}{\includeslide{manual:figures:opt}} +\bigskip + +\skbinput[from=rep]{manual/figures2} + +\clearpage + +\mode +<all> diff --git a/Master/texmf-dist/doc/latex/skb/user-guide/slides/manual-figures.tex b/Master/texmf-dist/doc/latex/skb/user-guide/slides/manual-figures.tex new file mode 100644 index 00000000000..f00786d3f1f --- /dev/null +++ b/Master/texmf-dist/doc/latex/skb/user-guide/slides/manual-figures.tex @@ -0,0 +1,29 @@ +\mode +<presentation> + +\begin{frame}{Figures} + \label{manual:figures} + + \begin{block}{Classic \LaTeX~Example} + \lstinputlisting[style=beamer-example,language=TeX]{\skbfileroot{examples/figure-classic}} + \end{block} + + \begin{block}{\skbem[code]{skbfigure}} + \lstinputlisting[style=beamer-exampleLN,language=TeX]{\skbfileroot{examples/skbfigure}} + \end{block} + +\end{frame} + + +\mode +<article> + +\resizebox{\textwidth}{!}{\includeslide{manual:figures}} +\bigskip + +\skbinput[from=rep]{manual/figures} + +\clearpage + +\mode +<all> diff --git a/Master/texmf-dist/doc/latex/skb/user-guide/slides/manual-haf.tex b/Master/texmf-dist/doc/latex/skb/user-guide/slides/manual-haf.tex new file mode 100644 index 00000000000..92719dd456d --- /dev/null +++ b/Master/texmf-dist/doc/latex/skb/user-guide/slides/manual-haf.tex @@ -0,0 +1,37 @@ +\mode +<presentation> + +\begin{frame}{Headings and Files} + \label{manual:haf} + + \begin{block}{\skbem[code]{skbheading}} + \lstinputlisting[style=beamer-example,language=TeX]{\skbfileroot{examples/skbheading}} + \end{block} + + \begin{block}{\skbem[code]{skbinput}} + \lstinputlisting[style=beamer-exampleLN,language=TeX]{\skbfileroot{examples/skbinput}} + \end{block} + + \scriptsize{ + \begin{itemize} + \item\skbem[code]{from}: pub, rep, fig, sli + + \item\skbem[code]{level}: book, part, title, chapter, section, subsection, subsubsection + \end{itemize} + } + +\end{frame} + + +\mode +<article> + +\resizebox{\textwidth}{!}{\includeslide{manual:haf}} +\bigskip + +\skbinput[from=rep]{manual/headings-and-files} + +\clearpage + +\mode +<all> diff --git a/Master/texmf-dist/doc/latex/skb/user-guide/slides/manual-listings.tex b/Master/texmf-dist/doc/latex/skb/user-guide/slides/manual-listings.tex new file mode 100644 index 00000000000..f75ae1a21e5 --- /dev/null +++ b/Master/texmf-dist/doc/latex/skb/user-guide/slides/manual-listings.tex @@ -0,0 +1,36 @@ +\mode +<presentation> + +\begin{frame}{Styles and Support for Listings} + \label{manual:listing} + + \begin{itemize} + \item A few pre-defined styles provided + \item Most of them set a small type writer font + \item Some provide for line numbers + \item \cmd{\lstdefinestyle} used to reset style to basic parameters + \end{itemize} + + \begin{example}[use within normal text] + \lstinputlisting[style=beamer-example,language=TeX,lastline=2]{\skbfileroot{examples/listings}} + \end{example} + + \begin{example}[use for beamer frames] + \lstinputlisting[style=beamer-example,language=TeX,firstline=3]{\skbfileroot{examples/listings}} + \end{example} + +\end{frame} + + +\mode +<article> + +\resizebox{\textwidth}{!}{\includeslide{manual:listing}} +\bigskip + +\skbinput[from=rep]{manual/listing} + +\clearpage + +\mode +<all> diff --git a/Master/texmf-dist/doc/latex/skb/user-guide/slides/manual-lists.tex b/Master/texmf-dist/doc/latex/skb/user-guide/slides/manual-lists.tex new file mode 100644 index 00000000000..af6854f37e6 --- /dev/null +++ b/Master/texmf-dist/doc/latex/skb/user-guide/slides/manual-lists.tex @@ -0,0 +1,37 @@ +\mode +<presentation> + +\begin{frame}{Lists} + \label{manual:lists} + + Two new environments for lists + \begin{itemize} + \item \cmd{\skbnotelist} for replacing itemize + \item \cmd{\skbnoteenum} for replacing enumerate + \end{itemize} + + Both do nothing but chaning \cmd{itemsep} and \cmd{parskip} + \begin{itemize} + \item Set to 0 + \item Same effect as \cmd{\tightlist} in the memoir package + \end{itemize} + + \bigskip + + Both enviroments do \skbem[italic]{nothing} if the memoir package is used! + +\end{frame} + + +\mode +<article> + +\resizebox{\textwidth}{!}{\includeslide{manual:lists}} +\bigskip + +\skbinput[from=rep]{manual/lists} + +\clearpage + +\mode +<all> diff --git a/Master/texmf-dist/doc/latex/skb/user-guide/slides/manual-optional-text.tex b/Master/texmf-dist/doc/latex/skb/user-guide/slides/manual-optional-text.tex new file mode 100644 index 00000000000..03840da4296 --- /dev/null +++ b/Master/texmf-dist/doc/latex/skb/user-guide/slides/manual-optional-text.tex @@ -0,0 +1,36 @@ +\mode +<presentation> + +\begin{frame}{Optional Text -- Versions and Optional} + \label{manual:optiona-text} + + \begin{itemize} + \item Supports the packages version and optional + \item Comes with 6 defined modes, automatically configured + \begin{itemize} + \item text -- normal text, i.e. in an article + \item slide -- slides, i.e. beamer frames + \item note -- annotated slides, i.e. beamerarticle + \item anim/noanim -- animated and non-animated slides/frames + \item memoir -- used when memoir package is loaded + \end{itemize} + \end{itemize} + + \begin{example} + \lstinputlisting[style=beamer-example,language=TeX]{\skbfileroot{examples/optional-text}} + \end{example} +\end{frame} + + +\mode +<article> + +\resizebox{\textwidth}{!}{\includeslide{manual:optiona-text}} +\bigskip + +\skbinput[from=rep]{manual/optional-text} + +\clearpage + +\mode +<all> diff --git a/Master/texmf-dist/doc/latex/skb/user-guide/slides/manual-paths.tex b/Master/texmf-dist/doc/latex/skb/user-guide/slides/manual-paths.tex new file mode 100644 index 00000000000..11d9e7bf6b5 --- /dev/null +++ b/Master/texmf-dist/doc/latex/skb/user-guide/slides/manual-paths.tex @@ -0,0 +1,37 @@ +\mode +<presentation> + +\begin{frame}{Commands to access Path and Filenames directly} + \label{manual:paths} + + \begin{itemize} + \item \cmd{\skbfileroot} -- the root directory + \item \cmd{\skbpathroot} -- with 1 argument, the root-dir/\#1 + \item \cmd{\skbfileacr} -- the acronym directory and file + \item \cmd{\skbfilebib} -- the reference directory and file + \item \cmd{\skbpathbib} -- the reference directory + \item \cmd{\skbfilerep} -- with 1 argument, the repository-dir/\#1 + \item \cmd{\skbfilepub} -- with 1 argument, the publish-dir/\#1 + \item \cmd{\skbfilefig} -- with 1 argument, the figure-dir/\#1 + \item \cmd{\skbfilesli} -- with 1 argument, the slide-dir/\#1 + \end{itemize} + + \begin{example} + \lstinputlisting[style=beamer-example,language=TeX]{\skbfileroot{examples/paths}} + \end{example} + +\end{frame} + + +\mode +<article> + +\resizebox{\textwidth}{!}{\includeslide{manual:paths}} +\bigskip + +\skbinput[from=rep]{manual/path-commands} + +\clearpage + +\mode +<all> diff --git a/Master/texmf-dist/doc/latex/skb/user-guide/slides/manual-pdfinfo.tex b/Master/texmf-dist/doc/latex/skb/user-guide/slides/manual-pdfinfo.tex new file mode 100644 index 00000000000..604fe4ecc2c --- /dev/null +++ b/Master/texmf-dist/doc/latex/skb/user-guide/slides/manual-pdfinfo.tex @@ -0,0 +1,32 @@ +\mode +<presentation> + +\begin{frame}{Macros for PDF Info} + \label{manual:pdfinfo} + + Macros to set information, call them anywere in your document: + \begin{itemize} + \item \cmd{\skbtitle} -- the title + \item \cmd{\skbauthor} -- the author + \item \cmd{\skbsubject} -- the subject + \item \cmd{\skbkeywords} -- the keywords + \item date -- will be set automatically to today + \end{itemize} + + \SKB~automatically calls the \cmd{\skbpdfinfo} macro at the end of the main document + +\end{frame} + + +\mode +<article> + +\resizebox{\textwidth}{!}{\includeslide{manual:pdfinfo}} +\bigskip + +\skbinput[from=rep]{manual/pdfinfo} + +\clearpage + +\mode +<all> diff --git a/Master/texmf-dist/doc/latex/skb/user-guide/slides/manual-skbem.tex b/Master/texmf-dist/doc/latex/skb/user-guide/slides/manual-skbem.tex new file mode 100644 index 00000000000..40def98a6d7 --- /dev/null +++ b/Master/texmf-dist/doc/latex/skb/user-guide/slides/manual-skbem.tex @@ -0,0 +1,31 @@ +\mode +<presentation> + +\begin{frame}{Emphasising Text} + \label{manual:skbem} + + \begin{block}{\LaTeX example for \skbem[code]{skbinput}} + \lstinputlisting[style=beamer-example,language=TeX]{\skbfileroot{examples/skbem}} + \end{block} + + \bigskip + + \begin{block}{And the result} + \skbinput{examples/skbem} + \end{block} + +\end{frame} + + +\mode +<article> + +\resizebox{\textwidth}{!}{\includeslide{manual:skbem}} +\bigskip + +\skbinput[from=rep]{manual/skbem} + +\clearpage + +\mode +<all> diff --git a/Master/texmf-dist/doc/latex/skb/user-guide/slides/manual-slides1.tex b/Master/texmf-dist/doc/latex/skb/user-guide/slides/manual-slides1.tex new file mode 100644 index 00000000000..d89b54f2e20 --- /dev/null +++ b/Master/texmf-dist/doc/latex/skb/user-guide/slides/manual-slides1.tex @@ -0,0 +1,35 @@ +\mode +<presentation> + +\begin{frame}{Slides} + \label{manual:slides1} + + Use \cmd{\skbslide} and \cmd{\skbslidecite} to integrate slides from outside the \LaTeX universe + \begin{itemize} + \item Load PDF slides with or without \LaTeX annotations + \item Load the PDF and/or the \LaTeX from any \SKB known path + \item Add standardised citation for the slides to the annotation + \end{itemize} + + Example with Microsoft Powerpoint + \begin{itemize} + \item Take a Powerpoint presentation and print all slides into a 4x3 format, individual PDFs + \item Write or reuse existing anotations using \LaTeX (and \BibTeX etc.) + \item Produce handouts using the \SKB and present the slides using Powerpoint + \end{itemize} + +\end{frame} + + +\mode +<article> + +\resizebox{\textwidth}{!}{\includeslide{manual:slides1}} +\bigskip + +\skbinput[from=rep]{manual/slides} + +\clearpage + +\mode +<all> diff --git a/Master/texmf-dist/doc/latex/skb/user-guide/slides/manual-slides2.tex b/Master/texmf-dist/doc/latex/skb/user-guide/slides/manual-slides2.tex new file mode 100644 index 00000000000..96ea268e3c1 --- /dev/null +++ b/Master/texmf-dist/doc/latex/skb/user-guide/slides/manual-slides2.tex @@ -0,0 +1,31 @@ +\mode +<presentation> + +\begin{frame}{Slides} + \label{manual:slides2} + + \begin{block}{\skbem[code]{skbslide}} + \lstinputlisting[style=beamer-exampleLN,language=TeX]{\skbfileroot{examples/skbslide}} + \end{block} + + \bigskip + + \begin{block}{\skbem[code]{skbslidecite}} + \lstinputlisting[style=beamer-exampleLN,language=TeX]{\skbfileroot{examples/skbslidecite}} + \end{block} + +\end{frame} + + +\mode +<article> + +\resizebox{\textwidth}{!}{\includeslide{manual:slides2}} +\bigskip + +\skbinput[from=rep]{manual/slides2} + +\clearpage + +\mode +<all> diff --git a/Master/texmf-dist/doc/latex/skb/user-guide/slides/separate-cs.tex b/Master/texmf-dist/doc/latex/skb/user-guide/slides/separate-cs.tex new file mode 100644 index 00000000000..66426b69b38 --- /dev/null +++ b/Master/texmf-dist/doc/latex/skb/user-guide/slides/separate-cs.tex @@ -0,0 +1,28 @@ +\mode +<presentation> + +\begin{frame}{Separate Content from Structure} + \label{separate:cs} + + \begin{example} + \skbinput[from=fig]{dirtree/repository} + \end{example} + + +\end{frame} + + + + +\mode +<article> + +\resizebox{\textwidth}{!}{\includeslide{separate:cs}} +\bigskip + +\skbinput[from=rep]{separate/separate-cs} + +\clearpage + +\mode +<all>
\ No newline at end of file diff --git a/Master/texmf-dist/doc/latex/skb/user-guide/slides/separate-parts-baf.tex b/Master/texmf-dist/doc/latex/skb/user-guide/slides/separate-parts-baf.tex new file mode 100644 index 00000000000..9860b6e4be3 --- /dev/null +++ b/Master/texmf-dist/doc/latex/skb/user-guide/slides/separate-parts-baf.tex @@ -0,0 +1,35 @@ +\mode +<presentation> + +\begin{frame}{Separate Parts of the Document, Part I} + \label{separate:parts:baf} + + \begin{itemize} + \item Create a folder for data + \begin{itemize} + \item Acronyms, References, ... + \end{itemize} + \item Create a folder for figures + \end{itemize} + + \begin{block}{Bibliography, Acronyms and Figures} + \skbinput[from=fig]{dirtree/baf} + \end{block} + +\end{frame} + + + + +\mode +<article> + +\resizebox{\textwidth}{!}{\includeslide{separate:parts:baf}} +\bigskip + +\skbinput[from=rep]{separate/separate-parts-baf} + +\clearpage + +\mode +<all>
\ No newline at end of file diff --git a/Master/texmf-dist/doc/latex/skb/user-guide/slides/separate-parts-pc1.tex b/Master/texmf-dist/doc/latex/skb/user-guide/slides/separate-parts-pc1.tex new file mode 100644 index 00000000000..f3d34b8da1d --- /dev/null +++ b/Master/texmf-dist/doc/latex/skb/user-guide/slides/separate-parts-pc1.tex @@ -0,0 +1,36 @@ +\mode +<presentation> + +\begin{frame}{Separate Parts of the Document, Part II} + \label{separate:parts:pc1} + + Publications and Content + + \begin{itemize} + \item Now look into published documents, there are different types + \begin{itemize} + \item Articles, Books, Lecture Notes, Presentations, ... + \end{itemize} + \end{itemize} + + \begin{block}{The Folder \skbem[code]{publish}} + \skbinput[from=fig]{dirtree/publish} + \end{block} + +\end{frame} + + + + +\mode +<article> + +\resizebox{\textwidth}{!}{\includeslide{separate:parts:pc1}} +\bigskip + +\skbinput[from=rep]{separate/separate-parts-pc} + +\clearpage + +\mode +<all>
\ No newline at end of file diff --git a/Master/texmf-dist/doc/latex/skb/user-guide/slides/separate-parts-pc2.tex b/Master/texmf-dist/doc/latex/skb/user-guide/slides/separate-parts-pc2.tex new file mode 100644 index 00000000000..58a5c98e469 --- /dev/null +++ b/Master/texmf-dist/doc/latex/skb/user-guide/slides/separate-parts-pc2.tex @@ -0,0 +1,39 @@ +\mode +<presentation> + +\begin{frame}{Separate Parts of the Document, Part III} + \label{separate:parts:pc2} + + Publications: Articles + + \begin{itemize} + \item Now look into articles, there are a few of them, i.e. + \begin{itemize} + \item Object Naming (\skbem[code]{naming.tex}) + \item Object Models (\skbem[code]{object-models.tex}) + \item Protocols (\skbem[code]{protocols.tex}) + \end{itemize} + \item And a separate folder with the links to repository files (\skbem[code]{tex}) + \end{itemize} + + \begin{block}{The Folder \skbem[code]{publish/articles}} + \skbinput[from=fig]{dirtree/publish-art} + \end{block} + +\end{frame} + + + + +\mode +<article> + +\resizebox{\textwidth}{!}{\includeslide{separate:parts:pc2}} +\bigskip + +\skbinput[from=rep]{separate/separate-parts-pc2} + +\clearpage + +\mode +<all>
\ No newline at end of file diff --git a/Master/texmf-dist/doc/latex/skb/user-guide/slides/separate.tex b/Master/texmf-dist/doc/latex/skb/user-guide/slides/separate.tex new file mode 100644 index 00000000000..b020c48dfca --- /dev/null +++ b/Master/texmf-dist/doc/latex/skb/user-guide/slides/separate.tex @@ -0,0 +1,38 @@ +\mode +<presentation> + +\begin{frame}{The Concept: Separate Things} + \label{separate} + + Separate as much as you can (but not more) + + \begin{itemize} + \item Separate content of a document from its structure + \begin{itemize} + \item Identify small, coherent blocks of information + \item Put them in a separate folder: the repository + \end{itemize} + \end{itemize} + + \begin{itemize} + \item Separate the different parts of a document + \begin{itemize} + \item Documentation reason (publish) from repository + \item Code, figures, examples, acronyms, references + \end{itemize} + \end{itemize} +\end{frame} + + +\mode +<article> + +\resizebox{\textwidth}{!}{\includeslide{separate}} +\bigskip + +\skbinput[from=rep]{separate/separate} + +\clearpage + +\mode +<all>
\ No newline at end of file diff --git a/Master/texmf-dist/doc/latex/skb/user-guide/slides/start-config-cmd.tex b/Master/texmf-dist/doc/latex/skb/user-guide/slides/start-config-cmd.tex new file mode 100644 index 00000000000..836cda47605 --- /dev/null +++ b/Master/texmf-dist/doc/latex/skb/user-guide/slides/start-config-cmd.tex @@ -0,0 +1,26 @@ +\mode +<presentation> + +\begin{frame}{Configuration: \cmd{\skbconfig}} + \label{start:config:cmd} + + \begin{example}[variations for \cmd{\skbconfig}] + \lstinputlisting[style=beamer-example,language=TeX]{\skbfileroot{examples/skbconfig}} + \end{example} +\end{frame} + + + + +\mode +<article> + +\resizebox{\textwidth}{!}{\includeslide{start:config:cmd}} +\bigskip + +\skbinput[from=rep]{getting-started/config-cmd} + +\clearpage + +\mode +<all> diff --git a/Master/texmf-dist/doc/latex/skb/user-guide/slides/start-config-opt.tex b/Master/texmf-dist/doc/latex/skb/user-guide/slides/start-config-opt.tex new file mode 100644 index 00000000000..ee975794d86 --- /dev/null +++ b/Master/texmf-dist/doc/latex/skb/user-guide/slides/start-config-opt.tex @@ -0,0 +1,26 @@ +\mode +<presentation> + +\begin{frame}{Configuration: Options} + \label{start:config:opt} + \begin{tabular*}{\textwidth}{ >{\scriptsize}p{.1\textwidth} >{\scriptsize}p{.65\textwidth} >{\scriptsize}p{.15\textwidth}} + \skbinput[from=rep]{getting-started/config-opt-table} + \end{tabular*} + +\end{frame} + + + + +\mode +<article> + +\resizebox{\textwidth}{!}{\includeslide{start:config:opt}} +\bigskip + +\skbinput[from=rep]{getting-started/config-opt} + +\clearpage + +\mode +<all> diff --git a/Master/texmf-dist/doc/latex/skb/user-guide/slides/start-distribution.tex b/Master/texmf-dist/doc/latex/skb/user-guide/slides/start-distribution.tex new file mode 100644 index 00000000000..65be4df0de9 --- /dev/null +++ b/Master/texmf-dist/doc/latex/skb/user-guide/slides/start-distribution.tex @@ -0,0 +1,26 @@ +\mode +<presentation> + +\begin{frame}{The \SKB~Distribution} + \label{start:distribution} + + \begin{block}{distribution contents} + \skbinput[from=fig]{dirtree/skb-distribution} + \end{block} +\end{frame} + + + + +\mode +<article> + +\resizebox{\textwidth}{!}{\includeslide{start:distribution}} +\bigskip + +\skbinput[from=rep]{getting-started/distribution} + +\clearpage + +\mode +<all> diff --git a/Master/texmf-dist/doc/latex/skb/user-guide/slides/start-folders.tex b/Master/texmf-dist/doc/latex/skb/user-guide/slides/start-folders.tex new file mode 100644 index 00000000000..b7697768730 --- /dev/null +++ b/Master/texmf-dist/doc/latex/skb/user-guide/slides/start-folders.tex @@ -0,0 +1,25 @@ +\mode +<presentation> + +\begin{frame}{Creating a Directory Structure} + \label{start:folders} + + \begin{block}{The Directory Structure used in this Guide} + \skbinput[from=fig]{dirtree/complete} + \end{block} + +\end{frame} + + +\mode +<article> + +\resizebox{\textwidth}{!}{\includeslide{start:folders}} +\bigskip + +\skbinput[from=rep]{getting-started/folders} + +\clearpage + +\mode +<all> diff --git a/Master/texmf-dist/doc/latex/skb/user-guide/slides/start-installation.tex b/Master/texmf-dist/doc/latex/skb/user-guide/slides/start-installation.tex new file mode 100644 index 00000000000..8a8cd42dd59 --- /dev/null +++ b/Master/texmf-dist/doc/latex/skb/user-guide/slides/start-installation.tex @@ -0,0 +1,46 @@ +\mode +<presentation> + +\begin{frame}{Installation} + \label{start:installation} + + First + \begin{itemize} + \item Go to your \LaTeX distribution + \end{itemize} + + Classes and Style Files + \begin{itemize} + \item Create a folder \skbem[code]{tex/latex/skb} + \item Copy \skbem[code]{run/*} into that folder (\skbem[code]{tex/latex/skb}) + \item Update filename database of your \LaTeX distribution + \end{itemize} + + Documentation + \begin{itemize} + \item Create a folder \skbem[code]{doc/latex/skb} + \item Copy \skbem[code]{doc/*} into that folder (\skbem[code]{doc/latex/skb}) + \end{itemize} + + Source + \begin{itemize} + \item Create a folder \skbem[code]{source/latex/skb} + \item Copy \skbem[code]{source/*} into that folder (\skbem[code]{source/latex/skb}) + \end{itemize} +\end{frame} + + + + +\mode +<article> + +\resizebox{\textwidth}{!}{\includeslide{start:installation}} +\bigskip + +\skbinput[from=rep]{getting-started/installation} + +\clearpage + +\mode +<all> diff --git a/Master/texmf-dist/doc/latex/skb/user-guide/slides/start-rebuild.tex b/Master/texmf-dist/doc/latex/skb/user-guide/slides/start-rebuild.tex new file mode 100644 index 00000000000..4a70817dbad --- /dev/null +++ b/Master/texmf-dist/doc/latex/skb/user-guide/slides/start-rebuild.tex @@ -0,0 +1,26 @@ +\mode +<presentation> + +\begin{frame}{Rebuilding the \SKB} + \label{start:rebuild} + + \begin{block}{Class/Style Files and Documentation} + \lstinputlisting[style=beamer-example,language=TeX]{\skbfileroot{examples/rebuild}} + \end{block} +\end{frame} + + + + +\mode +<article> + +\resizebox{\textwidth}{!}{\includeslide{start:rebuild}} +\bigskip + +\skbinput[from=rep]{getting-started/rebuild} + +\clearpage + +\mode +<all>
\ No newline at end of file diff --git a/Master/texmf-dist/doc/latex/skb/user-guide/slides/start-used-options.tex b/Master/texmf-dist/doc/latex/skb/user-guide/slides/start-used-options.tex new file mode 100644 index 00000000000..ecc563b4729 --- /dev/null +++ b/Master/texmf-dist/doc/latex/skb/user-guide/slides/start-used-options.tex @@ -0,0 +1,33 @@ +\mode +<presentation> + +\begin{frame}{Confguration: View Options Used} + \label{start:used:options} + + \begin{itemize} + \item Macro that can be used to show configuration options + \item Shows the Change Log and actually used options + \item Uses package warning to printout information + \item Automatically called at the end of processing main document + \end{itemize} + + \begin{example}[Root path Change Log and Option] + \lstinputlisting[style=beamer-example,firstline=2,lastline=3]{\skbfileroot{examples/used-options}} + \lstinputlisting[style=beamer-example,firstline=12,lastline=13]{\skbfileroot{examples/used-options}} + \end{example} + +\end{frame} + + +\mode +<article> + +\resizebox{\textwidth}{!}{\includeslide{start:used:options}} +\bigskip + +\skbinput[from=rep]{getting-started/used-options} + +\clearpage + +\mode +<all> diff --git a/Master/texmf-dist/doc/latex/skb/user-guide/slides/story-long1.tex b/Master/texmf-dist/doc/latex/skb/user-guide/slides/story-long1.tex new file mode 100644 index 00000000000..e56429c1525 --- /dev/null +++ b/Master/texmf-dist/doc/latex/skb/user-guide/slides/story-long1.tex @@ -0,0 +1,28 @@ +\mode +<presentation> + +\begin{frame}{The Story, long version, Part I} + \label{story:long:one} + + The Problems I was facing + \begin{itemize} + \item Ideas/concepts hidden and unaccessible + \item Many documents in many different formats + \item Reuse of `stuff' requires lots of work, and involves copy and paste + \item Many different versions of very similar `stuff', no time for maintenance + \item Same for text, figures, examples, tables, lists, acronyms, references; all created `stuff' + \end{itemize} +\end{frame} + + +\mode +<article> + +\resizebox{\textwidth}{!}{\includeslide{story:long:one}} +\bigskip + +\skbinput[from=rep]{story/long} +\clearpage + +\mode +<all> diff --git a/Master/texmf-dist/doc/latex/skb/user-guide/slides/story-long2.tex b/Master/texmf-dist/doc/latex/skb/user-guide/slides/story-long2.tex new file mode 100644 index 00000000000..783fdcdb550 --- /dev/null +++ b/Master/texmf-dist/doc/latex/skb/user-guide/slides/story-long2.tex @@ -0,0 +1,38 @@ +\mode +<presentation> + +\begin{frame}{The Story, long version, Part II} + \label{story:long:two} + + Solution: Create a (unified) document repository + \begin{itemize} + \item Then use it as source to generate documents + \item Leave text, heading text, figures etc. in the repository + \item Helps to keep information updated (no more copy and paste) + \item Only a few rules, little effort for maintanance + \end{itemize} + + An Example from 2009 (first version of the \SKB) + \begin{itemize} + \item Moved 4 lecture notes, 2 presentations, 1 book chapter, 2 books and 4 articles + \item Created 1,314 files in 87 folders, but: + \begin{itemize} + \item Removed about 100 pages of douplicated `stuff + \item Removed many many duplicated figures + \item Also found tons of errors from re-using already reused `stuff' + \end{itemize} + \end{itemize} + +\end{frame} + +\mode +<article> + +\resizebox{\textwidth}{!}{\includeslide{story:long:two}} +\bigskip + +\skbinput[from=rep]{story/long2} +\clearpage + +\mode +<all> diff --git a/Master/texmf-dist/doc/latex/skb/user-guide/slides/story-short.tex b/Master/texmf-dist/doc/latex/skb/user-guide/slides/story-short.tex new file mode 100644 index 00000000000..a30a4849371 --- /dev/null +++ b/Master/texmf-dist/doc/latex/skb/user-guide/slides/story-short.tex @@ -0,0 +1,34 @@ +\mode +<presentation> + +\begin{frame}{The Story, short version} + \label{story:short} + + After 10 years writing documents...and not maintaining them properly + \begin{itemize} + \item My `stuff' got distributed in multiple dimensions + \item Some hidden in emails, on shared discs, external document systems, web sites + \item Finding anything became almost impossible + \item Tried many tools, none really helped to organise my `mess' + \end{itemize} + + Early 2009, I decided to reorganise \skbem[italic]{everything} + \begin{itemize} + \item Well-defined set of tools/applications: PHP, \LaTeX, \BibTeX, Inkscape, SQLite, Java + \item Then I started writing the \LaTeX part for the \SKB + \item This now became the \SKB package + \end{itemize} +\end{frame} + + +\mode +<article> + +\resizebox{\textwidth}{!}{\includeslide{story:short}} +\bigskip + +\skbinput[from=rep]{story/short} +\clearpage + +\mode +<all> diff --git a/Master/texmf-dist/doc/latex/skb/user-guide/ug-slides-anim.tex b/Master/texmf-dist/doc/latex/skb/user-guide/ug-slides-anim.tex new file mode 100644 index 00000000000..9889966e988 --- /dev/null +++ b/Master/texmf-dist/doc/latex/skb/user-guide/ug-slides-anim.tex @@ -0,0 +1,19 @@ +\documentclass[beameranim]{skbbeamer} + +\IfFileExists{ug-slides-load} + {\skbconfig[root=./,pub=]{ug-slides-anim.tex}}{} +\IfFileExists{user-guide/ug-slides-load} + {\skbconfig[root=user-guide,pub=]{ug-slides-anim.tex}}{} + +\usepackage{dirtree} + +\mode<presentation> +{ + \usetheme{Darmstadt} +} + +\begin{document} + \skbinput[from=pub]{ug-slides-load} +\end{document} + +\endinput
\ No newline at end of file diff --git a/Master/texmf-dist/doc/latex/skb/user-guide/ug-slides-load.tex b/Master/texmf-dist/doc/latex/skb/user-guide/ug-slides-load.tex new file mode 100644 index 00000000000..7221e9c25a0 --- /dev/null +++ b/Master/texmf-dist/doc/latex/skb/user-guide/ug-slides-load.tex @@ -0,0 +1,86 @@ +\skbconfig[sli=slides]{skb-presentation} + +\AtBeginSubsection[] +{ + \begin{frame}<beamer>{Outline} + \tableofcontents[currentsection,currentsubsection] + \end{frame} +} + +\title[User Guide]{The \SKB~User Guide} +%\subtitle{} +\author[Sven van der Meer]{Sven van der Meer} + +%\institute[WIT] +%{ +% Department of Computer Science\\ +% University of Somewhere +%} + +%\date[Sven's LNCS]{M.Sc. Computer Science} + +\skbtitle{The SKB User Guide} +\skbauthor{Sven van der Meer} +\skbsubject{User Guide for the LaTeX package SKB} +\skbkeywords{LaTeX, SKB} + +\begin{frame} + \label{title} + \mode<presentation>{\titlepage} +\end{frame} + +\mode<presentation>{ +\begin{frame}{Outline} + \tableofcontents +\end{frame} +} + +\section{The \LaTeX~\SKB~Package} + \subsection{The Idea} + \skbinput[from=sli]{about} + \skbinput[from=sli]{intent} + \skbinput[from=sli]{applicability} + \subsection{The Story} + \skbinput[from=sli]{story-short} + \skbinput[from=sli]{story-long1} + \skbinput[from=sli]{story-long2} + \subsection{The underlying Concept} + \skbinput[from=sli]{separate} + \skbinput[from=sli]{separate-cs} + \skbinput[from=sli]{separate-parts-baf} + \skbinput[from=sli]{separate-parts-pc1} + \skbinput[from=sli]{separate-parts-pc2} + +\section{User Manual} + \subsection{Getting Started} + \skbinput[from=sli]{start-distribution} + \skbinput[from=sli]{start-installation} + \skbinput[from=sli]{start-rebuild} + \skbinput[from=sli]{start-config-opt} + \skbinput[from=sli]{start-config-cmd} + \skbinput[from=sli]{start-used-options} + \skbinput[from=sli]{start-folders} + + \only<article>{\skbinput[from=rep]{manual/manual}\clearpage} + \subsection{Headings, Files, Figures, Slides, Paths, Acronyms and References} + \skbinput[from=sli]{manual-haf} + \skbinput[from=sli]{manual-figures} + \skbinput[from=sli]{manual-figures-opt} + \skbinput[from=sli]{manual-slides1} + \skbinput[from=sli]{manual-slides2} + \skbinput[from=sli]{manual-paths} + \skbinput[from=sli]{manual-acrbib} + + \subsection{Other usefull Macros} + \skbinput[from=sli]{manual-skbem} + \skbinput[from=sli]{manual-lists} + \skbinput[from=sli]{manual-listings} + \skbinput[from=sli]{manual-pdfinfo} + \skbinput[from=sli]{manual-optional-text} + +\section{Examples} + \subsection{A simple Article} + \skbinput[from=sli]{example-art-tex1} + \skbinput[from=sli]{example-art-tex2} + \skbinput[from=sli]{example-art-tex3} \only<article>{\clearpage} + \only<presentation>{\skbinput[from=sli]{example-art-toc}} diff --git a/Master/texmf-dist/doc/latex/skb/user-guide/ug-slides-noanim.tex b/Master/texmf-dist/doc/latex/skb/user-guide/ug-slides-noanim.tex new file mode 100644 index 00000000000..8594eb66204 --- /dev/null +++ b/Master/texmf-dist/doc/latex/skb/user-guide/ug-slides-noanim.tex @@ -0,0 +1,18 @@ +\documentclass[beameranim]{skbbeamer} + + \IfFileExists{ug-slides-load} + {\skbconfig[root=./,pub=]{ug-slides-noanim.tex}}{} + \IfFileExists{user-guide/ug-slides-load} + {\skbconfig[root=user-guide,pub=]{ug-slides-noanim.tex}}{} + + \usepackage{dirtree} + + \mode<presentation> + { + \usetheme{Darmstadt} + } + + \begin{document} + \skbinput[from=pub]{ug-slides-load} + \end{document} +\endinput
\ No newline at end of file diff --git a/Master/texmf-dist/doc/latex/skb/user-guide/ug-slides-notes.tex b/Master/texmf-dist/doc/latex/skb/user-guide/ug-slides-notes.tex new file mode 100644 index 00000000000..2af8ee8c101 --- /dev/null +++ b/Master/texmf-dist/doc/latex/skb/user-guide/ug-slides-notes.tex @@ -0,0 +1,15 @@ +\documentclass{skblncsbeamer} + \setjobnamebeamerversion{ug-slides-noanim} + + \IfFileExists{ug-slides-load} + {\skbconfig[root=./,pub=]{ug-slides-notes.tex}}{} + \IfFileExists{user-guide/ug-slides-load} + {\skbconfig[root=user-guide,pub=]{ug-slides-notes.tex}}{} + + \usepackage{dirtree} + + \begin{document} + \skbinput[from=pub]{ug-slides-load} + \end{document} + +\endinput
\ No newline at end of file diff --git a/Master/texmf-dist/doc/latex/skb/user-guide/user-guide-load.tex b/Master/texmf-dist/doc/latex/skb/user-guide/user-guide-load.tex new file mode 100644 index 00000000000..7da386fba42 --- /dev/null +++ b/Master/texmf-dist/doc/latex/skb/user-guide/user-guide-load.tex @@ -0,0 +1,41 @@ +\skbinput[from=rep,level=section]{intent} + +\section{The Story} + \skbinput[from=rep,level=subsection]{story/short} + \skbinput[from=rep,level=subsection]{story/long} + +\skbinput[from=rep,level=section]{separate/separate} + \skbinput[from=rep,level=subsection]{separate/separate-cs} + \skbinput[from=rep,level=subsection]{separate/separate-parts} + \skbinput[from=rep,level=subsubsection]{separate/separate-parts-baf} + \skbinput[from=rep,level=subsubsection]{separate/separate-parts-pc} + \skbinput[from=rep,level=subsubsection]{separate/separate-final} + +\skbinput[from=rep,level=section]{manual/manual} + \skbinput[from=rep,level=subsection]{getting-started/start} + \skbinput[from=rep,level=subsubsection]{getting-started/distribution} + \skbinput[from=rep,level=subsubsection]{getting-started/installation} + \skbinput[from=rep,level=subsubsection]{getting-started/rebuild} + \skbinput[from=rep,level=subsubsection]{getting-started/config} + \skbinput[from=rep,level=subsubsection]{getting-started/used-options} + \skbinput[from=rep,level=subsubsection]{getting-started/folders} + + \subsection{Files, Figures and Slides} + \skbinput[from=rep,level=subsubsection]{manual/headings-and-files} + \skbinput[from=rep,level=subsubsection]{manual/figures} + \skbinput[from=rep,level=subsubsection]{manual/slides} + \subsection{Filenames, Acronyms and References} + \skbinput[from=rep,level=subsubsection]{manual/path-commands} + \skbinput[from=rep,level=subsubsection]{manual/acr-bib} + \subsection{Other useful Macros} + \skbinput[from=rep,level=subsubsection]{manual/skbem} + \skbinput[from=rep,level=subsubsection]{manual/lists} + \skbinput[from=rep,level=subsubsection]{manual/listing} + \skbinput[from=rep,level=subsubsection]{manual/optional-text} + +\section{Examples} + \skbinput[from=rep]{example-article} + +%^^A\skbinput[from=rep,level=section]{um} +%^^A \skbinput[from=rep,level=subsection]{example-article} +%^^A \skbinput[from=rep,level=subsection]{example-dtx}
\ No newline at end of file diff --git a/Master/texmf-dist/doc/latex/skb/user-guide/user-guide.tex b/Master/texmf-dist/doc/latex/skb/user-guide/user-guide.tex new file mode 100644 index 00000000000..c579b344228 --- /dev/null +++ b/Master/texmf-dist/doc/latex/skb/user-guide/user-guide.tex @@ -0,0 +1,33 @@ +\documentclass{skbarticle} + +\IfFileExists{user-guide} + {\skbconfig[root=./,pub=]{user-guide.tex}}{} +\IfFileExists{user-guide/user-guide} + {\skbconfig[root=user-guide,pub=]{user-guide.tex}}{} + +\begin{document} + \title{The \SKB~User Guide} + \author{Sven van der Meer} + \date{2010-08-04 v0.5} + \maketitle + + \begin{abstract} + \skbinput[from=rep]{abstract} + \end{abstract} + \footnote{ + Note: This article is part of the \SKB~package. It is typeset separated from + the original documentation to show the usage of the \cmd{\skbarticle} class + and to provide an example for the usage of the \SKB. + } + + \tableofcontents* + + \skbtitle{The SKB User Guide} + \skbauthor{Sven van der Meer, sven@vandermeer.de} + \skbsubject{LaTeX SKB} + \skbkeywords{SKB;LaTeX;Package} + + \skbinput[from=pub]{user-guide-load} + +\end{document} +\endinput
\ No newline at end of file |