From ccf70cdfb614954bcbbe3724a29840b092b7bfb2 Mon Sep 17 00:00:00 2001 From: shenleban tongying Date: Wed, 13 Nov 2024 22:48:06 -0500 Subject: [PATCH] doc: various updates --- website/README.md | 4 +-- website/docs/custom_dictionary.md | 2 ++ website/docs/manage_sources.md | 4 +-- website/docs/topic_userstyle.md | 1 + website/docs/ui_shortcuts.md | 14 -------- website/docs/ui_toolbar.md | 59 ++++++++++++++++++++----------- website/mkdocs.yml | 3 +- 7 files changed, 48 insertions(+), 39 deletions(-) diff --git a/website/README.md b/website/README.md index 616a2e5d..91694ed6 100644 --- a/website/README.md +++ b/website/README.md @@ -3,10 +3,10 @@ With venv ``` cd ./website -python -m venv ./venv/ +python3 -m venv ./venv/ source ./venv/bin/activate # source ./venv/bin/activate.fish -pip install mkdocs-material +pip3 install mkdocs-material ``` Then diff --git a/website/docs/custom_dictionary.md b/website/docs/custom_dictionary.md index 4ee0eb60..9dc68914 100644 --- a/website/docs/custom_dictionary.md +++ b/website/docs/custom_dictionary.md @@ -46,3 +46,5 @@ will disable the current dictionary's full-text search. You can check the full-text search status on each dictionary's info dialog. ![](img/dictionary-info-fullindex.png) + +Note that it is possible to enable full text for a single dictionary by disabling full-text search in the Preferences dialog, and set `fts=true` for that dictionary. \ No newline at end of file diff --git a/website/docs/manage_sources.md b/website/docs/manage_sources.md index f5053d9b..df10a324 100644 --- a/website/docs/manage_sources.md +++ b/website/docs/manage_sources.md @@ -1,4 +1,4 @@ -Dictionaries management dialog can be opened via menu `Edit` -> `Dictionaries`. +Dictionary management dialog can be opened via menu `Edit` -> `Dictionaries`. To use local dictionaries, add them via `Sources` -> `Files`. @@ -34,7 +34,7 @@ Morphology dictionary uses Hunspell's morphological analysis to obtain word's va You can specify a path that includes Hunspell format data files (`.aff` + `.dic`). GoldenDict scan this folder and create a list of available dictionaries. -One possible source of Hunspell dictionaries is Libreoffice's [dictionaries](https://github.com/LibreOffice/dictionaries). +One possible source of Hunspell dictionaries is LibreOffice's [dictionaries](https://github.com/LibreOffice/dictionaries). The detailed document about the affix file (`.aff`) and the dict file (`.dic`) can be found at [hunspell.5](https://man.archlinux.org/man/hunspell.5.en). diff --git a/website/docs/topic_userstyle.md b/website/docs/topic_userstyle.md index 45bee8c5..16d08405 100644 --- a/website/docs/topic_userstyle.md +++ b/website/docs/topic_userstyle.md @@ -4,6 +4,7 @@ By creating `article-style.css` or `article-script.js` in GoldenDict's configura . <- GD's configuration folder ├── config ├── article-style.css +├── article-style-print.css (affecting styles when printing) ├── article-script.js └── qt-style.css ``` diff --git a/website/docs/ui_shortcuts.md b/website/docs/ui_shortcuts.md index 8bf1df36..3d0a4aa3 100644 --- a/website/docs/ui_shortcuts.md +++ b/website/docs/ui_shortcuts.md @@ -54,17 +54,3 @@ | F3 | Dictionaries dialog | | F4 | GoldenDict preferences | | F12 | Inspector | - - -# Solo mode in the dictionary bar -Ctrl+Click, Enter solo mode, toggle between single & all dictionaries -Shift+Click, Exit solo mode, restore the previous dictionaries. - -For example, there are 4 dictionaries A,B,C,D with ABC selected. - -| Cases| Note| -|--------|--------| -| Ctrl+Click A|select A only| -| Ctrl+Click A, Ctrl+Click B | select B only| -| Ctrl+Click A, Ctrl+Click A | A,B,C,D selected(all dictionaries selected)| -| Ctrl+Click A, Shift+Click any dictionary| A,B,C selected | diff --git a/website/docs/ui_toolbar.md b/website/docs/ui_toolbar.md index 97dcbfb2..6f5b0082 100644 --- a/website/docs/ui_toolbar.md +++ b/website/docs/ui_toolbar.md @@ -1,37 +1,56 @@ ## Toolbar ![toolbar](img/toolbar.webp) -From left to right: +Type your word in Search Box and press `Enter` to search word in the current selected group. You can also choose a variant from a matches list. -* Forward/Backward navigation buttons; -* Group selector -* Search Line -* Toggle Scanning -* Play the first pronunciation in found articles; -* Font scale buttons; -* Save the article as HTML -* Print article -* Add to Favorites; - -Type your word in Search Box and press `Enter` to search word in the current selected group. You can also choose a variant from matches list. - -If Ctrl or Shift key has been pressed the new tab for translation will be created. +Holding Ctrl or Shift will display the translation result in a new tab. ### Wildcard matching -The Search Line can contain wildcard symbols `?` (matches any one character), `*` (matches any characters number) or ranges of characters `[...]`. To find characters `?`, `*`, `[` and `]` it should be escaped with backslash like `\?`, `\*`, `\[`, `\]`. +The search line can use wildcard or glob symbols for matching words. + +| Wildcard | Description | +|----------|------------------------------------------------------------------------| +| `?` | Matches any single character. | +| `*` | Matches zero or more of any characters. | +| `[abc]` | Matches one character given in the bracket. | +| `[a-c]` | Matches one character from the range given in the bracket. | +| `[!abc]` | Matches one character that is not given in the bracket. | +| `[!a-c]` | Matches one character that is not from the range given in the bracket. | +| `\` | Escaping wildcard symbols, e.g. `\?` to search `?` | !!! note - The wildcard symbol at first position in word leads to full headwords list scanning and it may take a long time for huge dictionaries. + The wildcard symbol in the first character leads to scanning of every dictionary's every word and may take a long time. + +More information about wildcard matching can be found in [Wikipedia's glob article](https://en.wikipedia.org/wiki/Glob_(programming)). + ## Dictionary Bar -The dictionaries bar contains all dictionaries from current dictionaries group. Click the icons to disable/enable them. +The dictionary bar contains all dictionaries from the current dictionaries group. Click the icons to disable/enable them. -Hold `Shift` and click dictionary bar will temporally focus on a single dictionary. Hold `Shift` and click again to defocus and restore the previous dictionaries bar state. +### "Solo" mode -Hold `Ctrl` and click dictionary bar will toggle between "Enable a single dictionary" and "Enable all dictionary". +Temporally focus on a single dictionary and restore back to all dictionaries or previously selected dictionaries. -Note: The `Shift` and `Ctrl` interaction can also be used on "Found in dictionaries" panel +To enter solo mode: +++ctrl+left-button++ -> Select a single dictionary. + +To exit solo mode: + +++ctrl+left-button++ -> Reselect all dictionaries. + +++shift+left-button++ -> Reselect dictionaries that were previously selected before entering solo mode. + +For example, there are 4 dictionaries A,B,C,D with ABC selected. + +| Cases | Note | +|------------------------------------------|----------------------------------------------| +| Ctrl+Click A | select A only | +| Ctrl+Click A, Ctrl+Click B | select B only | +| Ctrl+Click A, Ctrl+Click A | A,B,C,D selected (all dictionaries selected) | +| Ctrl+Click A, Shift+Click any dictionary | A,B,C selected | + +Note: This can also be used on the "Found in dictionaries" panel. diff --git a/website/mkdocs.yml b/website/mkdocs.yml index 7e6bb1b0..2d7eb1a8 100644 --- a/website/mkdocs.yml +++ b/website/mkdocs.yml @@ -21,6 +21,7 @@ markdown_extensions: - admonition - pymdownx.details - pymdownx.superfences + - pymdownx.keys nav: - Getting started: index.md @@ -33,7 +34,7 @@ nav: - Popup Window: ui_popup.md - Headwords Dialog: ui_headwords.md - Full Text Search: ui_fulltextsearch.md - - ToolBar & DictBar: ui_toolbar.md + - Tool & Dictionary Bar: ui_toolbar.md - Favorites: ui_favorites.md - Shortcuts: ui_shortcuts.md - Advanced Usages: