goldendict-ng/website/docs/custom_dictionary_name.md
xiaoyifang 715512eda3
feat: allow to customize dictionary name (#722)
* feat: allow to customize dictionary name

* 🎨 apply clang-format changes

* fix: code smell

* feat: allow to set custom dictionary name

* 🎨 apply clang-format changes

* feat: add doc for customizing dictionary name

* 🎨 apply clang-format changes

* 🎨 apply clang-format changes

---------

Co-authored-by: xiaoyifang <xiaoyifang@users.noreply.github.com>
2023-05-20 22:33:20 +08:00

754 B

You can customize the dictionary name by the metadata.toml which is also used in metadata grouping

About the configuration of metadata.toml

[metadata]
name = "New Name"

this New Name will be appeared as the dictionary name.

The metadata.toml should be placed beside dictionary files. One metadata.toml for each dictionary.

The metadata file uses TOML format.

For example,

.
├── Cambridge
│    ├── metadata.toml     (A)
│    ├── Cambridge.idx
│    ├── Cambridge.info
│    ├── Cambridge.syn
│    └── Cambridge.dict.dz    
└── Collins
     ├── metadata.toml
     ├── res.zip
     └── Collins.dsl       (B)