12-09-2009 04:39 PM
In many cases, I think that adding text comments to a LV BD is like a musician adding the letters of the notes to a piece of sheet music. Eventually you learn to "read" in G and well-written code is pretty easy to follow. Two notable exceptions are the state machine aka action engine and mathematical expressions. To help with the latter, I dusted off a little utility to convert LaTeX expressions into PNG files. If you think of paint when you see LaTeX, then this may not help you, but if you have been lucky enough to have written a thesis somewhere along the lines, then this little program is probably your friend.
Enter a LaTeX expression into the text box and run the VI. It will wrap the \begin and \end statements and if you check the box the \begin and \end math statements as well. It will chug through a few conversions and then spit back your PNG file. Drag to the BD and you have one spiffy comment, beats what you get with that other equation editing program that you have to pay $$ for (IMO).
Make sure that your LaTeX (I use MikTeX) and Ghostview paths are entered in your 'Paths' system variable, you should be able to type latex, or gswin32c at any command prompt.
12-09-2009 05:59 PM
Note that you can put animated GIFs on your block diagrams as well. I don't know how much this helps with documentation, but we have code with a picture of a burning computer on the BD. 🙂
Rob
12-09-2009 06:06 PM
12-10-2009 07:39 AM
12-10-2009 08:40 AM
DFGray wrote:
Microsoft Word and OpenOffice both have equation editors which can be used to produce nice equations without learning LaTEX, although one could argue that learning to use them is as bad as learning to use LaTEX. I used a similar system (RUNOFF) for my master's thesis and am very glad I had Word 2.0 and a Macintosh Plus to do my PhD.
That reminds me!
For my "Measure the diameter of a Pretzel" app where I had to use GPS to charaterize the turning radius of surface vessels...
I had to do some math so I used a two frame seq structure, one frame for the code and the other for my math
Ben