Differences

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

--- drafts:victron_manual_of_style [2022-01-19 13:02] – [Style] pbu
+++ drafts:victron_manual_of_style [2026-07-29 09:41] (current) – [Units] jono
@@ Line 34: / Line 34: @@
   * VE.Smart
   * CAN-bus
-  * VictronConnect
+  * VictronConnect app (always include the "app" term!)
   * VEConfigure
   * Color Control GX or CCGX
   * 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
   * synchronise or synchronisation - UK spelling, not synchronize or synchronization
@@ Line 52: / Line 53: @@
   * 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
+  * NMEA 2000
@@ Line 71: / Line 84: @@
 ==== Style ====
-If in doubt //The Economist// has one of the best style guides I know of: https://shop.economist.com/collections/books/products/the-economist-style-guide-12th-edition also available in EBook
+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 84: / Line 97: @@
 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, 100Ah and 10mA.
+==== Currency ====
+No space between the currency symbol and the figure. Use a comma as the thousands separator and a full stop before the pence or cents. For example: £12,500 / £12,500.89 / €12.57 / €120,800.57 / $400.67
+Include a three letter indication when dealing with multiple currencies when showing the Dollar sign to avoid confusion. Example $5000 USD, $864.50 AUD.
 ==== Victron Energy departments - names and definitions ====