This is a test suite for Emender framework. It consists of two tests: Documentation Guidelines Test and Word Usage Test. One tests documentation against the existing guidelines, checks spelling etc. Another one checks for correct word usage in specific context. The tests generate the results in multiple formats and give you an extensive summary.
To run the test suite locally, follow these steps.
- Download the repository to your local machine. You don't need to have the test and documentation in the same folder. In fact, it's advisable not to.
- Download Emender framework here.
- Install Emender by navigating into the source code directory and running
sudo make install. - Download documentation files into a separate folder. This folder must either include a publican.cfg file with documentation config (DocBook format) or master.adoc (AsciiDoc format).
- Before running the tests, make sure to install these dependencies:
sudo dnf install aspell publican lua; gem install asciidoctor
- Run the script "generate_dictionary.sh" in the test folder. It will generate "aspell.txt" with the dictionary words.
- You're ready to run the test! Through command line navigate to the documentation folder (or the folder where you want to store the results). From this folder run the following command:
PATH_TO_TEST_DIR/run.sh --XdocDir=PATH_TO_DOC_DIR
Only provide "docDir" argument if the documentation folder is different from the folder you're currently in.
This will run a shell script that basically does all the dirty work before running the actual test. After running it you should see the test output on the screen, as well as a bunch of results.* files in the current folder. These files provide the results in various formats.
8. Add any extra parameters to Emender by using them as shell script arguments. Consult this page for more info.
9. Add extra parameters to the test itself by using them as shell script arguments. Use this construct to do so: --XparamName=paramValue
You can, for example, change "blacklistUrl", "whitelistUrl", "glossaryUrl" and "differentSpellingWordsUrl" in this manner: --XblacklistUrl=url
Author of "atomic_typos.txt" is Stephen Wadeley (thanks!).
documentation-conventions-tests is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; version 3 of the License.
documentation-conventions-tests is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.