Tillägg:Score
Tillägget Score kräver att man installerar en extern tjänst, Shellbox , för att på ett säkert sätt behandla musiknotation via LilyPond. Granska informationen i #Säkerhetsrisker och säkerhetsråd från 2021 innan du installerar tillägget. |
Score Utgivningsstatus: stabil |
|
---|---|
Genomförande | Tagg |
Beskrivning | Gör så att man kan rendera musiknotation med LilyPond |
Författare | Alexander Klauer, Étienne Beaulé |
Senaste versionen | 0.3.0 (2019-03-23) |
MediaWiki | 1.36+ |
PHP | 5.3+ |
Licenser | GNU General Public License 3.0 eller senare |
Ladda ner | README.md |
|
|
score |
|
Kvartalsnedladdningar | 30 (Ranked 102nd) |
Offentliga wikier som använder | 918 (Ranked 265th) |
Översätt tillägget Score om det finns tillgängligt på translatewiki.net | |
Ärenden | Öppna ärenden · Rapportera en bugg |
Med tillägget Score kan man rendera musiknotation som PNG-bilder med hjälp av LilyPond och förvandla dem till ljud och MIDI-filer.
Erkännanden
- Den ursprungliga Extension:LilyPond skrevs av Johannes E. Schindelin.
- Tillägget bygger på en kodgranskning av Extension:LilyPond av Tim Starling.
- Den ursprungliga Extension:ABC skrevs av River Tarnell.
Användning
Efter installation kan du bädda in enkel LilyPond-notation i din wikitext inuti en <score>...</score>
-tagg. Till exempel:
<score>\relative c' { f d f a d f e d cis a cis e a g f e }</score>
ger:
Du kan också ange attribut till score-taggarna i det allmänna formatet
<score attribute1="value1" attribute2="value2">…</score>.
Till exempel:
<score sound="1">\relative c' { \set Staff.midiInstrument = "tenor sax" f d f a d f e d cis a cis e a g f e }</score>
ger:
Följande attribut är tillgängliga:
Attribut | Tillåtna värden | Effekt |
---|---|---|
lang | ABC, lilypond (default) | Anger not-språk. Till exempel, för att ange noter i ABC-notation kan du använda: <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 | (borttagen) Detta brukade styra om bilden av de renderade noterna länkade till en MIDI-fil. | |
override_midi | Känt filnamn, det vill säga, om override_midi="name" har angivits, ger [[File:name]] inte en röd länk. |
(avvecklad) Istället kan du lägga till en [[File:superior midi filename.mid]] -wikilänk efter den avslutande </score> -taggen.Använder den angivna MIDI-filen istället för att generera en med LilyPond. Använd detta attribut tillsammans med midi-attributet (se tidigare) eller ljudattributet (se senare). Detta attribut är användbart om du redan har en MIDI-fil vars kvalitet är bättre än den som skulle ha genererats av LilyPond. |
override_audio | Känt filnamn, det vill säga om override_audio="name" ges, ger [[File:Name]] inte en röd länk |
(avvecklad) Istället kan du lägga till en [[File:superior audio filename.oga]] -wikilänk efter den avslutande </score> -taggen.Bäddar in median som anges av filnamnet i HTML efter not-bilden (eller -bilderna). Detta är ett alternativ till ljudattribut (se vidare). Det kan, exempelvis, vara användbart om du har en lämplig ljudfil av bättre kvalitet än den automatiskt genererade ljudfilen. Om du föredrar det kan du förstås alltid utelämna båda attributen i detta fall och lägga till filen manuellt på sidan. |
override_ogg | (avvecklad) Dubbelt-föråldrat alias för override_audio. | |
raw | 0 (default), 1 | Om satt till 1 tolkas score-koden som en fullständig LilyPond-fil. Använd det här alternativet om du vill skapa mer avancerade noter. Om score-språket (lang-attributet) inte ställts till lilypond ignoreras det här attributet. Som standard (när raw=0) packas den angivna koden i ett \score{...} -block, tillsammans med standard \layout{...} och \midi{...} -block, om det inte redan angetts.
|
sound | 0 (default), 1 | Om ställd till 1 kommer en ljudfil genereras för notationen, förutsatt att du installerat och konfigurerat Tillägg:TimedMediaHandler . En ljudspelare kommer bäddas in i HTML efter notationsbild(erna). |
vorbis | 0 (default), 1 | (avvecklad) Alias för sound. |
LilyPond-språket
Låttexter kan läggas till så här:
<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>
För erfarna användare, kan \set Staff.midiInstrument
-kommandot användas för att ändra ljudets MIDI-instrument.
Krav
Följande packet rekommenderas:
- LilyPond
- Ghostscript
- ImageMagick
- FluidSynth
- Firejail
Det här tillägget använder LiltPond för att rendera not-bilder, så du behöver en fungerande LilyPond-installation (Special:Version visar LilyPond-versionen). Om du installerar LilyPond från ett paket kommer Ghostscript också installeras, eftersom LilyPond beror på Ghostscript. ImageMagick bör installeras för att trimma bilder, annars kommer de innehålla överdrivet mycket tomrum.
Av säkerhetsskäl rekommenderas det starkt att installera firejail för att vidare begränsa vad LilyPond och Ghostscript kan göra om obetrodda användare tillåts redigera på din wiki.
Tillägget kan också skapa ljudfiler från MIDI-filerna som genererats av LilyPond. Vill du använda den här funktionaliteten behöver du installera Tillägg:TimedMediaHandler .
FluidSynth är den föredragna metoden för att konvertera MIDI-filer till ljudfiler, men TiMidity++ stöds också.
Säkerhetsproblem
Score använder LilyPond i säkert läge, men det finns kända oåtgärdade svagheter hos säkert läge som leder till godtycklig prestanda.
Om du inte helt litar på alla som kan redigera på din wiki rekommenderas det starkt att innesluta lilypond med Shellbox . Se Shellbox#Server setup för detaljer på hur man sätter upp den inneslutna servern, och nedan för att konfigurera MediaWiki för att använda det. Se också till att du använder en ny version av LilyPond (2.22.0+) eller ett distribuerat paket (t.ex. från Debian) som har säkerhetslösningar. Håll säkert läge aktiverat, även med inneslutning som ett extra lager av skydd. Viss funktionalitet kommer inte fungera i säkert läge, man kan lösa detta genom att modifiera LilyPond till att tillåta funktionalitet i säkert läge.
Installation
- See the extension's
README.md
for detailed installation instructions.
- Ladda ner och placera filen/filerna i en katalog som heter
Score
i dinextensions/
-mapp.
Utvecklare och personer som bidrar med kod borde istället installera tillägget från Git, med:cd extensions/
git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/Score - Lägg till följande kod längst ner i din LocalSettings.php -fil:
wfLoadExtension( 'Score' ); $wgScoreTrim = true; $wgImageMagickConvertCommand = '/usr/bin/convert'; $wgShellboxUrl = '... address to Shellbox ...'; $wgShellboxSecretKey = '... your secret key ...';
- Skapa en underkatalog med namnet
lilypond
i din $wgUploadDirectory (oftast katalogen med namnetimages
i din MediaWiki-katalog). Se till att katalogen är kan skrivas av din webbserver. - Klart – Ta dig till Special:Version på din wiki för att bekräfta att tillägget har installerats ordentligt.
Konfigurering
Här följer några av tilläggets globala konfigurationsparametrar.
$wgScoreLilyPond
Ange $wgScoreLilyPond
i vägen till din LiltPond-executable (oftast /usr/bin/lilypond
eller /usr/local/bin/lilypond
).
$wgScoreTrim
$wgScoreTrim
är en boolesk som faller tillbaka på värdet hos $wgUseImageMagick
. Om true
trimmas de resulterande notations-PNG-bilderna med ImageMagick. Om du inte vill att de ska trimmas eller inte vill installera ImageMagick, ange $wgScoreTrim
till false
.
$wgScoreAbc2Ly
Ange $wgScoreAbc2Ly
till din ABC:s väg till LilyPond-konverterar-executable (oftast /usr/bin/abc2ly
eller /usr/local/bin/abc2ly
).
$wgScoreFluidsynth
Ange $wgScoreFluidsynth
till din Fluidsynth-executables väg (oftast /usr/bin/fluidsynth
eller /usr/local/bin/fluidsynth
).
$wgScoreSoundfont
Ange $wgScoreSoundfont
till din soundfont-fils väg (oftast /usr/share/sounds/sf2/FluidR3_GM.sf2
eller /usr/share/sounds/sf2/FluidR3_GS.sf2
).
$wgScoreLame
Ange $wgScoreLame
till din Lame-executables väg (oftast /usr/bin/lame
eller /usr/local/bin/lame
). Krävs om den genererade ljudfilen ska vara en MP3.
Anmärkningar
Det här tillägget kör diverse binärer i en Shellbox för att erbjuda viss säkerhet. Du kan behöva öka din $wgMaxShellMemory om du får "för lite minne"-fel.
Hitta noter
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.
Se även
- Help:Score på engelskspråkiga Wikipedia och Help:Sheet music på Wikisource har fler exempel på LilyPond-syntax.
- LilyPond-notation
- ABC-notation
Det här tillägget används på ett eller fler av Wikimedias projekt. Det betyder förmodligen att tillägget är stabilt och fungerar tillräckligt bra för att användas på högtrafikerade hemsidor. Leta efter tilläggets namn i Wikimedias CommonSettings.php och InitialiseSettings.php-konfigureringsfiler för att se var det har installerats. En fullständig lista över tillägg som installerats på en wiki finns på wikins Special:Version-sida. |
Tillägget ingår i följande wikihotell och/eller paket: Detta är inte en auktoritär lista. Vissa wikihotell och/eller paket kan innehålla detta tillägg även om de inte listas här. Kontrollera alltid med ditt wikihotell eller -bunt för bekräftelse. |