summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/latex/skb/README
diff options
context:
space:
mode:
authorKarl Berry <karl@freefriends.org>2011-05-12 22:54:15 +0000
committerKarl Berry <karl@freefriends.org>2011-05-12 22:54:15 +0000
commitce9e51c9b4a10fb42d7d641f6e6dd67a52e5788c (patch)
tree038a86cf280185aa619314a2cfb62efe92e695c8 /Master/texmf-dist/doc/latex/skb/README
parentf010d186f64cf079a9208e939636dc33263ad4d1 (diff)
skb (12may11)
git-svn-id: svn://tug.org/texlive/trunk@22443 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc/latex/skb/README')
-rw-r--r--Master/texmf-dist/doc/latex/skb/README143
1 files changed, 76 insertions, 67 deletions
diff --git a/Master/texmf-dist/doc/latex/skb/README b/Master/texmf-dist/doc/latex/skb/README
index 820e60da97b..f96d8a48ef7 100644
--- a/Master/texmf-dist/doc/latex/skb/README
+++ b/Master/texmf-dist/doc/latex/skb/README
@@ -1,7 +1,12 @@
-skb v0.5 2010/08/04
--------------------
-Create and maintain a repository for long-living documents
+SKB-LaTeX
+---------
+*Create and maintain a repository for long-living documents*
+
+*Latest version: v0.51 2011/05/12*
+
+Introduction
+------------
This package provides macros that help to build a document 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
@@ -13,24 +18,26 @@ 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.
-skb.sty v0.5 : the skb package
-skbarticle.cls v0.5 : an article class based on memoir
-skbbook.cls v0.5 : a book class based memoir
-skbbeamer.cls v0.5 : a beamer class based on beamer v3.10
-skblncsbeamer.cls v0.5 : a class for annotated beamer slides
-skblncsppt.cls v0.5 : a class for annotated ppt slides
+The following classes are supported
-See for more information the PDF documentation of this package. The history
-of the package is documented in /source/HISTORY.TXT and in the PDF
-documentation.
+- skbarticle: an article class using the memoir package
+- skbbook: a book class using the memoir package
+- skbbeamer: a class for presentations using the beamer package
+- skblncsbeamer: a class for annotated slides using the beamer package
+- skblncsppt: a class for annotated Powerpoint slides
+- skbmoderncv: a class integrating the moderncv package
+The documentation (current/doc) provides for a user guide, the documentation
+of the LaTeX package and classes and a few documents showing the
+capabilities of the skb package for documents and presentations. All
+documentation of the SKB is done using the SKB itself, so you can have a
+look into the LaTeX code as well to see how it works.
Status: Alpha, Experimental
---------------------------
-
This package, while being used by me and some early adaptors, is still in
-alpha status, thus experimental. we are using it to maintain a large amount
+alpha status, thus experimental. We are using it to maintain a large amount
of documents (articles, lecture notes, some books, project documentation,
open source documentation) and various different platforms (Windows with
MikTeX, several Linux systems and OSX). Since we eat our own dog food, we
@@ -41,80 +48,82 @@ machine. We are very interested in comments, critic, advice,
recommendations, complaints; as long as you try to keep them contructive ;)
-
Contents and Installation
-------------------------
-
Your LaTeX distribution might have the skb package already installed or
might install it automatically when you are trying to use it the first time.
If you have to manually install it, copy the files listed below to their
respective locations within your LaTeX distribution (TSD compliant
structure). Once you copied all files, please don't forget to update your
filename database. To use the skb package, you probably only need to copy
-the files from the /run folder
+the files from the /run folder. In the directory listing below, please
+substitute `texmf` with the root of your LaTeX distribution
[archive root]
- |
- |- doc
- |- skb.pdf : [your tex distribution]/doc/latex/skb
- |- ug-slides-anim : [your tex distribution]/doc/latex/skb
- |- ug-slides-noanim : [your tex distribution]/doc/latex/skb
- | `- ug-slides-notes : [your tex distribution]/doc/latex/skb
- |- source
- | |- skb.dtx : [your tex distribution]/source/latex/skb
- | `- skb.ins : [your tex distribution]/source/latex/skb
- `- run
- |- skb.cfg : [your tex distribution]/tex/latex/skb
- |- skb.sty : [your tex distribution]/tex/latex/skb
- |- skbarticle.cls : [your tex distribution]/tex/latex/skb
- |- skbbeamer.cls : [your tex distribution]/tex/latex/skb
- |- skbbook.cls : [your tex distribution]/tex/latex/skb
- |- skblncsbeamer.cls : [your tex distribution]/tex/latex/skb
- `- skblncsppt.cls : [your tex distribution]/tex/latex/skb
-
-The archive contains pre-generated files (in the /doc and /run
-folders). You can reproduce them from the source (/source) using the
-docstrip command and the ltxdoc package usting the following commands:
-
- $ cd run
- $ latex ../skb.ins
- $ cd ../doc
- $ pdflatex ../skb.dtx
- $ pdflatex ../skb.dtx
- $ pdflatex ../skb.dtx
-
-This will create the style file (skb.sty), the general configuration file
-(skb.cfg) and the class files (*.cls) in the directory run and the package
-documentation in the directory doc You need to have docstrip, ltxdoc and doc
-installed, which should be already part of your LaTeX distribution. Parts of
-the documentation (the user guide) are in the folder doc/user-guide and you
-will need to install the SKB before you can create the documentation (in
-other words, the SKB package uses itself to compile the PDF document)
-
+ v
+ +-- doc
+ | +-- skb.pdf : texmf/doc/latex/skb
+ | +-- ug-slides-anim : texmf/doc/latex/skb
+ | +-- ug-slides-noanim : texmf/doc/latex/skb
+ | `-- ug-slides-notes : texmf/doc/latex/skb
+ +-- source
+ | +-- skb.dtx : texmf/source/latex/skb
+ | `-- skb.ins : texmf/source/latex/skb
+ `-- run
+ +-- skb.cfg : texmf/tex/latex/skb
+ +-- skb.sty : texmf/tex/latex/skb
+ +-- skbarticle.cls : texmf/tex/latex/skb
+ +-- skbbeamer.cls : texmf/tex/latex/skb
+ +-- skbbook.cls : texmf/tex/latex/skb
+ +-- skblncsbeamer.cls : texmf/tex/latex/skb
+ +-- skblncsppt.cls : texmf/tex/latex/skb
+ `-- skbmoderncv.cls : texmf/tex/latex/skb
+
+The repository contains the LaTeX sources of the skb package
+(`current/source`) and the sources for the documentation (`/current/doc`).
+The distribution archive (download) also contains the generated LaTeX files
+(`/run`) and the generated PDF files of the documentation (`/doc`). You can
+reproduce them from the source in the repository (`current/source`) using
+the docstrip command and the ltxdoc package (assuming you are in the folder
+`/current`):
+
+----
+ # cd run
+ # latex ../skb.ins
+ # cd ../doc
+ # pdflatex ../skb.dtx
+ # pdflatex ../skb.dtx
+ # pdflatex ../skb.dtx
+----
+
+This will create the style file (`skb.sty`), the general configuration
+file (`skb.cfg`) and the class files (`*.cls`) in the directory /run and
+the package documentation in the directory /doc. You need to have docstrip,
+ltxdoc and doc installed, which should be already part of your LaTeX
+distribution. Parts of the documentation (the user guide) are in the folder
+doc/user-guide and you will need to install the SKB before you can
+create the documentation (in other words, the SKB package uses itself to
+compile the PDF document).
Configuration
-------------
-
-The SKB comes with a default configuration in the package (skb.sty) and an
-external configuration file (skb.cfg). There are multiple options to
-configure the SKB (changing the coniguration file, using a local
-configuration file called skblocal.cfg or using the provided macro
-\skbconfig). Please refer to the user guide for details.
-
+The SKB comes with a default configuration in the package (`skb.sty`) and
+an external configuration file (`skb.cfg`). There are multiple
+options to configure the SKB (changing the coniguration file,
+using a local configuration file called `skblocal.cfg` or using the
+provided macro `\skbconfig`). Please refer to the user guide for details.
Where do I get it?
------------------
-
-SourceForge: http://sourceforge.net/projects/latex-skb
-CTAN: [about to be submitted]
-
+- GitHub: https://github.com/vdmeer/skb-latex
+- CTAN: http://www.ctan.org/tex-archive/macros/latex/contrib/skb/
License
-------
-Copyright (c) 2010 Sven van der Meer <sven@vandermeer.de>
+Copyright (c) 2010-2011 Sven van der Meer <sven@vandermeer.de>
This work may be distributed and/or modified under the conditions of the
LaTeX Project Public License, either version 1.3 of this license or (at
@@ -133,4 +142,4 @@ This software is provided 'as is', without warranty of any kind, either
expressed or implied, including, but not limited to, the implied
warranties of merchantability and fitness for a particular purpose.
-This work consists of all files in source/MANIFEST.TXT \ No newline at end of file
+This work consists of all files in source/MANIFEST.TXT. \ No newline at end of file