Skip to content

Commit

Permalink
docs: Added documentation for examples/bgl-convert
Browse files Browse the repository at this point in the history
  • Loading branch information
pgaskin committed Mar 23, 2020
1 parent f490dfc commit a84722e
Show file tree
Hide file tree
Showing 3 changed files with 30 additions and 1 deletion.
2 changes: 1 addition & 1 deletion docs/dicthtml/install.md
Expand Up @@ -52,6 +52,6 @@ In short:
- **Therefore:** The steps required to install custom dictionaries are now (note that these have already been incorporated into the instructions above, they are just here for convenience):
- Copy the dictzip and mark it read-only.
- Add it to ExtraLocales if it is not a built-in locale.
- Use the patch to replace `Extra: ` in libnickel with any other string (same length or shorter with a null byte at the end), but not containing anything in the Unicode whitespace class.
- Use the patch to replace `Extra: ` in libnickel with any other string (same length or shorter with a null byte at the end), but does not contain a space (` `).

See [#49](https://github.com/geek1011/kobopatch-patches/issues/49) for more information.
28 changes: 28 additions & 0 deletions docs/examples/bgl-convert.md
@@ -0,0 +1,28 @@
---
layout: default
title: bgl-convert
parent: examples
---

# bgl-convert
Converts Babylon BGL dictionaries into dictfiles for use with dictgen.

Paste the BGL text in the box below to convert it:

<iframe src="https://raw.githack.com/geek1011/dictutil/master/examples/bgl-convert/index.html" style="border: 1px solid #000; width: 100%; height: 600px;"></iframe>

Example BGL:

```
### metadata trimmed for brevity
### ...
headword
Definition with <b>html</b> tags.
headword1|variant1|variant2
The second definition. Blah
blah blah blah.
```
1 change: 1 addition & 0 deletions docs/index.md
Expand Up @@ -49,6 +49,7 @@ These are some tools which make use of dictutil to convert actual dictionaries.
- **[gotdict-convert](./examples/gotdict-convert):** Converts [github.com/wjdp/gotdict](https://github.com/wjdp/gotdict) to a dictfile.
- **[webster1913-convert](./examples/webster1913-convert):** Converts [Project Gutenberg's Webster's Unabridged Dictionary](http://www.gutenberg.org/ebooks/29765.txt.utf-8) to a dictfile.
- **[dictzip-decompile](./examples/dictzip-decompile):** An **experimental** tool to convert a dictzip into a dictfile.
- **[bgl-convert](./examples/bgl-convert):** A simple tool to convert Babylon BGL dictionaries to a dictfile.

## other

Expand Down

0 comments on commit a84722e

Please sign in to comment.