Differences

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

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
start [2015/05/08 02:55]
slackermedia
start [2017/05/15 04:59] (current)
Line 11: Line 11:
  
  
-[[{arrown.png|border:0;​background:none;width:0;display:​inline-block;​position:​fixed;​bottom:​0;​margin-left:​66%}intro|]] +Typographical Conventions 
-[[{arrowp.png|border:​0;​background:​none;​width:​0;​display:​inline-block;​position:​fixed;​bottom:​0;​margin-left:​26%;​}start|]]+---------------------------- 
 + 
 +This text attempts to follow common conventions in technical documentationMost of it will be intuitive, but to be clear: 
 +  
 +''​Monotype''​ 
 +  *application names 
 +  *commands 
 +  *filename 
 + 
 +**Boldface** 
 +  *gui elementslabels, tabs, buttons, window_titles 
 +  *Keywords, jargon, or important phrases 
 + 
 +//​Italics//​ 
 +  *Emphasis 
 + 
 +**Alerts** 
 +<WRAP alert> 
 +Alert box 
 +</​WRAP>​ 
 +Important information that, if ignored, will cause something to fail.  
 + 
 +**Important** 
 +<WRAP important>​ 
 +Important box 
 +</​WRAP>​ 
 + 
 +Information that could confuse new users, but that will probably be common knowledge to experts. Pay special attention to these notices to level up. 
 + 
 +**Tip** 
 +<WRAP tip> 
 +Tip box 
 +</​WRAP>​ 
 + 
 +Optional information that often represents what the authors and other users of Slackermedia do, but may or may not be useful to you, depending on your personal style. 
 + 
 +**TL;DR** 
 +<WRAP info> 
 +Too LongDidn't Read 
 +</​WRAP>​ 
 + 
 +For the impatient. These boxes sum up the contents of a chapter or section. If you only need a reminder of what to do, go straight to these boxes. If you are a new user, these can be useful summaries, but you should still read //​everything//​. 
 + 
 + 
 +<WRAP centeralign>​ 
 +<wrap fa>​[[start|R]]</​wrap>​ <wrap fa>[[start|S]]</​wrap>​ <wrap fa>​[[intro|Q]]</​wrap>​ 
 +</​WRAP>​