Розширення:Score

Довідка про розширення MediaWiki

Score Статус релізу: стабільний
Реалізація	Тег
Опис	Allows rendering of musical scores with LilyPond
Автор(и)	Alexander Klauer, Étienne Beaulé
Найновіша версія	0.3.0 (2019-03-23)
MediaWiki	1.36+
PHP	5.3+
Параметри $wgScoreDirectory $wgScoreSoundfont $wgScoreFluidsynth $wgScoreLame $wgScoreEnvironment $wgScoreLilyPond $wgWikibaseMusicalNotationLineWidthInches $wgScoreImageMagickConvert $wgScoreLilyPondFakeVersion $wgScoreFileBackend $wgScoreTrim $wgScoreGhostscript $wgScoreMaxLength $wgMusicalNotationEnableWikibaseDataType $wgScoreOfferSourceDownload $wgScoreDebugOutput $wgScoreUseSvg $wgScorePath $wgScoreAbc2Ly $wgScoreDisableExec
Теги score
Використані hook'и ParserFirstCallInit ResourceLoaderRegisterModules SoftwareInfo WikibaseClientDataTypes WikibaseRepoDataTypes WikibaseRepoWbui2025InitResourceDependenciesHook
Licence	GNU General Public License 3.0 або пізніше
Завантажити	Download extension Git [?]: Browse repository (Phabricator · GitHub) Gerrit code review Git commit log Download source tarball README.md
Перекладіть розширення Score, якщо воно доступне у translatewiki.net
Проблеми	Відкриті проблеми · Повідомити про помилку

The Score extension allows the rendering of musical scores as SVG or PNG images using LilyPond and can also transform them into audio and MIDI files.

Встановлення

See the extension's README.md for detailed installation instructions.

• Завантажте і розмістіть файли в каталозі з назвою Score у вашій extensions/ папці.
  Розробники та автори коду повинні замість цього встановити розширення з Git, використовуючи:

  cd extensions/
  git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/Score
  

• Додайте такий код унизу вашого файлу LocalSettings.php :

  wfLoadExtension( 'Score' );
  $wgScoreTrim = true;
  $wgImageMagickConvertCommand = '/usr/bin/convert';
  $wgShellboxUrl = '... address to Shellbox ...';
  $wgShellboxSecretKey = '... your secret key ...';
  

• Створіть піддиректорію lilypond у своїй $wgUploadDirectory (зазвичай, директорія images у вашій директорії MediaWiki). Переконайтеся у спроможності веб-сервера писати в директорію.
• Готово – Перейдіть до Special:Version вашої вікі, щоб переконатися, що розширення встановлено успішно.

Передумови

Рекомендуються наступні пакунки:

• LilyPond
• Ghostscript
• ImageMagick
• FluidSynth
• Firejail

This extension uses LilyPond to render score images, so you need a working LilyPond installation (Special:Version displays the LilyPond version). If you install LilyPond from a package, Ghostscript will also be installed, since LilyPond depends on Ghostscript. ImageMagick should be installed to trim the images, otherwise they will contain an excessive amount of whitespace.

For security reasons, it is highly recommended to install firejail to further restrict what LilyPond and Ghostscript can do if untrusted users are allowed to edit your wiki.

The extension is also capable of creating audio files from the MIDI files generated by LilyPond. If you want to make use of this functionality, you need to have Extension:TimedMediaHandler installed.

FluidSynth is the preferred method to convert MIDI files to audio files, however TiMidity++ is also supported.

Міркування безпеки

Use Shellbox to secure LilyPond to protect your wiki!

LilyPond files can run arbitrary code on the server. If you don't absolutely trust everyone who has editing privileges on your wiki, it is strongly recommended to set up containment of lilypond using Shellbox . See Shellbox#Server setup for details on how to set up the contained server, and below for configuring MediaWiki to use it. Also, ensure you're using a recent version of LilyPond (2.22.0+) or a distribution package (e.g. from Debian) that has security fixes.

Remarks

This extension runs various binaries in a Shellbox to provide some security. You may have to increase $wgMaxShellMemory if you get "out of memory" errors.

Конфігурація

Here are some of the extension's global configuration parameters.

$wgScoreLilyPond

Set $wgScoreLilyPond to the path to your LilyPond executable (typically /usr/bin/lilypond or /usr/local/bin/lilypond).

$wgScoreUseSvg

Set $wgScoreUseSvg to true to render scores as SVG in the browser. Requires LilyPond version 2.24 or above, compiled with Cairo support (included by default since version 2.26).

$wgScoreTrim

