Differences

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

--- drafts:victron_manual_of_style [2019-11-14 13:56] – [Type Faces Used] mleeftink
+++ drafts:victron_manual_of_style [2025-06-27 16:40] (current) – [List of words that are often written incorrectly] jono
@@ Line 27: / Line 27: @@
   * 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.Bus
   * VE.Can
+  * VE.Smart
   * CAN-bus
   * VictronConnect
   * 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.
+  * SolidSwitch
-  * Equalisation  (Not Equalization)
+  * GX device - collective name for CCGX, VGX, Cerbo GX, Ekrano GX and so on.
+  * 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
+  * 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.
 ==== GX Product Classifications ====
@@ Line 56: / Line 82: @@
 ==== 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 67: / Line 93: @@
 ==== Units ====
-Use the International System of Units. for more info see [[https://en.wikipedia.org/wiki/International_System_of_Units|Wikepedia]].
+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 MW, 5 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 12MW, 5kVA and 10mA.
 ==== Victron Energy departments - names and definitions ====