[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 23:20 (UTC)] – Several small fix-ups. alienbobslackdocs:styleguide [2012/09/04 11:50 (UTC)] – [A General Note on Style] visualize key presses. alienbob
Line 97: Line 97:
   * 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).   * 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). Use %%<code></code>%% tags to enclose the output for better legibility.   * If quoting computer output, reproduce it exactly, including spelling (which is usually American). Use %%<code></code>%% tags to enclose the output for better legibility.
 +  * If your text has examples of key presses, use the %%<key></key>%% markup to make a visual impact. <key>Alt-F2</key> looks better than "''Alt-F2''".
  
  
Line 115: Line 116:
 If you think that a Wiki page (written by somebody else or by yourself) is in need of attention from the admin team, you can add a tag "needs_attention" to that page. This will cause the affected page to show up on the "[[tag:needs_attention|pages that need attention]]" page. The admin team will check that page regularly for new entries. If you think that a Wiki page (written by somebody else or by yourself) is in need of attention from the admin team, you can add a tag "needs_attention" to that page. This will cause the affected page to show up on the "[[tag:needs_attention|pages that need attention]]" page. The admin team will check that page regularly for new entries.
  
-When should you use this? For instance, you find an incomplete or badly written text or even an empty page (this can happen if someone writes a non-english text but does not take action to get a proper english translation arranged). Or perhaps you find spam, or offensive language. \\ Your observations will help us keep the Wiki clean and high-quality.+When should you use this? For instance, you find an incomplete or badly written text or even an empty page (this can happen if someone writes a non-English text but does not take action to get a proper English translation arranged). Or perhaps you find spam, or offensive language. \\ Your observations will help us keep the Wiki clean and high-quality.
  
 ===== See Also ===== ===== See Also =====
 slackdocs:styleguide ()