sublime-text-dashing.yml

name: Sublime Text
package: sublime-text
index: docs/index.html
icon32x32: ../../sublime-text-icon.png
allowJS: false
ExternalURL: 'https://www.sublimetext.com'
ignore:
  - id
  - id0
  - id1
  - id2

# https://github.com/technosophos/dashing?tab=readme-ov-file#usage
# https://kapeli.com/docsets#supportedentrytypes
selectors:

###[ GLOBAL ]##################################################################

  # Each pages' header
  title:
    type: Guide
    matchpath: '\.html$'

  # Page subheadings
  h2:
    type: Section
    matchpath: '\.html$'

###[ TAB MULTI-SELECT ]########################################################
###[ GIT INTEGRATION ]#########################################################

  # Git Status badges
  '#status-badge-key .badges li':
    type: Attribute
    matchpath: '/git_integration\.html$'

  # Commands and menus
  'ul li p':
    type: Command
    matchpath: '/git_integration\.html$'

  # Settings
  'dl.setting > dt[id]':
    attr: id
    type: Setting
    matchpath: '/git_integration\.html$'

###[ INCREMENTAL DIFF ]########################################################

  # Scopes as Tags
  '#styling li p':
    type: Tag
    matchpath: '/incremental_diff\.html$'

  # Settings
  'dl.setting > dt[id] ':
    attr: id
    type: Setting
    matchpath: '/incremental_diff\.html$'

###[ INDEXING ]################################################################

  # Settings
  'dl.setting > dt[id]  ':
    attr: id
    type: Setting
    matchpath: '/indexing\.html$'

###[ COMMAND LINE INTERFACE ]##################################################
###[ MULTIPLE SELECTION ]######################################################
###[ COMPLETIONS ]#############################################################

  # Completion kinds
  '#kind-info table.kinds td:not(:has(span))':
    type: Value
    matchpath: '/completions\.html$'

  # Completion kinds again
  '#rich-format dl.setting:has(#kind) ul.simple > li':
    type: Value
    matchpath: '/completions\.html$'

  # Completion fields
  '#completion-files dl.setting > dt':
    type: Field
    matchpath: '/completions\.html$'

  # Snippet fields
  '#snippets dl.setting > dt':
    type: Field
    matchpath: '/completions\.html$'

  # Variables
  '#variables table span.pre':
    type: Variable
    requiretext: '\$'
    matchpath: '/completions\.html$'

  # Settings
  'dl.setting > dt[id]    ':
    attr: id
    type: Setting
    matchpath: '/completions\.html$'

###[ DISTRACTION FREE MODE ]###################################################

  # File
  'span.file':
    type: File
    matchpath: '/distraction_free\.html$'

  # Settings
  '.highlight .nt':
    type: Setting
    matchpath: '/distraction_free\.html$'

###[ VINTAGE MODE ]############################################################
###[ PROJECTS ]################################################################

  # Settings
  'dl.setting > dt[id]     ':
    attr: id
    type: Setting
    matchpath: '/projects\.html$'

###[ SETTINGS ]################################################################

  # Files
  '#settings-files span.file':
    type: File
    matchpath: '/settings\.html$'

###[ KEY BINDINGS ]############################################################

  # Bindings keys
  '#bindings h3':
    type: Setting
    matchpath: '/key_bindings\.html$'

  # "context" modifiers
  '#context-key table code':
    type: Filter
    requiretext: '"'
    matchpath: '/key_bindings\.html$'

###[ FONT SETTINGS ]###########################################################
###[ INDENTATION SETTINGS ]####################################################

  # Settings
  'dl.setting > dt[id]      ':
    attr: id
    type: Setting
    matchpath: '/indentation\.html$'

###[ SPELL CHECKING ]##########################################################

  # Settings
  'dl.setting > dt[id]       ':
    attr: id
    type: Setting
    matchpath: '/spell_checking\.html$'

  # Commands
  '#commands code:first-child':
    type: Command
    matchpath: '/spell_checking\.html$'

###[ BUILD SYSTEMS ]###########################################################

  # Options
  'dl.setting > dt[id]        ':
    attr: id
    type: Option
    matchpath: '/build_systems\.html$'

  # Variables
  '#variables table code':
    type: Variable
    requiretext: '\$'
    matchpath: '/build_systems\.html$'

###[ PACKAGES ]################################################################

  # Files
  'li span.file ':
    type: File
    matchpath: '/packages\.html$'

###[ SELECTORS ]###############################################################
###[ FILE PATTERNS ]###########################################################

  # "Uses"
  '#uses li code':
    type: Setting
    matchpath: '/file_patterns\.html$'

