Document Style Guide

Layout Guidelines:

1. Text format:
1. Ascii text:
• Keep the document as simple as possible. Try to avoid newspaper type setup [of text]. The document should include only standard printable ascii characters (no control characters please).
2. Notes to Editing Team:
• All notes to the editing team (regarding fonts, links, formatting and such) must be enclosed in {curly brackets}. Hand annotations on a hard copy [of the document] are preferred here though.
3. Indenting:
1. General Rules:
• There should be no indenting used in any documents submitted. As html will do this automatically, if included, it is just something the editing team will have to remove. All text should be lined up flush with the left margin. Paragraphs should not be indented but should be separated with at least one blank line.
2. Bulleted Points:
• The only exception to this rule is bulleted points. The first line of a bulleted point should be indented one TAB stop; any additional lines should be flush with the left margin. The use of the initial TAB stop is just to let the editing team know that a bulleted point is desired in the final copy. Use no special characters for the bullet; these will be added later in final html formatting
eg.

	this is an example of a really long bulleted point that is indented one TAB stop on the first line but will not be indented on subsequent lines
	this is one small bulleted point
	and this is another small bulleted point

3. Special Effects:
• If any special text effects are required, please submit a hard-copy of the document to the editing team with hand drawn annotations regarding text effects, links and such. If it is not possible (because of possible time restrictions) to submit an annotated hard copy, special formatting notes should always be included in {curly braces}. Links documented in this fashion should appear as follows:
eg.

[heading] {make this heading bold face underlined please}
[text] [keyword(s)]{Link to 1}
[more text - blah blah blah...]
{Link 1 Here}

2. Advanced Layout
1. Section Headings (format):
• Headings and subheadings should not be indented. Sections should be separated with blank lines. Do not type headings and such in all capital characters. Headings and subheadings should be organized and appear as follows:
eg.

1.) Major section
2.) Another section
A.) Subsection
B.) another subsection
i.) subheadings
ii.) ditto
a.) further subheadings
b.) ditto

2. Tables:
• Try to avoid the use of tables. This does not mean that tables are to be entirely excluded; they are just a little bit of a pain to set up in html. If a table can illustrate a topic more efficiently, it should be used. Tables should be set up in a logical fashion so that the editing team clearly understands the intended format of the table; hand annotations on a hard copy would be helpful here. When setting up tables, please make note of size restrictions (page width). A table that may fit within an emacs window may not fit on a standard page!
3. Graphics
• If graphics are to be included with your document, .gif format is preferred although .xbm and .jpg are also acceptable. Desired location of the image should be clearly noted in the text; annotated or enclosed in curly braces. Special layout instructions should also be included in the curly braces.
eg.

[text - blah blah blah...]
{insert /a/nsa/ug/joeblow/pictures/big.gif here - centered}

• Please note that if the graphic files reside in a directory in your account, you will have to open up the permission codes for that particular directory.

General Notes:

1. Table of Contents:
• The editing team will generate a table of contents once the final document has been complied and revised.
2. Appendices:
• If there is material that should be included in an appendix, separate it from the main body of the document and clearly note in curly braces the desired location.
eg.

[text - blah blah blah.....]
{what follows should be included in an appendix}

Last Modified Jan. 20, 1996 by

Darrell Nash