Skip to content

Commit 376e29c

Browse files
iliusilius
committed
update plugins doc: omit "Sort-on-write" and "Sort key" if it has no write support
1 parent e37c32b commit 376e29c

24 files changed

+35
-72
lines changed

Diff for: ‎doc/p/abc_medical_notes.md

-2
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,6 @@
1212
| Write support | No |
1313
| Single-file | Yes |
1414
| Kind | 🔢 binary |
15-
| Sort-on-write | No (by default) |
16-
| Sort key | (`headword_lower`) |
1715
| Wiki | ― |
1816
| Website | [Makindo.co.uk Comprehensive Medical Encyclopedia](https://www.makindo.co.uk/topics/_index.php) |
1917

Diff for: ‎doc/p/almaany.md

-2
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,6 @@
1212
| Write support | No |
1313
| Single-file | Yes |
1414
| Kind | 🔢 binary |
15-
| Sort-on-write | No (by default) |
16-
| Sort key | (`headword_lower`) |
1715
| Wiki | ― |
1816
| Website | [Almaany.com Arabic Dictionary - Google Play](https://play.google.com/store/apps/details?id=com.almaany.arar) |
1917

Diff for: ‎doc/p/appledict_bin.md

-2
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,6 @@
1212
| Write support | No |
1313
| Single-file | Yes |
1414
| Kind | 🔢 binary |
15-
| Sort-on-write | No (by default) |
16-
| Sort key | (`headword_lower`) |
1715
| Wiki | ― |
1816
| Website | [Dictionary User Guide for Mac](https://support.apple.com/en-gu/guide/dictionary/welcome/mac) |
1917

Diff for: ‎doc/p/babylon_bgl.md

+12-14
Original file line numberDiff line numberDiff line change
@@ -2,20 +2,18 @@
22

33
### General Information
44

5-
| Attribute | Value |
6-
| --------------- | ------------------ |
7-
| Name | BabylonBgl |
8-
| snake_case_name | babylon_bgl |
9-
| Description | Babylon (.BGL) |
10-
| Extensions | `.bgl` |
11-
| Read support | Yes |
12-
| Write support | No |
13-
| Single-file | Yes |
14-
| Kind | 🔢 binary |
15-
| Sort-on-write | No (by default) |
16-
| Sort key | (`headword_lower`) |
17-
| Wiki | ― |
18-
| Website | ― |
5+
| Attribute | Value |
6+
| --------------- | -------------- |
7+
| Name | BabylonBgl |
8+
| snake_case_name | babylon_bgl |
9+
| Description | Babylon (.BGL) |
10+
| Extensions | `.bgl` |
11+
| Read support | Yes |
12+
| Write support | No |
13+
| Single-file | Yes |
14+
| Kind | 🔢 binary |
15+
| Wiki | ― |
16+
| Website | ― |
1917

2018
### Read options
2119

Diff for: ‎doc/p/cc_kedict.md

-2
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,6 @@
1212
| Write support | No |
1313
| Single-file | Yes |
1414
| Kind | 📝 text |
15-
| Sort-on-write | No (by default) |
16-
| Sort key | (`headword_lower`) |
1715
| Wiki | ― |
1816
| Website | [@mhagiwara/cc-kedict](https://github.com/mhagiwara/cc-kedict) |
1917

Diff for: ‎doc/p/dict_cc.md

-2
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,6 @@
1212
| Write support | No |
1313
| Single-file | Yes |
1414
| Kind | 🔢 binary |
15-
| Sort-on-write | No (by default) |
16-
| Sort key | (`headword_lower`) |
1715
| Wiki | [Dict.cc](https://en.wikipedia.org/wiki/Dict.cc) |
1816
| Website | [dict.cc dictionary - Google Play](https://play.google.com/store/apps/details?id=cc.dict.dictcc) |
1917

Diff for: ‎doc/p/dict_cc_split.md

-2
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,6 @@
1212
| Write support | No |
1313
| Single-file | Yes |
1414
| Kind | 🔢 binary |
15-
| Sort-on-write | No (by default) |
16-
| Sort key | (`headword_lower`) |
1715
| Wiki | [Dict.cc](https://en.wikipedia.org/wiki/Dict.cc) |
1816
| Website | [dict.cc dictionary - Google Play](https://play.google.com/store/apps/details?id=cc.dict.dictcc) |
1917

Diff for: ‎doc/p/dictunformat.md

-2
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,6 @@
1212
| Write support | No |
1313
| Single-file | Yes |
1414
| Kind | 📝 text |
15-
| Sort-on-write | No (by default) |
16-
| Sort key | (`headword_lower`) |
1715
| Wiki | [Dictd](https://directory.fsf.org/wiki/Dictd) |
1816
| Website | [dictd/dictunformat.1.in - @cheusov/dictd](https://github.com/cheusov/dictd/blob/master/dictunformat.1.in) |
1917

Diff for: ‎doc/p/digitalnk.md

-2
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,6 @@
1212
| Write support | No |
1313
| Single-file | Yes |
1414
| Kind | 🔢 binary |
15-
| Sort-on-write | No (by default) |
16-
| Sort key | (`headword_lower`) |
1715
| Wiki | ― |
1816
| Website | [@digitalprk/dicrs](https://github.com/digitalprk/dicrs) |
1917

Diff for: ‎doc/p/dsl.md

-2
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,6 @@
1212
| Write support | No |
1313
| Single-file | Yes |
1414
| Kind | 📝 text |
15-
| Sort-on-write | No (by default) |
16-
| Sort key | (`headword_lower`) |
1715
| Wiki | [ABBYY Lingvo](https://ru.wikipedia.org/wiki/ABBYY_Lingvo) |
1816
| Website | [www.lingvo.ru](https://www.lingvo.ru/) |
1917

Diff for: ‎doc/p/edict2.md

-2
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,6 @@
1212
| Write support | No |
1313
| Single-file | Yes |
1414
| Kind | 📝 text |
15-
| Sort-on-write | No (by default) |
16-
| Sort key | (`headword_lower`) |
1715
| Wiki | [CEDICT](https://en.wikipedia.org/wiki/CEDICT) |
1816
| Website | ― |
1917

Diff for: ‎doc/p/freedict.md

-2
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,6 @@
1212
| Write support | No |
1313
| Single-file | Yes |
1414
| Kind | 📝 text |
15-
| Sort-on-write | No (by default) |
16-
| Sort key | (`headword_lower`) |
1715
| Wiki | [@freedict/fd-dictionaries/wiki](https://github.com/freedict/fd-dictionaries/wiki) |
1816
| Website | [FreeDict.org](https://freedict.org/) |
1917

Diff for: ‎doc/p/jmdict.md

-2
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,6 @@
1212
| Write support | No |
1313
| Single-file | Yes |
1414
| Kind | 📝 text |
15-
| Sort-on-write | No (by default) |
16-
| Sort key | (`headword_lower`) |
1715
| Wiki | [JMdict](https://en.wikipedia.org/wiki/JMdict) |
1816
| Website | [The JMDict Project](https://www.edrdg.org/jmdict/j_jmdict.html) |
1917

Diff for: ‎doc/p/jmnedict.md

-2
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,6 @@
1212
| Write support | No |
1313
| Single-file | Yes |
1414
| Kind | 📝 text |
15-
| Sort-on-write | No (by default) |
16-
| Sort key | (`headword_lower`) |
1715
| Wiki | [JMdict](https://en.wikipedia.org/wiki/JMdict) |
1816
| Website | [EDRDG Wiki](https://www.edrdg.org/wiki/index.php/Main_Page) |
1917

Diff for: ‎doc/p/octopus_mdict.md

-2
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,6 @@
1212
| Write support | No |
1313
| Single-file | No |
1414
| Kind | 🔢 binary |
15-
| Sort-on-write | No (by default) |
16-
| Sort key | (`headword_lower`) |
1715
| Wiki | ― |
1816
| Website | [Download - MDict.cn](https://www.mdict.cn/wp/?page_id=5325&lang=en) |
1917

Diff for: ‎doc/p/wiktextract.md

-2
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,6 @@
1212
| Write support | No |
1313
| Single-file | Yes |
1414
| Kind | 📝 text |
15-
| Sort-on-write | No (by default) |
16-
| Sort key | (`headword_lower`) |
1715
| Wiki | ― |
1816
| Website | [@tatuylonen/wiktextract](https://github.com/tatuylonen/wiktextract) |
1917

Diff for: ‎doc/p/wordnet.md

-2
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,5 @@
1212
| Write support | No |
1313
| Single-file | No |
1414
| Kind | 📁 directory |
15-
| Sort-on-write | No (by default) |
16-
| Sort key | (`headword_lower`) |
1715
| Wiki | [WordNet](https://en.wikipedia.org/wiki/WordNet) |
1816
| Website | [WordNet - A Lexical Database for English](https://wordnet.princeton.edu/) |

Diff for: ‎doc/p/wordset.md

-2
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,6 @@
1212
| Write support | No |
1313
| Single-file | No |
1414
| Kind | 📁 directory |
15-
| Sort-on-write | No (by default) |
16-
| Sort key | (`headword_lower`) |
1715
| Wiki | ― |
1816
| Website | [@wordset/wordset-dictionary](https://github.com/wordset/wordset-dictionary) |
1917

Diff for: ‎doc/p/xdxf.md

-2
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,6 @@
1212
| Write support | No |
1313
| Single-file | Yes |
1414
| Kind | 📝 text |
15-
| Sort-on-write | No (by default) |
16-
| Sort key | (`headword_lower`) |
1715
| Wiki | [XDXF](https://en.wikipedia.org/wiki/XDXF) |
1816
| Website | [XDXF standard - @soshial/xdxf_makedict](https://github.com/soshial/xdxf_makedict/tree/master/format_standard) |
1917

Diff for: ‎doc/p/xdxf_css.md

-2
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,6 @@
1212
| Write support | No |
1313
| Single-file | Yes |
1414
| Kind | 📝 text |
15-
| Sort-on-write | No (by default) |
16-
| Sort key | (`headword_lower`) |
1715
| Wiki | [XDXF](https://en.wikipedia.org/wiki/XDXF) |
1816
| Website | [XDXF standard - @soshial/xdxf_makedict](https://github.com/soshial/xdxf_makedict/tree/master/format_standard) |
1917

Diff for: ‎doc/p/xdxf_lax.md

-2
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,6 @@
1212
| Write support | No |
1313
| Single-file | Yes |
1414
| Kind | 📝 text |
15-
| Sort-on-write | No (by default) |
16-
| Sort key | (`headword_lower`) |
1715
| Wiki | [XDXF](https://en.wikipedia.org/wiki/XDXF) |
1816
| Website | [XDXF standard - @soshial/xdxf_makedict](https://github.com/soshial/xdxf_makedict/tree/master/format_standard) |
1917

Diff for: ‎doc/p/zim.md

-2
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,6 @@
1212
| Write support | No |
1313
| Single-file | Yes |
1414
| Kind | 🔢 binary |
15-
| Sort-on-write | No (by default) |
16-
| Sort key | (`headword_lower`) |
1715
| Wiki | [ZIM (file format)](<https://en.wikipedia.org/wiki/ZIM_(file_format)>) |
1816
| Website | [OpenZIM](https://wiki.openzim.org/wiki/OpenZIM) |
1917

Diff for: ‎scripts/gen.sh

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ set -e
44
myDir1=$(dirname "$0")
55

66
# to handle rename of a plugin:
7-
rm $myDir1/../doc/p/*.md
7+
rm $myDir1/../doc/p/*.md || true
88

99
set -x
1010

Diff for: ‎scripts/plugin-doc.py

+22-15
Original file line numberDiff line numberDiff line change
@@ -254,23 +254,30 @@ def getToolSourceLink(tool):
254254
tool.update({"name": toolName})
255255
tools = tools_toml.values()
256256

257-
generalInfoTable = "### General Information\n\n" + renderTable(
258-
[
259-
("Attribute", "Value"),
260-
("Name", p.name),
261-
("snake_case_name", p.lname),
262-
("Description", p.description),
263-
("Extensions", ", ".join([codeValue(ext) for ext in p.extensions])),
264-
("Read support", yesNo(p.canRead)),
265-
("Write support", yesNo(p.canWrite)),
266-
("Single-file", yesNo(p.singleFile)),
267-
("Kind", f"{kindEmoji(module.kind)} {module.kind}"),
257+
table = [
258+
("Attribute", "Value"),
259+
("Name", p.name),
260+
("snake_case_name", p.lname),
261+
("Description", p.description),
262+
("Extensions", ", ".join([codeValue(ext) for ext in p.extensions])),
263+
("Read support", yesNo(p.canRead)),
264+
("Write support", yesNo(p.canWrite)),
265+
("Single-file", yesNo(p.singleFile)),
266+
("Kind", f"{kindEmoji(module.kind)} {module.kind}"),
267+
]
268+
269+
if p.canWrite:
270+
table += [
268271
("Sort-on-write", p.sortOnWrite.desc),
269272
("Sort key", sortKeyName(p)),
270-
("Wiki", wiki_md),
271-
("Website", website_md),
272-
],
273-
)
273+
]
274+
275+
table += [
276+
("Wiki", wiki_md),
277+
("Website", website_md),
278+
]
279+
280+
generalInfoTable = "### General Information\n\n" + renderTable(table)
274281
topTables = generalInfoTable
275282

276283
try:

0 commit comments

Comments
 (0)