Humdrum wiki extension - Revision history

Craig: /* Musical incipits */

2018-12-15T08:05:13Z

Musical incipits

← Older revision		Revision as of 08:05, 15 December 2018
Line 206:		Line 206:
	=== Musical incipits ===		=== Musical incipits ===

	There is a special option called '''incipit''' that displays only the first system of music. Here is an example of incipits for each movement of example Mozart sonata:		There is a special option called '''incipit''' that displays only the first system of music. Here is an example of incipits for each movement of the example Mozart sonata:

	Movement 1:		Movement 1:

Craig: /* Options */

2018-12-15T01:03:49Z

Options

@@ Line 201: / Line 201: @@
              scale="33"
              filter="myank -m 10-11"
     &gt;&lt;/humdrum&gt;

Craig: /* Options */

2018-12-15T00:56:35Z

Options

← Older revision		Revision as of 00:56, 15 December 2018
Line 187:		Line 187:

	In this case, the music is downloaded from the Github repository https://github.com/craigsapp/moart-piano-sonatas, specified by the '''url''' attribute. The '''scale''' attribute sets the music notation size to 33% of the default size in verovio (the humdrum plugin uses a default of 40%), and the '''header''' tag, when set to "true", displays the title and composer information above the first system of the music.		In this case, the music is downloaded from the Github repository https://github.com/craigsapp/moart-piano-sonatas, specified by the '''url''' attribute. The '''scale''' attribute sets the music notation size to 33% of the default size in verovio (the humdrum plugin uses a default of 40%), and the '''header''' tag, when set to "true", displays the title and composer information above the first system of the music.


			Here is an example of downloading the same score, but only displaying measures 10 and 11 using the filter option:

			<humdrum
			url="https://raw.githubusercontent.com/craigsapp/mozart-piano-sonatas/master/kern/sonata06-3c.krn"
			scale="33"
			filter="myank -m 10-11"
			></humdrum>

			<humdrum
			url="https://raw.githubusercontent.com/craigsapp/mozart-piano-sonatas/master/kern/sonata06-3c.krn"
			scale="33"
			filter="myank -m 10-11"
			></humdrum>

	== Installation ==		== Installation ==

Craig: /* Options */

2018-12-14T18:57:59Z

Options

← Older revision		Revision as of 18:57, 14 December 2018
Line 186:		Line 186:
	></humdrum>		></humdrum>

	In this case, the music is downloaded from the Github repository https://github.com/craigsapp/moart-piano-sonatas, specified by the url attribute. The scale attribute sets the music notation size to 33% of the default size in verovio (the humdrum plugin uses a default of 40%), and the header tag, when set to "true", displays the title and composer information above the first system of the music.		In this case, the music is downloaded from the Github repository https://github.com/craigsapp/moart-piano-sonatas, specified by the '''url''' attribute. The '''scale''' attribute sets the music notation size to 33% of the default size in verovio (the humdrum plugin uses a default of 40%), and the '''header''' tag, when set to "true", displays the title and composer information above the first system of the music.

	== Installation ==		== Installation ==

Craig: /* Installation */

2018-12-14T18:54:21Z

Installation

