Implement ChordPro annotations #1127
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
![codeclimate[bot]](https://avatars.githubusercontent.com/in/9403?s=60&v=4){kind=small}
Quoted from the ChordPro docs (https://www.chordpro.org/chordpro/chordpro-introduction/#markup-and-annotations): Annotations are textual remarks placed above the lyrics, just like chords. Annotations are specified with [*text], again just like chords. Depending on the software used to process the ChordPro data, annotations may be rendered in an outstanding manner. This is a first iteration on annotation support, where the annotation is added to a `ChordLyricsPair`. The pair can either have `chords` or `annotation`. In `TextFormatter` and `ChordsOverWordsFormatter` annotations are treated equally to lyrics. In `HtmlDivFormatter` and `HtmlTableFormatter` annotatioins are rendered similar to how lyrics are rendered, but the wrapping element is given the css class `annotation` instead of `lyrics`. See https://www.chordpro.org/chordpro/chordpro-introduction/#markup-and-annotations Resolves #980
martijnversluis
force-pushed
the
implement-annotations
branch
from
419372b to
df27dbf
Compare
|
Code Climate has analyzed commit df27dbf and detected 0 issues on this pull request. View more on Code Climate. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Quoted from the ChordPro docs
(https://www.chordpro.org/chordpro/chordpro-introduction/#markup-and-annotations):
This is a first iteration on annotation support, where the annotation is added to a
ChordLyricsPair. The pair can either havechordsorannotation.In
TextFormatterandChordsOverWordsFormatterannotations are treated equally to lyrics. InHtmlDivFormatterandHtmlTableFormatterannotatioins are rendered similar to how lyrics are rendered, but the wrapping element is given the css classannotationinstead oflyrics.See https://www.chordpro.org/chordpro/chordpro-introduction/#markup-and-annotations
Resolves #980