Workbook for SLD Offline Users - Writing Standards

All members of the New Users Task Force should feel free to update this file.

Use this page to note writing standards for the workbook. These could be either HTML style conventions or IDA coding conventions.

HTML Style Conventions

• Text that the user should type in should be indicated using the kbd and /kbd formats.
• Text that the computer returns should be indicated using the pre and /pre formats if it is to be displayed separately from other text.
• Text that the computer returns should be indicated using the code and /code formats if it is to be incorporated into other text.
• The first time a new word is introduced, it should be in quotation marks.
• Avoid using other style marks. If we start to use too many different marks, we quickly lose the consistent feel of the Workbook.

IDA Coding Conventions

• Use Mini-DST data in examples wherever reasonable.
• Use explicit POINTER constructions in IDA, i.e. POINTER P_PHCHRG --> PHCHRG
• HIST statements should contain explicit, integer, hist ids.