Style

By DocLab | 27 August, 2017

Description

Boxxd has a certain style in the naming of names, directories, writing of titles in help texts, etc.

This page contains notes concerning these styles.

User front facing components

Front facing files and directory components are similar to users expectations in Windows i.e.:

  • Start with a capital letter.

To provide coherent file paths, all names should be without whitespace, i.e.:

  • Dashes are used between words.

Technical components

Technical components such as .help, .wiring, are:

  • Written in small case.
  • Dashes are used between words.

Help text

Titles are:

  • Start with a capital letter
  • Written in small case