Skip to content

Commit

Permalink
update user doc
Browse files Browse the repository at this point in the history
  • Loading branch information
shenlebantongying committed Feb 23, 2025
1 parent 6334277 commit 458d0d4
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 24 deletions.
18 changes: 4 additions & 14 deletions website/docs/manage_groups.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,16 +7,16 @@ Additionally, multiple strategies of automatic grouping are provided:
* based on the language info embedded within dictionary files
* based on the folder structure
* based on customizable metadata files
## Auto grouping
### Auto groups by dictionary language

## Auto groups by dictionary language

For formats like DSL, which has embedded language from / to metadata, GD will use the dictionary's built-in metadata.

For other formats, GD will try finding the last `{id}-{id}` pair delimited by non-alphabets in dictionary name or main file name to extract languages. The `{id}` is 2 or 3 letters ISO 639 codes. For example, if a dictionary named `some name en-zh`, it will be automatically grouped into `en-zh`.

Groups created in this method also include a context menu when right-click the group name, in which you can do additional dictionaries grouping by source or target language and combine dictionaries in more large groups.

### Auto groups by folders
## Auto groups by folders

Click the "Group by folders" will group your dicts based on folder structure.

Expand Down Expand Up @@ -69,7 +69,7 @@ More levels of folder nesting are not supported.
| └─ DictB Files
```

### Auto groups by `metadata.toml`
## Auto groups by `metadata.toml`

Click the "group by metadata" will group your dicts based on `metadata.toml`.

Expand Down Expand Up @@ -121,13 +121,3 @@ The structure above will be auto grouped into three groups:
* `汉英词典` with `Cambridge`,`Collins`

Note: Dictionaries without `metadata.toml` won't be auto-grouped.

## Favoriates folder

A group can have an existing folder as target for saving favoriates.

When switching groups, the target folder will be automatically activated.

For simple use cases, just type the name of an existing folder name.

If a folder is nested, then use `/` as a separator, such as `english/food/spicy` or `spanish/greetings`.
24 changes: 14 additions & 10 deletions website/docs/ui_favorites.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,24 @@
![favoriates](img/fav.webp)

Favorites is a hierarchical structure of folders and words in them.
Favorites is a hierarchical structure of folders and words in them. You could create folders manually via context menu.

You could create folders manually via context menu.
By default, the ⭐ icon on the toolbar will indiciate if word is in top most level.

By default the ⭐icon on the toolbar will add/remove word from the top most level.
You can "active" a folder via context menu. Then the ⭐ icon will indiciate if a word is in this folder and clicking the ⭐ icon will add/remove words to/from this folder.

To add/remove word from a specific folder, you can "active" a folder via context menu,
then clicking the ⭐icon will add/remove words from this folder.
A group can have a associated folder.
When switching groups, the associated folder will be automatically activated. For simple use cases, just use the name of an existing folder.
If a folder is nested, then use `/` as a separator, such as `english/food/spicy` or `spanish/greetings`.

Group can be associated with specific folders.
When switching groups, the associated folder will be automatically activated.
The entries can be moved simply by dragging and dropping. The entries can be deleted via context menu or by pressing the "Delete" key.

The entries can be moved simply by dragging and dropping. The entries can be deleted via context menu or by pressing the "Del" key.
## Import & Export

In addition to adding and removing items to/from the Favorites you can perform the following operations via context menu or the main menu:

* "Export" - the Favorites contents will be exported to the specified XML file while preserving the entire structure.
* "Export to plain list" - all headwords stored in the Favorites will be saved to the specified text file as plain list without saving the folder structure.* * "Import" - the current contents of the Favorites will be replaced by the contents of the specified XML file.
* "Export" - Export the all favoriates to a plain text or XML file.
* "Import" - The current favorites will be **replaced** by the content of XML or plain text.

!!! info
Currently, XML will perserve folder structure but plain text won't!

0 comments on commit 458d0d4

Please sign in to comment.