commit | 4fb1c09ee4e8add553a7e8fd496d426ae3abfaf7 | [log] [tgz] |
---|---|---|
author | Translation updater bot <[email protected]> | Mon Jul 01 09:26:17 2024 +0200 |
committer | Translation updater bot <[email protected]> | Mon Jul 01 09:26:17 2024 +0200 |
tree | 895c5db7d3ef644bfaffec9925a06757ebcd3a04 | |
parent | 1a01077bec5ba9781a779fbd4067c9336120c6d6 [diff] |
Localisation updates from https://translatewiki.net. Change-Id: I578634621ea69b3d570f73dc75edd5999653ce3d
Score, a MediaWiki extension for rendering musical scores with LilyPond.
By default, this extension runs LilyPond in safe mode, however it is unsafe to rely on it due to unfixed vulnerabilities, and indeed safe mode was removed in LilyPond version 2.23.12 and causes an error when used.
It is recommended that LilyPond is run as an unprivileged user inside an isolated container with no external network access.
MediaWiki's system for remote execution of shell commands is called Shellbox. Instructions to set up a Shellbox server can be found at: https://www.mediawiki.org/wiki/Shellbox.
Ensure the following additional packages are installed in your Shellbox container:
If you are not using SVG output, you will also need to install:
You'll also want fonts for whatever characters are used in lyrics. The Noto font family may be a good choice as it aims to cover all scripts.
Note that upstream packaging changed for versions 2.23 and later; a tarball can be downloaded directly from the GitLab releases page and extracted into /usr/local/lilypond
(for example). In this case, the binary locations for the extension setup (see below) will be:
/usr/local/lilypond/bin/lilypond /usr/local/lilypond/bin/abc2ly
Running the Score extension on Windows is possible, although inadvisable.
Shellbox cannot do cross-platform requests, so if MediaWiki runs on Windows, it would be necessary to run LilyPond on Windows as well. Proper security isolation in such a setup would be difficult. Consider instead running MediaWiki inside a Linux container.
Score uses POSIX shell scripts and so requires a Bash or a similar shell to be installed, for example, the MinGW shell that is distributed with Git for Windows. Configure its location with $wgShellboxShell
, typically:
$wgShellboxShell = 'C:\Program Files\Git\bin\bash.exe';
GhostScript is distributed with LilyPond, however this GhostScript cannot find its library directory unless an environment variable is set, e.g.:
$wgScoreEnvironment = [ 'GS_LIB' => 'C:\Program Files (x86)\LilyPond\usr\share\ghostscript\9.21\Resource\Init' ];
LocalSettings.php
file:wfLoadExtension( 'Score' ); $wgScoreTrim = true;
$wgScoreUseSvg = true; $wgScoreSafeMode = false;
if you are not using SVG, you will need to ensure Score knows where to find Ghostscript and ImageMagick binaries (see below). 6. If you are using shellbox to sandbox your lilypond processes, add:
$wgShellboxUrls['score'] = 'http://shellbox.internal/shellbox'; $wgShellboxSecretKey = '... your secret key ...';
If you get unexpected out-of-memory errors, you may also have to increase $wgMaxShellMemory.
By default, Score will look for binaries by their usual names in /usr/bin. If you need to customise the locations of any of the binaries, you can copy the lines below and change them as necessary:
$wgImageMagickConvertCommand = '/usr/bin/convert'; $wgScoreLilyPond = '/usr/bin/lilypond'; $wgScoreAbc2Ly = '/usr/bin/abc2ly'; /* part of LilyPond */ $wgScoreFluidsynth = '/usr/bin/fluidsynth'; $wgScoreSoundfont = '/usr/share/sounds/sf2/FluidR3_GM.sf2'; /* for FluidSynth */ $wgScoreGhostScript = '/usr/bin/gs';
After setup, you can use the … tags in your wiki markup. For a simple score, use e.g.
<score>\relative c' { f d f a d f e d cis a cis e a g f e }</score>
This will render the appropriate score as a PNG image.
You may also specify attributes to the score tags in the general form
<score attribute1="value1" attribute2="value2">…</score>.
The following attributes are available:
Attribute: lang
Allowed values: ABC, lilypond (default)
Effect: Sets the score language. For example, to provide a score in ABC notation, you might use
<score lang="ABC"> X:1 M:C L:1/4 K:C C, D, E, F,|G, A, B, C|D E F G|A B c d| e f g a|b c' d' e'|f' g' a' b'|] </score>.
Attribute: override_midi
Attribute: override_audio
Attribute: raw
Attribute: sound