← Older revision		Revision as of 18:54, 14 December 2018
Line 206:		Line 206:
	* Humdrum music notation extension for MediaWiki.		* Humdrum music notation extension for MediaWiki.
	*		*
	* Craig Stuart Sapp <craig@ccrma.stanford.edu~~>~~		* Craig Stuart Sapp <craig@ccrma.stanford.edu>
	* Wed Dec 12 14:54:26 PST 2018		* Wed Dec 12 14:54:26 PST 2018
	* Developed for use in MediaWiki 1.24		* Developed for use in MediaWiki 1.24
	*		*
	* This <humdrum~~>~~ tag extension converts Humdrum scores into SVG images using		* This <humdrum> tag extension converts Humdrum scores into SVG images using
	* the Verovio toolkit on a MediaWiki-based wiki (https://www.mediawiki.org/wiki/MediaWiki).		* the Verovio toolkit on a MediaWiki-based wiki (https://www.mediawiki.org/wiki/MediaWiki).
	* The extension loads two external javascript libraries to produce SVG images		* The extension loads two external javascript libraries to produce SVG images
Line 222:		Line 222:
	* wikis (such as Wikipedia).		* wikis (such as Wikipedia).
	*		*
	* The extension will convert a <humdrum~~>~~ tag such as this:		* The extension will convert a <humdrum> tag such as this:
	*		*
	* <humdrum scale="40"~~>~~		* <humdrum scale="40">
	* **kern		* **kern
	* *clefG2		* *clefG2
Line 231:		Line 231:
	* ==		* ==
	* *-		* *-
	* </humdrum~~>~~		* </humdrum>
	*		*
	* into the following HTML code inserted onto the page:		* into the following HTML code inserted onto the page:
	*		*
	* <script~~>~~		* <script>
	* displayHumdrum({		* displayHumdrum({
	* "scale": "40"		* "scale": "40"
	* })		* })
	* </script~~>~~		* </script>
	* <script type="text/x-humdrum" id="example"~~>~~		* <script type="text/x-humdrum" id="example">
	* **kern		* **kern
	* *clefG2		* *clefG2
Line 247:		Line 247:
	* ==		* ==
	* *-		* *-
	* </script~~>~~		* </script>
	*		*
	* The scale parameter sets the size of the music. Additional parameters		* The scale parameter sets the size of the music. Additional parameters
	* are listed at https://plugin.humdrum.org/options. The first use of		* are listed at https://plugin.humdrum.org/options. The first use of
	* the <humdrum~~>~~ tag will insert the following initializtion code:		* the <humdrum> tag will insert the following initializtion code:
	*		*
	* <script src="https://verovio-script.humdrum.org/scripts/verovio-toolkit.js"~~>~~</script~~>~~		* <script src="https://verovio-script.humdrum.org/scripts/verovio-toolkit.js"></script>
	* <script src="https://plugin.humdrum.org/scripts/humdrum-plugin.js"~~>~~</script~~>~~		* <script src="https://plugin.humdrum.org/scripts/humdrum-plugin.js"></script>
	* <script~~>~~var vrvToolkit = new verovio.toolkit()</script~~>~~		* <script>var vrvToolkit = new verovio.toolkit()</script>
	*		*
	*		*
Line 268:		Line 268:
	$wgExtensionFunctions[] = 'wfHumdrum';		$wgExtensionFunctions[] = 'wfHumdrum';
	$wgExtensionCredits['parserhook'][] = array(		$wgExtensionCredits['parserhook'][] = array(
	'name'=~~>~~'Humdrum',		'name'=>'Humdrum',
	'author'=~~>~~'Craig Stuart Sapp',		'author'=>'Craig Stuart Sapp',
	'url'=~~>~~'http://www.mediawiki.org/wiki/Extension:Humdrum',		'url'=>'http://www.mediawiki.org/wiki/Extension:Humdrum',
	'description'=~~>~~'Humdrum music notation renderer',		'description'=>'Humdrum music notation renderer',
	);		);

Line 288:		Line 288:
	return Humdrum::hookHumdrum($input, $argv, $parser, $frame, $tagName);		return Humdrum::hookHumdrum($input, $argv, $parser, $frame, $tagName);
	};		};
	$parser-~~>~~setHook($tagName, $callback);		$parser->setHook($tagName, $callback);
	return true;		return true;
	}		}
