Extension:Score

L'extension Score permet l'affichage de partitions musicales au format PNG en utilisant LilyPond et peut aussi les transformer en fichier audio ou MIDI.

La documentation de cette page se réfère à la version actuelle de l'extension Score. Si vous téléchargez la version 0.1, référez-vous au fichier README.

Remerciements

La première version de l'Extension:LilyPond a été écrite par Johannes E. Schindelin.
Cette extension est basée sur une revue du code de l'Extension:LilyPond par Tim Starling.
La première version de l'Extension:ABC a été écrite par River Tarnell.

Utilisation

Après l'installation, vous pouvez intégrer du code LilyPond simple dans le wikitext en utilisant les balises score. Par exemple :

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

donne :

Vous pouvez aussi préciser les attributs dans les balises score, sous la forme générale

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

Par exemple :

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

donne :

Les attributs suivants sont disponibles :

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

Des paroles peuvent être ajoutées de cette manière :

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

Pré-requis

Cette extension utilise Lilypond pour générer les images des partitions, donc vous avez besoin de l'installer. Si vous souhaitez que l'extension puisse modifier les images à votre place, vous aurez aussi besoin de ImageMagick.

L'extension est également capable de créer des fichiers audio à partir des fichiers MIDI générés par Lilypond. Si vos souhaitez utiliser cette fonctionnalité, vous devez installer Extension:TimedMediaHandler.

La version 0.1 de cette extension a été testée avec MediaWiki 1.18.0 et LilyPond 2.12.3. Le snapshot SVN actuel peut nécessiter une version plus récente de MediaWiki et/ou de LilyPond.

Instructions de téléchargement

Utilisez le distributeur d'extension. Vous pouvez également télécharger un fichier tar depuis GitHub : [1], ou un fichier zippé : [2].

Installation

Téléchargez et placez le(s) fichiers (s) dans un répertoire appelé Score dans votre dossier extensions/.

Ajoutez le code suivant à la fin de votre fichier LocalSettings.php :

wfLoadExtension( 'Score' );
$wgScoreLilyPond = '/path/to/your/lilypond/executable'; /* required */
$wgScoreAbc2Ly = '/path/to/your/abc2ly/executable'; /* if you want ABC to LilyPond conversion */
$wgScoreFluidsynth = '/path/to/your/fluidsynth/executable'; /* if you want MIDI to audio conversion */
$wgScoreSoundfont = '/path/to/your/soundfont/file'; /* required for Fluidsynth */
$wgScoreTimidity = '/path/to/your/timidity/executable'; /* fallback when Fluidsynth is not installed */
$wgScoreLame = '/path/to/your/lame/executable'; /* required to convert audio file for MP3 */
$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.
Fait – Accédez à Special:Version sur votre wiki pour vérifier que l'extension a bien été installée.

Pour les utilisateurs de MediaWiki 1.26 ou précédents :

Les instructions ci-dessous décrivent la nouvelle procédure pour installer cette extension en utilisant wfLoadExtension() Si vous avez besoin d'installer cette extension sur les précédentes versions de MediaWiki (1.26 ou précédent), à la place de wfLoadExtension( 'Score' );, vous devez utiliser :

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

Configuration

L'extension possède actuellement les paramètres de configuration global suivants.

$wgScoreLilyPond

Mettez le chemin de votre exécutable LilyPond à la variable $wgScoreLilyPond (typiquement /usr/bin/lilypond ou /usr/local/bin/lilypond).

$wgScoreTrim

la variable $wgScoreTrim est un booléen qui utilisée par défaut, la valeur de $wgUseImageMagick. Si à true (vrai), les images PNG de la partition résultante sont retaillées avec ImageMagick. Si vous ne désirez pas de recadrage ou ne désirez pas installer ImageMagick, réglez $wgScoreTrim à false (faux).

$wgScoreAbc2Ly

Réglez $wgScoreAbc2Ly avec le chemin de l'exécutable de votre convertisseur d'ABC à LilyPond (typiquement /usr/bin/abc2ly ou /usr/local/bin/abc2ly).

$wgScoreFluidsynth

Réglez $wgScoreFluidsynth avec le chemin de votre exécutable Fluidsynth (typiquement /usr/bin/fluidsynth ou /usr/local/bin/fluidsynth).

$wgScoreSoundfont

Réglez $wgScoreSoundfont au chemin de votre fichier de soundfont (typiquement /usr/share/sounds/sf2/FluidR3_GM.sf2 ou /usr/share/sounds/sf2/FluidR3_GS.sf2).

$wgScoreTimidity

Réglez $wgScoreTimidity au chemin de votre exécutable TiMidity++ (typiquement /usr/bin/timidity ou /usr/local/bin/timidity). Si $wgScoreFluidsynth n'existe pas, TiMidity++ sera alors utilisé comme plan de repli.

$wgScoreLame

Réglez $wgScoreLame au chemin de votre exécutable Lame (typiquement /usr/bin/lame ou /usr/local/bin/lame). Requit, si le fichier audio généré doit être au format MP3.

Remarques

Cette extension lance divers exécutables dans un shell. Si vous avez des erreurs de dépassement mémoire, il faudra peut-être augmenter la valeur de $wgMaxShellMemory.

Rechercher des partitions

Les pages incluant des partitions ont la propriété de page "score" activée. Vous pouvez rechercher les pages incluant une partition en utilisant la recherche par propriété de page (Exemple de recherche pour la Wikipedia francophone).

Voir également

Code review by Tim Starling; this extension is based on it
https://fr.wikisource.org/wiki/Wikisource:Partitions
VexFlow Générateur de musique SVG/Canvas open source

Liens externes

Cette extension est utilisée par au moins un des projets Wikimédia. Cela signifie probablement que l’extension est assez stable et fonctionnelle pour être utilisée sur des sites à fort trafic. Recherchez le nom de cette extension dans le CommonSettings.php de Wikimédia et dans le fichier de configuration InitialiseSettings.php pour situer les endroits où elle est installée. Une liste complète des extensions installées sur un Wiki donné peut être visualisée sur la page Special:Version de ce wiki.