Skip to content

Commit

Permalink
update plugins doc: omit "Sort-on-write" and "Sort key" if it has no …
Browse files Browse the repository at this point in the history 
…write support
  • Loading branch information
@ilius
ilius committed Dec 28, 2024
1 parent e37c32b commit 376e29c
Show file tree
Hide file tree
Showing 24 changed files with 35 additions and 72 deletions.
2 changes: 0 additions & 2 deletions doc/p/abc_medical_notes.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,6 @@
| Write support | No |
| Single-file | Yes |
| Kind | 🔢 binary |
| Sort-on-write | No (by default) |
| Sort key | (`headword_lower`) |
| Wiki | ― |
| Website | [Makindo.co.uk Comprehensive Medical Encyclopedia](https://www.makindo.co.uk/topics/_index.php) |

Expand Down
2 changes: 0 additions & 2 deletions doc/p/almaany.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,6 @@
| Write support | No |
| Single-file | Yes |
| Kind | 🔢 binary |
| Sort-on-write | No (by default) |
| Sort key | (`headword_lower`) |
| Wiki | ― |
| Website | [Almaany.com Arabic Dictionary - Google Play](https://play.google.com/store/apps/details?id=com.almaany.arar) |

Expand Down
2 changes: 0 additions & 2 deletions doc/p/appledict_bin.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,6 @@
| Write support | No |
| Single-file | Yes |
| Kind | 🔢 binary |
| Sort-on-write | No (by default) |
| Sort key | (`headword_lower`) |
| Wiki | ― |
| Website | [Dictionary User Guide for Mac](https://support.apple.com/en-gu/guide/dictionary/welcome/mac) |

Expand Down
26 changes: 12 additions & 14 deletions doc/p/babylon_bgl.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,20 +2,18 @@

### General Information

| Attribute | Value |
| --------------- | ------------------ |
| Name | BabylonBgl |
| snake_case_name | babylon_bgl |
| Description | Babylon (.BGL) |
| Extensions | `.bgl` |
| Read support | Yes |
| Write support | No |
| Single-file | Yes |
| Kind | 🔢 binary |
| Sort-on-write | No (by default) |
| Sort key | (`headword_lower`) |
| Wiki | ― |
| Website | ― |
| Attribute | Value |
| --------------- | -------------- |
| Name | BabylonBgl |
| snake_case_name | babylon_bgl |
| Description | Babylon (.BGL) |
| Extensions | `.bgl` |
| Read support | Yes |
| Write support | No |
| Single-file | Yes |
| Kind | 🔢 binary |
| Wiki | ― |
| Website | ― |

### Read options

Expand Down
2 changes: 0 additions & 2 deletions doc/p/cc_kedict.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,6 @@
| Write support | No |
| Single-file | Yes |
| Kind | 📝 text |
| Sort-on-write | No (by default) |
| Sort key | (`headword_lower`) |
| Wiki | ― |
| Website | [@mhagiwara/cc-kedict](https://github.com/mhagiwara/cc-kedict) |

Expand Down
2 changes: 0 additions & 2 deletions doc/p/dict_cc.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,6 @@
| Write support | No |
| Single-file | Yes |
| Kind | 🔢 binary |
| Sort-on-write | No (by default) |
| Sort key | (`headword_lower`) |
| Wiki | [Dict.cc](https://en.wikipedia.org/wiki/Dict.cc) |
| Website | [dict.cc dictionary - Google Play](https://play.google.com/store/apps/details?id=cc.dict.dictcc) |

Expand Down
2 changes: 0 additions & 2 deletions doc/p/dict_cc_split.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,6 @@
| Write support | No |
| Single-file | Yes |
| Kind | 🔢 binary |
| Sort-on-write | No (by default) |
| Sort key | (`headword_lower`) |
| Wiki | [Dict.cc](https://en.wikipedia.org/wiki/Dict.cc) |
| Website | [dict.cc dictionary - Google Play](https://play.google.com/store/apps/details?id=cc.dict.dictcc) |

Expand Down
2 changes: 0 additions & 2 deletions doc/p/dictunformat.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,6 @@
| Write support | No |
| Single-file | Yes |
| Kind | 📝 text |
| Sort-on-write | No (by default) |
| Sort key | (`headword_lower`) |
| Wiki | [Dictd](https://directory.fsf.org/wiki/Dictd) |
| Website | [dictd/dictunformat.1.in - @cheusov/dictd](https://github.com/cheusov/dictd/blob/master/dictunformat.1.in) |

Expand Down
2 changes: 0 additions & 2 deletions doc/p/digitalnk.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,6 @@
| Write support | No |
| Single-file | Yes |
| Kind | 🔢 binary |
| Sort-on-write | No (by default) |
| Sort key | (`headword_lower`) |
| Wiki | ― |
| Website | [@digitalprk/dicrs](https://github.com/digitalprk/dicrs) |

Expand Down
2 changes: 0 additions & 2 deletions doc/p/dsl.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,6 @@
| Write support | No |
| Single-file | Yes |
| Kind | 📝 text |
| Sort-on-write | No (by default) |
| Sort key | (`headword_lower`) |
| Wiki | [ABBYY Lingvo](https://ru.wikipedia.org/wiki/ABBYY_Lingvo) |
| Website | [www.lingvo.ru](https://www.lingvo.ru/) |

Expand Down
2 changes: 0 additions & 2 deletions doc/p/edict2.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,6 @@
| Write support | No |
| Single-file | Yes |
| Kind | 📝 text |
| Sort-on-write | No (by default) |
| Sort key | (`headword_lower`) |
| Wiki | [CEDICT](https://en.wikipedia.org/wiki/CEDICT) |
| Website | ― |

Expand Down
2 changes: 0 additions & 2 deletions doc/p/freedict.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,6 @@
| Write support | No |
| Single-file | Yes |
| Kind | 📝 text |
| Sort-on-write | No (by default) |
| Sort key | (`headword_lower`) |
| Wiki | [@freedict/fd-dictionaries/wiki](https://github.com/freedict/fd-dictionaries/wiki) |
| Website | [FreeDict.org](https://freedict.org/) |

Expand Down
2 changes: 0 additions & 2 deletions doc/p/jmdict.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,6 @@
| Write support | No |
| Single-file | Yes |
| Kind | 📝 text |
| Sort-on-write | No (by default) |
| Sort key | (`headword_lower`) |
| Wiki | [JMdict](https://en.wikipedia.org/wiki/JMdict) |
| Website | [The JMDict Project](https://www.edrdg.org/jmdict/j_jmdict.html) |

Expand Down
2 changes: 0 additions & 2 deletions doc/p/jmnedict.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,6 @@
| Write support | No |
| Single-file | Yes |
| Kind | 📝 text |
| Sort-on-write | No (by default) |
| Sort key | (`headword_lower`) |
| Wiki | [JMdict](https://en.wikipedia.org/wiki/JMdict) |
| Website | [EDRDG Wiki](https://www.edrdg.org/wiki/index.php/Main_Page) |

Expand Down
2 changes: 0 additions & 2 deletions doc/p/octopus_mdict.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,6 @@
| Write support | No |
| Single-file | No |
| Kind | 🔢 binary |
| Sort-on-write | No (by default) |
| Sort key | (`headword_lower`) |
| Wiki | ― |
| Website | [Download - MDict.cn](https://www.mdict.cn/wp/?page_id=5325&lang=en) |

Expand Down
2 changes: 0 additions & 2 deletions doc/p/wiktextract.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,6 @@
| Write support | No |
| Single-file | Yes |
| Kind | 📝 text |
| Sort-on-write | No (by default) |
| Sort key | (`headword_lower`) |
| Wiki | ― |
| Website | [@tatuylonen/wiktextract](https://github.com/tatuylonen/wiktextract) |

Expand Down
2 changes: 0 additions & 2 deletions doc/p/wordnet.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,5 @@
| Write support | No |
| Single-file | No |
| Kind | 📁 directory |
| Sort-on-write | No (by default) |
| Sort key | (`headword_lower`) |
| Wiki | [WordNet](https://en.wikipedia.org/wiki/WordNet) |
| Website | [WordNet - A Lexical Database for English](https://wordnet.princeton.edu/) |
2 changes: 0 additions & 2 deletions doc/p/wordset.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,6 @@
| Write support | No |
| Single-file | No |
| Kind | 📁 directory |
| Sort-on-write | No (by default) |
| Sort key | (`headword_lower`) |
| Wiki | ― |
| Website | [@wordset/wordset-dictionary](https://github.com/wordset/wordset-dictionary) |

Expand Down
2 changes: 0 additions & 2 deletions doc/p/xdxf.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,6 @@
| Write support | No |
| Single-file | Yes |
| Kind | 📝 text |
| Sort-on-write | No (by default) |
| Sort key | (`headword_lower`) |
| Wiki | [XDXF](https://en.wikipedia.org/wiki/XDXF) |
| Website | [XDXF standard - @soshial/xdxf_makedict](https://github.com/soshial/xdxf_makedict/tree/master/format_standard) |

Expand Down
2 changes: 0 additions & 2 deletions doc/p/xdxf_css.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,6 @@
| Write support | No |
| Single-file | Yes |
| Kind | 📝 text |
| Sort-on-write | No (by default) |
| Sort key | (`headword_lower`) |
| Wiki | [XDXF](https://en.wikipedia.org/wiki/XDXF) |
| Website | [XDXF standard - @soshial/xdxf_makedict](https://github.com/soshial/xdxf_makedict/tree/master/format_standard) |

Expand Down
2 changes: 0 additions & 2 deletions doc/p/xdxf_lax.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,6 @@
| Write support | No |
| Single-file | Yes |
| Kind | 📝 text |
| Sort-on-write | No (by default) |
| Sort key | (`headword_lower`) |
| Wiki | [XDXF](https://en.wikipedia.org/wiki/XDXF) |
| Website | [XDXF standard - @soshial/xdxf_makedict](https://github.com/soshial/xdxf_makedict/tree/master/format_standard) |

Expand Down
2 changes: 0 additions & 2 deletions doc/p/zim.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,6 @@
| Write support | No |
| Single-file | Yes |
| Kind | 🔢 binary |
| Sort-on-write | No (by default) |
| Sort key | (`headword_lower`) |
| Wiki | [ZIM (file format)](<https://en.wikipedia.org/wiki/ZIM_(file_format)>) |
| Website | [OpenZIM](https://wiki.openzim.org/wiki/OpenZIM) |

Expand Down
2 changes: 1 addition & 1 deletion scripts/gen.sh
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ set -e
myDir1=$(dirname "$0")

# to handle rename of a plugin:
rm $myDir1/../doc/p/*.md
rm $myDir1/../doc/p/*.md || true

set -x

Expand Down
37 changes: 22 additions & 15 deletions scripts/plugin-doc.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -254,23 +254,30 @@ def getToolSourceLink(tool):
tool.update({"name": toolName})
tools = tools_toml.values()

generalInfoTable = "### General Information\n\n" + renderTable(
[
("Attribute", "Value"),
("Name", p.name),
("snake_case_name", p.lname),
("Description", p.description),
("Extensions", ", ".join([codeValue(ext) for ext in p.extensions])),
("Read support", yesNo(p.canRead)),
("Write support", yesNo(p.canWrite)),
("Single-file", yesNo(p.singleFile)),
("Kind", f"{kindEmoji(module.kind)} {module.kind}"),
table = [
("Attribute", "Value"),
("Name", p.name),
("snake_case_name", p.lname),
("Description", p.description),
("Extensions", ", ".join([codeValue(ext) for ext in p.extensions])),
("Read support", yesNo(p.canRead)),
("Write support", yesNo(p.canWrite)),
("Single-file", yesNo(p.singleFile)),
("Kind", f"{kindEmoji(module.kind)} {module.kind}"),
]

if p.canWrite:
table += [
("Sort-on-write", p.sortOnWrite.desc),
("Sort key", sortKeyName(p)),
("Wiki", wiki_md),
("Website", website_md),
],
)
]

table += [
("Wiki", wiki_md),
("Website", website_md),
]

generalInfoTable = "### General Information\n\n" + renderTable(table)
topTables = generalInfoTable

try:
Expand Down

0 comments on commit 376e29c

Please sign in to comment.