|
|
Back to UserFriendly Strip Comments Index
| Even among geeks I think I'm a geek |
by SnappingTurtle |
2009-05-08 12:00:38 |
So I'm writing this long, tedious technical document that references a long, not-as-tedious program. The document includes blocks of code from the program ("...the following code provides an example of ...") and also references specific lines of code ("...lines 2301-2309 calculate the new value of...").
I knew that trying to copy and paste and correctly reference all those lines of code would drive me crazy. I'd never quite believe that I copied and referenced correctly. Also, no matter how sure I am that the code is finalized, there always seems to be one more edit that changes all the line numbers.
So with a little Perl and OpenOffice magic I basically created my own little documentation system in which I can give blocks and lines names right in the code. Then I can set sections and fields in an OpenOffice document to reference blocks and lines by those names. Click click click and my blocks and references all work. If I edit the code then click click click everything jives again.
BTW, I now fully expect someone to mention that there's already some system that does this. If experience is a guide, it will probably be a system with lots of features that don't quite exactly do what I need and will be so confusingly documented that I would have ended spending much more time finding out I can't get it to work then I did just rolling my own. Ah, but that's the bitter pessimist in me coming out. Feel free to prove me wrong. |
|
[ Reply ] |
|
Bibtex? ;) | by jpprater | 2009-05-08 12:37:57 |
|
|
[Todays Cartoon Discussion]
[News Index]
|
|
