doc/colors_notes.md

   1 # Notes on Color usage
   2 <a id="Top"></a>
   3
   4
   5 # Table of Contents
   6 - [Notes on Color usage](#notes-on-color-usage)
   7 - [Table of Contents](#table-of-contents)
   8   - [style/color](#stylecolor)
   9     - [Definition](#definition)
  10     - [Styled header](#styled-header)
  11     - [non styled header](#non-styled-header)
  12   - [Proxspace](#proxspace)
  13   - [Help texts](#help-texts)
  14
  15 The client should autodetect color support when starting.
  16
  17 You can also use the command  `pref show` to see and set your personal setting.
  18
  19 Why use colors in the Proxmark3 client? When everything is white it is hard to extract the important information fast. You also need new-lines for extra space to be easier to read.
  20 We have gradually been introducing this color scheme into the client since we got decent color support on all systems: OSX, Linux, WSL, Proxspace.
  21
  22
  23 ## style/color
  24 ^[Top](#top)
  25
  26 The following definition has be crystallized out from these experiments.  Its not set in stone yet so take this document as a guideline for how to create unified system scheme.
  27
  28 ### Definition
  29 ^[Top](#top)
  30
  31 - blue - system related headers
  32 - white  - normal
  33 - cyan - headers, banner
  34 - red - warning, error,  catastrophic failures
  35 - yellow - informative  (to make things stick out from white blob)
  36 - green - successful,  (to make things stick out from white blob)
  37 - magenta - device side messages
  38
  39
  40 ### Styled header
  41 ^[Top](#top)
  42
  43 ```
  44     PrintAndLogEx(NORMAL, "");
  45     PrintAndLogEx(INFO, "--- " _CYAN_("Tag Information") " ---------------------------");
  46 ```
  47 For more examples, see also all **-h**  helptext now in the LUA scripts.
  48 For the command help texts using _YELLOW_ for the example makes it very easy to see what is the command vs the description.
  49
  50 ### non styled header
  51 ^[Top](#top)
  52
  53 Most commands doesn't use a header yet. We added it to make it standout (ie: yellow,  green) of the informative tidbits in the output of a command.
  54
  55
  56 ## Proxspace
  57 ^[Top](#top)
  58
  59 Proxspace has support for colors.
  60
  61
  62 ## Help texts
  63 ^[Top](#top)
  64
  65 The help text uses a hard coded template deep inside the cliparser.c file.