Tk Library Source Code

View Ticket
Login
Ticket UUID: 1099581
Title: New module submission: docstrip
Type: Patch Version: None
Submitter: lars_h Created on: 2005-01-10 17:22:16
Subsystem: doctools Assigned To: andreas_kupries
Priority: 5 Medium Severity:
Status: Closed Last Modified: 2005-02-15 07:59:14
Resolution: Accepted Closed By: andreas_kupries
    Closed on: 2005-02-15 00:59:14
Description:
This is a suggested new module for tcllib, containing two 
packages 'docstrip' and 'docstrip::util'.

What the docstrip package provides is primarily the ability 
to use source files that are not in the traditional "raw code" 
form, but may contain also much other material (typically 
documentation). Secondarily this makes it convenient to use 
a form of literate programming that is very common in the 
LaTeX community also for Tcl programs.

(For an example, see
  http://cvs.sourceforge.net/viewcvs.py/alphatcl/Developer/
Source/dialogs/dialogsNew.dtx?rev=HEAD&view=log   
(source file)
and
  http://cvs.sourceforge.net/viewcvs.py/alphatcl/Help/
Dialogs%20Help.pdf?rev=HEAD&content-type=application/
pdf   (typeset form of the above)
.)

The attached archive contains seven files.
  docstrip.tcl
  docstrip.man
  docstrip.test
  docstrip_util.tcl
  docstrip_util.man
are the traditional .tcl sources, doctools-style 
documentation, and test suite required a tcllib module. The 
sixth file
  tcldocstrip.dtx
is the _actual_ source for the entire module. The first five 
files can be regenerated from it by LaTeXing the seventh file
  tcldocstrip.ins
For what good would a source documentation system be if 
one couldn't use it to document itself?
User Comments: andreas_kupries added on 2005-02-15 07:59:13:
Logged In: YES 
user_id=75003

Committed/added to CVS head. Lars will be added as developer
to Tcllib as well, and bug reports etc. in the docstrip
category will be (auto-)assigned to him.

lars_h added on 2005-01-11 00:22:16:

File Added - 115276: tcldocstrip.tar.gz

Attachments: