Data

Tools

Indexes

Applications

Experiments

Open Source Science

edirom-verovio-renderer

This web component renders and append svg rendering of MEI file using verovio library.

https://github.com/edirom/edirom-verovio-renderer

Science Score: 44.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ✓
    CITATION.cff file
    Found CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ✓
    .zenodo.json file
    Found .zenodo.json file
  • ○
    DOI references
  • ○
    Academic publication links
  • ○
    Academic email domains
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (11.2%) to scientific vocabulary

Keywords

edirom-online
Last synced: 6 months ago · JSON representation ·

Repository

This web component renders and append svg rendering of MEI file using verovio library.

Basic Info
  • Host: GitHub
  • Owner: Edirom
  • License: gpl-3.0
  • Language: JavaScript
  • Default Branch: develop
  • Homepage:
  • Size: 88.9 KB
Statistics
  • Stars: 0
  • Watchers: 4
  • Forks: 0
  • Open Issues: 10
  • Releases: 0
Topics
edirom-online
Created almost 2 years ago · Last pushed 7 months ago
Metadata Files
Readme License Code of conduct Citation

README.md

GitHub License

Edirom Verovio Renderer Component

This web component renders and append svg rendring of MEI file using verovio library. It is intended to be used in tbe Edirom Online, but can also be (re-)used in other web applications. No compilation or building is necessary to use the web component. The component uses (https://www.verovio.org/index.xhtml) library. Note: This repository only contains the bare JavaScript-based component, there is a separate demo suite for web components developed in the Edirom Online Reloaded project, where the component can be seen and tested.

Licensea

The edirom-verovio-renderer.js comes with the license GPL-3.0.

The imported verovio library comes with the license LGPL-3.0, GPL-3.0.

How to use this web component

  1. Clone the repository into a directory of your choice
  2. Include the path to the web component's JavaScript file into the <head> an HTML page html <script src="path/to/edirom-verovio-renderer.js"></script>
  3. Include a custom element (this is specified and can be processed by the component) into the <body> of the HTML page. The attributes of the custom element are used as parameters at initialization of the component and changing them (manually or programmatically) can control the components state and behaviour during runtime. The state changes of the web component are communicated outwards via custom events (called 'communicate-{change-type}-update'). The component/document that instantiates the web component (its parent) can listen (via event listeners which have to be implemented individually) and react to the communicated state changes if necessary. The separation of inward communication (via custom element's attributes) and outward communication (via custom events) is esp. necessary to handle frequently populated information like currentTime of the audio player and avoid interference between reading and writing info about the component's state.

html <edirom-verovio-renderer meiurl="https://editor.verovio.org/examples/puccini.mei" pagenumber="1" elementid="" measurenumber="" mdivname="" movementid="" zoom="20" height="500px" width="500px" pagewidth="" pageheight="" verovio-url="https://www.verovio.org/javascript/5.3.2/verovio-toolkit-wasm.js" verovio-options="{ breaks: 'auto', scale: 20, spacingStaff: 7, pageHeight: 4500, pageWidth: 4500, footer: 'none', header: 'none' }" ></edirom-verovio-renderer>

Parameters

Note: All attribute values are strings internally, the data type information below indicates the necessary format of the attribute value.

The verovio parameters mentioned below are based on the available Verovio library.

Attributes

Note: All attribute values are internally handled as strings. The data type below reflects the expected format.

These attributes control how the component renders MEI data using the Verovio library:

| Attribute | Type | Description | Default | |------------------|----------|-----------------------------------------------------------------------------|-------------------------------------------------------------------------| | width | Integer | Width of the rendered SVG (in pixels) | "200" | | height | Integer | Height of the rendered SVG (in pixels) | "700" | | zoom | Integer | Zoom level (Verovio scale percentage) | "20" | | pagenumber | Integer | Page number to be displayed | "1" | | meiurl | String | URL to the source MEI file | "https://www.verovio.org/examples/downloads/Schubert_Lindenbaum.mei" | | measurenumber | Integer | (Optional) Navigate to a specific measure number (if found) | — | | mdivname | String | (Optional) Lookup to a specific <mdiv> with this label | — | | movementid | String | (Optional) Navigate to a specific movement with this id | — | | elementid | String | (Optional) Navigate to any element with this id | — | | verovio-url | String | (Optional) Provide a specific URL for the verovio library | "https://www.verovio.org/javascript/5.3.2/verovio-toolkit-wasm.js" | | verovio-options| Object | (Optional) An object with options for verovio | "{breaks: "auto", scale: 20, spacingStaff: 7, pageHeight: 4500, pageWidth: 4500, footer: "none", header: "none"}"|

Owner

  • Name: Virtueller Forschungsverbund Edirom
  • Login: Edirom
  • Kind: organization
  • Location: Germany

Citation (CITATION.cff) 

cff-version: 1.2.0
title: Edirom Verovio Renderer
message: >-
  If you use this software, please cite it using the
  metadata from this file.
type: software
authors:
  - given-names: Hizkiel
    family-names: Alemayehu
    email: hizkiel.alemayehu@uni-paderborn.de
    affiliation: Universität Paderborn
  - given-names: Daniel
    family-names: Röwenstrunk
    email: roewenstrunk@uni-paderborn.de
    affiliation: Universität Paderborn
repository-code: 'https://github.com/Edirom/edirom-verovio-renderer'
abstract: >-
  This web component renders an SVG from an MEI file using the Verovio library (https://www.verovio.org/index.xhtml). It is intended to be used in tbe Edirom Online, but can also be (re-)used in other web applications. No compilation or building is necessary to use the web component. 
license: MIT

GitHub Events

Total
  • Issues event: 2
  • Push event: 14
  • Pull request event: 1
  • Pull request review event: 2
  • Create event: 2
Last Year
  • Issues event: 2
  • Push event: 14
  • Pull request event: 1
  • Pull request review event: 2
  • Create event: 2

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 2
  • Total pull requests: 1
  • Average time to close issues: N/A
  • Average time to close pull requests: 15 days
  • Total issue authors: 1
  • Total pull request authors: 1
  • Average comments per issue: 0.0
  • Average comments per pull request: 0.0
  • Merged pull requests: 1
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 2
  • Pull requests: 1
  • Average time to close issues: N/A
  • Average time to close pull requests: 15 days
  • Issue authors: 1
  • Pull request authors: 1
  • Average comments per issue: 0.0
  • Average comments per pull request: 0.0
  • Merged pull requests: 1
  • Bot issues: 0
  • Bot pull requests: 0
View more stats
Top Authors
Issue Authors
  • daniel-jettka (2)
Pull Request Authors
  • roewenstrunk (1)
Top Labels
Issue Labels
Pull Request Labels