alex/yomichan
1
Fork 0
Code Releases Activity
1e91bf151f
yomichan/ext/data/schemas/options-schema.json

1243 lines
70 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",
Fix default options missing profiles (#829) * Add minItems requirement for profiles array * Use minItems/maxItems for default value construction
2020-09-13 23:59:02 +00:00
"minItems": 1,
Add schema file for options
2019-11-27 17:11:45 +00:00
"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": [
"general",
Popup window options (#1245) * Add popupWindow options * Add toBoolean converter * Add settings * Use new options * Add test link * Fix window state not working * Make the window section advanced only
2021-01-16 15:22:24 +00:00
"popupWindow",
Add schema file for options
2019-11-27 17:11:45 +00:00
"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",
Sentence parsing options (#1214) * Rename options.anki.sentenceExt to options.sentenceParsing.scanExtent * Create sentence parsing icon * Create new sentence parsing section
2021-01-10 02:25:04 +00:00
"anki",
Hotkeys (#1236) * Set up hotkey inputs * Improve key display * Add setInput * Add KeyboardShortcutController * Update how display handles hotkeys
2021-01-15 01:56:18 +00:00
"sentenceParsing",
Update clipboard options organization (#1318) * Update options organization * Update general.enableClipboardPopups to clipboard.enableBackgroundMonitor * Update general.enableClipboardMonitor to clipboard.enableSearchPageMonitor * Update general.maximumClipboardSearchLength to clipboard.maximumSearchLength * Update general.autoSearchClipboardContent to clipboard.autoSearchContent
2021-01-26 23:30:01 +00:00
"inputs",
Google Docs accessibility (#1875) * Add accessibility option for forcing Google Docs HTML-based rendering * Update settings * Send a documentStart message at document start * Add accessibility script for Google Docs * Set up accessibility * Update tests
2021-08-07 16:40:51 +00:00
"clipboard",
"accessibility"
Add schema file for options
2019-11-27 17:11:45 +00:00
],
"properties": {
"general": {
"type": "object",
"required": [
"enable",
"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",
Popup style updates (#1066) * Replace compactGlossaries option with new glossaryLayoutMode option * Update attributes * Update attributes * Update color definitions * Fix default theme scrollbar
2020-11-26 04:22:05 +00:00
"glossaryLayoutMode",
Add schema file for options
2019-11-27 17:11:45 +00:00
"mainDictionary",
"popupTheme",
"popupOuterTheme",
"customPopupCss",
"customPopupOuterCss",
"enableWanakana",
Add options
2020-03-01 19:38:16 +00:00
"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",
Maximum clipboard search length (#1118) * Add maximumClipboardSearchLength an option * Add setting * Add limits * Update tests
2020-12-18 16:24:43 +00:00
"usePopupWindow",
Popup action bar options (#1140) * Add options for action bar visibility and location * Add settings * Update styles * Expose properties * Update styles * Update tests
2020-12-20 01:07:55 +00:00
"popupCurrentIndicatorMode",
"popupActionBarVisibility",
Fix missing required options (#1482)
2021-03-03 03:51:06 +00:00
"popupActionBarLocation",
"frequencyDisplayMode",
Frequency dictionary sort (#1938) * Add sortDictionary/sortDictionaryOrder options * Update options * Add API.getTermFrequencies * Add settings * Implement frequency dictionary sorting * Update test * Update test data * Fix handling of undefined rank-based frequencies
2021-09-26 15:08:16 +00:00
"termDisplayMode",
"sortFrequencyDictionary",
"sortFrequencyDictionaryOrder"
Add schema file for options
2019-11-27 17:11:45 +00:00
],
"properties": {
"enable": {
"type": "boolean",
"default": true
},
"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
},
Popup style updates (#1066) * Replace compactGlossaries option with new glossaryLayoutMode option * Update attributes * Update attributes * Update color definitions * Fix default theme scrollbar
2020-11-26 04:22:05 +00:00
"glossaryLayoutMode": {
"type": "string",
"enum": ["default", "compact"],
"default": "default"
Add schema file for options
2019-11-27 17:11:45 +00:00
},
"mainDictionary": {
"type": "string"
},
"popupTheme": {
"type": "string",
Theme updates (#2105) * Change siteColor to siteTheme * Fix potential null exception * Simplify * Update display theme assignment * Add a data-browser-theme attribute * Add "browser" option for theme * Create ThemeController * Add theme-controller.js to relevant pages * Use ThemeController * Simplify * Fix 'light' being used instead of 'default' * Update the settings values to more accurately reflect their usage * Change default site theme in display.js * Remove async * Restore async for consistency
2022-04-03 20:20:55 +00:00
"enum": ["light", "dark", "browser"],
Fix invalid default values for popupTheme and popupOuterTheme (#2180) * Fix invalid default values for popupTheme and popupOuterTheme * Options update
2022-08-20 15:29:31 +00:00
"default": "light"
Add schema file for options
2019-11-27 17:11:45 +00:00
},
"popupOuterTheme": {
"type": "string",
Theme updates (#2105) * Change siteColor to siteTheme * Fix potential null exception * Simplify * Update display theme assignment * Add a data-browser-theme attribute * Add "browser" option for theme * Create ThemeController * Add theme-controller.js to relevant pages * Use ThemeController * Simplify * Fix 'light' being used instead of 'default' * Update the settings values to more accurately reflect their usage * Change default site theme in display.js * Remove async * Restore async for consistency
2022-04-03 20:20:55 +00:00
"enum": ["light", "dark", "browser", "site"],
Fix invalid default values for popupTheme and popupOuterTheme (#2180) * Fix invalid default values for popupTheme and popupOuterTheme * Options update
2022-08-20 15:29:31 +00:00
"default": "light"
Add schema file for options
2019-11-27 17:11:45 +00:00
},
"customPopupCss": {
"type": "string",
"default": ""
},
"customPopupOuterCss": {
"type": "string",
"default": ""
},
"enableWanakana": {
"type": "boolean",
"default": true
},
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",
Enable showIframePopupsInRootFrame by default for new installs (#1630)
2021-04-27 00:07:27 +00:00
"default": true
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
Maximum clipboard search length (#1118) * Add maximumClipboardSearchLength an option * Add setting * Add limits * Update tests
2020-12-18 16:24:43 +00:00
},
Entry indicator update (#1134) * Move entry current indicator rules * Simplify rules * Add popupCurrentIndicatorMode option * Add option to settings page * Expose popupCurrentIndicatorMode * Restore asterisk current indicator * Implement dot * Update action button vars * Fix tests * Add none option * Add triangle option
2020-12-19 20:42:44 +00:00
"popupCurrentIndicatorMode": {
"type": "string",
"enum": ["none", "asterisk", "triangle", "bar-left", "bar-right", "dot-left", "dot-right"],
Change popupCurrentIndicatorMode default to triangle (#1161)
2020-12-22 23:22:14 +00:00
"default": "triangle"
Popup action bar options (#1140) * Add options for action bar visibility and location * Add settings * Update styles * Expose properties * Update styles * Update tests
2020-12-20 01:07:55 +00:00
},
"popupActionBarVisibility": {
"type": "string",
"enum": ["auto", "always"],
"default": "auto"
},
"popupActionBarLocation": {
"type": "string",
"enum": ["left", "right", "top", "bottom"],
Change popupActionBarLocation to top (#1222)
2021-01-10 21:49:40 +00:00
"default": "top"
Improve frequency display (#1438) * Add frequencyDisplayMode option * Update tests * Add setting * Update frequency display styles * Improve wrapping
2021-02-25 22:48:39 +00:00
},
"frequencyDisplayMode": {
"type": "string",
"enum": ["tags", "tags-grouped", "split-tags", "split-tags-grouped", "inline-list", "list"],
"default": "split-tags-grouped"
Add standalone reading (#1448) * Add option * Update display * Hide redundant readings * Improve label and description
2021-02-27 19:04:52 +00:00
},
"termDisplayMode": {
"type": "string",
"enum": ["ruby", "ruby-and-reading", "term-and-reading"],
"default": "ruby"
Frequency dictionary sort (#1938) * Add sortDictionary/sortDictionaryOrder options * Update options * Add API.getTermFrequencies * Add settings * Implement frequency dictionary sorting * Update test * Update test data * Fix handling of undefined rank-based frequencies
2021-09-26 15:08:16 +00:00
},
"sortFrequencyDictionary": {
"type": ["string", "null"],
"default": null
},
"sortFrequencyDictionaryOrder": {
"type": "string",
"enum": ["ascending", "descending"],
"default": "descending"
Add schema file for options
2019-11-27 17:11:45 +00:00
}
}
},
Popup window options (#1245) * Add popupWindow options * Add toBoolean converter * Add settings * Use new options * Add test link * Fix window state not working * Make the window section advanced only
2021-01-16 15:22:24 +00:00
"popupWindow": {
"type": "object",
"required": [
"width",
"height",
"left",
"top",
"useLeft",
"useTop",
"windowType",
"windowState"
],
"properties": {
"width": {
"type": "integer",
"minimum": 0,
"default": 400
},
"height": {
"type": "integer",
"minimum": 0,
"default": 250
},
"left": {
"type": "integer",
"default": 0
},
"top": {
"type": "integer",
"default": 0
},
"useLeft": {
"type": "boolean",
"default": false
},
"useTop": {
"type": "boolean",
"default": false
},
"windowType": {
"type": "string",
"enum": ["normal", "popup"],
"default": "popup"
},
"windowState": {
"type": "string",
"enum": ["normal", "maximized", "fullscreen"],
"default": "normal"
}
}
},
Add schema file for options
2019-11-27 17:11:45 +00:00
"audio": {
"type": "object",
"required": [
"enabled",
"volume",
"autoPlay",
Refactor json audio source (#1711) * Move sources to the end of audio options object * Add custom-json audio source type * Add support for downloading custom-json * Remove customSourceType
2021-05-27 00:38:15 +00:00
"sources"
Add schema file for options
2019-11-27 17:11:45 +00:00
],
"properties": {
"enabled": {
"type": "boolean",
"default": true
},
"volume": {
"type": "number",
"minimum": 0,
"maximum": 100,
"default": 100
},
"autoPlay": {
"type": "boolean",
"default": false
},
Refactor json audio source (#1711) * Move sources to the end of audio options object * Add custom-json audio source type * Add support for downloading custom-json * Remove customSourceType
2021-05-27 00:38:15 +00:00
"sources": {
"type": "array",
"items": {
Improve multiple audio sources (#1718) * Add url/voice options to audio sources * Add help for TTS * Remove old settings * Update tests * Update use of audio source URL * Improve labels for sources with the same type
2021-05-30 16:41:19 +00:00
"type": "object",
"additionalProperties": false,
"required": [
"type",
"url",
"voice"
Refactor json audio source (#1711) * Move sources to the end of audio options object * Add custom-json audio source type * Add support for downloading custom-json * Remove customSourceType
2021-05-27 00:38:15 +00:00
],
Improve multiple audio sources (#1718) * Add url/voice options to audio sources * Add help for TTS * Remove old settings * Update tests * Update use of audio source URL * Improve labels for sources with the same type
2021-05-30 16:41:19 +00:00
"properties": {
"type": {
"type": "string",
"enum": [
"jpod101",
"jpod101-alternate",
"jisho",
"text-to-speech",
"text-to-speech-reading",
"custom",
"custom-json"
],
"default": "jpod101"
},
"url": {
"type": "string",
"default": ""
},
"voice": {
"type": "string",
"default": ""
}
}
Refactor json audio source (#1711) * Move sources to the end of audio options object * Add custom-json audio source type * Add support for downloading custom-json * Remove customSourceType
2021-05-27 00:38:15 +00:00
},
"default": [
Improve multiple audio sources (#1718) * Add url/voice options to audio sources * Add help for TTS * Remove old settings * Update tests * Update use of audio source URL * Improve labels for sources with the same type
2021-05-30 16:41:19 +00:00
{
"type": "jpod101",
"url": "",
"voice": ""
}
Refactor json audio source (#1711) * Move sources to the end of audio options object * Add custom-json audio source type * Add support for downloading custom-json * Remove customSourceType
2021-05-27 00:38:15 +00:00
]
Add schema file for options
2019-11-27 17:11:45 +00:00
}
}
},
"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 middle mouse prevention option (#868) * Add preventMiddleMouse option to TextScanner * Add preventMiddleMouse options * Add options * Apply preventMiddleMouse options
2020-09-26 23:24:21 +00:00
"preventMiddleMouse",
Add schema file for options
2019-11-27 17:11:45 +00:00
"touchInputEnabled",
Pointer events support (#819) * Add option pointerEventsEnabled * Add _pointerEventsEnabled option to TextScanner * Add additional options * Mouse pointer events * Touch pointer events * Pen pointer events
2020-09-13 15:33:10 +00:00
"pointerEventsEnabled",
Add schema file for options
2019-11-27 17:11:45 +00:00
"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",
"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",
Scanning wildcards (#2042) * Add scanning.matchTypePrefix option * Update TextScanner to use matchTypePrefix option * Add setting * Update warning
2021-12-18 17:38:39 +00:00
"layoutAwareScan",
Hide popup on cursor exit (#2109) * Update phrasing * Add new options * Add settings * Implement
2022-04-04 02:52:53 +00:00
"matchTypePrefix",
"hidePopupOnCursorExit",
Exclude documentElement from zoom calculation (#2227) * Exclude documentElement from zoom calculation * Add an option * Refactor zoom coordinate conversion functions * Convert zoom coordinates for text sources * Rename variable * Convert rect coordinate spaces * Handle shadow DOM
2022-09-21 01:06:39 +00:00
"hidePopupOnCursorExitDelay",
"normalizeCssZoom"
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",
Scanning mouse button fixes (#866) * Move mouse0 blocking during mousemove into options * Update primary button detection
2020-09-26 21:51:52 +00:00
"exclude": "mouse0",
Input type filters (#806) * Add options for scanning input types * Move buttons in layout, refactor CSS * Add options for input types * Use input type filters * Add _getMatchingInputGroupFromEvent * Use input filters for touch events
2020-09-11 18:13:52 +00:00
"types": {
"mouse": true,
"touch": false,
"pen": false
Settings upgrade and schema fixes (#823) * Add missing defaults * Always include touch input during upgrade
2020-09-13 17:16:56 +00:00
},
"options": {
"showAdvanced": false,
Move searchTerms/searchKanji to front of object definitions (#873)
2020-09-27 15:53:07 +00:00
"searchTerms": true,
"searchKanji": true,
Add scan on touch move and prevent touch scroll options (#871) * Add scanOnTouchMove/preventTouchScrolling scanning input options * Add settings controls * Support scanOnTouchMove in TextScanner * Support preventTouchScrolling in TextScanner
2020-09-27 15:46:37 +00:00
"scanOnTouchMove": true,
Touch and pen input updates (#2172) * Remove unnecessary return * Move touch start input filtering * Refactor * Add scanOnTouchPress * Add preventPenScrolling * Rename scanOnPenPress to scanOnPenMove * Rename scanOnPenRelease to scanOnPenReleaseHover * Simplify * Refactor _searchAtFromPen early exit * Merge _penPointerPressed and _penPointerReleased into a single variable * Add more options * Simplify pen pointer coordinates * Implement scanOnPenPress and scanOnPenRelease * Implement scanOnTouchRelease * Fix tests * Don't search on touch cancel * Cancel touch if the touch action is used for scrolling or other gestures * Fix incorrect scroll prevention options being used * Organize options * Fix typos
2022-06-03 21:11:32 +00:00
"scanOnTouchPress": true,
"scanOnTouchRelease": false,
"scanOnPenMove": true,
Settings upgrade and schema fixes (#823) * Add missing defaults * Always include touch input during upgrade
2020-09-13 17:16:56 +00:00
"scanOnPenHover": true,
Touch and pen input updates (#2172) * Remove unnecessary return * Move touch start input filtering * Refactor * Add scanOnTouchPress * Add preventPenScrolling * Rename scanOnPenPress to scanOnPenMove * Rename scanOnPenRelease to scanOnPenReleaseHover * Simplify * Refactor _searchAtFromPen early exit * Merge _penPointerPressed and _penPointerReleased into a single variable * Add more options * Simplify pen pointer coordinates * Implement scanOnPenPress and scanOnPenRelease * Implement scanOnTouchRelease * Fix tests * Don't search on touch cancel * Cancel touch if the touch action is used for scrolling or other gestures * Fix incorrect scroll prevention options being used * Organize options * Fix typos
2022-06-03 21:11:32 +00:00
"scanOnPenReleaseHover": false,
Settings upgrade and schema fixes (#823) * Add missing defaults * Always include touch input during upgrade
2020-09-13 17:16:56 +00:00
"scanOnPenPress": true,
Add scan dictionary type filters (#822) * Add options for searchTerms and searchKanji * Add settings HTML * Add options to TextScanner * Update _search/_findDefinitions to include searchTerms/searchKanji args * Update _searchAtFromMouseMove args * Change argument structure for _searchAt * Use scanning options for searchTerms and searchKanji
2020-09-13 17:25:03 +00:00
"scanOnPenRelease": false,
Touch and pen input updates (#2172) * Remove unnecessary return * Move touch start input filtering * Refactor * Add scanOnTouchPress * Add preventPenScrolling * Rename scanOnPenPress to scanOnPenMove * Rename scanOnPenRelease to scanOnPenReleaseHover * Simplify * Refactor _searchAtFromPen early exit * Merge _penPointerPressed and _penPointerReleased into a single variable * Add more options * Simplify pen pointer coordinates * Implement scanOnPenPress and scanOnPenRelease * Implement scanOnTouchRelease * Fix tests * Don't search on touch cancel * Cancel touch if the touch action is used for scrolling or other gestures * Fix incorrect scroll prevention options being used * Organize options * Fix typos
2022-06-03 21:11:32 +00:00
"preventTouchScrolling": false,
"preventPenScrolling": false
Input type filters (#806) * Add options for scanning input types * Move buttons in layout, refactor CSS * Add options for input types * Use input type filters * Add _getMatchingInputGroupFromEvent * Use input filters for touch events
2020-09-11 18:13:52 +00:00
}
},
{
"include": "",
"exclude": "",
"types": {
"mouse": false,
"touch": true,
"pen": true
Settings upgrade and schema fixes (#823) * Add missing defaults * Always include touch input during upgrade
2020-09-13 17:16:56 +00:00
},
"options": {
"showAdvanced": false,
Move searchTerms/searchKanji to front of object definitions (#873)
2020-09-27 15:53:07 +00:00
"searchTerms": true,
"searchKanji": true,
Add scan on touch move and prevent touch scroll options (#871) * Add scanOnTouchMove/preventTouchScrolling scanning input options * Add settings controls * Support scanOnTouchMove in TextScanner * Support preventTouchScrolling in TextScanner
2020-09-27 15:46:37 +00:00
"scanOnTouchMove": true,
Touch and pen input updates (#2172) * Remove unnecessary return * Move touch start input filtering * Refactor * Add scanOnTouchPress * Add preventPenScrolling * Rename scanOnPenPress to scanOnPenMove * Rename scanOnPenRelease to scanOnPenReleaseHover * Simplify * Refactor _searchAtFromPen early exit * Merge _penPointerPressed and _penPointerReleased into a single variable * Add more options * Simplify pen pointer coordinates * Implement scanOnPenPress and scanOnPenRelease * Implement scanOnTouchRelease * Fix tests * Don't search on touch cancel * Cancel touch if the touch action is used for scrolling or other gestures * Fix incorrect scroll prevention options being used * Organize options * Fix typos
2022-06-03 21:11:32 +00:00
"scanOnTouchPress": true,
"scanOnTouchRelease": false,
"scanOnPenMove": true,
Settings upgrade and schema fixes (#823) * Add missing defaults * Always include touch input during upgrade
2020-09-13 17:16:56 +00:00
"scanOnPenHover": true,
Touch and pen input updates (#2172) * Remove unnecessary return * Move touch start input filtering * Refactor * Add scanOnTouchPress * Add preventPenScrolling * Rename scanOnPenPress to scanOnPenMove * Rename scanOnPenRelease to scanOnPenReleaseHover * Simplify * Refactor _searchAtFromPen early exit * Merge _penPointerPressed and _penPointerReleased into a single variable * Add more options * Simplify pen pointer coordinates * Implement scanOnPenPress and scanOnPenRelease * Implement scanOnTouchRelease * Fix tests * Don't search on touch cancel * Cancel touch if the touch action is used for scrolling or other gestures * Fix incorrect scroll prevention options being used * Organize options * Fix typos
2022-06-03 21:11:32 +00:00
"scanOnPenReleaseHover": false,
Settings upgrade and schema fixes (#823) * Add missing defaults * Always include touch input during upgrade
2020-09-13 17:16:56 +00:00
"scanOnPenPress": true,
Add scan dictionary type filters (#822) * Add options for searchTerms and searchKanji * Add settings HTML * Add options to TextScanner * Update _search/_findDefinitions to include searchTerms/searchKanji args * Update _searchAtFromMouseMove args * Change argument structure for _searchAt * Use scanning options for searchTerms and searchKanji
2020-09-13 17:25:03 +00:00
"scanOnPenRelease": false,
Touch and pen input updates (#2172) * Remove unnecessary return * Move touch start input filtering * Refactor * Add scanOnTouchPress * Add preventPenScrolling * Rename scanOnPenPress to scanOnPenMove * Rename scanOnPenRelease to scanOnPenReleaseHover * Simplify * Refactor _searchAtFromPen early exit * Merge _penPointerPressed and _penPointerReleased into a single variable * Add more options * Simplify pen pointer coordinates * Implement scanOnPenPress and scanOnPenRelease * Implement scanOnTouchRelease * Fix tests * Don't search on touch cancel * Cancel touch if the touch action is used for scrolling or other gestures * Fix incorrect scroll prevention options being used * Organize options * Fix typos
2022-06-03 21:11:32 +00:00
"preventTouchScrolling": true,
"preventPenScrolling": true
Input type filters (#806) * Add options for scanning input types * Move buttons in layout, refactor CSS * Add options for input types * Use input type filters * Add _getMatchingInputGroupFromEvent * Use input filters for touch events
2020-09-11 18:13:52 +00:00
}
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
}
],
"items": {
"required": [
"include",
Input type filters (#806) * Add options for scanning input types * Move buttons in layout, refactor CSS * Add options for input types * Use input type filters * Add _getMatchingInputGroupFromEvent * Use input filters for touch events
2020-09-11 18:13:52 +00:00
"exclude",
More scanning options (#815) * Reorganize options * Add advanced options * Add a setting transform 'setRelativeAttribute' * Add advanced options to HTML/CSS
2020-09-12 17:20:02 +00:00
"types",
"options"
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
],
"properties": {
"include": {
"type": "string",
"default": "shift"
},
"exclude": {
"type": "string",
"default": ""
Input type filters (#806) * Add options for scanning input types * Move buttons in layout, refactor CSS * Add options for input types * Use input type filters * Add _getMatchingInputGroupFromEvent * Use input filters for touch events
2020-09-11 18:13:52 +00:00
},
"types": {
"type": "object",
"required": [
"mouse",
"touch",
"pen"
],
"properties": {
"mouse": {
"type": "boolean",
"default": true
},
"touch": {
"type": "boolean",
"default": true
},
"pen": {
"type": "boolean",
"default": true
}
}
More scanning options (#815) * Reorganize options * Add advanced options * Add a setting transform 'setRelativeAttribute' * Add advanced options to HTML/CSS
2020-09-12 17:20:02 +00:00
},
"options": {
"type": "object",
"required": [
"showAdvanced",
Move searchTerms/searchKanji to front of object definitions (#873)
2020-09-27 15:53:07 +00:00
"searchTerms",
"searchKanji",
Add scan on touch move and prevent touch scroll options (#871) * Add scanOnTouchMove/preventTouchScrolling scanning input options * Add settings controls * Support scanOnTouchMove in TextScanner * Support preventTouchScrolling in TextScanner
2020-09-27 15:46:37 +00:00
"scanOnTouchMove",
Touch and pen input updates (#2172) * Remove unnecessary return * Move touch start input filtering * Refactor * Add scanOnTouchPress * Add preventPenScrolling * Rename scanOnPenPress to scanOnPenMove * Rename scanOnPenRelease to scanOnPenReleaseHover * Simplify * Refactor _searchAtFromPen early exit * Merge _penPointerPressed and _penPointerReleased into a single variable * Add more options * Simplify pen pointer coordinates * Implement scanOnPenPress and scanOnPenRelease * Implement scanOnTouchRelease * Fix tests * Don't search on touch cancel * Cancel touch if the touch action is used for scrolling or other gestures * Fix incorrect scroll prevention options being used * Organize options * Fix typos
2022-06-03 21:11:32 +00:00
"scanOnTouchPress",
"scanOnPenMove",
More scanning options (#815) * Reorganize options * Add advanced options * Add a setting transform 'setRelativeAttribute' * Add advanced options to HTML/CSS
2020-09-12 17:20:02 +00:00
"scanOnPenHover",
Touch and pen input updates (#2172) * Remove unnecessary return * Move touch start input filtering * Refactor * Add scanOnTouchPress * Add preventPenScrolling * Rename scanOnPenPress to scanOnPenMove * Rename scanOnPenRelease to scanOnPenReleaseHover * Simplify * Refactor _searchAtFromPen early exit * Merge _penPointerPressed and _penPointerReleased into a single variable * Add more options * Simplify pen pointer coordinates * Implement scanOnPenPress and scanOnPenRelease * Implement scanOnTouchRelease * Fix tests * Don't search on touch cancel * Cancel touch if the touch action is used for scrolling or other gestures * Fix incorrect scroll prevention options being used * Organize options * Fix typos
2022-06-03 21:11:32 +00:00
"scanOnPenReleaseHover",
"preventTouchScrolling",
"preventPenScrolling"
More scanning options (#815) * Reorganize options * Add advanced options * Add a setting transform 'setRelativeAttribute' * Add advanced options to HTML/CSS
2020-09-12 17:20:02 +00:00
],
"properties": {
"showAdvanced": {
"type": "boolean",
"default": false
},
Move searchTerms/searchKanji to front of object definitions (#873)
2020-09-27 15:53:07 +00:00
"searchTerms": {
Add scan on touch move and prevent touch scroll options (#871) * Add scanOnTouchMove/preventTouchScrolling scanning input options * Add settings controls * Support scanOnTouchMove in TextScanner * Support preventTouchScrolling in TextScanner
2020-09-27 15:46:37 +00:00
"type": "boolean",
"default": true
},
Move searchTerms/searchKanji to front of object definitions (#873)
2020-09-27 15:53:07 +00:00
"searchKanji": {
More scanning options (#815) * Reorganize options * Add advanced options * Add a setting transform 'setRelativeAttribute' * Add advanced options to HTML/CSS
2020-09-12 17:20:02 +00:00
"type": "boolean",
"default": true
},
Move searchTerms/searchKanji to front of object definitions (#873)
2020-09-27 15:53:07 +00:00
"scanOnTouchMove": {
More scanning options (#815) * Reorganize options * Add advanced options * Add a setting transform 'setRelativeAttribute' * Add advanced options to HTML/CSS
2020-09-12 17:20:02 +00:00
"type": "boolean",
"default": true
},
Touch and pen input updates (#2172) * Remove unnecessary return * Move touch start input filtering * Refactor * Add scanOnTouchPress * Add preventPenScrolling * Rename scanOnPenPress to scanOnPenMove * Rename scanOnPenRelease to scanOnPenReleaseHover * Simplify * Refactor _searchAtFromPen early exit * Merge _penPointerPressed and _penPointerReleased into a single variable * Add more options * Simplify pen pointer coordinates * Implement scanOnPenPress and scanOnPenRelease * Implement scanOnTouchRelease * Fix tests * Don't search on touch cancel * Cancel touch if the touch action is used for scrolling or other gestures * Fix incorrect scroll prevention options being used * Organize options * Fix typos
2022-06-03 21:11:32 +00:00
"scanOnTouchPress": {
"type": "boolean",
"default": true
},
"scanOnTouchRelease": {
"type": "boolean",
"default": false
},
"scanOnPenMove": {
"type": "boolean",
"default": true
},
Move searchTerms/searchKanji to front of object definitions (#873)
2020-09-27 15:53:07 +00:00
"scanOnPenHover": {
More scanning options (#815) * Reorganize options * Add advanced options * Add a setting transform 'setRelativeAttribute' * Add advanced options to HTML/CSS
2020-09-12 17:20:02 +00:00
"type": "boolean",
Move searchTerms/searchKanji to front of object definitions (#873)
2020-09-27 15:53:07 +00:00
"default": true
Add scan dictionary type filters (#822) * Add options for searchTerms and searchKanji * Add settings HTML * Add options to TextScanner * Update _search/_findDefinitions to include searchTerms/searchKanji args * Update _searchAtFromMouseMove args * Change argument structure for _searchAt * Use scanning options for searchTerms and searchKanji
2020-09-13 17:25:03 +00:00
},
Touch and pen input updates (#2172) * Remove unnecessary return * Move touch start input filtering * Refactor * Add scanOnTouchPress * Add preventPenScrolling * Rename scanOnPenPress to scanOnPenMove * Rename scanOnPenRelease to scanOnPenReleaseHover * Simplify * Refactor _searchAtFromPen early exit * Merge _penPointerPressed and _penPointerReleased into a single variable * Add more options * Simplify pen pointer coordinates * Implement scanOnPenPress and scanOnPenRelease * Implement scanOnTouchRelease * Fix tests * Don't search on touch cancel * Cancel touch if the touch action is used for scrolling or other gestures * Fix incorrect scroll prevention options being used * Organize options * Fix typos
2022-06-03 21:11:32 +00:00
"scanOnPenReleaseHover": {
"type": "boolean",
"default": false
},
Move searchTerms/searchKanji to front of object definitions (#873)
2020-09-27 15:53:07 +00:00
"scanOnPenPress": {
Add scan dictionary type filters (#822) * Add options for searchTerms and searchKanji * Add settings HTML * Add options to TextScanner * Update _search/_findDefinitions to include searchTerms/searchKanji args * Update _searchAtFromMouseMove args * Change argument structure for _searchAt * Use scanning options for searchTerms and searchKanji
2020-09-13 17:25:03 +00:00
"type": "boolean",
"default": true
},
Move searchTerms/searchKanji to front of object definitions (#873)
2020-09-27 15:53:07 +00:00
"scanOnPenRelease": {
Add scan dictionary type filters (#822) * Add options for searchTerms and searchKanji * Add settings HTML * Add options to TextScanner * Update _search/_findDefinitions to include searchTerms/searchKanji args * Update _searchAtFromMouseMove args * Change argument structure for _searchAt * Use scanning options for searchTerms and searchKanji
2020-09-13 17:25:03 +00:00
"type": "boolean",
Move searchTerms/searchKanji to front of object definitions (#873)
2020-09-27 15:53:07 +00:00
"default": false
Add scan on touch move and prevent touch scroll options (#871) * Add scanOnTouchMove/preventTouchScrolling scanning input options * Add settings controls * Support scanOnTouchMove in TextScanner * Support preventTouchScrolling in TextScanner
2020-09-27 15:46:37 +00:00
},
"preventTouchScrolling": {
"type": "boolean",
"default": true
Touch and pen input updates (#2172) * Remove unnecessary return * Move touch start input filtering * Refactor * Add scanOnTouchPress * Add preventPenScrolling * Rename scanOnPenPress to scanOnPenMove * Rename scanOnPenRelease to scanOnPenReleaseHover * Simplify * Refactor _searchAtFromPen early exit * Merge _penPointerPressed and _penPointerReleased into a single variable * Add more options * Simplify pen pointer coordinates * Implement scanOnPenPress and scanOnPenRelease * Implement scanOnTouchRelease * Fix tests * Don't search on touch cancel * Cancel touch if the touch action is used for scrolling or other gestures * Fix incorrect scroll prevention options being used * Organize options * Fix typos
2022-06-03 21:11:32 +00:00
},
"preventPenScrolling": {
"type": "boolean",
"default": true
More scanning options (#815) * Reorganize options * Add advanced options * Add a setting transform 'setRelativeAttribute' * Add advanced options to HTML/CSS
2020-09-12 17:20:02 +00:00
}
}
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
}
}
}
Add schema file for options
2019-11-27 17:11:45 +00:00
},
Add middle mouse prevention option (#868) * Add preventMiddleMouse option to TextScanner * Add preventMiddleMouse options * Add options * Apply preventMiddleMouse options
2020-09-26 23:24:21 +00:00
"preventMiddleMouse": {
"type": "object",
"required": [
"onWebPages",
"onPopupPages",
"onSearchPages",
"onSearchQuery"
],
"properties": {
"onWebPages": {
"type": "boolean",
"default": false
},
"onPopupPages": {
"type": "boolean",
"default": false
},
"onSearchPages": {
"type": "boolean",
"default": false
},
"onSearchQuery": {
"type": "boolean",
"default": false
}
}
},
Add schema file for options
2019-11-27 17:11:45 +00:00
"touchInputEnabled": {
"type": "boolean",
"default": true
},
Pointer events support (#819) * Add option pointerEventsEnabled * Add _pointerEventsEnabled option to TextScanner * Add additional options * Mouse pointer events * Touch pointer events * Pen pointer events
2020-09-13 15:33:10 +00:00
"pointerEventsEnabled": {
"type": "boolean",
"default": false
},
Add schema file for options
2019-11-27 17:11:45 +00:00
"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,
Increase the default scanning length to 16 (#1646)
2021-05-01 16:23:39 +00:00
"default": 16
Add schema file for options
2019-11-27 17:11:45 +00:00
},
"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
Scanning wildcards (#2042) * Add scanning.matchTypePrefix option * Update TextScanner to use matchTypePrefix option * Add setting * Update warning
2021-12-18 17:38:39 +00:00
},
"matchTypePrefix": {
"type": "boolean",
"default": false
Hide popup on cursor exit (#2109) * Update phrasing * Add new options * Add settings * Implement
2022-04-04 02:52:53 +00:00
},
"hidePopupOnCursorExit": {
"type": "boolean",
"default": false
},
"hidePopupOnCursorExitDelay": {
"type": "number",
"minimum": 0,
"default": 0
Exclude documentElement from zoom calculation (#2227) * Exclude documentElement from zoom calculation * Add an option * Refactor zoom coordinate conversion functions * Convert zoom coordinates for text sources * Rename variable * Convert rect coordinate spaces * Handle shadow DOM
2022-09-21 01:06:39 +00:00
},
"normalizeCssZoom": {
"type": "boolean",
"default": true
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",
Translator regex replacements (#1199) * Add support for regex replacements during the translation process * Allow assignment of textReplacements * Rename * Set up test data * Write expected data * Set up options * Prevent infinite loop if regex matches empty string * Implement setting controller * Add support for testing pattern replacements
2021-01-03 17:12:55 +00:00
"collapseEmphaticSequences",
"textReplacements"
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"
Translator regex replacements (#1199) * Add support for regex replacements during the translation process * Allow assignment of textReplacements * Rename * Set up test data * Write expected data * Set up options * Prevent infinite loop if regex matches empty string * Implement setting controller * Add support for testing pattern replacements
2021-01-03 17:12:55 +00:00
},
"textReplacements": {
"type": "object",
"required": [
"searchOriginal",
"groups"
],
"properties": {
"searchOriginal": {
"type": "boolean",
"default": true
},
"groups": {
"type": "array",
"items": {
"type": "array",
"items": {
"required": [
"pattern",
"ignoreCase",
"replacement"
],
"properties": {
"pattern": {
"type": "string",
"default": ""
},
"ignoreCase": {
"type": "boolean",
"default": false
},
"replacement": {
"type": "string",
"default": ""
}
}
}
}
}
}
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": {
Update dictionary settings structure (#1587) * Update dictionary settings structure to use an array instead of an object * Update ensureDictionarySettings implementation * Remove some usage of ObjectPropertyAccessor
2021-04-03 17:02:49 +00:00
"type": "array",
"items": {
Add schema file for options
2019-11-27 17:11:45 +00:00
"type": "object",
"required": [
Update dictionary settings structure (#1587) * Update dictionary settings structure to use an array instead of an object * Update ensureDictionarySettings implementation * Remove some usage of ObjectPropertyAccessor
2021-04-03 17:02:49 +00:00
"name",
Add schema file for options
2019-11-27 17:11:45 +00:00
"priority",
"enabled",
Definition collapsing when overflowing (#1575) * Add double-down-chevron.svg * Add options * Update dictionary importers * Update settings * Add support for collapsible definitions * Improve case when there is a very small amount of overflow * Fix incorrect enabled state of newly imported dictionaries
2021-03-31 22:17:28 +00:00
"allowSecondarySearches",
"definitionsCollapsible"
Add schema file for options
2019-11-27 17:11:45 +00:00
],
"properties": {
Update dictionary settings structure (#1587) * Update dictionary settings structure to use an array instead of an object * Update ensureDictionarySettings implementation * Remove some usage of ObjectPropertyAccessor
2021-04-03 17:02:49 +00:00
"name": {
"type": "string",
"default": ""
},
Add schema file for options
2019-11-27 17:11:45 +00:00
"priority": {
"type": "number",
"default": 0
},
"enabled": {
"type": "boolean",
"default": true
},
"allowSecondarySearches": {
"type": "boolean",
"default": false
Definition collapsing when overflowing (#1575) * Add double-down-chevron.svg * Add options * Update dictionary importers * Update settings * Add support for collapsible definitions * Improve case when there is a very small amount of overflow * Fix incorrect enabled state of newly imported dictionaries
2021-03-31 22:17:28 +00:00
},
"definitionsCollapsible": {
"type": "string",
Collapsible dictionary updates (#2170) * Add "force collapsed" and "force expanded" options * Simplify "any" check * Update style * Add help modal for collapsible dictionaries * Disable wrapping
2022-05-30 17:34:37 +00:00
"enum": ["not-collapsible", "expanded", "collapsed", "force-collapsed", "force-expanded"],
Definition collapsing when overflowing (#1575) * Add double-down-chevron.svg * Add options * Update dictionary importers * Update settings * Add support for collapsible definitions * Improve case when there is a very small amount of overflow * Fix incorrect enabled state of newly imported dictionaries
2021-03-31 22:17:28 +00:00
"default": "not-collapsible"
Add schema file for options
2019-11-27 17:11:45 +00:00
}
}
}
},
"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",
Text parse updates (#1811) * Expose more settings to QueryParser * Rename textParse to parseText * Refactor * Convert reading inside QueryParser rather than Backend * Remove use of readingMode from backend * Rename * Update parseText args * Simplify * Update results * Move use of optionsContext * Run mecab and internal parser in parallel * Added "dictionary-reading" reading mode * Update romaji conversion case
2021-07-09 20:05:57 +00:00
"enum": ["hiragana", "katakana", "romaji", "dictionary-reading", "none"],
Add schema file for options
2019-11-27 17:11:45 +00:00
"default": "hiragana"
}
}
},
"anki": {
"type": "object",
"required": [
"enable",
"server",
"tags",
"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",
Duplicate scope check all models (#1810) * Add duplicateScopeCheckAllModels option to createNote * Add duplicateScopeCheckAllModels option * Add setting
2021-07-14 00:29:53 +00:00
"duplicateScopeCheckAllModels",
Add duplicate check option (#1012) * Add anki.checkForDuplicates option * Use checkForDuplicates for button display * Add property to card creation
2020-11-08 21:25:07 +00:00
"checkForDuplicates",
Support suspending new anki cards (#1240) * Add new option: anki.suspendNewCards * Update Anki APIs * Suspend card based on options * Add setting * Disable wrap for toggle property
2021-01-15 03:42:11 +00:00
"fieldTemplates",
Show any custom tags on words that have anki cards created (#1628) * Proof-of-concept for showing card tags (#1626) * Resolved most PR comments: - Added a snackbar notification when clicking tag button - Replaced magnifying glass icon with new tag icon - Button now contains a span w/icon, to use text color - Removed unnecessary attributes from button - Backend now returns full noteInfos object - Frontend now handles filtering tags * Add options to show/hide tag button & filter tags * Do not show tags button if, after filtering, we have zero tags. * Change tags option to enums, optimize tags intersection check & fix code style. * Update options-util.js to include new tag options. * Fix wording on new tag setting. * Add CSS to remove hidden buttons from the display layout. * getAnkiNoteInfo extra parameter for additional info. * Add new tag option to tests. * Remove unnecessary changes related to anki tags option. * Code style fixes.
2021-04-30 21:57:53 +00:00
"suspendNewCards",
Add support for guiEditNote to view notes (#2143) * Add AnkiConnect.guiEditNote * Update _onApiNoteView to first try guiEditNote * Add setting * Update noteView API * Use setting * Return which mode was used * Update DisplayGenerator * Handle errors in DisplayAnki * Update docs * Add isErrorUnsupportedAction function * Add an allowFallback option to noteView * Disambiguate * Simplify now that preferredMode isn't used * Update settings info * Implement test buttons * Update styles * Update status visibility * Wrap layout * Update description * Update date
2022-05-30 01:24:41 +00:00
"displayTags",
Add support for Anki API key (#2169) * Update material.css to support password fields * Support password * Add "apiKey" setting * Use apiKey * Update options if API key changes * Update tests
2022-05-30 16:03:24 +00:00
"noteGuiMode",
Audio download timeout (#2187) * Add support for an idle timeout when downloading audio * Update eslint rules * Pass idleTimeout to the downloader from DisplayAnki * Add anki.downloadTimeout setting * Update tests * Assign _audioDownloadIdleTimeout using settings * Show info about cancelled downloads * Handle Firefox bug * Improve audio errors * Refactor * Move functions to RequestBuilder
2022-08-20 15:17:24 +00:00
"apiKey",
"downloadTimeout"
Add schema file for options
2019-11-27 17:11:45 +00:00
],
"properties": {
"enable": {
"type": "boolean",
"default": false
},
"server": {
"type": "string",
"default": "http://127.0.0.1:8765"
},
"tags": {
"type": "array",
"items": {
"type": "string"
},
"default": [
"yomichan"
]
},
"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",
Duplicate scope options (#955) * Add deck-root duplicate scope option * Implement support for deck-root scope
2020-10-31 23:03:45 +00:00
"enum": ["collection", "deck", "deck-root"]
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
},
Duplicate scope check all models (#1810) * Add duplicateScopeCheckAllModels option to createNote * Add duplicateScopeCheckAllModels option * Add setting
2021-07-14 00:29:53 +00:00
"duplicateScopeCheckAllModels": {
"type": "boolean",
"default": false
},
Add duplicate check option (#1012) * Add anki.checkForDuplicates option * Use checkForDuplicates for button display * Add property to card creation
2020-11-08 21:25:07 +00:00
"checkForDuplicates": {
"type": "boolean",
"default": true
},
Add schema file for options
2019-11-27 17:11:45 +00:00
"fieldTemplates": {
"type": ["string", "null"],
"default": null
Support suspending new anki cards (#1240) * Add new option: anki.suspendNewCards * Update Anki APIs * Suspend card based on options * Add setting * Disable wrap for toggle property
2021-01-15 03:42:11 +00:00
},
"suspendNewCards": {
"type": "boolean",
"default": false
Show any custom tags on words that have anki cards created (#1628) * Proof-of-concept for showing card tags (#1626) * Resolved most PR comments: - Added a snackbar notification when clicking tag button - Replaced magnifying glass icon with new tag icon - Button now contains a span w/icon, to use text color - Removed unnecessary attributes from button - Backend now returns full noteInfos object - Frontend now handles filtering tags * Add options to show/hide tag button & filter tags * Do not show tags button if, after filtering, we have zero tags. * Change tags option to enums, optimize tags intersection check & fix code style. * Update options-util.js to include new tag options. * Fix wording on new tag setting. * Add CSS to remove hidden buttons from the display layout. * getAnkiNoteInfo extra parameter for additional info. * Add new tag option to tests. * Remove unnecessary changes related to anki tags option. * Code style fixes.
2021-04-30 21:57:53 +00:00
},
"displayTags": {
"type": "string",
"enum": ["never", "always", "non-standard"],
"default": "never"
Add support for guiEditNote to view notes (#2143) * Add AnkiConnect.guiEditNote * Update _onApiNoteView to first try guiEditNote * Add setting * Update noteView API * Use setting * Return which mode was used * Update DisplayGenerator * Handle errors in DisplayAnki * Update docs * Add isErrorUnsupportedAction function * Add an allowFallback option to noteView * Disambiguate * Simplify now that preferredMode isn't used * Update settings info * Implement test buttons * Update styles * Update status visibility * Wrap layout * Update description * Update date
2022-05-30 01:24:41 +00:00
},
"noteGuiMode": {
"type": "string",
"enum": ["browse", "edit"],
"default": "browse"
Add support for Anki API key (#2169) * Update material.css to support password fields * Support password * Add "apiKey" setting * Use apiKey * Update options if API key changes * Update tests
2022-05-30 16:03:24 +00:00
},
"apiKey": {
"type": "string",
"default": ""
Audio download timeout (#2187) * Add support for an idle timeout when downloading audio * Update eslint rules * Pass idleTimeout to the downloader from DisplayAnki * Add anki.downloadTimeout setting * Update tests * Assign _audioDownloadIdleTimeout using settings * Show info about cancelled downloads * Handle Firefox bug * Improve audio errors * Refactor * Move functions to RequestBuilder
2022-08-20 15:17:24 +00:00
},
"downloadTimeout": {
"type": "number",
"default": 0,
"minimum": 0
Add schema file for options
2019-11-27 17:11:45 +00:00
}
}
Sentence parsing options (#1214) * Rename options.anki.sentenceExt to options.sentenceParsing.scanExtent * Create sentence parsing icon * Create new sentence parsing section
2021-01-10 02:25:04 +00:00
},
"sentenceParsing": {
"type": "object",
"required": [
Customizable sentence parsing (#1217) * Add new sentenceParsing options * Update TextScanner.setOptions * Assign terminator/quote maps * Pass sentence parsing info to extractSentence * Simplify setting * Add setting for enableTerminationCharacters * Create new settings for sentence termination characters
2021-01-10 19:43:06 +00:00
"scanExtent",
Sentence termination character mode (#1682) * Change enableTerminationCharacters to terminationCharacterMode * Update settings * Update sentence extraction * Update tests * Add tests
2021-05-16 19:24:38 +00:00
"terminationCharacterMode",
Customizable sentence parsing (#1217) * Add new sentenceParsing options * Update TextScanner.setOptions * Assign terminator/quote maps * Pass sentence parsing info to extractSentence * Simplify setting * Add setting for enableTerminationCharacters * Create new settings for sentence termination characters
2021-01-10 19:43:06 +00:00
"terminationCharacters"
Sentence parsing options (#1214) * Rename options.anki.sentenceExt to options.sentenceParsing.scanExtent * Create sentence parsing icon * Create new sentence parsing section
2021-01-10 02:25:04 +00:00
],
"properties": {
"scanExtent": {
"type": "integer",
"minimum": 0,
"default": 200
Customizable sentence parsing (#1217) * Add new sentenceParsing options * Update TextScanner.setOptions * Assign terminator/quote maps * Pass sentence parsing info to extractSentence * Simplify setting * Add setting for enableTerminationCharacters * Create new settings for sentence termination characters
2021-01-10 19:43:06 +00:00
},
Sentence termination character mode (#1682) * Change enableTerminationCharacters to terminationCharacterMode * Update settings * Update sentence extraction * Update tests * Add tests
2021-05-16 19:24:38 +00:00
"terminationCharacterMode": {
"type": "string",
"enum": ["custom", "custom-no-newlines", "newlines", "none"],
Fix invalid default value in options schema (#1827)
2021-07-14 01:27:18 +00:00
"default": "custom"
Customizable sentence parsing (#1217) * Add new sentenceParsing options * Update TextScanner.setOptions * Assign terminator/quote maps * Pass sentence parsing info to extractSentence * Simplify setting * Add setting for enableTerminationCharacters * Create new settings for sentence termination characters
2021-01-10 19:43:06 +00:00
},
"terminationCharacters": {
"type": "array",
"items": {
"type": "object",
"required": [
"enabled",
"character1",
"character2",
"includeCharacterAtStart",
"includeCharacterAtEnd"
],
"properties": {
"enabled": {
"type": "boolean",
"default": true
},
"character1": {
"type": "string",
"default": "\"",
"minLength": 1,
"maxLength": 1
},
"character2": {
"type": ["string", "null"],
"default": "\"",
"minLength": 1,
"maxLength": 1
},
"includeCharacterAtStart": {
"type": "boolean",
"default": false
},
"includeCharacterAtEnd": {
"type": "boolean",
"default": false
}
}
},
"default": [
{"enabled": true, "character1": "「", "character2": "」", "includeCharacterAtStart": false, "includeCharacterAtEnd": false},
{"enabled": true, "character1": "『", "character2": "』", "includeCharacterAtStart": false, "includeCharacterAtEnd": false},
{"enabled": true, "character1": "\"", "character2": "\"", "includeCharacterAtStart": false, "includeCharacterAtEnd": false},
{"enabled": true, "character1": "'", "character2": "'", "includeCharacterAtStart": false, "includeCharacterAtEnd": false},
{"enabled": true, "character1": ".", "character2": null, "includeCharacterAtStart": false, "includeCharacterAtEnd": true},
{"enabled": true, "character1": "!", "character2": null, "includeCharacterAtStart": false, "includeCharacterAtEnd": true},
{"enabled": true, "character1": "?", "character2": null, "includeCharacterAtStart": false, "includeCharacterAtEnd": true},
{"enabled": true, "character1": "．", "character2": null, "includeCharacterAtStart": false, "includeCharacterAtEnd": true},
{"enabled": true, "character1": "。", "character2": null, "includeCharacterAtStart": false, "includeCharacterAtEnd": true},
{"enabled": true, "character1": "！", "character2": null, "includeCharacterAtStart": false, "includeCharacterAtEnd": true},
{"enabled": true, "character1": "？", "character2": null, "includeCharacterAtStart": false, "includeCharacterAtEnd": true},
Update sentence termination characters (#2059) * Add vertical punctuation to terminationCharacters * Upgrade settings * Update tests
2022-02-03 01:09:13 +00:00
{"enabled": true, "character1": "…", "character2": null, "includeCharacterAtStart": false, "includeCharacterAtEnd": true},
{"enabled": true, "character1": "︒", "character2": null, "includeCharacterAtStart": false, "includeCharacterAtEnd": true},
{"enabled": true, "character1": "︕", "character2": null, "includeCharacterAtStart": false, "includeCharacterAtEnd": true},
{"enabled": true, "character1": "︖", "character2": null, "includeCharacterAtStart": false, "includeCharacterAtEnd": true},
{"enabled": true, "character1": "︙", "character2": null, "includeCharacterAtStart": false, "includeCharacterAtEnd": true}
Customizable sentence parsing (#1217) * Add new sentenceParsing options * Update TextScanner.setOptions * Assign terminator/quote maps * Pass sentence parsing info to extractSentence * Simplify setting * Add setting for enableTerminationCharacters * Create new settings for sentence termination characters
2021-01-10 19:43:06 +00:00
]
Sentence parsing options (#1214) * Rename options.anki.sentenceExt to options.sentenceParsing.scanExtent * Create sentence parsing icon * Create new sentence parsing section
2021-01-10 02:25:04 +00:00
}
}
Hotkeys (#1236) * Set up hotkey inputs * Improve key display * Add setInput * Add KeyboardShortcutController * Update how display handles hotkeys
2021-01-15 01:56:18 +00:00
},
"inputs": {
"type": "object",
"required": [
"hotkeys"
],
"properties": {
"hotkeys": {
"type": "array",
"items": {
"type": "object",
"required": [
"action",
Hotkey arguments (#1565) * Update display * Move scope definitions * Update scopes button after changing action * Don't show menu if empty * Improve scope updating * Update style * Simplify * Add argument to settings * Update convertToNumber implementation * Add support for arguments * Pass argument to action handler * Update hotkey action definitions * Remove x3 options
2021-03-28 02:30:45 +00:00
"argument",
Hotkeys (#1236) * Set up hotkey inputs * Improve key display * Add setInput * Add KeyboardShortcutController * Update how display handles hotkeys
2021-01-15 01:56:18 +00:00
"key",
"modifiers",
"scopes",
"enabled"
],
"properties": {
"action": {
"type": "string",
"default": ""
},
Hotkey arguments (#1565) * Update display * Move scope definitions * Update scopes button after changing action * Don't show menu if empty * Improve scope updating * Update style * Simplify * Add argument to settings * Update convertToNumber implementation * Add support for arguments * Pass argument to action handler * Update hotkey action definitions * Remove x3 options
2021-03-28 02:30:45 +00:00
"argument": {
"type": "string",
"default": ""
},
Hotkeys (#1236) * Set up hotkey inputs * Improve key display * Add setInput * Add KeyboardShortcutController * Update how display handles hotkeys
2021-01-15 01:56:18 +00:00
"key": {
"type": ["string", "null"],
"default": null
},
"modifiers": {
"type": "array",
"items": {
"type": "string",
"enum": ["alt", "ctrl", "shift", "meta"],
"default": "alt"
}
},
"scopes": {
"type": "array",
"items": {
"type": "string",
Add support for frontend hotkeys; add scanSelectedText action (#1266) * Add support for frontend hotkeys; add scanSelectedText action * Remove unused global * Remove duplicate hotkey handler script
2021-01-18 00:28:42 +00:00
"enum": ["popup", "search", "web"],
Hotkeys (#1236) * Set up hotkey inputs * Improve key display * Add setInput * Add KeyboardShortcutController * Update how display handles hotkeys
2021-01-15 01:56:18 +00:00
"default": "popup"
},
"default": ["popup", "search"]
},
"enabled": {
"type": "boolean",
"default": true
}
}
},
"default": [
Hotkey arguments (#1565) * Update display * Move scope definitions * Update scopes button after changing action * Don't show menu if empty * Improve scope updating * Update style * Simplify * Add argument to settings * Update convertToNumber implementation * Add support for arguments * Pass argument to action handler * Update hotkey action definitions * Remove x3 options
2021-03-28 02:30:45 +00:00
{"action": "close", "argument": "", "key": "Escape", "modifiers": [], "scopes": ["popup"], "enabled": true},
{"action": "focusSearchBox", "argument": "", "key": "Escape", "modifiers": [], "scopes": ["search"], "enabled": true},
{"action": "previousEntry", "argument": "3", "key": "PageUp", "modifiers": ["alt"], "scopes": ["popup", "search"], "enabled": true},
{"action": "nextEntry", "argument": "3", "key": "PageDown", "modifiers": ["alt"], "scopes": ["popup", "search"], "enabled": true},
{"action": "lastEntry", "argument": "", "key": "End", "modifiers": ["alt"], "scopes": ["popup", "search"], "enabled": true},
{"action": "firstEntry", "argument": "", "key": "Home", "modifiers": ["alt"], "scopes": ["popup", "search"], "enabled": true},
{"action": "previousEntry", "argument": "1", "key": "ArrowUp", "modifiers": ["alt"], "scopes": ["popup", "search"], "enabled": true},
{"action": "nextEntry", "argument": "1", "key": "ArrowDown", "modifiers": ["alt"], "scopes": ["popup", "search"], "enabled": true},
{"action": "historyBackward", "argument": "", "key": "KeyB", "modifiers": ["alt"], "scopes": ["popup", "search"], "enabled": true},
{"action": "historyForward", "argument": "", "key": "KeyF", "modifiers": ["alt"], "scopes": ["popup", "search"], "enabled": true},
{"action": "addNoteKanji", "argument": "", "key": "KeyK", "modifiers": ["alt"], "scopes": ["popup", "search"], "enabled": true},
{"action": "addNoteTermKanji", "argument": "", "key": "KeyE", "modifiers": ["alt"], "scopes": ["popup", "search"], "enabled": true},
{"action": "addNoteTermKana", "argument": "", "key": "KeyR", "modifiers": ["alt"], "scopes": ["popup", "search"], "enabled": true},
{"action": "playAudio", "argument": "", "key": "KeyP", "modifiers": ["alt"], "scopes": ["popup", "search"], "enabled": true},
{"action": "viewNote", "argument": "", "key": "KeyV", "modifiers": ["alt"], "scopes": ["popup", "search"], "enabled": true},
{"action": "copyHostSelection", "argument": "", "key": "KeyC", "modifiers": ["ctrl"], "scopes": ["popup"], "enabled": true}
Hotkeys (#1236) * Set up hotkey inputs * Improve key display * Add setInput * Add KeyboardShortcutController * Update how display handles hotkeys
2021-01-15 01:56:18 +00:00
]
}
}
Update clipboard options organization (#1318) * Update options organization * Update general.enableClipboardPopups to clipboard.enableBackgroundMonitor * Update general.enableClipboardMonitor to clipboard.enableSearchPageMonitor * Update general.maximumClipboardSearchLength to clipboard.maximumSearchLength * Update general.autoSearchClipboardContent to clipboard.autoSearchContent
2021-01-26 23:30:01 +00:00
},
"clipboard": {
"type": "object",
"required": [
"enableBackgroundMonitor",
"enableSearchPageMonitor",
"autoSearchContent",
"maximumSearchLength"
],
"properties": {
"enableBackgroundMonitor": {
"type": "boolean",
"default": false
},
"enableSearchPageMonitor": {
"type": "boolean",
"default": false
},
"autoSearchContent": {
"type": "boolean",
"default": true
},
"maximumSearchLength": {
"type": "integer",
"default": 1000,
"minimum": 0
}
}
Google Docs accessibility (#1875) * Add accessibility option for forcing Google Docs HTML-based rendering * Update settings * Send a documentStart message at document start * Add accessibility script for Google Docs * Set up accessibility * Update tests
2021-08-07 16:40:51 +00:00
},
"accessibility": {
"type": "object",
"required": [
"forceGoogleDocsHtmlRendering"
],
"properties": {
"forceGoogleDocsHtmlRendering": {
"type": "boolean",
"default": false
}
}
Add schema file for options
2019-11-27 17:11:45 +00:00
}
}
}
}
}
},
"profileCurrent": {
"type": "integer",
"minimum": 0,
"default": 0
},
"global": {
"type": "object",
"required": [
Remove old settings page (#1524) * Remove old settings page * Remove spinner.gif
2021-03-15 02:51:48 +00:00
"database"
Add schema file for options
2019-11-27 17:11:45 +00:00
],
"properties": {
"database": {
"type": "object",
"required": [
"prefixWildcardsSupported"
],
"properties": {
"prefixWildcardsSupported": {
"type": "boolean",
"default": false
}
}
}
}
}
}
}
Copy Permalink