[2024-feb-29] Sad news: Eric Layton aka Nocturnal Slacker aka vtel57 passed away on Feb 26th, shortly after hospitalization. He was one of our Wiki's most prominent admins. He will be missed.

Welcome to the Slackware Documentation Project

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision		Previous revision
Next revisionBoth sides next revision
slackdocs:styleguide [2012/09/03 16:14 (UTC)] – [Note About Notes] New paragraph on style added. hazelslackdocs:styleguide [2012/09/03 21:33 (UTC)] – change capitalization point - added link nocturnal.slacker
Line 100: Line 100:
 The button bar at the top of the edit window contains buttons for easy creation of these notification boxes. The button bar at the top of the edit window contains buttons for easy creation of these notification boxes.
  
-====A General note on Style====+=====A General Note on Style====
  
-This is a wiki so a certain degree of informality is acceptable. This includes, for example, conversational contractions such as "you've". Readers should feel that they are talking to a knowledgeable friend rather than reading a manual. However any appearance of sloppiness must be avoided.+This is a wiki so a certain degree of informality is acceptable. This includes, for example, conversational contractions such as "you've". Readers should feel that they are talking to a knowledgeable friend rather than reading a manual. However, any appearance of sloppiness must be avoided.
   * Do not use slang or "textspeak".   * Do not use slang or "textspeak".
   * Write complete sentences and try to avoid grammatical errors. If English is not your native language, you can always get help from an English editor.   * Write complete sentences and try to avoid grammatical errors. If English is not your native language, you can always get help from an English editor.
-  * Capitalise proper names and the main (subject-oriented) words in headings. +  * Follow proper [[http://www.writersblock.ca/tips/monthtip/tipmar98.htm|capitalization rules]] for words in titles and headings. 
-  * Long passages of plain text are hard to read; always consider if something can be better expressed using a list format. Use numbered lists only for sequential operations, bulleted lists for options or examples (as here)+  * Long passages of plain text are hard to read; always consider if something can be better expressed using a list format. Use numbered lists only for sequential operations, bulleted lists for options or examples (as shown here).
   * If quoting computer output, reproduce it exactly, including spelling (which is usually American).   * If quoting computer output, reproduce it exactly, including spelling (which is usually American).
 ===== Translating a Page ===== ===== Translating a Page =====

Trace:

slackdocs:styleguide ()