User Tools

Site Tools


drafts:victron_manual_of_style

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
drafts:victron_manual_of_style [2019-11-27 12:37]
mvader [Units]
drafts:victron_manual_of_style [2020-03-31 04:00] (current)
guy_stewart [List of words that are often written incorrectly]
Line 27: Line 27:
   * Omission or inclusion of spaces or hyphenation.   * Omission or inclusion of spaces or hyphenation.
  
-List of words that are often written incorrectly:+===== List of words that are often written incorrectly ​===== 
   * VE.Direct   * VE.Direct
   * VE.Bus   * VE.Bus
   * VE.Can   * VE.Can
 +  * VE.Smart ​
   * CAN-bus   * CAN-bus
   * VictronConnect   * VictronConnect
   * VEConfigure   * VEConfigure
-  * Color Control GX -> CCGX +  * Color Control GX or CCGX 
-  * Venus GX -> VGX +  * Venus GX or VGX 
-  * CCGX/VGX - Referred to collectively as a GX device+  * GX device - collective name for CCGXVGX, Cerbo GX and so on
-  * Equalisation ​ (Not Equalization)+  * equalisation - UK spelling, not Equalization 
 +  * synchronise or synchronisation - UK spelling, not synchronize or synchronization 
 +  * state of charge - do not capitalise or hyphenate, not State of Charge or state-of-charge 
 +  * midpoint – this is one word, it is not capitalised or hyphenated, not Mid point or mid-point 
 +  * house battery - not domestic battery  
 +  * starter battery - not start battery 
 +  * PIN code – not pincode or pin code 
 +  * NMEA 2000, or N2K - note the spacing 
 +  * Off-grid - note the grid is lowercase and the word is hyphenated. Use off-grid mid-sentence. 
 +  * Grid-connected - similar to off-grid. 
 +  * BMS-Can - The implementation of CAN-bus that is specific to managed batteries in Victron GX devices 
  
 ==== GX Product Classifications ==== ==== GX Product Classifications ====
Line 69: Line 82:
 Use the International System of Units. for more info see [[https://​en.wikipedia.org/​wiki/​International_System_of_Units|Wikipedia]]. Use the International System of Units. for more info see [[https://​en.wikipedia.org/​wiki/​International_System_of_Units|Wikipedia]].
  
-There should be a space between the value and the unit. Example ​12 V.+There should ​not be a space between the value and the unit. Example ​12V.
  
-When using a symbol as prefix, like m for milli, K for kilo or M for mega, these are written either capitalized or are lowercase. The symbols for mega and above are capitals, while kilo and below are lowercase. Example ​12 MW5 kVA and 10 mA.+When using a symbol as prefix, like m for milli, K for kilo or M for mega, these are written either capitalized or are lowercase. The symbols for mega and above are capitals, while kilo and below are lowercase. Example ​12MW5kVA and 10mA.
  
 ==== Victron Energy departments - names and definitions ==== ==== Victron Energy departments - names and definitions ====
drafts/victron_manual_of_style.1574854670.txt.gz · Last modified: 2019-11-27 12:37 by mvader