StyleSheet

From Win-Test Wiki
Jump to: navigation, search

This article is designed to be a guideline for authors to accomplish reasonable consistency when editing articles featured on the Wiki-based Win-Test documentation.

The project was originally started by Simon Pearson, M0CLW, as an additional source of information for Win-Test users. As time progressed, more users began contributing, each of them with slightly different ideas and editing know-how. So we found it's time for a style guide as this documentation will finally grow into a complete reference manual that will - hopefully - be included with the Win-Test software distribution in the near future, thus replacing the slightly outdated reference manual.

The guideline itself is an example how to format text, commands, function keys, screenshots and how to structure information described in this manual. The current version was agreed among M0CLW, DL4NER and DL6RAI on July 31, 2006. New articles should be formatted accordingly, existing articles should be re-formatted as time permits or whenever they are being worked on.

Note you can click on the 'edit' button at the top of each article/page to view the source code to give you an idea on how things are done.

Language

  • Use proper English.
  • What's proper should be defined by native speakers.

Structuring of articles

  • Start with a short introduction before starting with the meat of the article.
  • The first structure level (i.e. major headings) should use == (i.e. double equal signs). Do not use a single equal sign.
  • Try to group information into subchapters and subsections so that the reader can easily find what they are looking for, courtesy of the automatically generated table of contents.
  • Add a "See also" section at the end of the article if you have references.
  • At the bottom of the page add a link to the next level up Wiki page. If there is none, there is always the Main_Page.
  • Do not put pictures on top of the page. The upper part of the page containing the "Table Of Content" will be stripped when generating the pdf manual.

Previewing and summarising your edits

  • It is always recommended you click on the "Show preview" button after making any changes to ensure everything is formatted as expected.
  • After you have edited a page, please type a brief summary of your changes in the summary field before clicking on "save page". This helps when looking through the history of a page (by clicking on the "History" button at the top of a page) and when viewing the recent changes.

Menu items

  • Put menu items into <code></code> statements.
  • If you have a sequence of Menu actions, use the vertical bar '|' to separate these, like this:

Options | Load contest at startup | Enabled .

The above was created using the following statement:

<code>Options | Load contest at startup | Enabled </code>

Text commands

  • Use Bold typewriter font and Capitals for all Text commands like NOSOUND, QUIT and for message variables like $MYCALL and $SERIAL.

Keys

Most keys should be bold typewriter text.

  • Type F-keys as F1, F2
  • Control keys: ctrl-A
  • Alt keys: Alt-C, Alt-W
  • Shift keys: Shift-F1, Shift-F7
  • Editing keys: [Shift], [Enter], [Insert], [Plus] or [+], [Minus] , [Backspace], [Delete].

Images

  • The windows should come with English titles except for operating system based windows (like the file open dialog).
  • Use PNG or GIF format for the pictures. JPEG is normally not suitable for screen captures.
  • Center any images and use a frame around every image to include a caption, like this:
N + 1 window (Captured call : W5TQ)

The above was created using the following statement:

[[Image:WindowsNp1_1.gif|center|frame|N + 1 window (Captured call : W5TQ)]]

References

  • Try to avoid duplicate information spread all over the Wiki. Use cross-references where applicable like Menu:Edit.
  • Keep a focus - do not try to explain topics beyond the Win-Test application. Use external references where applicable like Cabrillo Specs.

Notes and Tips

Be consistent throughout the text and use the wbox macro for Notes and Tips.

{{wbox|Note|This search only works for contests where ... }}

The result will be indented and displayed in a nicely formatted box which catches the eye of the reader:

Note: This search only works for contests where ...


Back to Main Page