Ebe123 has uploaded a new change for review. (
https://gerrit.wikimedia.org/r/370305 )
Change subject: Update documentation
......................................................................
Update documentation
Rendered the installation guide up-to-date and
matched the documentation of the tag attributes
to the code.
Bug: T113046
Change-Id: Ie4818d6a9edc18c1cefdbcbff217ed0721130f1c
---
M README
1 file changed, 15 insertions(+), 21 deletions(-)
git pull ssh://gerrit.wikimedia.org:29418/mediawiki/extensions/Score
refs/changes/05/370305/1
diff --git a/README b/README
index bece82e..834e7bf 100644
--- a/README
+++ b/README
@@ -15,24 +15,22 @@
for more information.
-This extension was tested with LilyPond 2.12.3.
+This extension was tested with LilyPond 2.12.3 through 2.18.2.
Setup
=====
1. Change to the "extensions" directory of your MediaWiki installation.
-2. Create a new subdirectory named "Score".
-3. Copy the files Score.php, Score.body.php and Score.i18n.php into the new
- subdirectory. Make sure they are readable by your webserver.
-4. Create a subdirectory named "lilypond" in your $wgUploadDirectory (usually
+2. Clone this repository.
+3. 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 webserver. If you do not create this
directory, the Score extension will attempt to create it for you with the
rights available to it.
-5. Add the lines
+4. Add the lines
- require_once("$IP/extensions/Score/Score.php");
+ wfLoadExtension( 'score' );
$wgScoreLilyPond = '/path/to/your/lilypond/executable'; /* required */
$wgScoreAbc2Ly = '/path/to/your/abc2ly/executable'; /* if you want ABC to
LilyPond conversion
*/
@@ -79,9 +77,8 @@
</score>.
* Attribute: midi
- Allowed values: 0 (default), 1
- Effect: If set to 1, the rendered image(s) will be embedded into a hyperlink
- to an appropriate MIDI file.
+ Effect: If included in the tag, the rendered image(s) will be embedded into a
+ hyperlink to an appropriate MIDI file.
* Attribute: override_ogg
Allowed values: Known file name, that is, if override_ogg="name" is given,
@@ -95,16 +92,13 @@
page, if you prefer.
* Attribute: raw
- Allowed valued: 0 (default), 1
- Effect: 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.
+ Effect: If included in the tag, 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.
* Attribute: vorbis
- Allowed values: 0 (default), 1
- Effect: If set to 1, an Ogg/Vorbis file will be generated for the score,
- provided you installed and configured the OggHandler extension.
- An Ogg/Vorbis player will be embedded in the HTML below the score
- image(s).
-
+ Effect: If included in the tag, an Ogg/Vorbis file will be generated for the
+ score, provided you installed and configured the OggHandler
+ extension. An Ogg/Vorbis player will be embedded in the HTML below
+ the score image(s).
--
To view, visit https://gerrit.wikimedia.org/r/370305
To unsubscribe, visit https://gerrit.wikimedia.org/r/settings
Gerrit-MessageType: newchange
Gerrit-Change-Id: Ie4818d6a9edc18c1cefdbcbff217ed0721130f1c
Gerrit-PatchSet: 1
Gerrit-Project: mediawiki/extensions/Score
Gerrit-Branch: master
Gerrit-Owner: Ebe123 <beauleetien...@gmail.com>
_______________________________________________
MediaWiki-commits mailing list
MediaWiki-commits@lists.wikimedia.org
https://lists.wikimedia.org/mailman/listinfo/mediawiki-commits
