You are here

Home » API reference » TOC API 8

toc_api.toc_type.schema.yml in TOC API 8

config/schema/toc_api.toc_type.schema.yml

File

config/schema/toc_api.toc_type.schema.yml
View source 
  1. toc_api.toc_type.*:

  2.   type: config_entity

  3.   label: 'Table of contents type'

  4.   mapping:

  5.     id:

  6.       type: string

  7.       label: 'ID'

  8.     uuid:

  9.       type: string

  10.       label: 'UUID'

  11.     label:

  12.       type: label

  13.       label: 'Label'

  14.     options:

  15.       type: mapping

  16.       label: 'Options (YAML)'

  17.       mapping:

  18.         template:

  19.           type: string

  20.           label: 'Template'

  21.         title:

  22.           type: label

  23.           label: 'Title'

  24.         block:

  25.           type: boolean

  26.           label: 'Display in block'

  27.         header_count:

  28.           type: integer

  29.           label: 'Minimum number of headers'

  30.         header_min:

  31.           type: integer

  32.           label: 'Header minimum level'

  33.         header_max:

  34.           type: integer

  35.           label: 'Header maximum level'

  36.         header_allowed_tags:

  37.           type: string

  38.           label: 'Allowed HTML tags'

  39.         header_id:

  40.           type: string

  41.           label: 'Header ID type'

  42.         header_id_prefix:

  43.           type: string

  44.           label: 'Header ID prefix'

  45.         top_label:

  46.           type: string

  47.           label: 'Back to top'

  48.         top_min:

  49.           type: integer

  50.           label: 'Back to top minimum header level'

  51.         top_max:

  52.           type: integer

  53.           label: 'Back to top maximum header level'

  54.         number_path:

  55.           type: boolean

  56.           label: 'Numbering path'

  57.         number_path_separator:

  58.           type: string

  59.           label: 'Numbering path separator'

  60.         number_path_truncate:

  61.           type: boolean

  62.           label: 'Numbering path truncate'

  63.         default:

  64.           type: mapping

  65.           label: 'Default header'

  66.           mapping:

  67.             number_type:

  68.               type: string

  69.               label: 'Numbering type'

  70.             number_prefix:

  71.               type: string

  72.               label: 'Numbering prefix'

  73.             number_suffix:

  74.               type: string

  75.               label: 'Numbering suffix'

  76.         headers:

  77.           label: 'Headers (h1 - h6)'

  78.           type: mapping

  79.           mapping:

  80.             h1:

  81.               type: ignore

  82.             h2:

  83.               type: ignore

  84.             h3:

  85.               type: ignore

  86.             h4:

  87.               type: ignore

  88.             h5:

  89.               type: ignore

  90.             h6:

  91.               type: ignore