CTAN Comprehensive TeX Archive Network

Directory macros/latex/contrib/democodetools

README.md

democodetools

This is 'yet another doc/docx/doc3' package for code documetation. It is designed to be 'as class independent as possible', no assumption about underline macros is made. Furthermore, it's assumed that maketitle and the abstract environment were modified by the underline class, so alternatives (based on the article class) are provided.

For more details, see the documentation, democodetools.pdf


Requirements

  • none besides a fairly recent distribution as recent as 2022/06/01

(with the new in kernel ProcessKeyOptions and NewDocumentCommand)

Installation

The stable version is available at CTAN.

Usage

Stable version

Just place

  \usepackage{democodetools}

in the preamble and compile away.

Be aware that options might change between versions, so you have to check them manually.

More Information and documentation

More Information can be found in the documentation; you can find a "bleeding edge" version at the github page

Contacting Author

For bug reports and enhacement suggestions, the preferred way is to use the project's issue page. Please be ready to provide an example code showing the bug, if any.

Please do not use the issue page for generic help on how to use the package.


Copyright 2022 by Alceu Frigeri

This work may be distributed and/or modified under the conditions of

This work has the LPPL maintenance status maintained.

The Current Maintainer of this work is Alceu Frigeri


## This work consists of the files

  • democodelisting.sty
    • set of macros to typeset and demonstrate code
  • democodetools.sty
    • set of macros to document packages
  • README.md (this file)
    • quick introduction
  • democode.tex
    • package documentation
  • democode.pdf
    • documentation in PDF format

————-

Changelog

  • Version 1.0.1beta (this)
    • readme file cleanup (switch to markdown)
      • text files CRLF / LF 'corrected' (hopefully)
    • copyright cleanup
  • Version 1.0beta
    • Initial release by CTAN.

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

democodetools – Package for code documentation

This is ‘yet another doc/docx/doc3’ package for code documentation.

Packagedemocodetools
Bug trackerhttps://github.com/alceu-frigeri/democodetools/issues
Repositoryhttps://github.com/alceu-frigeri/democodetools
Version1.0.1beta 2022-09-06
LicensesThe Project Public License 1.3c
GNU General Public License
Copyright2022 Alceu Frigeri
MaintainerAlceu Frigeri
Contained inTeX Live as democodetools
MiKTeX as democodetools
TopicsDocumentation support
...
Guest Book Sitemap Contact Contact Author