Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

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.

...