Difference between revisions of "Help:Editing"

From PC-BSD Wiki
Jump to: navigation, search
m (sweet! :-D)
(9 intermediate revisions by 2 users not shown)
Line 1: Line 1:
===Objective===
+
<!-- This ought to be more about how to use the wiki markup than about style guidelines but those ought to be mentioned via link. Silly, I should have added this as a comment. -->
The purpose of defining how pages on the wiki should be written, is to help maintain consistency by having a set guideline, and to enable easier translations of the site into other languages. Since this page is easily accessible below the edit box, it (currently) contains more details of style than actual edit instruction.
+
== Handbook ==
 +
[[PC-BSD Wiki:Style Guidelines|Style Guidelines]]
  
===Typographic Conventions===
+
== Special Characters ==
 
+
The PC-BSD Handbook uses the following typographic conventions:
+
 
+
:'''bold text:''' represents a command written at the command line. In usage examples, the font is changed with any command output displayed in unbolded text.
+
 
+
:''italic text:'' used to represent device names or file name paths.
+
 
+
:''' ''bold italic text:'' ''' used to emphasize an important point.
+
 
+
===Language usage and word choice===
+
 
+
To facilitate future translations avoid the following:
+
 
+
;Contractions
+
:in place of '''''don't''''', '''''can't''''' or '''''won't''''' use '''do not''', '''cannot''', or '''will not'''.
+
 
+
;Avoid brand names
+
:use '''web''' ''search'' instead of '''''Google''' search''
+
 
+
===Special Characters===
+
;Traversal of menus/windows
+
:use an arrow (➜) as in the example:
+
::PC-BSD control panel ➜ System manager ➜ System packages tab
+
  
 
----
 
----
Line 32: Line 10:
 
<!-- LEFT Column -->
 
<!-- LEFT Column -->
 
| style="width:33%; background:#F6FFf6; padding:1em; text-align:left; border:solid #BFBFA3; border-width:2px 1px 2px 2px;" valign="top"|
 
