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 revisionPrevious revision
Next revision
Previous revision
drafts:victron_manual_of_style [2020-03-30 01:39] – [List of words that are often written incorrectly] guy_stewartdrafts:victron_manual_of_style [2026-02-27 05:19] (current) – [List of words that are often written incorrectly] guy_stewart
Line 38: Line 38:
   * Color Control GX or CCGX   * Color Control GX or CCGX
   * Venus GX or VGX   * Venus GX or VGX
-  * GX device - collective name for CCGX, VGX, Cerbo GX and so on.+  * SolidSwitch 
 +  * GX device - collective name for CCGX, VGX, Cerbo GX, Ekrano GX and so on.
   * equalisation - UK spelling, not Equalization   * equalisation - UK spelling, not Equalization
   * synchronise or synchronisation - UK spelling, not synchronize or synchronization   * synchronise or synchronisation - UK spelling, not synchronize or synchronization
Line 49: Line 50:
   * Off-grid - note the grid is lowercase and the word is hyphenated. Use off-grid mid-sentence.   * Off-grid - note the grid is lowercase and the word is hyphenated. Use off-grid mid-sentence.
   * Grid-connected - similar to off-grid.   * Grid-connected - similar to off-grid.
 +  * BMS-Can - The implementation of CAN-bus that is specific to managed batteries in Victron GX devices
 +  * MultiPlus-II
 +  * BatteryLife - feature in the GX device, part of ESS.
 +  * Node-RED
 +  * Modbus-TCP   (yes officially its perhaps without a dash, but we include it)
 +  * Signal K   (yes with that confusing space)
 +  * run time - as in generator run time. not runtime or run-time
 +  * Passthrough
 +  * Victron Recommended Software Integrator Program
 +  * VRM Online Portal, or VRM Portal - also fine to just be VRM, but when using Online and/or Portal capitalise them
 +  * VRM Portal ID - unique GX device hexadecimal code used to register on VRM, not site id. 
 +  * BMS plural is BMSs. Incorrect: BMS's, BMSes, 
 +  * Switch pane - the name of the switch area that is an option on a GX device menu.
 +  * AC-IN and AC-OUT
  
  
Line 68: Line 83:
 ==== Style ==== ==== Style ====
  
-If in doubt //The Economist// has one of the best style guides I know of: http://www.economist.com/styleguide/introduction+If in doubt //The Economist// has one of the best style guides I know of: https://profilebooks.com/work/the-economist-style-guide/ is also available in an eBook.
  
  
Line 81: Line 96:
 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 not be a space between the value and the unit. Example 12V.+There should not be a space between the value and the unit. Example 12V & 3000VA.
  
 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 12MW, 5kVA and 10mA. 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 12MW, 5kVA and 10mA.
drafts/victron_manual_of_style.1585525182.txt.gz · Last modified: by guy_stewart

Donate Powered by PHP Valid HTML5 Valid CSS Driven by DokuWiki