Updated the entire section regarding spell checking libraries (pyenchant, pyspellchecker and symspellpy).

worstje 2019-08-07 22:41:55 +02:00
parent 4e4298bbbb
commit 60f8cc7dc3

@ -43,7 +43,15 @@ https://www.riverbankcomputing.com/software/pyqt/download5
Download [lxml-3.4.4.win32-py3.4.exe](https://pypi.python.org/packages/dd/6e/f0ffb41406def64554a21997ea03861c5089006a070b9de3e12321b7ab38/lxml-3.4.4.win32-py3.4.exe#md5=f193aed07ee95bc5d4805d7167b14740) and run the installer accepting all defaults.
https://pypi.python.org/pypi/lxml/3.4.4/
### PyEnchant (Optional - spell checker)
### Spell checker libraries (Optional - provides spell checking functionality)
Why does Manuskript support so many of spell checker libraries, you might wonder. Simply put: they all have their pros and cons, and what is best for me may not be best for you.
You ideally want to install at least one to keep the typos at bay.
All of them exist as modules that are easily installed through `pip`, the python package manager.
This can be done as follows:
1. Open a command prompt as described earlier.
@ -52,19 +60,45 @@ https://pypi.python.org/pypi/lxml/3.4.4/
C:
cd \Python34\Scripts
3. Install PyEnchant using pip.
pip install pyenchant
At time of writing v1.6.8 was installed. You can specify this version with the `pip install pyenchant==1.6.8` command.
3. Install module(s) using pip. You can find the command for your chosen spellchecker(s) below.
4. Close command prompt.
At time of writing the following dictionaries were automatically installed with PyEnchant: `de_DE, en_AU, en_GB, en_US, and fr_FR`.
The spell checkers that manuskript supports are as follows:
- __PyEnchant__
_[PyEnchant](https://github.com/rfk/pyenchant) is perhaps the most traditional spellchecker in that it interacts with the Enchant library written by Dom Lachowicz. Unfortunately, PyEnchant is no longer maintained by anyone, and this causes a problem: it currently cannot be installed on 64-bit versions of Python._
Install it using: `pip install pyenchant`
At time of writing v1.6.8 was installed. You can specify this version with the `pip install pyenchant==1.6.8` command.
The following dictionaries were automatically installed with PyEnchant: `de_DE, en_AU, en_GB, en_US, and fr_FR`.
- __PySpellChecker__
_[PySpellChecker](https://pypi.org/project/pyspellchecker/) is a pure-Python implementation of a spell checker that uses the Levenshtein Distance algorithm. It should work on all systems and comes with dictionaries generated using the WordFrequency project for several popular languages. The drawback? It tends to be rather slow._
Install it using: `pip install pyspellchecker`
At time of writing v0.5.0 was installed. You can specify this version with the `pip install pyspellchecker==0.5.0` command.
It includes dictionaries for English, Spanish, German, French and Portuguese.
- __Symspellpy__
_[Symspellpy](https://pypi.org/project/symspellpy/) is a Python port of [SymSpell](https://github.com/wolfgarbe/SymSpell). Despite not being optimized for speed (according to the the project description), it is considerably faster than PySpellChecker when operating on the same dictionaries._
Install it using: `pip install symspellpy`
At time of writing v6.3.9 was installed. You can specify this version with the `pip install symspellpy==6.3.9` command.
It does not come with any dictionaries of its own, but if pyspellchecker is installed, manuskript will use those in conjunction with symspellpy.
### MarkDown (Optional - provides Manuskript export as HTML)
Use steps similar to those above to install _PyEnchant_.
Use steps similar to those above to install a spell checker.
- Install MarkDown using pip.
@ -115,7 +149,7 @@ At any time after you have cloned the source code, you can update your copy to t
Note that you can return to the master branch with the `git checkout master` command.
# EXCECUTION
# EXECUTION
## Run manuskript from Source Code