Line 298:		Line 298:
	}		}

	# hookHumdrum -- The hook function. Handles <humdrum~~>~~</humdrum~~>~~.		# hookHumdrum -- The hook function. Handles <humdrum></humdrum>.
	# Receives the Humdrum content and <humdrum~~>~~ parameters.		# Receives the Humdrum content and <humdrum> parameters.
	public static function hookHumdrum($humdrumText, $argv, $parser, $frame, $tagName) {		public static function hookHumdrum($humdrumText, $argv, $parser, $frame, $tagName) {

	// prevent caching of pages using the extension		// prevent caching of pages using the extension
	$parser-~~>~~disableCache();		$parser->disableCache();

	// Build the displayHumdrum parameters string from the tag parameters		// Build the displayHumdrum parameters string from the tag parameters
	// and insert into a <script~~>~~ element.		// and insert into a <script> element.
	global $tagCounter;		global $tagCounter;
	$source = "";		$source = "";
	$optionContainer = "<script~~>~~displayHumdrum({";		$optionContainer = "<script>displayHumdrum({";
	foreach ($argv as $key =~~>~~ $val) {		foreach ($argv as $key => $val) {
	$optionContainer .= "\t\"$key\":\t\"$val\",";		$optionContainer .= "\t\"$key\":\t\"$val\",";
	if ($key == "source") {		if ($key == "source") {
Line 323:		Line 323:
	}		}
	$optionContainer = preg_replace('/,$/', "", $optionContainer);		$optionContainer = preg_replace('/,$/', "", $optionContainer);
	$optionContainer .= "})</script~~>~~";		$optionContainer .= "})</script>";

	$humdrumContainer = "<script type=\"text/x-humdrum\" id=\"$source\"~~>~~\n";		$humdrumContainer = "<script type=\"text/x-humdrum\" id=\"$source\">\n";
	$humdrumContainer .= $humdrumText;		$humdrumContainer .= $humdrumText;
	$humdrumContainer .= "</script~~>~~";		$humdrumContainer .= "</script>";

	$initialization = "";		$initialization = "";
	if ($tagCounter == 100) {		if ($tagCounter == 100) {
	# Only include this code the first time an example is placed on the page.		# Only include this code the first time an example is placed on the page.
	$initialization .= "<script src=\"https://verovio-script.humdrum.org/scripts/verovio-toolkit.js\"~~>~~</script~~>~~";		$initialization .= "<script src=\"https://verovio-script.humdrum.org/scripts/verovio-toolkit.js\"></script>";
	$initialization .= "<script src=\"https://plugin.humdrum.org/scripts/humdrum-plugin.js\"~~>~~</script~~>~~";		$initialization .= "<script src=\"https://plugin.humdrum.org/scripts/humdrum-plugin.js\"></script>";
	$initialization .= "<script~~>~~var vrvToolkit = new verovio.toolkit()</script~~>~~";		$initialization .= "<script>var vrvToolkit = new verovio.toolkit()</script>";
	}		}
	$tagCounter++;		$tagCounter++;

	return array("$initialization$optionContainer$humdrumContainer", "markerType" =~~>~~ 'nowiki');		return array("$initialization$optionContainer$humdrumContainer", "markerType" => 'nowiki');
	}		}
	}		}

	?~~>~~		?>
	</syntaxhighlight>		</syntaxhighlight>

Craig: /* Installation */

2018-12-14T18:53:39Z

Installation

