Index: README.txt ================================================================== --- README.txt +++ README.txt @@ -10,7 +10,5 @@ License: GPL 3 -- http://www.gnu.org/copyleft/gpl.html Grammalecte is a fork of Lightproof from László Németh (nemeth /at/ numbertext /dot/ org) http://cgit.freedesktop.org/libreoffice/lightproof/ - -Required : Python 3.6 Index: doc/build.txt ================================================================== --- doc/build.txt +++ doc/build.txt @@ -0,0 +1,72 @@ + +BUILDER + += Required = + + Python 3.6 + Firefox Nightly + NodeJS + npm + jpm + Thunderbird + + += Commands = + +== build a language == + + make.py LANG + generate the LibreOffice extension and the package folder. + LANG is the lang code (ISO 639). + + This script uses the file `config.ini` in the folder `gc_lang/LANG`. + +== First build == + + Type: + make.py LANG -b -d -js + + This command is required to generate all necessary files. + +== options == + + -b --build_data + Launch the script `build_data.py` in the folder `gc_lang/LANG`. + + -d --dict + Generate the indexable binary dictionary from the lexicon in the folder `lexicons`. + + -js --javascript + Also generate JavaScript extensions. + Without this option only Python modules, data and extensions are generated. + + -t --tests + Run unit tests. + + -i --install + Install the LibreOffice extension. + + -fx --firefox + Launch Firefox Nightly. + Unit tests can be lanched from Firefox, with CTRL+SHIFT+F12. + + -tb --thunderbird + Launch Thunderbird. + + += Examples = + + First build: + make.py LANG -b -d -js + + After modifying grammar rules: + make.py LANG -t + + If you modify the lexicon: + make.py LANG -d -js + + If you modify your script build_data.py: + make.py LANG -b -js + + + DELETED doc/options.txt Index: doc/options.txt ================================================================== --- doc/options.txt +++ /dev/null @@ -1,53 +0,0 @@ -# 1. Copy this template to the data folder. -# -# 2. Define your group ids and option ids and the localized title -# texts (see later for the syntax). -# -# Syntax of the dialog data file: -# -# Options and title texts for the Settings and conditional rules -# -# Format of the dialog definition: -# -# GroupID: OptionID [OptionsInTheSameLines_or_hyphen_placeholder], OptionID ... -# Group2ID: OptionID, OptionID ... -# ... -# [Language_code=title of the window] -# GroupID=title of the group -# OptionID=title of the option [\n tooltip] -# Option2ID=title of the option [\n tooltip] -# -# The first language is the default language for the other locales -# (use en_US or the common language of your country) -# -# The OptionIDs are used in the rules, too. For example: -# -# foo <<- option("style") ->> bar # bar is far better -# -# or -# -# __[i]/style__ foo <<- ->> bar # bar is far better -# -# these rule depends from the state of the "style" option. - -# options - -spelling: comma, hyphen -proofreading: style, moregrammar - -# titles - -[en_US=Hungarian grammar checking] - -spelling=Spelling -comma=Comma usage -hyphen=Check compound words with hyphen -proofreading=Proofreading -style=Style checking -moregrammar=Use grammar rules with ambiguous word analysis - -[yourlocale=yourtitle] - -spelling=... -wordpart=... -...