mirror of
https://github.com/xiaoyifang/goldendict-ng.git
synced 2024-11-23 16:04:06 +00:00
doc: various updates
This commit is contained in:
parent
6865b02547
commit
ccf70cdfb6
|
@ -3,10 +3,10 @@
|
||||||
With venv
|
With venv
|
||||||
```
|
```
|
||||||
cd ./website
|
cd ./website
|
||||||
python -m venv ./venv/
|
python3 -m venv ./venv/
|
||||||
source ./venv/bin/activate
|
source ./venv/bin/activate
|
||||||
# source ./venv/bin/activate.fish
|
# source ./venv/bin/activate.fish
|
||||||
pip install mkdocs-material
|
pip3 install mkdocs-material
|
||||||
```
|
```
|
||||||
|
|
||||||
Then
|
Then
|
||||||
|
|
|
@ -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.
|
You can check the full-text search status on each dictionary's info dialog.
|
||||||
|
|
||||||
![](img/dictionary-info-fullindex.png)
|
![](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.
|
|
@ -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`.
|
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.
|
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).
|
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).
|
||||||
|
|
||||||
|
|
|
@ -4,6 +4,7 @@ By creating `article-style.css` or `article-script.js` in GoldenDict's configura
|
||||||
. <- GD's configuration folder
|
. <- GD's configuration folder
|
||||||
├── config
|
├── config
|
||||||
├── article-style.css
|
├── article-style.css
|
||||||
|
├── article-style-print.css (affecting styles when printing)
|
||||||
├── article-script.js
|
├── article-script.js
|
||||||
└── qt-style.css
|
└── qt-style.css
|
||||||
```
|
```
|
||||||
|
|
|
@ -54,17 +54,3 @@
|
||||||
| F3 | Dictionaries dialog |
|
| F3 | Dictionaries dialog |
|
||||||
| F4 | GoldenDict preferences |
|
| F4 | GoldenDict preferences |
|
||||||
| F12 | Inspector |
|
| 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 |
|
|
||||||
|
|
|
@ -1,37 +1,56 @@
|
||||||
## Toolbar
|
## Toolbar
|
||||||
![toolbar](img/toolbar.webp)
|
![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;
|
Holding Ctrl or Shift will display the translation result in a new tab.
|
||||||
* 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.
|
|
||||||
|
|
||||||
### Wildcard matching
|
### 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
|
!!! 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
|
## 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.
|
||||||
|
|
||||||
|
|
|
@ -21,6 +21,7 @@ markdown_extensions:
|
||||||
- admonition
|
- admonition
|
||||||
- pymdownx.details
|
- pymdownx.details
|
||||||
- pymdownx.superfences
|
- pymdownx.superfences
|
||||||
|
- pymdownx.keys
|
||||||
|
|
||||||
nav:
|
nav:
|
||||||
- Getting started: index.md
|
- Getting started: index.md
|
||||||
|
@ -33,7 +34,7 @@ nav:
|
||||||
- Popup Window: ui_popup.md
|
- Popup Window: ui_popup.md
|
||||||
- Headwords Dialog: ui_headwords.md
|
- Headwords Dialog: ui_headwords.md
|
||||||
- Full Text Search: ui_fulltextsearch.md
|
- Full Text Search: ui_fulltextsearch.md
|
||||||
- ToolBar & DictBar: ui_toolbar.md
|
- Tool & Dictionary Bar: ui_toolbar.md
|
||||||
- Favorites: ui_favorites.md
|
- Favorites: ui_favorites.md
|
||||||
- Shortcuts: ui_shortcuts.md
|
- Shortcuts: ui_shortcuts.md
|
||||||
- Advanced Usages:
|
- Advanced Usages:
|
||||||
|
|
Loading…
Reference in a new issue