drafts:victron_manual_of_style
Differences
This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revision | ||
drafts:victron_manual_of_style [2018-08-23 13:08] – mvader | drafts:victron_manual_of_style [2024-09-25 15:48] (current) – [List of words that are often written incorrectly] aleximb | ||
---|---|---|---|
Line 7: | Line 7: | ||
==== Language ==== | ==== Language ==== | ||
- | Use US English, as opposed to UK English. | + | Use British |
==== Numbers ==== | ==== Numbers ==== | ||
Line 28: | Line 27: | ||
* Omission or inclusion of spaces or hyphenation. | * Omission or inclusion of spaces or hyphenation. | ||
- | List of words that are often written | + | ===== List of words that are often written |
* 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 the Venus-device. | + | * GX device - collective name for CCGX, VGX, Cerbo GX and so on. |
+ | * equalisation | ||
+ | * 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 | ||
+ | * Signal K (yes with that confusing space) | ||
+ | * run time - as in generator run time. not runtime or run-time | ||
+ | * Passthrough | ||
+ | ==== GX Product Classifications ==== | ||
- | ==== Spelling ==== | + | * GX product range - all GX devices (eg CCGX), |
- | There are several areas in which British | + | |
- | Ref: | + | * GX device |
+ | * GX Card - a circuit board featuring all the GX features that is used in the integrated products, eg EasySolar-II GX and MultiPlus-II GX. | ||
+ | |||
+ | Products that have the GX suffix are a GX device, or contain a GX device. | ||
+ | |||
+ | Products that have a GX prefix are accessories for a GX device. | ||
+ | |||
+ | Generally, public/ | ||
+ | |||
+ | Specific internal/ | ||
==== Style ==== | ==== Style ==== | ||
- | If in doubt //The Economist// has one of the best style guides I know of: http://www.economist.com/ | + | If in doubt //The Economist// has one of the best style guides I know of: https://shop.economist.com/ |
+ | |||
+ | |||
+ | ==== Type Faces Used ==== | ||
+ | |||
+ | * Myriad Pro-Bold | ||
+ | * 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:// | ||
+ | |||
+ | 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 " | ||
+ | |||
+ | **Repair Centre** (previously called Service Partner) - These are external companies (customers) who perform product repairs on behalf of the Victron Energy Service Department. | ||
+ | |||
+ | |||
+ | |||
+ | |||
+ | |||
drafts/victron_manual_of_style.1535022521.txt.gz · Last modified: 2018-08-23 13:08 by mvader