← Older revision		Revision as of 18:53, 14 December 2018
Line 200:		Line 200:

	<syntaxhighlight lang="php">		<syntaxhighlight lang="php">
	~~<~~?php		<?php

	/*		/*
Line 206:		Line 206:
	* Humdrum music notation extension for MediaWiki.		* Humdrum music notation extension for MediaWiki.
	*		*
	* Craig Stuart Sapp ~~<~~craig@ccrma.stanford.edu>		* Craig Stuart Sapp <craig@ccrma.stanford.edu>
	* Wed Dec 12 14:54:26 PST 2018		* Wed Dec 12 14:54:26 PST 2018
	* Developed for use in MediaWiki 1.24		* Developed for use in MediaWiki 1.24
	*		*
	* This ~~<~~humdrum> tag extension converts Humdrum scores into SVG images using		* This <humdrum> tag extension converts Humdrum scores into SVG images using
	* the Verovio toolkit on a MediaWiki-based wiki (https://www.mediawiki.org/wiki/MediaWiki).		* the Verovio toolkit on a MediaWiki-based wiki (https://www.mediawiki.org/wiki/MediaWiki).
	* The extension loads two external javascript libraries to produce SVG images		* The extension loads two external javascript libraries to produce SVG images
Line 222:		Line 222:
	* wikis (such as Wikipedia).		* wikis (such as Wikipedia).
	*		*
	* The extension will convert a ~~<~~humdrum> tag such as this:		* The extension will convert a <humdrum> tag such as this:
	*		*
	* ~~<~~humdrum scale="40">		* <humdrum scale="40">
	* **kern		* **kern
	* *clefG2		* *clefG2
Line 231:		Line 231:
	* ==		* ==
	* *-		* *-
	* ~~<~~/humdrum>		* </humdrum>
	*		*
	* into the following HTML code inserted onto the page:		* into the following HTML code inserted onto the page:
	*		*
	* ~~<~~script>		* <script>
	* displayHumdrum({		* displayHumdrum({
	* "scale": "40"		* "scale": "40"
	* })		* })
	* ~~<~~/script>		* </script>
	* ~~<~~script type="text/x-humdrum" id="example">		* <script type="text/x-humdrum" id="example">
	* **kern		* **kern
	* *clefG2		* *clefG2
Line 247:		Line 247:
	* ==		* ==
	* *-		* *-
	* ~~<~~/script>		* </script>
	*		*
	* The scale parameter sets the size of the music. Additional parameters		* The scale parameter sets the size of the music. Additional parameters
	* are listed at https://plugin.humdrum.org/options. The first use of		* are listed at https://plugin.humdrum.org/options. The first use of
	* the ~~<~~humdrum> tag will insert the following initializtion code:		* the <humdrum> tag will insert the following initializtion code:
	*		*
	* ~~<~~script src="https://verovio-script.humdrum.org/scripts/verovio-toolkit.js">~~<~~/script>		* <script src="https://verovio-script.humdrum.org/scripts/verovio-toolkit.js"></script>
	* ~~<~~script src="https://plugin.humdrum.org/scripts/humdrum-plugin.js">~~<~~/script>		* <script src="https://plugin.humdrum.org/scripts/humdrum-plugin.js"></script>
	* ~~<~~script>var vrvToolkit = new verovio.toolkit()~~<~~/script>		* <script>var vrvToolkit = new verovio.toolkit()</script>
	*		*
	*		*
Line 298:		Line 298:
	}		}

	# hookHumdrum -- The hook function. Handles ~~<~~humdrum>~~<~~/humdrum>.		# hookHumdrum -- The hook function. Handles <humdrum></humdrum>.
	# Receives the Humdrum content and ~~<~~humdrum> parameters.		# Receives the Humdrum content and <humdrum> parameters.
	public static function hookHumdrum($humdrumText, $argv, $parser, $frame, $tagName) {		public static function hookHumdrum($humdrumText, $argv, $parser, $frame, $tagName) {

Line 306:		Line 306:

	// Build the displayHumdrum parameters string from the tag parameters		// Build the displayHumdrum parameters string from the tag parameters
	// and insert into a ~~<~~script> element.		// and insert into a <script> element.
	global $tagCounter;		global $tagCounter;
	$source = "";		$source = "";
	$optionContainer = "~~<~~script>displayHumdrum({";		$optionContainer = "<script>displayHumdrum({";
	foreach ($argv as $key => $val) {		foreach ($argv as $key => $val) {
	$optionContainer .= "\t\"$key\":\t\"$val\",";		$optionContainer .= "\t\"$key\":\t\"$val\",";
Line 323:		Line 323:
	}		}
	$optionContainer = preg_replace('/,$/', "", $optionContainer);		$optionContainer = preg_replace('/,$/', "", $optionContainer);
	$optionContainer .= "})~~<~~/script>";		$optionContainer .= "})</script>";

	$humdrumContainer = "~~<~~script type=\"text/x-humdrum\" id=\"$source\">\n";		$humdrumContainer = "<script type=\"text/x-humdrum\" id=\"$source\">\n";
	$humdrumContainer .= $humdrumText;		$humdrumContainer .= $humdrumText;
	$humdrumContainer .= "~~<~~/script>";		$humdrumContainer .= "</script>";

	$initialization = "";		$initialization = "";
	if ($tagCounter == 100) {		if ($tagCounter == 100) {
	# Only include this code the first time an example is placed on the page.		# Only include this code the first time an example is placed on the page.
	$initialization .= "~~<~~script src=\"https://verovio-script.humdrum.org/scripts/verovio-toolkit.js\">~~<~~/script>";		$initialization .= "<script src=\"https://verovio-script.humdrum.org/scripts/verovio-toolkit.js\"></script>";
	$initialization .= "~~<~~script src=\"https://plugin.humdrum.org/scripts/humdrum-plugin.js\">~~<~~/script>";		$initialization .= "<script src=\"https://plugin.humdrum.org/scripts/humdrum-plugin.js\"></script>";
	$initialization .= "~~<~~script>var vrvToolkit = new verovio.toolkit()~~<~~/script>";		$initialization .= "<script>var vrvToolkit = new verovio.toolkit()</script>";
	}		}
	$tagCounter++;		$tagCounter++;

Craig: /* Installation */

