DocBy.TeX -- snadné dokumentování zdrojových kódů TeXem
Petr Olšák
DocBy.TeX umožňuje dokumentovat zdrojové kódy v jazyce C nebo v jiném
jazyce. Výstupem je klikací PDF. V TeXovém souboru píšete dokumentaci
a značky, kterými vyjadřujete, která část zdrojového kódu se má do
dokumentace vložit. Také vyznačujete cílové výskyty dokumentovaných
slov (funkcí, proměnných atd.). Všechny ostatní výskyty
dokumentovaných slov se stanou automaticky klikatelnými odkazy na
cíl. Není pro to nutné psát další značky, protože výskyty
dokumentovaných slov se vyhledají automaticky pomocí
encTeXu.
DocBy.TeX zapisuje do poznámek pod čarou stránky s výskyty
dokumentovaných slov napříč celou dokumentací, udělá automaticky obsah
i rejstřík. Pro tvorbu rejstříku nepotřebuje externí program (hesla si
zatřídí sám).
- Dokumentace k DocBy.TeXu slouží ke třem účelům:
- podrobná uživatelská dokumentace i popis implementace maker,
- je to příklad výstupu z DocBy.TeXu, protože je napsaná DocBy.TeXem,
- je to inspirace makro-programování v TeXu, všechna makra jsou
podrobně dokumentovaná.
- Makro docby.tex
- Příklad použití DocBy.TeXu -- hypotetický program lup.
- Zip archiv, kde je vše dohromady
- Annonce -- zveřejnění první verze DocBy.TeXu
na diskusní skupině cstex.
- Licence: se soubory
z balíčku DocBy.TeX si můžete bez omezení dělat
co chcete. Bude-li se vám makro jevit
užitečné, můžete potěšit autora informací o tom. Na makro není
poskytována žádná záruka.
Na http://www.olsak.net/mirek/kraluk.html
je ukázka použití DocBy.TeXu k dokumentování rozsáhlejšího programu.
DocBy.TeX -- making documentation of source codes easily by TeX
Petr Olšák
You can make your documentation of C source codes (or another language) by
DocBy.TeX. The output is PDF with hyperlinks. You can write
a special marks in TeX source with specification of which part of
source code will be placed here. Moreover you can sign ``documented
words'' (functions, variables etc.) at place where they are
documented. All another occurrences of documented words will be turned
to hyperlink (pointing to documentation place of the word)
automatically by encTeX.
You cannot mark these occurrences.
DocBy.TeX creates footnotes with page lists of occurrences of
documented words across whole documentation. It creates Table of
Contents and Index automatically too. You need not any external
program (no makeindex, for example), all stuff is done at
macro level in TeX.
- Documentation
of DocBy.TeX has three purposes:
- it is a detail documentation at user and technical level,
- it is an example of DocBy.TeX output because it was created by
DocBy.TeX itself,
- it is an inspiration for TeX macro programmers because all macros
are explained here in detail.
- The docby.tex macro.
- The example of usage of DocBy.TeX --
an hypothetical program lup.
- The ZIP archive with all files packed here.
- Annonce -- the email about first version
of DocBy.TeX sent to cstex list.
- License: you can do anything
with the files from DocBy.TeX package without any limit.
If the macro will be usable for you, you can tell the author about it.
There is no warranty for this macro.
The more extensive example of DocBy.TeX usage is on http://www.olsak.net/mirek/kraluk.html.