扩展:Score

MediaWiki扩展手册Manual:Extensions

Score 发布状态：Extension status 稳定版
实现Template:Extension#type	Tag
描述Template:Extension#description	允许通过LilyPond渲染乐谱
作者Template:Extension#username	Alexander Klauer (GrafZahltalk)
最新版本Template:Extension#version	0.3 (2014-03-28)
MediaWikiTemplate:Extension#mediawiki	1.25+
PHPTemplate:Extension#php	5.3+
数据更新Template:Extension#needs-updatephp	否
许可协议Template:Extension#license	GNU General Public License 3.0 or later
下载	下载扩展 Git [?]: 下载Git主线 浏览存储库 (GitHub) 提交历史 代码复核 README
参数Template:Extension#parameters * $wgScoreLilyPond $wgScoreAbc2Ly $wgScoreTimidity $wgScoreTrim $wgScorePath $wgScoreDirectory $wgScoreFileBackend
标签Template:Extension#tags score
使用的钩子Template:Extension#hook ParserFirstCallInitManual:Hooks/ParserFirstCallInit
翻译Score扩展如果在translatewiki.net可用
检查使用和版本矩阵。
问题Phabricator	开放的工作 · 报告错误

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

 注意： The documentation on this page refers to the current master of the Score extension. If you download version 0.1, refer to the README file.

Acknowledgements

• The original Extension:LilyPond was written by Johannes E. Schindelin.
• This extension is based on a code review of Extension:LilyPond by Tim Starling.
• The original Extension:ABC was written by River Tarnell.

用法

After setup, you can embed simple LilyPond notation into your wikitext using the score tags. For example:

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

yields:

You may also specify attributes to the score tags in the general form

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

例如：

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

yields:

The following attributes are available:

Attribute	Allowed values	Effect
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>.
midi	0 (default), 1	If set to 1, the rendered image(s) will be embedded into a hyperlink to an appropriate MIDI file.
override_midi	Known file name, that is, if override_midi="name" is given, [[File:name]] does not yield a red link	Uses the specified MIDI file instead of generating one with LilyPond. Use this attribute together with the midi attribute (see before) or the vorbis 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_ogg	Known file name, that is, if override_ogg="name" is given, [[File:Name]] does not yield a red link	Embeds the media specified by the file name in the HTML after the score image(s). This is an alternative to the vorbis attribute (see further). It can, for example, be useful if you have a suitable Ogg/Vorbis file of superior quality compared with the auto-generated Ogg/Vorbis file the vorbis attribute yields. Of course, you can still omit both attributes in this case and add the file manually to the page, if you prefer.
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.
vorbis	0 (default), 1	If set to 1, an Ogg/Vorbis file will be generated for the score, provided you installed and configured Extension:TimedMediaHandler. An Ogg/Vorbis player will be embedded in the HTML after the score image(s).

Lyrics may be added like this:

<score>\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>

Prerequisites

This extension uses LilyPond to render score images, so you need a working LilyPond installation. If you want the extension to trim the score files for you, you will also need ImageMagick.

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

Version 0.1 of this extension was tested with MediaWiki 1.18.0 and LilyPond 2.12.3. The current SVN snapshot might require a newer version of MediaWiki and/or LilyPond.

Download instructions

Use the extension distributor. You can also download a tarball from GitHub: [1]; or as a zipped file: [2]. The score master branch on GitHub works with a stable version of MediaWiki, but may not yet have the newest features in it.

Installation

• 下载文件，并将其放置在您extensions/文件夹中的Score目录内。

• 将下列代码放置在您的LocalSettings.php的底部：

  wfLoadExtension( 'Score' );
  $wgScoreLilyPond = '/path/to/your/lilypond/executable'; /* required */
  $wgScoreAbc2Ly = '/path/to/your/abc2ly/executable'; /* if you want ABC to LilyPond conversion */
  $wgScoreTimidity = '/path/to/your/timidity/executable'; /* if you want MIDI to Vorbis conversion */
  $wgScoreTrim = true; /* Set to false if you don't want score trimming */
  

• Create a subdirectory named lilypond in your $wgUploadDirectory (usually the directory named images in in your MediaWiki directory). Make sure the directory is writable by your Web server.
• Y 完成 – 在您的wiki上导航至Special:Version，以验证扩展已成功安装。

致使用MediaWiki 1.26或更早版本的用户：

上面的说明介绍的是安装此扩展的新方法，它使用wfLoadExtension() 如果您需要在早期版本（MediaWiki 1.26和更早版本）中安装此扩展，而不是wfLoadExtension( 'Score' );，您需要使用：

require_once "$IP/extensions/Score/Score.php";

Configuration

Currently, the extension has the following global configuration parameters.

$wgScoreLilyPond

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

$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).

$wgScoreTimidity

Set $wgScoreTimidity to the path of your TiMidity++ executable (typically /usr/bin/timidity or /usr/local/bin/timidity).

Remarks

This extension runs various binaries on a shell. You may have to increase $wgMaxShellMemory if you get out of memory errors.

Finding scores

Pages with scores on them will have the "score" page property set. Using Special:PagesWithProp, you can find pages that have scores. (Example query for the English Wikipedia.)

See also

• Code review by Tim Starling; this extension is based on it
• https://en.wikisource.org/wiki/Help:Sheet_music

External links

• LilyPond notation
• ABC notation