On Generating Documented Source Code by Blocks in TeX

Jan Šustek

Zpravodaj Československého sdružení uživatelů TeXu (2023)

  • Volume: 033, Issue: 3-4, page 66-101
  • ISSN: 1211-6661

Abstract

top
This paper concerns writing programs and their documentation. We show author's package gensrc running on OPmac, which allows to write both program and its documentation in one TeX file. We also show more possibilities and applications of this package.

How to cite

top

Šustek, Jan. "Generování dokumentovaného zdrojového souboru po blocích v TeXu." Zpravodaj Československého sdružení uživatelů TeXu 033.3-4 (2023): 66-101. <http://eudml.org/doc/299158>.

@article{Šustek2023,
abstract = {Článek popisuje problematiku psaní programů a dokumentace k nim. Ukazuje autorův balíček gensrc nad OPmacem, který umožňuje psát program i dokumentaci k němu v jediném TeXovém souboru. Jsou ukázány další možnosti a aplikace tohoto balíčku.},
author = {Šustek, Jan},
journal = {Zpravodaj Československého sdružení uživatelů TeXu},
language = {cze},
number = {3-4},
pages = {66-101},
publisher = {Československé sdružení uživatelů TeXu},
title = {Generování dokumentovaného zdrojového souboru po blocích v TeXu},
url = {http://eudml.org/doc/299158},
volume = {033},
year = {2023},
}

TY - JOUR
AU - Šustek, Jan
TI - Generování dokumentovaného zdrojového souboru po blocích v TeXu
JO - Zpravodaj Československého sdružení uživatelů TeXu
PY - 2023
PB - Československé sdružení uživatelů TeXu
VL - 033
IS - 3-4
SP - 66
EP - 101
AB - Článek popisuje problematiku psaní programů a dokumentace k nim. Ukazuje autorův balíček gensrc nad OPmacem, který umožňuje psát program i dokumentaci k němu v jediném TeXovém souboru. Jsou ukázány další možnosti a aplikace tohoto balíčku.
LA - cze
UR - http://eudml.org/doc/299158
ER -

References

top
  1. Olšák, Petr, OPmac: Rozšiřující makra plain TeXu, [online]. [cit. 2023-11-13]. Dostupné z: https://petr.olsak.net/opmac.html. 
  2. Knuth, Donald E., Literate Programming, [online]. 1983-09. [cit. 2023-11-13]. Dostupné z: http://www.literateprogramming.com/knuthweb.pdf. Submitted to The Computer Journal. (1983) 
  3. Knuth, Donald E., TeX: The Program, Sv. B. Reading, MA: Addison-Wesley, 1986. Computers & Typesetting. Dostupné také z: https://tug.ctan.org/systems/knuth/dist/tex/tex.web. (1986) MR0400642
  4. Olšák, Petr, TeXbook naruby, 2. vyd. Konvoj, 2001. Dostupné také z: http://petr.olsak.net/ftp/olsak/tbn/tbn.pdf. (2001) 
  5. The LaTeX Project Team, Mittelbach, Frank, docstrip: Remove comments from file, [online]. 2022-09-03. [cit. 2023-11-13]. Dostupné z: https://ctan.org/pkg/docstrip. (2022) 
  6. Mittelbach, Frank, The doc and shortvrb Packages, [online]. 2023-11-01. [cit. 2023-11-13]. Dostupné z: https://mirrors.ctan.org/macros/latex/base/doc.pdf. (2023) 
  7. Mittelbach, Frank, Duchier, Denys, Braams, Johannes, Woliński, Marcin, Wooding, Mark, The DocStrip program, [online]. 2023-11-01. [cit. 2023-11-13]. Dostupné z: http://mirrors.ctan.org/macros/latex/base/docstrip.pdf. (2023) 
  8. Šustek, Jan, gensrc.tex, [online]. 2023-11-07. [cit. 2023-11-13]. Dostupné z: https://github.com/jsustek/gensrc/blob/main/gensrc.tex. (2023) 
  9. virtualconsoles.com, C64 online emulator, [online]. [cit. 2023-11-13]. Dostupné z: https://virtualconsoles.com/online-emulators/c64/. 
  10. VICE, VICE: The Versatile Commodore Emulator, [online]. [cit. 2023-11-13]. Dostupné z: https://vice-emu.sourceforge.io/. 
  11. the Dragon, Tom, prg2wav: C64 PRG to Turbo Tape 64, [online]. [cit. 2023-11-13]. Dostupné z: https://github.com/tomdwaggy/prg2wav. 

NotesEmbed ?

top

You must be logged in to post comments.

To embed these notes on your page include the following JavaScript code on your page where you want the notes to appear.

Only the controls for the widget will be shown in your chosen language. Notes will be shown in their authored language.

Tells the widget how many notes to show per page. You can cycle through additional notes using the next and previous controls.

    
                

Note: Best practice suggests putting the JavaScript code just before the closing </body> tag.