Git Product home page Git Product logo

vhv-documentation's People

Contributors

alexandermorgan avatar craigsapp avatar davidrizo avatar mkonik avatar wolfgangdrescher avatar

Stargazers

 avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar

vhv-documentation's Issues

Mensural accidental not shown in vhv

Hi Craig,

I want to inform you that the accidentals are not shown on the web page. You can see this in this screenshot taken on 06. April directly from the homepage.
grafik
This issue can also be found in the editor. No accidentals are shown in '**mens'-files.

Maybe you can fix this issue.

Thank you in advance.

Kind regards
Olaf

Documentation about spine ordering

When a voice is split into two spines, the ordering does not follow the same principle used for staves.

In Multiple voices on a staff, the example:

**kern
*M4/4
*^
2..gg	4b
.	4a
.	4g
.	4f
8ff	.
*v	*v
=
*-

clearly shows that the spine encoded at left is drawn as the top voice, and the one encoded at right is encoded as the bottom voice.

image

This is the opposite of how staves must be encoded, left spines mean bottom staves, and right spines mean top staves.

This issue is just a request for documenting it.

fb documentation enhancements

  • For --frequency, I am thinking that --rate would be better (or as another long-form alias. but the primary one used in the documentation), particularly since it is shorter, and also --frequency is also associated with hertz in sound, which may cause confusion.
  • "passend" I see is a German word. You probably mean an English word?
  • "--abbr" is good, but the primary long name should be --abbreviate.
  • In the 9/8 examples, you use the letter s in measure 1 top staff? Is that a typo, since I expect it to be an r as in 4.r. If you want in invisible rest, then use either 4. or 4.ryy.

Also, it would be useful to have a summary table of options. There are not too many filters that have this yet, but a good prototype to use is the cmr filter
documentation:

https://doc.verovio.humdrum.org/filter/cmr/#options

Screenshot 2023-01-22 at 8 24 31 PM

This table is generated from a ATON file (similar to JSON) describing the options:

https://github.com/humdrum-tools/vhv-documentation/blob/master/filter/cmr/options.aton

Note that the question mark to the left of the table is a hyperlink to the location in the documentation where the option is discussed. To have a hyperlink display, add a line such as:

<a name="option-l"></a>

in the documentation where that option is discussed (-l in this case).

To print the options list, you add this line to index.md:

{% include filter-options.html file="options.aton" lang="EN" %}

In the future, I am thinking of embedding this option list into the tool itself, which will generate the list when using the CLI version of the program (and perhaps in VHV somehow as well).

Documentation about spine operator *v

In Partial voices/layers, when two spines are to be merged into one spine the *v operator is used on both spines:

**kern
*M4/4
=1
*^
2cc	4a
.	4g
*v	*v
4f
4e
=2
*^
2cc	4a
.	4g
2ryy	4f
.	4e
*v	*v
=
*-

image

In Multiple staves, the top staff spines are merged into just one using the same method, while the bottom staff is maintained without being split or merged. This is perfect.

**kern	**kern
*M4/4	*M4/4
=1	=1
*	*^
1E	2cc	4a
.	.	4g
*	*v	*v
.	4f
.	4e
=2	=2
*	*^
1E	2cc	4a
.	.	4g
.	2ryy	4f
.	.	4e
*	*v	*v
=	=
*-	*-

image

However, for getting the example below the encoding is a bit different.
image

Given the examples in the documentation, when two splines must be merged into one, the *v operator must be used at the end of both spines. Then, the expected encoding should be:

**kern	**kern
*staff2	*staff1
*clefF4	*clefG2
*k[f#c#]	*k[f#c#]
*D:	*D:
*M2/4	*M2/4
*^	*^
G2	BB2	g8L	d4
.	.	a8J	.
.	.	b8L	e4
.	.	cc#8J	.
=	=	=	=
D2	AA2	dd2	f#2
*v	*v	*v	*v
=	=
*-	*-

However, VHV complains because the number of tokens in the last bar line record do not match.
To make it work, I've had to remove the left spine merge operator :

....
D2	AA2	dd2	f#2
*	*v	*v	*v
=	=
*-	*-

Grace note documentation

Please, when possible it would be very useful to have documentation about grace notes. I've found the ones related to cue-sized notes, but not that for appoggiatura and acciaccatura.

At least it would be nice to know what part of the explanation about it in https://www.humdrum.org/rep/kern/ is supported in VHV. I've tested the encoding of acciaccaturas with q and it works, but not the appoggiatura with P and p, or the grace note groups.

Thanks.

Non lazy beaming

The example in the documentation of non lazy beaming contains a k signifier that is not explained (I'm sorry if I'm missing something). In fact, if removed the result is the same
image

I wonder if it's necessary to encode the first beam group in this weird unit test (don't look at the cross-measure beam that's not supported in VHV or the rest starting a beam):
image

If encoded using lazy beaming with:

**kern
*clefG2
*M4/4
*met(c)
32cL
32d
16e
*clefF4
32FF
32BB
32AA
32GGJ
*clefG2
8r
16ccL
8dd
8r
16eeJ
8r
8cc
=
*-

we get
image

If we want to encode the same number of beams of the example we need to use a non-lazy approach, we get no note beamed. Is my encoding wrong, should I add some k or is it VHV?

**kern
*clefG2
*M4/4
*met(c)
32cLLL
32dJ
16eJ
*clefF4
32FFLL
32BB
32AA
32GGJJ
*clefG2
8r
16ccL
8dd
8r
16eeJ
8r
8cc
=
*-

Thanks !!

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.