| style="width:33%; background:#F6FFf6; padding:1em; text-align:left; border:solid #BFBFA3; border-width:2px 1px 2px 2px;" valign="top"|
;Punctuation
+
; Punctuation
*apostrophe ( ’ ' )
+
* apostrophe ( ’ ' )
*brackets ( [ ], ( ), { }, ⟨ ⟩ )
+
* brackets ( [ ], ( ), { }, ⟨ ⟩ )
*colon ( : )
+
* colon ( : )
*comma ( , )
+
* comma ( , )
*dash ( ‒, –, —, ― )
+
* dash ( ‒, –, —, ― )
*ellipsis ( …, ..., . . . )
+
* ellipsis ( …, ..., . . . )
*exclamation mark ( ! )
+
* exclamation mark ( ! )
*full stop/period ( . )
+
* full stop/period ( . )
*guillemets ( « » )
+
* guillemets ( « » )
*hyphen ( ‐ )
+
* hyphen ( ‐ )
*hyphen-minus ( - )
+
* hyphen-minus ( - )
*question mark ( ? )
+
* question mark ( ? )
*quotation marks ( ‘ ’, “ ”, ' ', " " )
+
* quotation marks ( ‘ ’, “ ”, ' ', " " )
*semicolon ( ; )
+
* semicolon ( ; )
*slash/stroke ( / )
+
* slash/stroke ( / )
*solidus ( ⁄ )
+
* solidus ( ⁄ )
 
<!-- MIDDLE Column -->
 
<!-- MIDDLE Column -->
 
| style="width:33%; background:#F6FFf6; padding:1em; text-align:left; border:solid #BFBFA3; border-width:2px 1px 2px 1px;" valign="top"|
 
| style="width:33%; background:#F6FFf6; padding:1em; text-align:left; border:solid #BFBFA3; border-width:2px 1px 2px 1px;" valign="top"|
;Word dividers
+
; Word dividers
*space ( ) ( ) ( ) (␠) (␢) (␣)
+
* space ( ) ( ) ( ) (␠) (␢) (␣)
*interpunct ( · )
+
* interpunct ( · )
;General typography
+
; General typography
*ampersand ( & )
+
* ampersand ( & )
*at sign ( @ )
+
* at sign ( @ )
*asterisk ( * )
+
* asterisk ( * )
*backslash ( \ )
+
* backslash ( \ )
*bullet ( • )
+
* bullet ( • )
*caret ( ^ )
+
* caret ( ^ )
*dagger ( †, ‡ )
+
* dagger ( †, ‡ )
*degree ( ° )
+
* degree ( ° )
*ditto mark ( 〃 )
+
* ditto mark ( 〃 )
*inverted exclamation mark ( ¡ )
+
* inverted exclamation mark ( ¡ )
*inverted question mark ( ¿ )
+
* inverted question mark ( ¿ )
*number sign/pound/hash/octothorpe ( # )
+
* number sign/pound/hash/octothorpe ( # )
 
<!-- RIGHT Column -->
 
<!-- RIGHT Column -->
 
| style="width:33%; background:#F6FFf6; padding:1em; text-align:left; border:solid #BFBFA3; border-width:2px 2px 2px 1px;" valign="top"|
 
| style="width:33%; background:#F6FFf6; padding:1em; text-align:left; border:solid #BFBFA3; border-width:2px 2px 2px 1px;" valign="top"|
*numero sign ( № )
+
* numero sign ( № )
*obelus ( ÷ )
+
* obelus ( ÷ )
*ordinal indicator ( º, ª )
+
* ordinal indicator ( º, ª )
*percent etc. ( %, ‰, ‱ )
+
* percent etc. ( %, ‰, ‱ )
*pilcrow ( ¶ )
+
* pilcrow ( ¶ )
*prime ( ′, ″, ‴ )
+
* prime ( ′, ″, ‴ )
*section sign ( § )
+
* section sign ( § )
*tilde ( ~ )
+
* tilde ( ~ )
*underscore/understrike ( _ )
+
* underscore/understrike ( _ )
*vertical/broken bar, pipe ( ¦, | )
+
* vertical/broken bar, pipe ( ¦, | )
;Intellectual property
+
; Intellectual property
*copyright symbol ( © )
+
* copyright symbol ( © )
*registered trademark ( ® )
+
* registered trademark ( ® )
*sound recording copyright ( ℗ )
+
* sound recording copyright ( ℗ )
*service mark ( ℠ )
+
* service mark ( ℠ )
*trademark ( ™ )
+
* trademark ( ™ )
 
|}
 
|}
 
{| border="1" cellspacing="0" cellpadding="5" class="wikitable" style="border-collapse:collapse;background:#FFFFFF;font-size:large;text-align:center"
 
{| border="1" cellspacing="0" cellpadding="5" class="wikitable" style="border-collapse:collapse;background:#FFFFFF;font-size:large;text-align:center"
Line 320: Line 298:
 
* [[wikipedia:E-Prime#Discouraged_forms_and_rationale_for_typical_replacements]]
 
* [[wikipedia:E-Prime#Discouraged_forms_and_rationale_for_typical_replacements]]
 
----
 
----
====[http://meta.wikimedia.org/wiki/Help:Editing Wikimedia: Help:Editing]====
+
 
[[Wikipedia:Manual_of_Style]]
+
=== [[wikimedia:meta:Help:Editing]] ===
 +
 
 +
[[wikipedia:Wikipedia:Manual of Style]]

Revision as of 12:50, 22 August 2012

Handbook

Style Guidelines

Special Characters


Reference
Punctuation
  • apostrophe ( ’ ' )
  • brackets ( [ ], ( ), { }, ⟨ ⟩ )
  • colon ( : )
  • comma ( , )
  • dash ( ‒, –, —, ― )
  • ellipsis ( …, ..., . . . )
  • exclamation mark ( ! )
  • full stop/period ( . )
  • guillemets ( « » )
  • hyphen ( ‐ )
  • hyphen-minus ( - )
  • question mark ( ? )
  • quotation marks ( ‘ ’, “ ”, ' ', " " )
  • semicolon ( ; )
  • slash/stroke ( / )
  • solidus ( ⁄ )
Word dividers
  • space ( ) ( ) ( ) (␠) (␢) (␣)
  • interpunct ( · )
General typography
  • ampersand ( & )
  • at sign ( @ )
  • asterisk ( * )
  • backslash ( \ )
  • bullet ( • )
  • caret ( ^ )
  • dagger ( †, ‡ )
  • degree ( ° )
  • ditto mark ( 〃 )
  • inverted exclamation mark ( ¡ )
  • inverted question mark ( ¿ )
  • number sign/pound/hash/octothorpe ( # )
  • numero sign ( № )
  • obelus ( ÷ )
  • ordinal indicator ( º, ª )
  • percent etc. ( %, ‰, ‱ )
  • pilcrow ( ¶ )
  • prime ( ′, ″, ‴ )
  • section sign ( § )
  • tilde ( ~ )
  • underscore/understrike ( _ )
  • vertical/broken bar, pipe ( ¦, | )
Intellectual property
  • copyright symbol ( © )
  • registered trademark ( ® )
  • sound recording copyright ( ℗ )
  • service mark ( ℠ )
  • trademark ( ™ )
Dingbats
  0 1 2 3 4 5 6 7 8 9 A B C D E F
U+270x
U+271x
U+272x
U+273x
U+274x
U+275x
U+276x
U+277x
U+278x
U+279x
U+27Ax
U+27Bx
Notes
1. As of Unicode version 6.1


wikimedia:meta:Help:Editing

wikipedia:Wikipedia:Manual of Style