The $wgScoreTrim is a boolean which defaults to the value of $wgUseImageMagick. If true, the resulting score PNG images are trimmed with ImageMagick. If you don't want trimming, or don't want to install ImageMagick, set $wgScoreTrim to false.

$wgScoreAbc2Ly

Set $wgScoreAbc2Ly to the path of your ABC to LilyPond converter executable (typically /usr/bin/abc2ly or /usr/local/bin/abc2ly).

$wgScoreFluidsynth

Set $wgScoreFluidsynth to the path of your Fluidsynth executable (typically /usr/bin/fluidsynth or /usr/local/bin/fluidsynth).

$wgScoreSoundfont

Set $wgScoreSoundfont to the path of your soundfont file (typically /usr/share/sounds/sf2/FluidR3_GM.sf2 or /usr/share/sounds/sf2/FluidR3_GS.sf2).

$wgScoreLame

Set $wgScoreLame to the path of your Lame executable (typically /usr/bin/lame or /usr/local/bin/lame). Required if the generated audio file should be a MP3.

Використання

Після встановлення можна вбудовувати просту нотацію LilyPond у вікітекст усередині тегу ‎<score>...‎</score>. Наприклад:

<score lang="lilypond">\relative c' { f d f a d f e d cis a cis e a g f e }</score>

yields:

Також можна зазначати атрибути тегів score у загальному вигляді

<score attribute1="value1" attribute2="value2">…</score>.

Наприклад:

<score sound="1" lang="lilypond">\relative c' { \set Staff.midiInstrument = "tenor sax" f d f a d f e d cis a cis e a g f e }</score>

yields:

Attributes

Доступні такі атрибути:

Атрибут	Дозволені значення	Ефект
lang	ABC, lilypond (default)	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>
line_width_inches	Positive non-zero number, can have decimal places	Sets the width of the lines in the rendered score, by setting the line-width directive in the LilyPond paper settings.
midi		(removed) This used to control whether the rendered score image linked to a MIDI file.
override_midi	Known file name, that is, if override_midi="name" is given, [[File:name]] does not yield a red link	(deprecated) Натомість, можна додати вікіпосилання [[File:superior midi filename.mid]] після закривного тегу ‎</score>. Використовує зазначений файл MIDI замість згенерованого LilyPond. Use this attribute together with the midi attribute (see before) or the sound attribute (see later). This attribute is useful if you already have a MIDI file whose quality is superior to what would be generated by LilyPond.
override_audio	Known file name, that is, if override_audio="name" is given, [[File:Name]] does not yield a red link	(deprecated) Натомість, можна додати вікіпосилання [[File:superior audio filename.oga]] після закривного тегу ‎</score>. Embeds the media specified by the file name in the HTML after the score image(s). This is an alternative to the sound attribute (see further). It can, for example, be useful if you have a suitable audio file of superior quality compared with the auto-generated audio file. Of course, you can still omit both attributes in this case and add the file manually to the page, if you prefer.
override_ogg		(deprecated) Doubly-deprecated alias for override_audio.
raw	0 (default), 1	If set to 1, the score code is interpreted as a complete LilyPond file. Use this option if you want to create more complex scores. If the score language (lang attribute) is not set to LilyPond, this attribute is ignored. By default (when raw=0), provided code is wrapped in a \score{...} block, along with default \layout{...} and \midi{...} blocks, if not already provided.
sound	0 (default), 1	If set to 1, an audio file will be generated for the score, provided you installed and configured Extension:TimedMediaHandler . An audio player will be embedded in the HTML after the score image(s).
vorbis	0 (default), 1	(deprecated) Alias for sound.

Мова LilyPond

Lyrics may be added like this:

<score lang="lilypond" sound="1">
\relative c'' { \time 4/4 \key c \major 
c4 g8 g a4 g r b^> c^> r \bar "|." } 
\addlyrics { Shave and a hair -- cut: two bits. }
</score>

For advanced users, the \set Staff.midiInstrument command can be used to change the MIDI instrument for the sound.

Tracking category

Pages containing ‎<score> tags are in the tracking category with message name score-use-category. Visit Special:TrackingCategories to find the localized title of this category on your wiki and show the pages in it, for example w:Category:Pages using the Score extension on the English Wikipedia.

Acknowledgements

• Оригінал Extension:LilyPond написаний Йоганнесом Е. Шінделіном.
• Це розширення засноване на перегляді коду Extension:LilyPond Тіма Старлінга.
• Оригінал Extension:ABC написаний Рівер Тарнелл.

Див. також

• Help:Score on English Wikipedia and Help:Sheet music on Wikisource have more examples of LilyPond syntax.

• Нотація LilyPond
• Нотація ABC

• ABC notation