Also check out the Grammar Guidelines for Reports for a simple table of common errors!
Presenting data in an understandable format requires thought and attention to detail. Follow these guidelines when preparing graphs for lab reports and presentations.
{float:right|border=2px solid black|width=200px}
!Process Controller^stampbox.jpg|width=200px!
h5. Basic Stamp® microprocessor control box with ports for 6 on/off devices and 6 variable speed peristaltic pumps.
{float} |
An #output control box designed and fabricated around the Basic Stamp® Microprocessors (Parallax 16 port BS2sx and 40 port BS2p BASIC Stamp® modules) is used for on/off control of up to six devices and for variable control of up to six peristaltic pumps.
The float macro keeps the graphic and the caption together and floats the figure on the page with text wrapping around it automatically. Because the top of the figure will align with the text that the float is above, I recommend inserting the figure wrapped in the float macro immediately above the paragraph where the first reference to the figure occurs. This will place the figure along side the paragraph with the reference. Use anchors to refer to the figure just like you would use "Figure 11" references in a conventional manuscript. There is no way to implement auto numbering of the Figures so for now don't even bother to use numbers in the Figure. Instead, in the body of the report where you first reference the #output control box add an anchor link that connects to the Figure. Use heading 5 for table and figure captions. This makes it possible to generate a list of tables and figures. Note that there is no numbered Figure reference in the caption. Also note that the image is a hyperlink to the full size original image. If the image is from a different source file the hyperlink should be to the original source file such as a MathCAD or Excel sheet.
In this example I set the size of the float and the size of the image to 200px. The viewer can see the full image by clicking on it.
Save the data as an excel spreadsheet containing only the data that you actually want to graph. For info on the parameters see the chart userguide.
|
Do not use poor quality images. Images are used to convey ideas, so they should be clear, legible and descriptive. You should update them until they look good enough to present in a paper. Some useful guidelines:
Tables do not convey trends nearly as well as graphs. They should only be used to display information that is not meant to be on a graph. Tables should be created using the following format. You should not use images of tables.
{float:right|border=2px solid black|width=270px}
{anchor:analog wiring standard}
h5. Wiring standard used for combining power supplies and analog data acquisition in a Category 5 Ethernet cable.
|| *T-568B standard* || *T-568A standard* || *voltage* ||
| white/orange | white/green | S\- |
| orange | green | S\+ |
| white/green | white/orange | ground |
| blue | blue | \-5 V |
| white/blue | white/blue | \+5 V |
| green | orange | \+10V |
| white/brown | white/brown | \-15 V |
| brown | brown | \+15 V |
{float} |
Here is an example table. This is a relatively complex example because when you go to edit this page, you will see that the simple table code is included in a "float" command. Here I refer to the table by creating an internal link (an anchor) that will take the viewer to the top of the table. For example here I am talking about the #analog wiring standard that we use in the AguaClara laboratory. Note that I position the floating table above the paragraph where it is first referenced so that it appears along the side of that paragraph. I haven't figured out an automatic way to set the width of the table. Currently I am doing it by trial and error. If someone figures out a better way, please edit this!
To create a simple table, you just need a series of vertical slashes in rows-- two slashes makes a header cell, and one slash makes a regular cell.
|| column 1 || column 2 || column 3 || | item 1 | item 2 | item 3 | |
column 1 |
column 2 |
column 3 |
|---|---|---|
item 1 |
item 2 |
item 3 |
When you are creating tables:
All equations should be added using MathType. Do not simply type in an equation to the wiki.
{float:right|border=2px solid black|width=400px}
[!Style Guide for Figures, Tables, and Equations^MathTypeHelp.png|width=400px!|Style Guide for Figures, Tables, and Equations]
{float} |
{latex}
\large
paste your equation here
{latex}
|
For example:
{latex}
$$
\varphi _
{floc} = {{C_{Al\left( {OH} \right)_3 } \left( {{{\rho _{Al\left( {OH} \right)_3 } - \rho _{H_2 O} } \over {\rho _{Al\left( {OH} \right)_3 } }}} \right) + C_{clay} \left( {{{\rho _{clay} - \rho _{H_2 O} } \over {\rho _{clay} }}} \right)} \over {\left( {\rho _{floc}
\- \rho _
{H_2 O}
} \right)}}
$$
\\
{latex} |
Congratulations, you have created an equation.