Extension:Score/pt

Manual de extensões do MediaWiki

File:OOjs UI icon advanced-invert.svg Score Estado de lançamento: estável
File:Lilytest1.png
Implementação	Etiqueta
Descrição	Allows rendering of musical scores with LilyPond
Autor(es)	Alexander Klauer, Étienne Beaulé
Última versão	0.3.0 (2019-03-23)
MediaWiki	1.36+
PHP	5.3+
Licença	Licença não especificada
Transferência	<translate> Download extension</translate> <translate> Git</translate> [?]: <translate> Download Git master</translate> <translate> browse repository</translate> (Phabricator · GitHub) <translate> commit history</translate> <translate> repository contributors (GitHub)</translate> <translate> code review</translate> README.md
Etiquetas score
Quarterly downloads
Public wikis using
Traduza a extensão Score se ela estiver disponível em translatewiki.net
Problemas	Tarefas em aberto · Reportar um erro

A extensão Score permite a representação de partituras através de imagens do tipo PNG usando o LilyPond, podendo transformar em arquivos de audio e MIDI.

Agradecimentos

• A versão original Extension:LilyPond (LilyPond) foi escrita por 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.

Uso

After setup, you can embed simple LilyPond notation into your wikitext inside a ‎<score>...‎</score> tag. For example:

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

produz:

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

Também pode especificar os valores nas etiquetas score na forma geral.

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

Por exemplo:

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

produz:

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

Os seguintes atributos estão disponíveis:

Atributo	Valores permitidos	Effect
lang	ABC, lilypond (default)	Define o idioma da partitura. Por exemplo, para fornecer uma pontuação em notação ABC, você pode usar. <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		<translate> (removed)</translate> Isso é usado para controlar se a imagem da partitura renderizada está vinculada a um arquivo MIDI.
override_midi	Known file name, that is, if override_midi="name" is given, [[File:name]] does not yield a red link	<translate> (deprecated)</translate> Instead you can add a [[File:superior midi filename.mid]] wikilink after the closing ‎</score> tag. 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	<translate> (deprecated)</translate> Instead you can add a [[File:superior audio filename.oga]] wikilink after the closing ‎</score> tag. 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		<translate> (deprecated)</translate> 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	<translate> (deprecated)</translate> Alias for sound.

A linguagem LilyPond

As letras podem ser adicionadas assim:

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

<score lang="lilypond" vorbis="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>

Para usuários avançados, o comando \set Staff.midiInstrument pode ser usado para alterar o instrumento MIDI para o som.

Pré-requisitos

The following packages are recommended:

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

Security concerns

File:Shellbox with music notes.png

Use Shellbox to secure LilyPond to protect your wiki!

Score uses LilyPond in safe mode, however there are known unfixed safe mode escape vulnerabilities leading to arbitrary execution.

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. Keep safe mode enabled, even with containment as an extra layer of defense. Certain functionality will not work in safe mode, the fix for that is to modify LilyPond to allow that functionality in safe mode.

Instalação

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

• <translate> [[<tvar name=2>Special:ExtensionDistributor/Score/pt</tvar>|Download]] and move the extracted <tvar name=name>Score/pt</tvar> folder to your <tvar name=ext>extensions/</tvar> directory.</translate>
  <translate> Developers and code contributors should install the extension [[<tvar name=git>Special:MyLanguage/Download from Git</tvar>|from Git]] instead, using:</translate>cd extensions/
git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/Score%2Fpt
• <translate> Add the following code at the bottom of your <tvar name=1>LocalSettings.php </tvar> file:</translate>

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

• Crie uma pasta (diretório) chamado lilypond em seu $wgUploadDirectory (geralmente o é chamado images dentro da pasta MediaWiki). Make sure the directory is writable by your Web server.
• File:OOjs UI icon check-constructive.svg <translate> Done</translate> – <translate> Navigate to <tvar name=special>Special:Version</tvar> on your wiki to verify that the extension is successfully installed.</translate>

Configuration

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

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

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.

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

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

• Vexflow Open source SVG/Canvas music renderer

• LilyPond notation
• ABC notation

• vexflow github repository