[Tex/LaTex] Packages for documenting self written packages (sty-files)

documentationpackages

I am looking for packages useful for creating a documentation for a self written package.

I have found doc, but the documentation ltxdoc.pdf did not give me any useful example.
Also I know of docstrip, but reading dtxtut.pdf was mostly scary for me. Preceding the whole documenting code with comments is not what I am looking for. (I know emacs has a special setup for docstrip, but I do not consider to switch to emacs)

I know that many packages are documented in different classes/templates. If some of them should be packaged and documented I would like to know about them.

Best Answer

Note that docstrip and doc/ltxdoc are used often together, but are not dependent on each other. The first is to extract files from a DTX file and strip the comments from it, the others for writing the package manual. You can use the doc package with other classes as ltxdoc as well.

Further classes for package documentation are:

codedoc Replaces docstrip.
xdoc Extends doc.
dox Extends doc.
ltxdockit
ydoc

However, the last two are written by package authors mainly for their own packages and are not (yet) supported for the use by others. ydoc is written by me, not to be considered finished and almost undocumented.

`scrextend`

This package makes basic features of KOMA-Script classes available for other classes, so it extends them. It is mainly meant for document writers, but could also be used by package and class writers. Description is found in main KOMA-Script documentation.

As explicitly stated in documentation this package should not be used together with a KOMA-Script class.

Feature overview:

Early or late option selection: Options can be given in key-value pairs, and not only with \documentclass respective \usepackage, but also later in preamble and most options even in document using \KOMAoption or \KOMAoptions.
Enhancement of draft mode: Provides marks for overful lines also for classes, where this is originally not defined, cf. What does the draft mode change?
Document titles: This feature must activated as package option, but then one can use the enhanced KOMA-Script features for \maketitle and environment titlepage.

See How to span \textit{} and \Large several lines in \author{} and compare my answer with the others or float left figure in titlepage (scrextend at the end of answer).
Fontsize selection: Choose any desired fontsize instead of the limited set of standard classes, it is also more flexible than package extsizes. Of course, a scalable font must be loaded, either explicitly or by loading fontenc and having cm-super installed.

See this:
```
\documentclass{article}
\usepackage[T1]{fontenc}
\usepackage[fontsize=14pt]{scrextend}
\usepackage{kantlipsum}% for some filler text
\begin{document}
\kant[160-164]
\end{document}
```
See also How to specify font size less than 10pt (or more than 12pt)? or second part of lockstep’s answer to How to set a small default font size with beamer?.
Enhanced text markup opportunities: A \textsubscript is provided, and for a limited set of elements the commands \setkomafont, \addtokomafont etc. can be used, where in standard classes often internal commands must be redefined. Supported elements are title (and disposition, that will be only active for title markup), all elements for footnotes, dictum and all elements for labeling environment.

See in How to span \textit{} and \Large several lines in \author{} (already linked above) and Description-like environment with fixed labels width.
Detection of even and odd pages: A command \ifthispageodd is provided.

Example: If Then Else for odd page/even page.
Commands for interleaf pages: Additons to \clearpage offering more flexibility.
Footnote features of KOMA-Script, but for some features the command \deffootnote must have been used for activation.

Examples with \deffootnote: Layout of multiple lines footnotes, Different formatting of footnote mark in text and in footnote, Footnote number in braces / parentheses and How to set superscript footnote mark in the text body but normalsized in the foot?. In Reference different places to the same footnote you can see the command \footref in action.
Dicta, aphorisma, slogans for chapters and parts.
Enhanced decription list labeling.

Examples: Make the lines of a description item line up, align list of symbols with dash and Description-like environment with fixed labels width (already linked above).
Simple margin changes with (trivlist) environment addmargin.

Examples: Write text with some fixed amount of space from the margin, How can I indent a block of text for a specified amount?
Margin notes like with package marginpar. Do not mix up with package marginnote also written by Markus Kohm.

Best Answer

Related Solutions

[Tex/LaTex] find documentation about TikZ/TikZPicture

[Tex/LaTex] Using KOMA-Script packages with other classes

scrextend

Feature overview:

Related Question

`scrextend`