2018-12-14T18:52:31Z

Installation

← Older revision		Revision as of 18:52, 14 December 2018
Line 196:		Line 196:
	require_once "$IP/extensions/Humdrum/Humdrum.php";		require_once "$IP/extensions/Humdrum/Humdrum.php";

	(2) Place ~~this~~ file ~~into~~ extensions/Humdrum/Humdrum.php in relation to the base directory of your wiki website:		(2) Place the following contents into a file called extensions/Humdrum/Humdrum.php in relation to the base directory of your wiki website:

Craig: /* Options */

2018-12-14T18:50:50Z

Options

← Older revision		Revision as of 18:50, 14 December 2018
Line 186:		Line 186:
	></humdrum>		></humdrum>

	In this case, the music is downloaded from the Github repository https://github.com/craigsapp/moart-piano-sonatas, specified by the `url` attribute. The `scale` attribute sets the music notation size to 33% of the default size in verovio (the humdrum plugin uses a default of 40%), and the `header` tag, when set to "true", displays the title and composer information above the first system of the music.		In this case, the music is downloaded from the Github repository https://github.com/craigsapp/moart-piano-sonatas, specified by the url attribute. The scale attribute sets the music notation size to 33% of the default size in verovio (the humdrum plugin uses a default of 40%), and the header tag, when set to "true", displays the title and composer information above the first system of the music.

	== Installation ==		== Installation ==

Craig: /* Installation */

2018-12-14T18:49:36Z

Installation

