Differences

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

--- drafts:victron_manual_of_style [2019-09-10 05:53] – [Units] mleeftink
+++ drafts:victron_manual_of_style [2024-11-13 12:56] (current) – [List of words that are often written incorrectly] guy_stewart
@@ 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.
+  * GX device - collective name for CCGX, VGX, Cerbo GX, Ekrano 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
+  * 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.
 ==== GX Product Classifications ====
@@ Line 56: / Line 79: @@
 ==== 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://shop.economist.com/collections/books/products/the-economist-style-guide-12th-edition also available in EBook
 ==== Type Faces Used ====
-  * MyriadPro-Bold
+  * Myriad Pro-Bold
-  * MyriadPro-It
+  * Myriad Pro
   * Helvetica Neue regular, bold and condensed black
   * Arial regular and bold
 ==== 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 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 12MW, 5kVA and 10mA.
+==== Victron Energy departments - names and definitions ====
+**Service Department** - Sometimes referred to as "Repairs Department" but the correct name is Service Department.
-There should be a space between the value and the unit. Example 12 V.
+**Repair Centre** (previously called Service Partner) - These are external companies (customers) who perform product repairs on behalf of the Victron Energy Service Department.
-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.