CTAN Comprehensive TeX Archive Network

Directory macros/latex/contrib/skdoc

%% skdoc documentation class
%% Copyright (C) 2012-2020 by Simon Sigurdhsson <sigurdhsson@gmail.com>
%% 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 your option) any later version.
%% The latest version of this license is in
%%   http://www.latex-project.org/lppl.txt
%% and version 1.3 or later is part of all distributions of LaTeX
%% version 2005/12/01 or later.
%% This work has the LPPL maintenance status `maintained'.
%% The Current Maintainer of this work is Simon Sigurdhsson.
%% This work consists of the files skdoc.dtx
%% and the derived filebase skdoc.cls.

This is version 1.5d of the skdoc document class. It is designed to
generate both documentation and derivative files using only LaTeX,
i.e. without using docstrip and ins/dtx files.

The following files are enclosed.

  README        - This file
  Makefile      - GNU Makefile for making the package and documentation
  skdoc.dtx     - LaTeX source code of the package
  skdoc.pdf     - PDF version of the documentation

Installation notes:
The easiest way to install this package, assuming you have obtained the
source code from Github or CTAN, is to simply run `make install`. This
will generate package code and documentation, install it into TEXMFHOME
and run `mktexlsr`. If you wish to compile the package but not install
it, run `make all` instead. If you insist on doing it manually, remember
to run `tex` to generate the code, and `pdflatex` (or `latex`, if you
don't fancy PDFs) to generate the documentation.

Download the contents of this package in one zip archive (345.4k).

skdoc – Documentation and extraction for packages and document classes

The class provides the functionality and implementation of packages and document classes. It is loosely based on the ydoc and ltxdoc classes, but has a number of incompatible differences.

The class defines a MacroCode environment which offers an alternative to the usual docstrip method of installing packages. It has the ability to generate both documentation and code in a single run of a single file.

Version1.5d 2020-11-16
LicensesThe Project Public License 1.3
Copyright2012–2020 Simon Sigurdhsson
MaintainerSimon Sigurdhsson
Contained inTeX Live as skdoc
MiKTeX as skdoc
Documentation support
Guest Book Sitemap Contact Contact Author