Loading...
 


This page lists the typographic conventions used on the N1MM wiki website. The purpose of these conventions is to:

  • deliver a professional appearance across the entire document
  • enforce consistency among multiple authors
  • ensure compatibility with the wiki platform
  • improve readability on-line and in off-line hard copy


The hierarchy of each wiki structure will consist of: Book >Chapter >Section >Subsection >Sentences
The N1MM Manual is built upon a wiki structure that contains Chapters, Sections, and Subsections. Please review the following guidelines for the proper display of those elements.

1. Chapters

  • Do not include the word Chapter, nor a number, in the title line. The wiki will automatically add numbering at time of display and/or print
  • The Chapter title will follow proper upper/lower case format (upper case each word except words like of, to, the, a, an...)
  • The Chapter title font will be wiki H1, centered on the page (wiki editor syntax: one exclam and double surrounding colons
    • For example: (go to <Edit> mode to see wiki editor syntax for Chapters)

Here is a Chapter Title

1. Sections

  • Do not include the word Section, nor a number, in the title line. The wiki will automatically add numbering at time of display and/or print
  • The Section title will follow proper upper/lower case format (upper case each word except words like of, to, the, a, an...)
  • The Section title font will be wiki H2, left-justified on the page (wiki editor syntax: double exclams)
    • For example: (go to <Edit> mode to see wiki editor syntax for Sections)

Here is a Section of a Chapter

1. Subsections

  • The Subsection title line will not be numbered, but merely be a visible heading in a section
  • The Subsection title will appear like a regular sentence - first letter in upper case, and all remaining words in lower case except for proper nouns and acronyms
  • The Subsection title will be enclosed withan an HTML DIV (wiki editor syntax: a dash and equal sign at the beginning of the Subsection, following by an equal sign and dash at the end)
    • For example: (go to <Edit> mode to see wiki editor syntax for Subsections)

2. Sentences

  • All paragraphs should be left-justified (no paragraph indenting)
  • The first letter of each sentence should be in upper case, and all remaining words in lower case except for proper nouns and acronyms
  • Use the standard wiki font for sentences
  • Each sentence ends with a period, except questions (?) or exclamatory statements (!)
  • Do not use multiple ? or ! as those are reserved for wiki formatting and may cause problems
  • Separate all sentences with a SINGLE SPACE. reference: Your PC is Not a Typewriter by Williams

3. Displaying N1MM Menus

When instructing users on complicated menu choices, it is often best to include a screenshot of the menu choice.

Image


However, for simpler menu instructions, use a method similar to the instructions seen on this website. The wiki pages display a breadcrumb trail which lists the user's current location on the website. For example, the breadcrumb trail for this page is probably listed as:
Location: N1MM Logger Documentation >wikidev >Notes to Authors and Editors >Style Guide

For consistency, use a similar breadcrumb trail in your documents, using the > symbol to navigate the N1MM menu system. For example, the trail for the menu screenshot above would be:
Config >Change CW/SSB/Digital Message Buttons >Change CW Buttons

When instructing the user to make a program choice involving a button on their screen, identify the button within pointy <> brackets. For example, Press <OK>, Press <Run>, Press <Wipe>


 Special wiki characters

Some combinations of punctuation characters are intercepted by the wiki as control characters and do not display correctly. At times, the characters will not display correctly in wiki editor Preview mode but will look fine in a regular browser window. When inserting text with < > [ ] { }, open a separate browser window to the wiki site to see exactly how the text is displayed.

4. Function Keys, Labeled Keys, and Typed Text

  • List keyboard keys with upper-case first letters and lower remainders. Exception is the two-word keys PgUp and PgDn
    • Tab, Enter, Space, Ctrl, Alt, Shift, Home, End, Delete, Ins, PgUp, PgDn
  • Use Ctrl and Alt as abbreviations for the Control and Alternate keys
  • Add a plus sign + to indicate key combinations with the Shift, Ctrl, and Alt keys
    • Ctrl+J, Ctrl+Shift+J, Alt+Home
  • When referring to a function key, use an upper case F followed by the key number
    • F4, Ctrl+F8, Shift+F4

5. Bullets

  • Bullets always begin with a capital letter
  • Bullets are not considered sentences, and should not end with a period
  • The only time periods should be used within Bullets is when you have a long single bullet with multiple statements. Terminate each internal statement with a period, but not the final statement
  • These bullets are good examples of how to use bullets


Another bullet example:

  • Just type the text and it will line-feed and indent auto-magically
  • This is fast, and keeps you from having to force a linefeed and then make the indent

6. Acronyms

Acronyms should always be entered in all UPPER case. Most technical documents are full of acronyms and special expressions, and the N1MM Logger manual is no exception. Upon first use of an acronym in a chapter or section, enter its definition in parenthesis. If you think you might be using the acronym for the very first time anywhere in the manual, consider adding it to the Glossary Page in the Wiki User Guide.
For example, when writing about ESM (Enter Sends Messages), the definition of the acronym helps the user understand what the acronym means.

7. Q Codes

Q Codes should be treated like acronyms and entered in all UPPER case. For example: QSO, QRV, QTH

8. Filenames

Filenames should be listed in case-appropriate bold text. For example: Save the file, named N1MM-FulIInstaller.exe, to your download directory or the desktop of your PC.

9. Special Words

Program components

Window names will have initial capitals, but the word "window" in such a name will be all lower case - e.g. Entry window
Dialog names will have initial capitals, but the word "dialog" will not be - e.g., Contest Setup dialog
Error Message titles will have initial capitals, but when used generically "error message" will not.

Others

Callsign - one word, no dash
Filename - one word
Key names - Individual characters will be capitalized and bold-faced - e.g., R. Text key names - e.g., Scroll Lock, Space (not spacebar), and Enter will have initial capitals and be bold-faced.


Last Modification: 23 July 2015 19:45:57 EDT by K8UT.