Documentation
Fields
...
Fields are a simple way for Word to insert images and equations into the document. They also have the benefit of automatically updating formats based on changes.
...
If the field you want to insert does not fit in the Field Codes line, return to the document to add additional text. With codes visible (Alt+F9), type in the desired text. Then, right-click on the text and select "Update Field."
Design Specification document
To insert regular text, simply type as you would for any document. This text will remain constant for every design.
To add variables, simply type in the name and LabView will insert the correct numerical value when a design is requested from the Server. This text will be specific to the design values used in each particular plant. For example, type "The surface area of the Entrance Tank is A.EtFloor" and the value of A.EtFloor, with any attached units, will be inserted.
Whether working from a description ("diameter of horizontal pipe in entrance tank") or a variable name ("ND.RMPipe") it is imperative that we use accurate variables. Use the Variable Naming Guide (attached here), the MathCAD files, and the wiki to ensure consistent naming convention.
Formatting
Table of Contents and Headings
To add a Table of Contents (TOC), go to the References tab and click on the Table of Contents button in the Table of Contents section at the left edge.
Select the Insert Table of Contents... option and click the OK button. A small amount of text should appear that says, "No table of contents entries found." If you tap Alt+F9, you should see the following: "TOC\o"1-3"\h\z\u"
To add your first heading to your document, and to the TOC, type text below the TOC field where you want the text to appear, highlight it, and select the Heading 1 option from the Styles tab. The text should now appear slightly larger and colored blue.
To update the TOC, click on the References Tab, go to the Table of Contents section again, and click on the Update Table option. If a dialog box opens giving you two options, select the Update entire table option and click the OK button.
For example, adding the Table of Contents will look like this when Fields are on, and like this when they are off.
Equations
We want to be able to write equations to satisfy two criteria:
1) They are formatted well
2) We can reference an equation multiple times while only having to write it out explicitly once.
To do this, we use MathType, which is a simple way to put equations into MS Word Documents.
...
In Office 2007, go to the "MathType" Section of the main ribbon. It should be on the far right, next to "View"
Go to the Insert Equation section of the ribbon on the far left and click on one of the options to open up MathType. "Inline", "Display" or "Right-Numbered" all determine the alignment of the equation in the document.
Once you type the equation you want in MathType, go to File > Update "Document Name" and then close MathType.
Numbering an Equation (Not
...
needed if you already inserted a number)
Go to the "MathType" Section of the main ribbon. It should be on the far right, next to "View"
Click on the equation you wish to number. A blue box with little blue squares should appear around it.
Go to the Equation Numbers section and select the Insert Number option. (Note there is a dropdown menu there, so you can decide how you want to number the equations.)
A number should appear by the equation you selected.
...