schema documentaion (#940)

Add documentation and an extention to help people to write a yaml schema

docs/schema/suggestions.yaml

+m_annotations:
+  eln: "ELN annotations"
+  tabular: "tabular annotations"
+  plot: "plot annotations"
+
+tabular:
+  name: "Either < column name > in csv and xls or in the format of < sheet name >/< column name > only for excel files"
+  unit: "The unit to display the data"
+  comment: "A character denoting the commented lines in excel or csv files"
+
+eln:
+  component: "The name of ELN edit component"
+  hide: "list of hidden items"
+  overview: "with or without overview"
+  default: "The default value fo the component"
+  defaultDisplayUnit: "default display unit for numbers"
+  minValue: "minimum value of the numbers"
+  maxValue: "minimum value of the numbers"
+  dict(): "python dict"
+
+plot:
+  label: "plotly: label of the plot"
+  x: "plotly: x axis"
+  y: "plotly: y axis"
+  lines: "plotly: style of lines"
+  config: "plotly: plot config"
+  layout: "plotly: plot layout"
+
+component:
+  NumberEditQuantity: "a component: to edit quantity of type number"
+  StringEditQuantity: "a component to edit quantity of type string"
+  URLEditQuantity: "a component to edit quantity of type url"
+  EnumEditQuantity: "a component to edit quantity of type enumerate as a dropdown list. This component may be used for short enumerates."
+  RadioEnumEditQuantity: "a component to edit quantity of type enumerate as a list of radio buttons."
+  AutocompleteEditQuantity: "a component to edit quantity of type enumerate as an autocomplete dropdown list. This component may be used for longer enumerates."
+  BoolEditQuantity: "a component to edit quantity of type boolean"
+  FileEditQuantity: "a component to edit quantity of type file path"
+  DateTimeEditQuantity: "a component to edit quantity of type data and time"
+  RichTextEditQuantity: "a component to edit quantity of type rich text"
+  ReferenceEditQuantity: "a component to edit quantity of type reference"
+  UserEditQuantity: "a component to edit quantity of type nomad user"
+  AuthorEditQuantity: "a component to edit quantity of type author"
+
+type:
+  string: "Quantity Type: python string"
+  str: "Quantity Type: python string"
+  float: "Quantity Type: python float"
+  integer: "Quantity Type: python integer"
+  int: "Quantity Type: python integer"
+  boolean: "Quantity Type: python boolean"
+  bool: "Quantity Type: python boolean"
+  np.int32: "Quantity Type: numpy 32 bits integer"
+  np.int64: "Quantity Type: numpy 64 bits integer"
+  np.float32: "Quantity Type: numpy 32 bits float"
+  np.float64: "Quantity Type: numpy 64 bits float"
+  Datetime: "Quantity Type: Date and time"
+  User: "Quantity Type: Nomad User"
+  Author: "Quantity Type: Author"
+  '{type_kind: Enum, type_data: []}': "Quantity Type: Enumerate"
+  '< section name >': "Quantity Type: reference"
+  type_kind: "Quantity Type: Nomad Type kind"
+  type_data: "Quantity Type: Nomad Type data"
+  log: "Plotly Type: logarithmic plot"
+  scatter: "Plotly Type: scatter plot"
+
+type_kind:
+  Enum: "Type kind: Enumerate"
+
+type_data:
+  '[]': "Type data: Array of data"
+
+repeats:
+  true: "The section is an array"
+  false: "The section is not an array"
+
+overview:
+  true: "with overview"
+  false: "with no overview"
+
+lines:
+  mode: "plotly: line mode"
+  line: "plotly: line settings"
+  marker: "plotly: marker settings"
+
+mode:
+  markers: "plotly: plot by markers"
+  lines: "plotly: plot by line"
+
+line:
+  color: "plotly: color of line"
+
+marker:
+  color: "plotly: color of marker"
+
+layout:
+  xaxis: "plotly: x-axis layout settings"
+  yaxis: "plotly: y-axis layout settings"
+
+xaxis:
+  title: "plotly: x-axis title"
+  type: "plotly: x-axis type"
+  autorange: "plotly: auto range x-axis"
+
+yaxis:
+  title: "plotly: y-axis title"
+  type: "plotly: y-axis type"
+  autorange: "plotly: auto range y-axis"
+
+config:
+  editable: "plotly config: editable plot"
+  scrollZoom: "plotly config: zoom scrollable plot"
+
+editable:
+  true: "plotly: editable plot"
+  false: "plotly: non-editable plot"
+
+scrollZoom:
+  true: "plotly: zoom by scroll button"
+  false: "plotly: do not zoom by scroll button"
+
+autorange:
+  true: "plotly: autorange axis"
+  false: "plotly: not autorange axis"