From: Grzegorz A. H. <gr...@ti...> - 2006-09-09 18:29:05
|
On 2006-09-06, Alan G Isaac <ai...@am...> wrote: > My current need: > I am discussing some code. > I need to use current examples of the actual code. > If the code changes, I need those changes to be reflected in my document. > > A need at other times: > I am referencing documents that are under active revision, > and I need to include text drawn from the current version of > those documents. I did extract fragments of source code for a document. I marked the beginning and ending in the source code, and used sed to extract them to individual files which would be included inside LaTeX as verbatim sections. Everything was driven with make, so updating the source code would regenerate all affected postscript files. This kind of methods works pretty well with any program, not just reST. You could be using other software which deals with external resources. Putting explicit extraction support in a documentation tool can be nice, but is limited precisely to the type of source code allowed, either in the parsing or the kind of tokens used to delimit the fragments. Are you talking about C, Java, Python, XML, SQL database initialisation scripts? By manually extracting fragments you can also do nice things like syntax highlighting or inserting automatic cross references. |