summaryrefslogtreecommitdiff
path: root/Build/source/texk/gregorio/gregorio-src/contrib/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'Build/source/texk/gregorio/gregorio-src/contrib/README.md')
-rw-r--r--Build/source/texk/gregorio/gregorio-src/contrib/README.md40
1 files changed, 36 insertions, 4 deletions
diff --git a/Build/source/texk/gregorio/gregorio-src/contrib/README.md b/Build/source/texk/gregorio/gregorio-src/contrib/README.md
index c4e43da23f9..4372f39c6b0 100644
--- a/Build/source/texk/gregorio/gregorio-src/contrib/README.md
+++ b/Build/source/texk/gregorio/gregorio-src/contrib/README.md
@@ -20,20 +20,52 @@ under Windows).
* click `Add` in the `Render Frames`
* select the file `900_gregorio.xml`
-After that you can insert a render frame using Gregorio, and simply
+After that you can insert a render frame using Gregorio, and simply
typing gabc (`right-click->edit sources`).
For more details see [the website](http://home.gna.org/gregorio/scribus).
+## Syllabation checker
+
+The scripts in this folder allow to check the syllabation of a gabc score against syllabation rules that you must provide.
+
+#### Dependencies
+
+The main script, `checkSyllabation.py` is in Python3, so you obviously need it. It uses the [pyphen](http://pyphen.org/) package. You will also need the hyphenation of the text language in the `libhyphen` format in order to run it.
+
+If you want liturgical Latin hyphenation rules, you can pick those from the [hyphen-la](https://github.com/gregorio-project/hyphen-la) project. They are available in `libhyphen` format on the [webpage](http://gregorio-project.github.io/hyphen-la/).
+
+#### Running the scripts
+
+Once you have the hyphenation rules in the `libhyphen` format, you can check one score by running
+
+```
+checkSyllabation.py -p path/to/file.dic my_file.gabc
+```
+
+where `path/to/file.dic` is the path to the hyphenation rules file (default is `hyph_la_liturgical.dic` in the current directory). You can also analyze all gabc scores of a directory (with subdirectories) by replacing `my_file.gabc` by the name of the directory. By default, the script analyzes the current directory. The script outputs the report to `stdout` on Unix systems, and to `check-syllabation.log` on Windows systems.
+
+You can see more options by running
+
+```
+checkSyllabation.py --help
+```
+
+#### Hyphenation problems
+
+If you encounter problems of hyphenation, meaning you disagree with the proposed hyphenation, please contact the author of the hyphenation rules you are using ([here](https://github.com/gregorio-project/hyphen-la/issues) for `hyphen-la` for example).
+
+If you encounter problems because the script got confused by a gabc construct you are using or has bugs not directly related to hyphenation, please report it on the [gregorio tracker](https://github.com/gregorio-project/gregorio/issues).
+
## Kde editors (Kate, Kedit)
-You can use `gabc.xml` for syntax highlighting in kate (and Kedit, etc.). To
+You can use `gabc.xml` for syntax highlighting in kate (and Kedit, etc.). To
install it, copy the file in `/usr/share/apps/katepart/syntax`. This path
may vary according to your distribution.
## Gnome editors (Gedit)
-You can use `gabc.lang` for syntax highlighting in GtkSourceView (Gedit, etc.). To
+You can use `gabc.lang` for syntax highlighting in GtkSourceView (Gedit, etc.). To
install it, copy the file in `/usr/share/gtksourceview-3.0/language-specs`. This path
may vary according to your distribution.
@@ -45,7 +77,7 @@ To use gregorio in [Emacs](https://www.gnu.org/software/emacs/), see [this scrip
To get gabc syntax highlighting in [Vim](http://www.vim.org/):
- * copy `gabc.vim` in `/usr/share/vim/vimcurrent/syntax`
+ * copy `gabc.vim` in `/usr/share/vim/vimcurrent/syntax`
* add the line `au BufNewFile,BufRead *.gabc setf gabc`
somewhere near lines of the same type (near line 100 for example) in
`/usr/share/vim/vimcurrent/filetype.vim`. This will autodetect the filetypes.