← Older revision		Revision as of 18:49, 14 December 2018
Line 200:		Line 200:

	<syntaxhighlight lang="php">		<syntaxhighlight lang="php">
	&lg;?php		<?php

	/*		/*
Line 206:		Line 206:
	* Humdrum music notation extension for MediaWiki.		* Humdrum music notation extension for MediaWiki.
	*		*
	* Craig Stuart Sapp &lg;craig@ccrma.stanford.edu>		* Craig Stuart Sapp <craig@ccrma.stanford.edu>
	* Wed Dec 12 14:54:26 PST 2018		* Wed Dec 12 14:54:26 PST 2018
	* Developed for use in MediaWiki 1.24		* Developed for use in MediaWiki 1.24
	*		*
	* This &lg;humdrum> tag extension converts Humdrum scores into SVG images using		* This <humdrum> tag extension converts Humdrum scores into SVG images using
	* the Verovio toolkit on a MediaWiki-based wiki (https://www.mediawiki.org/wiki/MediaWiki).		* the Verovio toolkit on a MediaWiki-based wiki (https://www.mediawiki.org/wiki/MediaWiki).
	* The extension loads two external javascript libraries to produce SVG images		* The extension loads two external javascript libraries to produce SVG images
Line 222:		Line 222:
	* wikis (such as Wikipedia).		* wikis (such as Wikipedia).
	*		*
	* The extension will convert a &lg;humdrum> tag such as this:		* The extension will convert a <humdrum> tag such as this:
	*		*
	* &lg;humdrum scale="40">		* <humdrum scale="40">
	* **kern		* **kern
	* *clefG2		* *clefG2
Line 231:		Line 231:
	* ==		* ==
	* *-		* *-
	* &lg;/humdrum>		* </humdrum>
	*		*
	* into the following HTML code inserted onto the page:		* into the following HTML code inserted onto the page:
	*		*
	* &lg;script>		* <script>
	* displayHumdrum({		* displayHumdrum({
	* "scale": "40"		* "scale": "40"
	* })		* })
	* &lg;/script>		* </script>
	* &lg;script type="text/x-humdrum" id="example">		* <script type="text/x-humdrum" id="example">
	* **kern		* **kern
	* *clefG2		* *clefG2
Line 247:		Line 247:
	* ==		* ==
	* *-		* *-
	* &lg;/script>		* </script>
	*		*
	* The scale parameter sets the size of the music. Additional parameters		* The scale parameter sets the size of the music. Additional parameters
	* are listed at https://plugin.humdrum.org/options. The first use of		* are listed at https://plugin.humdrum.org/options. The first use of
	* the &lg;humdrum> tag will insert the following initializtion code:		* the <humdrum> tag will insert the following initializtion code:
	*		*
	* &lg;script src="https://verovio-script.humdrum.org/scripts/verovio-toolkit.js">&lg;/script>		* <script src="https://verovio-script.humdrum.org/scripts/verovio-toolkit.js"></script>
	* &lg;script src="https://plugin.humdrum.org/scripts/humdrum-plugin.js">&lg;/script>		* <script src="https://plugin.humdrum.org/scripts/humdrum-plugin.js"></script>
	* &lg;script>var vrvToolkit = new verovio.toolkit()&lg;/script>		* <script>var vrvToolkit = new verovio.toolkit()</script>
	*		*
	*		*
Line 298:		Line 298:
	}		}

	# hookHumdrum -- The hook function. Handles &lg;humdrum>&lg;/humdrum>.		# hookHumdrum -- The hook function. Handles <humdrum></humdrum>.
	# Receives the Humdrum content and &lg;humdrum> parameters.		# Receives the Humdrum content and <humdrum> parameters.
	public static function hookHumdrum($humdrumText, $argv, $parser, $frame, $tagName) {		public static function hookHumdrum($humdrumText, $argv, $parser, $frame, $tagName) {

Line 306:		Line 306:

	// Build the displayHumdrum parameters string from the tag parameters		// Build the displayHumdrum parameters string from the tag parameters
	// and insert into a &lg;script> element.		// and insert into a <script> element.
	global $tagCounter;		global $tagCounter;
	$source = "";		$source = "";
	$optionContainer = "&lg;script>displayHumdrum({";		$optionContainer = "<script>displayHumdrum({";
	foreach ($argv as $key => $val) {		foreach ($argv as $key => $val) {
	$optionContainer .= "\t\"$key\":\t\"$val\",";		$optionContainer .= "\t\"$key\":\t\"$val\",";
Line 323:		Line 323:
	}		}
	$optionContainer = preg_replace('/,$/', "", $optionContainer);		$optionContainer = preg_replace('/,$/', "", $optionContainer);
	$optionContainer .= "})&lg;/script>";		$optionContainer .= "})</script>";

	$humdrumContainer = "&lg;script type=\"text/x-humdrum\" id=\"$source\">\n";		$humdrumContainer = "<script type=\"text/x-humdrum\" id=\"$source\">\n";
	$humdrumContainer .= $humdrumText;		$humdrumContainer .= $humdrumText;
	$humdrumContainer .= "&lg;/script>";		$humdrumContainer .= "</script>";

	$initialization = "";		$initialization = "";
	if ($tagCounter == 100) {		if ($tagCounter == 100) {
	# Only include this code the first time an example is placed on the page.		# Only include this code the first time an example is placed on the page.
	$initialization .= "&lg;script src=\"https://verovio-script.humdrum.org/scripts/verovio-toolkit.js\">&lg;/script>";		$initialization .= "<script src=\"https://verovio-script.humdrum.org/scripts/verovio-toolkit.js\"></script>";
	$initialization .= "&lg;script src=\"https://plugin.humdrum.org/scripts/humdrum-plugin.js\">&lg;/script>";		$initialization .= "<script src=\"https://plugin.humdrum.org/scripts/humdrum-plugin.js\"></script>";
	$initialization .= "&lg;script>var vrvToolkit = new verovio.toolkit()&lg;/script>";		$initialization .= "<script>var vrvToolkit = new verovio.toolkit()</script>";
	}		}
	$tagCounter++;		$tagCounter++;

Craig: /* Installation */

2018-12-14T18:48:54Z

Installation

← Older revision		Revision as of 18:48, 14 December 2018
Line 190:		Line 190:
	== Installation ==		== Installation ==

	If you have a wiki that uses [https://www.mediawiki.org MediaWiki], then here are instructions for allowing use of the <humdrum> tag to ~~generation~~ music notation on wiki pages:		If you have a wiki that uses [https://www.mediawiki.org MediaWiki], then here are instructions for allowing use of the <humdrum> tag to generate music notation on wiki pages:

	(1) Place this line in the LocalSettings.php file that is located in the base directory of the wiki's website (wherever that is installed on your web server):		(1) Place this line in the LocalSettings.php file that is located in the base directory of the wiki's website (wherever that is installed on your web server):