More AWKwardness

For Emu86, we had documentation in two places: the source code, and a help file. We needed to get this DRY, and fast!

So, we needed a documentation extraction and web page generating system. First I added tags to the source code documentation, like this. See lines 23-36.

Then I wrote this program to pull out the tags and everything in between. A single line of code!

Then we read the "tagged-text-only" files and turn those into HTML with this program. The last two items could have been a single program, but why clutter up that elegant first program with HTML tagging specific to this project? The program to extract tagged text could be useful in many, many projects: Best to make it standalone, and combine it in a pipeline with other programs.

Finally, we use our existing include facility to pull the HTML descriptions of the instructions into our help file.

Comments

Popular posts from this blog

Central Planning Works!