Skip to content

Commit

Permalink
readme: square notation instructions, example output updated
Browse files Browse the repository at this point in the history
  • Loading branch information
igneus committed Oct 20, 2024
1 parent e8fd1ae commit 91776d9
Show file tree
Hide file tree
Showing 4 changed files with 73 additions and 2 deletions.
39 changes: 37 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -76,12 +76,47 @@ It's suggested to include one of them either in the global
}
```

It's necessary to add the lilygabc root directory to LilyPond
When engraving the document
it's necessary to add the lilygabc root directory to LilyPond
include paths:

`$ lilypond --include=path/to/lilygabc my_document.ly`

[![Example output](/doc/example.png)](/doc/example.ly)
[![Example output: modern notation](/doc/example.png)](/doc/example.ly)

In order to render gabc scores in square notation,
use commands `\gabc-vaticana` and `\gabc-vaticana-file`.

Note that in this case you have to `\include "gregorian.ly"`
in addition to lilygabc.
(lilygabc doesn't include `gregorian.ly` by default
and leaves it to the user, because `gregorian.ly` changes
global settings quite recklessly and the user should be in
control over *if* and *when* these changes are applied.)

```lilypond
% If the \lilygabcVaticanaLayout layout variable is used,
% it's important to include gregorian.ly *before* lilygabc
\include "gregorian.ly"
\include "lilygabc.ily"
\score {
\gabc-vaticana
"(c4) Ju(e)bi(f)lá(g')te(f) De(d_f)o(f'_) (,)
o(f)mnis(f) ter(e_f)ra,(d) al(f)le(fg)lú(e.)ia.(e.) (::)
E(h) u(g) o(h) u(ih) a(gf) e.(e.) (::)"
\layout {
\lilygabcVaticanaLayout
}
}
```

[![Example output: square notation](/doc/vaticana-example.png)](/doc/vaticana-example.ly)

(The square notation support in lilygabc is still very much a work
in progress, limits of what LilyPond can do haven't been reached yet.)

## Running tests

Expand Down
Binary file modified doc/example.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
36 changes: 36 additions & 0 deletions doc/vaticana-example.ly
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
\version "2.24.1"

\header {
tagline = #f
}

\paper {
% TODO: font settings have no effect in VaticanaLyrics and I've no idea why
#(define fonts
(make-pango-font-tree
"Linux Libertine O"
"VL Gothic"
"Courier"
1))

top-margin = 1.5\cm
left-margin = 1\mm
right-margin = 1\mm
}

\include "gregorian.ly"
\include "../lilygabc.ily"

% https://gregobase.selapa.net/chant.php?id=13305
\score {
\gabc-vaticana
"(c4) Ju(e)bi(f)lá(g')te(f) De(d_f)o(f'_) (,)
o(f)mnis(f) ter(e_f)ra,(d) al(f)le(fg)lú(e.)ia.(e.) (::)
E(h) u(g) o(h) u(ih) a(gf) e.(e.) (::)"
\layout {
\lilygabcVaticanaLayout
}
\header {
piece = "Ant. VIII G"
}
}
Binary file added doc/vaticana-example.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 91776d9

Please sign in to comment.