readme.md

A Lexicanum-based dictionary for Kindles.
· Report Bug · Request Feature

Table of Contents

• Table of Contents
• About The Project
• Downloading / Installing
• Local build
  • Prerequisites
  • Installation
• Roadmap
• Contributing
• License
• Acknowledgments

About The Project

This project is a dictionary for the Warhammer 40k universe, based on the Lexicanum website. It is intended to be used on Kindles, but can be used on any device that supports MOBI files.

The dictionary is automatically generated after parsing and filtering a dump of allpages of the Lexicanum website. The dictionary is then converted into a MOBI file using Amazon's kindlegen.exe tool.

It offers support for inflections, based on redirects of a page. For example, the page "Neverborn" redirects to "Daemon". By highlighting either word, one would be able to see the same definition.

You can also join the discord to keep up with updates and changes

(back to top)

Downloading / Installing

In order to obtain the latest version of the dictionary, you can download the latest release here.

Connect your kindle via USB, open the documents folder and paste the MOBI file into the dictionaries folder. It should be available for use after that.

If you already have an older version and wish to update, simply delete the old MOBI file and paste the new one in its place. Then restart your Kindle.

Note that, the pre-releases are always the latest version of the dictionary, but may not be stable and can also have bigger filesizes due to no compression.

(back to top)

Local build

Prerequisites

• cargo

  cargo install

Installation

1. Clone the repo

   git clone https://github.com/JCalebBR/LectitioLexicanus.git

2. Run cargo run --release to obtain the latest version of the Lexicanum Dump. This will create a file called filtered-output.jsonl which will be used to create the dictionary. This will create a file called content.html in the dict directory, which will be the contents of the dictionary.

   Note that this will take approximately 5 minutes

   cargo run --release

3. Run kindlegen.exe to create the MOBI file. This will create a file called dict.mobi in the dict directory, which will be the dictionary.

   kindlegen.exe dict/dict.opf -c2 -verbose -dont_append_source

(back to top)

Roadmap

• Reduce number of entries by associating entries with a parent entry. For example, "Theron (Planet)" and "Theron (Squad)" could be associated with "Theron (Ultramarines)".
• Add better formatting to the dictionary entries.

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the GNU GPLv3. See LICENSE.txt for more information.

(back to top)

Acknowledgments

• Lexicanum - For hosting their wiki and making such a project possible
• Jake McCrary - For his insightful documentation on creating a Kindle dictionary.
• Games Workshop and The Black Library - For creating the Warhammer 40k universe.

(back to top)