| 1 |
Documentation for gregorio and gregoriotex |
| 2 |
========================================== |
| 3 |
|
| 4 |
This folder contains the source files of a manual is primarily intended for |
| 5 |
developers. Users should not expect to find an indepth guide on using gregorio. |
| 6 |
|
| 7 |
You can find a compiled PDF version in the files of each [Gregorio release](https://github.com/gregorio-project/gregorio/releases). |
| 8 |
|
| 9 |
Developers can use this manual as a reference for information on the |
| 10 |
internal workings of gregorio. |
| 11 |
|
| 12 |
## Building |
| 13 |
|
| 14 |
To compile the pdf you must have |
| 15 |
* an up-to-date [TeX Live](https://www.tug.org/texlive/) system, with at least the `luatex` bundle and `latexmk` |
| 16 |
* the [Linux Libertine](http://www.linuxlibertine.org/index.php?id=1&L=1) and [Inconsolata](http://www.levien.com/type/myfonts/inconsolata.html) fonts (distributed by TeX Live too) |
| 17 |
* the [`pygments` library](http://pygments.org/) |
| 18 |
|
| 19 |
Once you have run `./configure` in the main directory, run `make doc` in this directory. |
| 20 |
|
| 21 |
|
| 22 |
Developer notes on extending the gregall and grelaon fonts |
| 23 |
========================================================== |
| 24 |
|
| 25 |
The glyphs are drawn with cropped pictures of the neumes |
| 26 |
from the manuscripts. The gregall glyphs are coming from |
| 27 |
multiple manuscripts with different neume sizes and furthermore |
| 28 |
in some manuscripts like Einsiedeln codex 121 even the sizes of |
| 29 |
neumes varies between different folios and often even on the same |
| 30 |
folio. Therefore, when loading the images as background images |
| 31 |
in fontforge (version used so far is 20120731), they need to be |
| 32 |
scaled accordingly. The easiest way is to measure the height in |
| 33 |
pixels of a clivis with episema (cl-) neume from the highest to |
| 34 |
the lowest extreme and divide by 42.0 pixels which is corresponding |
| 35 |
height of the original cl- background picture. The result is the |
| 36 |
scale factor listed in GregiorioNabcRef.tex. After loading the |
| 37 |
background image, the background layer in fontforge should be scaled |
| 38 |
(same in both axis) by the height of the glyph image in pixels |
| 39 |
divided by the scale factor computed above and divided by 52.0 (the |
| 40 |
pixel height of the cl- background picture). The cl- background |
| 41 |
picture in the gregall font had the height of 1000 fontforge units. |
| 42 |
The grelaon font has as a source only a single manuscript with |
| 43 |
approximately comparable neume sizes everywhere, so if using as the |
| 44 |
source images with heights around 3500-3600 pixels, the scale factor |
| 45 |
is just 1 and height 52 pixels should correspond to 1000 fontforge |
| 46 |
units. Each neume should be named in fontforge with the corresponding |
| 47 |
nabc string, with - replaced by N, > replaced by B, ! replaced by E |
| 48 |
and ~ replaced by T. After adding any glyph, GregorioNabcRef.tex |
| 49 |
should be updated to list the source of the neume and if the corresponding |
| 50 |
gregorian piece is not listed yet, also update list of them, if possible |
| 51 |
with a reference to Graduale Triplex, Antiphonale Monasticum, |
| 52 |
Nocturnale Romanum etc. book pages where the gregorian piece can be |
| 53 |
found. |