Skip Navigation.

NWE Help: Make: Conventions

NWE Home :: Help :: Make


Notes

One of the general patterns we use when we're writing help pages is the "note." A note is usually a warning or important tidbit we've included on one of the help pages.

Notes are formatted as follows:

Note: This code for this note appears below.

<P>
  <STRONG>
    <FONT COLOR="#990000">
       Note: This same code appears above.
    </FONT>
  </STRONG>
</P>

Terminology:

  • Don't use "yourID", "login", etc to describe usernames; use "username" instead.
  • For a hyptothetical student username, use "jdoe" -- we have an account which corresponds to that, so we can make sample files.
  • We will use lower case "w" for all forms of the word "web" hereafter.

Incomplete documentation:

Use this text for incomplete or out of date dox:

Note: Due to the recent NWE upgrade, this documentation needs to be developed. This will be completed as soon as possible.

If you have problems with these applications please contact the NWE help staff. If you are an NWE instructor and can help develop documentation for these applications, we'd love to hear from you as well.

We apologize for the inconvenience.

Here is the code:

<table cellpadding=10 width=80% align=center bgcolor=#FFFFCC>
<tr>
<TD>

<P>
 <STRONG>
   <FONT COLOR="#990000">
      Note: 
   </FONT>
      Due to the recent NWE upgrade, this documentation needs to be
      developed. This will be completed as soon as possible.
 </STRONG>
</P>

<P>
    If you have problems with these applications
    please <A HREF="HELP_DIR/contact.shtml">contact the NWE help staff.</A>
    If you are an NWE instructor and can help develop documentation for
    these applications, we'd love to hear from you as well.
</P>

<P>
We apologize for the inconvenience.
</P>

</td>
</tr>
</table>