Comprehensive TeX Archive Network

Direc­tory macros/latex/contrib/skdoc

%% skdoc documentation class
%% Copyright (C) 2012-2017 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.5 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.

Down­load the con­tents of this pack­age in one zip archive (322.7k).

skdoc – Doc­u­men­ta­tion and ex­trac­tion for pack­ages and doc­u­ment classes

The class pro­vides the func­tion­al­ity and im­ple­men­ta­tion of pack­ages and doc­u­ment classes. It is loosely based on the ydoc and ltx­doc classes, but has a num­ber of in­com­pat­i­ble dif­fer­ences.

The class de­fines a MacroCode en­vi­ron­ment which of­fers an al­ter­na­tive to the usual doc­strip method of in­stalling pack­ages. It has the abil­ity to gen­er­ate both doc­u­men­ta­tion and code in a sin­gle run of a sin­gle file.

Ver­sion1.5 2017-02-07
Li­cense The Project Public Li­cense 1.3
Copy­right2012–2017 Si­mon Sig­ur­dhs­son
Main­tainer Si­mon Sig­ur­dhs­son
TDS archiveskdoc.tds.zip
Con­tained inTeX Live as skdoc
MiKTeX as skdoc
Topics macros and tools for prepar­ing doc­u­men­ta­tion
Guest Book Sitemap Contact Contact Author