###[ GPU RENDERING ]###########################################################
###[ OPERATING SYSTEM COMPATIBILITY ]##########################################
###[ LINUX PACKAGE MANAGER REPOSITORIES ]######################################
###[ SAFE MODE ]###############################################################

  # Safe Mode Data Dir
  '#behavior > ul li span.file':
    type: File
    matchpath: '/safe_mode\.html$'

  # Safe Mode command
  '#starting pre':
    type: Command
    matchpath: '/safe_mode\.html$'

###[ REVERTING TO A FRESHLY INSTALLED STATE ]##################################

  # Files
  'li span.file  ':
    type: File
    matchpath: '/revert\.html$'

###[ RUNNING 3 AND 4 SIDE BY SIDE ]############################################
###[ ACCESSING PREVIOUS VERSIONS ]#############################################
###[ LIGATURES ]###############################################################

  # Options
  '.s2 .pre':
    type: Option
    matchpath: '/ligatures\.html$'

###[ PORTABLE LICENSE KEYS ]###################################################

  # Files
  'li span.file':
    type: File
    matchpath: '/portable_license_keys\.html$'

###[ COLOR SCHEMES ]###########################################################

  # Color functions
  '#colors li b':
    type: Function
    matchpath: '/color_schemes\.html$'

  # Settings
  'dl.setting > dt[id]         ':
    attr: id
    type: Setting
    matchpath: '/color_schemes\.html$'

  # Font Styles
  'dt#font-style dd li code':
    type: Value
    matchpath: '/color_schemes\.html$'

  # CSS Colors
  '#appendix-css-colors span:not(.color-block)':
    type: Value
    matchpath: '/color_schemes\.html$'

###[ THEMES ]##################################################################

  # Settings
  'dl.setting > dt[id]          ':
    attr: id
    type: Setting
    matchpath: '/themes\.html$'

  # Properties
  'dl.themeprop > dt':
    type: Property
    matchpath: '/themes\.html$'

  # Theme elements
  'dl.themeclass > dt':
    type: Element
    matchpath: '/themes\.html$'

  # Element properties
  # TODO: Maybe split these into attributes and properties
  'dl.themeclass > dd > dl dt code':
    type: Property
    matchpath: '/themes\.html$'

###[ MENUS ]###################################################################

  # Settings
  'dl.setting > dt[id]           ':
    attr: id
    type: Setting
    matchpath: '/menus\.html$'

  '.subl .descname':
    requiretext: '.sublime-menu'
    type: File
    matchpath: '/menus\.html$'

###[ API ENVIRONMENTS ]########################################################
###[ API REFERENCE ]###########################################################

  # Types
  '#types dt.sig[id]':
    attr: id
    type: Type
    matchpath: '/api_reference\.html$'

  # Modules
  '#sublime-module h2 code':
    type: Module
    matchpath: 'api_reference\.html$'
  '#module-sublime_plugin h2 code':
    type: Module
    matchpath: '/api_reference\.html$'

  # Classes
  'dl.class > div > dt[id]':
    attr: id
    type: Class
    matchpath: 'api_reference\.html$'
  'dl.class > dt[id]':
    attr: id
    type: Class
    matchpath: '/api_reference\.html$'

  # Functions
  'dl.function > dt[id]':
    attr: id
    type: Function
    matchpath: '/api_reference\.html$'

  # Methods
  'dl.method > dt[id]':
    attr: id
    type: Method
    matchpath: '/api_reference\.html$'

  # Attributes
  'dl.attribute > dt[id]':
    attr: id
    type: Attribute
    matchpath: '/api_reference\.html$'

###[ SYNTAX DEFINITIONS ]######################################################

  # Syntax header
  '#header dl.setting > dt > span.sig-name':
    type: Trait
    matchpath: '/syntax\.html$'

  # Syntax body
  '#contexts dl.setting > dt > span.sig-name':
    type: Instruction
    matchpath: '/syntax\.html$'

  # Index tests
  '#testing ul > li > p > code:first-child':
    type: Test
    matchpath: '/syntax\.html$'

###[ SCOPE NAMING ]############################################################

  # Scope names as Tags
  'ul.simple li code':
    type: Tag
    matchpath: '/scope_naming\.html$'

###[ MINIHTML REFERENCE ]######################################################

  # Elements
  '#tags li code':
    type: Element
    requiretext: '<.+>'
    matchpath: '/minihtml\.html$'

  # Attributes
  '#attributes li code':
    type: Attribute
    matchpath: '/minihtml\.html$'

  # CSS styles
  '#css > ul li code:first-child':
    type: Style
    matchpath: '/minihtml\.html$'

  # Color functions
  '#color-mod-function-proprietary > ul li code':
    type: Function
    matchpath: '/minihtml\.html$'

  # Variables
  '#predefined-variables > ul li code':
    type: Variable
    matchpath: '/minihtml\.html$'

###[ PLUGIN PORTING GUIDE ]####################################################