alex/yomichan
1
Fork 0
Code Releases Activity
52b0feb255
yomichan/ext/bg/data/options-schema.json

676 lines
33 KiB
JSON
Raw Normal View History

Add schema file for options
2019-11-27 17:11:45 +00:00
{
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"required": [
"version",
"profiles",
"profileCurrent",
"global"
],
"properties": {
"version": {
"type": "integer",
"minimum": 0,
"default": 0
},
"profiles": {
"type": "array",
"items": {
"type": "object",
"required": [
"name",
"conditionGroups",
"options"
],
"properties": {
"name": {
"type": "string",
"default": "Default"
},
"conditionGroups": {
"type": "array",
"items": {
"type": "object",
"required": [
"conditions"
],
"properties": {
"conditions": {
"type": "array",
"items": {
"type": "object",
"required": [
"type",
"operator",
"value"
],
"properties": {
"type": {
"type": "string"
},
"operator": {
"type": "string"
},
"value": {}
}
}
}
}
}
},
"options": {
"type": "object",
"required": [
"version",
"general",
"audio",
"scanning",
Update options schema
2019-12-29 23:32:41 +00:00
"translation",
Add schema file for options
2019-11-27 17:11:45 +00:00
"dictionaries",
"parsing",
"anki"
],
"properties": {
"version": {
"type": "integer",
"minimum": 0
},
"general": {
"type": "object",
"required": [
"enable",
add global clipboard monitor that spawns popups TODO: refactor the search page clipboard monitor and popup clipboard monitor to use a common ClipboardMonitor class
2020-01-25 17:00:36 +00:00
"enableClipboardPopups",
Add schema file for options
2019-11-27 17:11:45 +00:00
"resultOutputMode",
"debugInfo",
"maxResults",
"showAdvanced",
"popupDisplayMode",
"popupWidth",
"popupHeight",
"popupHorizontalOffset",
"popupVerticalOffset",
"popupHorizontalOffset2",
"popupVerticalOffset2",
"popupHorizontalTextPosition",
"popupVerticalTextPosition",
Update options schema
2019-12-29 23:35:12 +00:00
"popupScalingFactor",
"popupScaleRelativeToPageZoom",
Add option for changing poup scale relative to visual viewport
2019-12-30 17:42:12 +00:00
"popupScaleRelativeToVisualViewport",
Add schema file for options
2019-11-27 17:11:45 +00:00
"showGuide",
"compactTags",
"compactGlossaries",
"mainDictionary",
"popupTheme",
"popupOuterTheme",
"customPopupCss",
"customPopupOuterCss",
"enableWanakana",
Add options
2020-03-01 19:38:16 +00:00
"enableClipboardMonitor",
"showPitchAccentDownstepNotation",
"showPitchAccentPositionNotation",
add option for iframe popups
2020-04-04 22:43:12 +00:00
"showPitchAccentGraph",
Add option to use the unsecure frame URL (#618)
2020-06-21 19:52:43 +00:00
"showIframePopupsInRootFrame",
Shadow DOM container for popup iframes (#623) * Add support for injecting stylesheets into a custom parent node * Add api.getStylesheetContent * Add support for injecting a CSS file's content * Add usePopupShadowDom option * Use a per-parentNode cache * Add support for using a shadow DOM wrapper around popup iframes * Ignore the popup container instead of the frame
2020-06-25 01:46:13 +00:00
"useSecurePopupFrameUrl",
Popup window (#773) * Add option usePopupWindow * Add PopupWindow class * Add support for creating PopupWindow
2020-09-06 02:03:35 +00:00
"usePopupShadowDom",
"usePopupWindow"
Add schema file for options
2019-11-27 17:11:45 +00:00
],
"properties": {
"enable": {
"type": "boolean",
"default": true
},
add global clipboard monitor that spawns popups TODO: refactor the search page clipboard monitor and popup clipboard monitor to use a common ClipboardMonitor class
2020-01-25 17:00:36 +00:00
"enableClipboardPopups": {
"type": "boolean",
"default": false
},
Add schema file for options
2019-11-27 17:11:45 +00:00
"resultOutputMode": {
"type": "string",
"enum": ["group", "merge", "split"],
"default": "group"
},
"debugInfo": {
"type": "boolean",
"default": false
},
"maxResults": {
"type": "integer",
"minimum": 1,
"default": 32
},
"showAdvanced": {
"type": "boolean",
"default": false
},
"popupDisplayMode": {
"type": "string",
"enum": ["default", "full-width"],
"default": "default"
},
"popupWidth": {
"type": "number",
"minimum": 0,
"default": 400
},
"popupHeight": {
"type": "number",
"minimum": 0,
"default": 250
},
"popupHorizontalOffset": {
"type": "number",
"default": 0
},
"popupVerticalOffset": {
"type": "number",
"default": 10
},
"popupHorizontalOffset2": {
"type": "number",
"default": 10
},
"popupVerticalOffset2": {
"type": "number",
"default": 0
},
"popupHorizontalTextPosition": {
"type": "string",
"enum": ["below", "above"],
"default": "below"
},
"popupVerticalTextPosition": {
"type": "string",
"enum": ["default", "before", "after", "left", "right"],
"default": "before"
},
Update options schema
2019-12-29 23:35:12 +00:00
"popupScalingFactor": {
"type": "number",
"default": 1
},
"popupScaleRelativeToPageZoom": {
"type": "boolean",
Fix default value for popupScaleRelativeToPageZoom
2019-12-30 17:36:11 +00:00
"default": false
Update options schema
2019-12-29 23:35:12 +00:00
},
Add option for changing poup scale relative to visual viewport
2019-12-30 17:42:12 +00:00
"popupScaleRelativeToVisualViewport": {
"type": "boolean",
"default": true
},
Add schema file for options
2019-11-27 17:11:45 +00:00
"showGuide": {
"type": "boolean",
"default": true
},
"compactTags": {
"type": "boolean",
"default": false
},
"compactGlossaries": {
"type": "boolean",
"default": false
},
"mainDictionary": {
"type": "string"
},
"popupTheme": {
"type": "string",
"enum": ["default", "dark"],
"default": "default"
},
"popupOuterTheme": {
"type": "string",
"enum": ["default", "dark", "auto"],
"default": "default"
},
"customPopupCss": {
"type": "string",
"default": ""
},
"customPopupOuterCss": {
"type": "string",
"default": ""
},
"enableWanakana": {
"type": "boolean",
"default": true
},
"enableClipboardMonitor": {
"type": "boolean",
"default": false
Add options
2020-03-01 19:38:16 +00:00
},
"showPitchAccentDownstepNotation": {
"type": "boolean",
"default": true
},
"showPitchAccentPositionNotation": {
"type": "boolean",
"default": true
},
"showPitchAccentGraph": {
"type": "boolean",
"default": false
add option for iframe popups
2020-04-04 22:43:12 +00:00
},
"showIframePopupsInRootFrame": {
"type": "boolean",
"default": false
Add option to use the unsecure frame URL (#618)
2020-06-21 19:52:43 +00:00
},
Secure popup frame url changes (#622) * Throw error if options is not ready * Remove id * Change unsecurePopupFrameUrl to useSecurePopupFrameUrl
2020-06-22 23:26:59 +00:00
"useSecurePopupFrameUrl": {
Add option to use the unsecure frame URL (#618)
2020-06-21 19:52:43 +00:00
"type": "boolean",
Secure popup frame url changes (#622) * Throw error if options is not ready * Remove id * Change unsecurePopupFrameUrl to useSecurePopupFrameUrl
2020-06-22 23:26:59 +00:00
"default": true
Shadow DOM container for popup iframes (#623) * Add support for injecting stylesheets into a custom parent node * Add api.getStylesheetContent * Add support for injecting a CSS file's content * Add usePopupShadowDom option * Use a per-parentNode cache * Add support for using a shadow DOM wrapper around popup iframes * Ignore the popup container instead of the frame
2020-06-25 01:46:13 +00:00
},
"usePopupShadowDom": {
"type": "boolean",
"default": true
Popup window (#773) * Add option usePopupWindow * Add PopupWindow class * Add support for creating PopupWindow
2020-09-06 02:03:35 +00:00
},
"usePopupWindow": {
"type": "boolean",
"default": false
Add schema file for options
2019-11-27 17:11:45 +00:00
}
}
},
"audio": {
"type": "object",
"required": [
"enabled",
"sources",
"volume",
"autoPlay",
"customSourceUrl",
"textToSpeechVoice"
],
"properties": {
"enabled": {
"type": "boolean",
"default": true
},
"sources": {
"type": "array",
"items": {
"type": "string",
"enum": [
"jpod101",
"jpod101-alternate",
"jisho",
"text-to-speech",
"text-to-speech-reading",
"custom"
],
"default": "jpod101"
}
},
"volume": {
"type": "number",
"minimum": 0,
"maximum": 100,
"default": 100
},
"autoPlay": {
"type": "boolean",
"default": false
},
"customSourceUrl": {
"type": "string",
"default": ""
},
"textToSpeechVoice": {
"type": "string",
"default": ""
}
}
},
"scanning": {
"type": "object",
"required": [
Scanning input generalization (#789) * Add inputs to options.scanning * Update CSS for mouse buttons * Update list counters * Set up HTML/CSS * Add input controller * Use new inputs * Include mouse buttons * Update how button inputs are detected * Add index/empty fields to the input details object * Update none check for scanning modifier * Remove old settings * Remove unused global
2020-09-09 20:59:03 +00:00
"inputs",
Add schema file for options
2019-11-27 17:11:45 +00:00
"touchInputEnabled",
"selectText",
"alphanumeric",
"autoHideResults",
"delay",
Delay hide option (#774) * Add hideDelay option * Add _clearSelection * Use hideDelay * Prevent repeated delayed selection clears * Fix popup hide timer being cleared when the cursor is moved into the frame
2020-09-08 23:40:15 +00:00
"hideDelay",
Add schema file for options
2019-11-27 17:11:45 +00:00
"length",
"modifier",
"deepDomScan",
"popupNestingMaxDepth",
"enablePopupSearch",
"enableOnPopupExpressions",
add scannable tags for expression and reading
2020-01-26 19:00:19 +00:00
"enableOnSearchPage",
Use DOMTextScanner (#536) * Use DOMTextScanner instead of TextSourceRange.seek* * Move getNodesInRange to dom.js * Move anyNodeMatchesSelector to dom.js * Remove unused functions * Update tests * Add layoutAwareScan option * Use layoutAwareScan for source and sentence scanning * Remove unused IGNORE_TEXT_PATTERN
2020-06-21 20:07:51 +00:00
"enableSearchTags",
"layoutAwareScan"
Add schema file for options
2019-11-27 17:11:45 +00:00
],
"properties": {
Scanning input generalization (#789) * Add inputs to options.scanning * Update CSS for mouse buttons * Update list counters * Set up HTML/CSS * Add input controller * Use new inputs * Include mouse buttons * Update how button inputs are detected * Add index/empty fields to the input details object * Update none check for scanning modifier * Remove old settings * Remove unused global
2020-09-09 20:59:03 +00:00
"inputs": {
"type": "array",
"default": [
{
"include": "shift",
"exclude": ""
}
],
"items": {
"required": [
"include",
"exclude"
],
"properties": {
"include": {
"type": "string",
"default": "shift"
},
"exclude": {
"type": "string",
"default": ""
}
}
}
Add schema file for options
2019-11-27 17:11:45 +00:00
},
"touchInputEnabled": {
"type": "boolean",
"default": true
},
"selectText": {
"type": "boolean",
"default": true
},
"alphanumeric": {
"type": "boolean",
"default": true
},
"autoHideResults": {
"type": "boolean",
"default": false
},
"delay": {
"type": "number",
"minimum": 0,
"default": 20
},
Delay hide option (#774) * Add hideDelay option * Add _clearSelection * Use hideDelay * Prevent repeated delayed selection clears * Fix popup hide timer being cleared when the cursor is moved into the frame
2020-09-08 23:40:15 +00:00
"hideDelay": {
"type": "number",
"minimum": 0,
"default": 0
},
Add schema file for options
2019-11-27 17:11:45 +00:00
"length": {
"type": "integer",
"minimum": 1,
"default": 10
},
"deepDomScan": {
"type": "boolean",
"default": false
},
"popupNestingMaxDepth": {
"type": "integer",
"minimum": 0,
"default": 0
},
"enablePopupSearch": {
"type": "boolean",
"default": false
},
"enableOnPopupExpressions": {
"type": "boolean",
"default": false
},
"enableOnSearchPage": {
"type": "boolean",
"default": true
add scannable tags for expression and reading
2020-01-26 19:00:19 +00:00
},
"enableSearchTags": {
"type": "boolean",
"default": false
Use DOMTextScanner (#536) * Use DOMTextScanner instead of TextSourceRange.seek* * Move getNodesInRange to dom.js * Move anyNodeMatchesSelector to dom.js * Remove unused functions * Update tests * Add layoutAwareScan option * Use layoutAwareScan for source and sentence scanning * Remove unused IGNORE_TEXT_PATTERN
2020-06-21 20:07:51 +00:00
},
"layoutAwareScan": {
"type": "boolean",
"default": false
Add schema file for options
2019-11-27 17:11:45 +00:00
}
}
},
Update options schema
2019-12-29 23:32:41 +00:00
"translation": {
"type": "object",
"required": [
"convertHalfWidthCharacters",
"convertNumericCharacters",
Reorganized variants to better reflect usage order
2020-01-24 01:28:38 +00:00
"convertAlphabeticCharacters",
Add convertHiraganaToKatakana option
2020-01-24 01:49:41 +00:00
"convertHiraganaToKatakana",
Add support for collapsing emphatic character sequences
2020-04-10 15:56:18 +00:00
"convertKatakanaToHiragana",
"collapseEmphaticSequences"
Update options schema
2019-12-29 23:32:41 +00:00
],
"properties": {
"convertHalfWidthCharacters": {
"type": "string",
"enum": ["false", "true", "variant"],
"default": "false"
},
"convertNumericCharacters": {
"type": "string",
"enum": ["false", "true", "variant"],
"default": "false"
},
"convertAlphabeticCharacters": {
"type": "string",
"enum": ["false", "true", "variant"],
"default": "false"
Reorganized variants to better reflect usage order
2020-01-24 01:28:38 +00:00
},
Add convertHiraganaToKatakana option
2020-01-24 01:49:41 +00:00
"convertHiraganaToKatakana": {
"type": "string",
"enum": ["false", "true", "variant"],
"default": "false"
},
Reorganized variants to better reflect usage order
2020-01-24 01:28:38 +00:00
"convertKatakanaToHiragana": {
"type": "string",
"enum": ["false", "true", "variant"],
"default": "variant"
Add support for collapsing emphatic character sequences
2020-04-10 15:56:18 +00:00
},
"collapseEmphaticSequences": {
"type": "string",
"enum": ["false", "true", "full"],
"default": "false"
Update options schema
2019-12-29 23:32:41 +00:00
}
}
},
Add schema file for options
2019-11-27 17:11:45 +00:00
"dictionaries": {
"type": "object",
"additionalProperties": {
"type": "object",
"required": [
"priority",
"enabled",
"allowSecondarySearches"
],
"properties": {
"priority": {
"type": "number",
"default": 0
},
"enabled": {
"type": "boolean",
"default": true
},
"allowSecondarySearches": {
"type": "boolean",
"default": false
}
}
}
},
"parsing": {
"type": "object",
"required": [
"enableScanningParser",
"enableMecabParser",
"selectedParser",
query parser: add toggle for term spacing
2020-01-25 00:57:57 +00:00
"termSpacing",
Add schema file for options
2019-11-27 17:11:45 +00:00
"readingMode"
],
"properties": {
"enableScanningParser": {
"type": "boolean",
"default": true
},
"enableMecabParser": {
"type": "boolean",
"default": false
},
"selectedParser": {
"type": ["string", "null"],
"default": null
},
query parser: add toggle for term spacing
2020-01-25 00:57:57 +00:00
"termSpacing": {
"type": "boolean",
"default": true
},
Add schema file for options
2019-11-27 17:11:45 +00:00
"readingMode": {
"type": "string",
query parser: add reading mode 'none'
2020-01-25 00:56:14 +00:00
"enum": ["hiragana", "katakana", "romaji", "none"],
Add schema file for options
2019-11-27 17:11:45 +00:00
"default": "hiragana"
}
}
},
"anki": {
"type": "object",
"required": [
"enable",
"server",
"tags",
"sentenceExt",
"screenshot",
"terms",
"kanji",
Add duplicateScope: 'deck' option (#476) * Add duplicateScope: 'deck' option * Add option to control duplicate scope * Use duplicateScope for findNoteIds * Update location of quotes
2020-04-27 22:10:59 +00:00
"duplicateScope",
Add schema file for options
2019-11-27 17:11:45 +00:00
"fieldTemplates"
],
"properties": {
"enable": {
"type": "boolean",
"default": false
},
"server": {
"type": "string",
"default": "http://127.0.0.1:8765"
},
"tags": {
"type": "array",
"items": {
"type": "string"
},
"default": [
"yomichan"
]
},
"sentenceExt": {
"type": "integer",
"minimum": 0,
"default": 200
},
"screenshot": {
"type": "object",
"required": [
"format",
"quality"
],
"properties": {
"format": {
"type": "string",
"enum": ["png", "jpeg"],
"default": "png"
},
"quality": {
"type": "integer",
"minimum": 0,
"maximum": 100,
"default": 92
}
}
},
"terms": {
"type": "object",
"required": [
"deck",
"model",
"fields"
],
"properties": {
"deck": {
"type": "string",
"default": ""
},
"model": {
"type": "string",
"default": ""
},
"fields": {
"type": "object",
"additionalProperties": {
"type": "string",
"default": ""
}
}
}
},
"kanji": {
"type": "object",
"required": [
"deck",
"model",
"fields"
],
"properties": {
"deck": {
"type": "string",
"default": ""
},
"model": {
"type": "string",
"default": ""
},
"fields": {
"type": "object",
"additionalProperties": {
"type": "string",
"default": ""
}
}
}
},
Add duplicateScope: 'deck' option (#476) * Add duplicateScope: 'deck' option * Add option to control duplicate scope * Use duplicateScope for findNoteIds * Update location of quotes
2020-04-27 22:10:59 +00:00
"duplicateScope": {
"type": "string",
"default": "collection",
"enum": ["collection", "deck"]
},
Add schema file for options
2019-11-27 17:11:45 +00:00
"fieldTemplates": {
"type": ["string", "null"],
"default": null
}
}
}
}
}
}
}
},
"profileCurrent": {
"type": "integer",
"minimum": 0,
"default": 0
},
"global": {
"type": "object",
"required": [
"database"
],
"properties": {
"database": {
"type": "object",
"required": [
"prefixWildcardsSupported"
],
"properties": {
"prefixWildcardsSupported": {
"type": "boolean",
"default": false
}
}
}
}
}
}
}
Copy Permalink