goldendict-ng/website/docs/custom_dictionary.md
shenleban tongying ccf70cdfb6
Some checks failed
SonarCloud / Build and analyze (push) Waiting to run
deploy_website / deploy (push) Has been cancelled
doc: various updates
2024-11-13 23:05:40 -05:00

1.4 KiB

A metadata.toml, which uses toml format, can be used to customize or override some properties of a certain dictionary. It is also used in auto grouping by metadata

The metadata.toml should be placed on each dictionary's root folder (beside dictionary files) like

.
├── Cambridge
│    ├── metadata.toml < here
│    ├── Cambridge.idx
│    ├── Cambridge.info
│    ├── Cambridge.syn
│    └── Cambridge.dict.dz    
└── Collins
     ├── metadata.toml < here
     ├── res.zip
     └── Collins.dsl 

Override display name

Some dictionary formats' display is embedded inside the dictionary, which cannot be easily changed, but you can add the following to override it.

[metadata]
name = "New Name"

This New Name will be appeared as the dictionary name.

fts=false

[metadata]
name="New Name"

The fts field's value can be on/off, 1/0 ,true/false etc.

fts=false

will disable the current dictionary's full-text search.

You can check the full-text search status on each dictionary's info dialog.

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.