LyricExtension - Revision history

Trevorp: /* Installation */

2006-06-11T06:08:25Z

Installation

←Older revision		Revision as of 06:08, 11 June 2006
Line 55:		Line 55:
	*Extensions:		*Extensions:
	**Parser hooks:		**Parser hooks:
-	***''[http://wiki.peacocktech.com/wiki/LyricExtension Lyric Extension (version 0.1)]'', Adds features allowing easy notation of lyrics in mediawiki, by [http://about.peacocktech.com/trevorp/ Trevor Peacock]	+	***''[http://wiki.peacocktech.com/wiki/LyricExtension Lyric Extension (version 0.2)]'', Adds features allowing easy notation of lyrics in mediawiki, by [http://about.peacocktech.com/trevorp/ Trevor Peacock]
	**Extension functions:		**Extension functions:
	***LyricExtension		***LyricExtension

Trevorp: /* Details */

2006-06-11T06:06:50Z

Details

←Older revision		Revision as of 06:06, 11 June 2006
Line 2:		Line 2:

	==Details==		==Details==
-	*Version 0.1	+	*Version 0.2
-	*Date 18 May 2006	+	*Date 1 June 2006
	*Tested on MediaWiki 1.6devel, PHP 5.0.5 (apache2handler)		*Tested on MediaWiki 1.6devel, PHP 5.0.5 (apache2handler)

Line 9:		Line 9:
	*Allows basic lyric notation		*Allows basic lyric notation
	*Optional CSS styling embedded in every page		*Optional CSS styling embedded in every page
		+	*Remove CSS from metadata. Replace with insert
		+	*Allow extension script file to be run as a standalone php file, to generate CSS data.

	==Usage==		==Usage==

Trevorp: /* Source Code */

2006-06-01T03:24:29Z

Source Code

←Older revision		Revision as of 03:24, 1 June 2006
Line 72:		Line 72:
	[[LyricExtension/History\|Full History]]		[[LyricExtension/History\|Full History]]
	==Source Code==		==Source Code==
		+	Authoritative version of source code available at [[LyricExtension/Source_Code]].
	{{:LyricExtension/Source_Code}}		{{:LyricExtension/Source_Code}}

	[[LyricExtension/Source_Code_Dev\|Development version]]		[[LyricExtension/Source_Code_Dev\|Development version]]

Trevorp: /* Source Code */

2006-06-01T03:20:33Z

Source Code

←Older revision		Revision as of 03:20, 1 June 2006
Line 72:		Line 72:
	[[LyricExtension/History\|Full History]]		[[LyricExtension/History\|Full History]]
	==Source Code==		==Source Code==
-	<pre>	+	{{:LyricExtension/Source_Code}}
-	<?php	+

-	#	+	[[LyricExtension/Source_Code_Dev\|Development version]]
-	# Simple lyric parser extension for mediawiki.	+
-	# Written by Trevor Peacock, 18 May 2006	+
-	# version 0.1	+
-	# Tested on MediaWiki 1.6devel, PHP 5.0.5 (apache2handler)	+
-	#	+
-	# developed to support the notation of lyrics in mediawiki.	+
-	# see http://lyricwiki.org/User:TrevorP/Notation	+
-	#	+
-	# Features:	+
-	# * Allows basic lyric notation	+
-	# * Optional CSS styling embedded in every page	+
-	#	+
-	# To install, copy this file into "extensions" directory, and add	+
-	# the following line to the end of LocalSettings.php	+
-	# (above the ? > )	+
-	#	+
-	# require("extensions/lyric.php");	+
-	#	+
-		+
-	################################################################################	+
-	# Extension Credits Definition	+
-	#	+
-	# This section has no configuration, and can be ignored.	+
-	#	+
-		+
-	$wgExtensionCredits["parserhook"][]=array(	+
-	'name' => 'Lyric Extension',	+
-	'version' => '0.1',	+
-	'url' => 'http://wiki.peacocktech.com/wiki/LyricExtension',	+
-	'author' => '[http://about.peacocktech.com/trevorp/ Trevor Peacock]',	+
-	'description' => 'Adds features allowing easy notation of lyrics in mediawiki' );	+
-		+
-		+
-	################################################################################	+
-	# Lyric Render Section	+
-	#	+
-	# This section has no configuration, and can be ignored.	+
-	#	+
-	# This section renders <lyric> tags. It forces a html break on every line,	+
-	# and styles the section with a css id.	+
-	# this id can either be in the mediawiki css files, or defined by the extension	+
-	#	+
-		+
-	#Instruct mediawiki to call LyricExtension to initialise new extension	+
-	$wgExtensionFunctions[] = "LyricExtension";	+
-		+
-	#Install extension	+
-	function LyricExtension()	+
-	{	+
-	#install hook on the element <lyric>	+
-	global $wgParser;	+
-	$wgParser->setHook("lyric", "renderLyric");	+
-	}	+
-		+
-	#render <lyric> text	+
-	function renderLyric($input, $argv)	+
-	{	+
-	#make new lines in wikitext new lines in html	+
-	$transform=str_replace(array("\r\n", "\r","\n"), "<br/>", trim($input));	+
-		+
-	#define css lyric style	+
-	$transform="<div id=\"lyric\">".$transform."</div>";	+
-		+
-	#parse embedded wikitext	+
-	global $wgOut;	+
-	return $wgOut->parse($transform, false);	+
-	}	+
-		+
-	################################################################################	+
-	# CSS Styling Section	+
-	#	+
-	# This section may require configuration.	+
-	#	+
-	# This section adds a css style to all pages to style lyric sections	+
-	#	+
-		+
-	# If you wish to manually define the style in the css templates,	+
-	# add a "#" at the start of this line:	+
-	$wgHooks['SkinTemplateSetupPageCss'][] = 'LyricCss';	+
-		+
-	function LyricCss(&$css) {	+
-	$css = "/<![CDATA[/\n".	+
-	"#lyric {\n".	+
-	" padding: 1em;\n".	+
-	" border: 1px solid silver;\n".	+
-	" color: black;\n".	+
-	" background-color: #ffffcc;\n".	+
-	"}\n".	+
-	"\n/]]>/";	+
-	return true;	+
-	}	+
-		+
-	?>	+
-	</pre>	+

Trevorp at 11:17, 18 May 2006

2006-05-18T11:17:35Z

←Older revision		Revision as of 11:17, 18 May 2006
Line 61:		Line 61:
	The SkinTemplateSetupPageCss:LyricCss hook may be disabled, and if done so, will not appear.		The SkinTemplateSetupPageCss:LyricCss hook may be disabled, and if done so, will not appear.

		+	==Releases==
		+	===Todo===
		+	{{:LyricExtension/Todo}}
		+	[[LyricExtension/Todo\|Full Todo]]
		+	===RoadMap===
		+	{{:LyricExtension/RoadMap}}
		+	[[LyricExtension/RoadMap\|Full RoadMap]]
		+	===History===
		+	{{:LyricExtension/History}}
		+	[[LyricExtension/History\|Full History]]
	==Source Code==		==Source Code==
	<pre>		<pre>
Line 160:		Line 170:
	?>		?>
	</pre>		</pre>
-
-	==History==
-	===0.1 - Date 18 May 2006===
-	No Functional change.
-	*Fixed wgExtensionCredits
-
-	===0.1 - Date 17 May 2006===
-	First release
-	*Allows basic lyric notation
-	*Optional CSS styling embedded in every page

Trevorp: /* 0.1 - Date 18 May 2006 */

2006-05-18T03:00:49Z

0.1 - Date 18 May 2006

←Older revision		Revision as of 03:00, 18 May 2006
Line 163:		Line 163:
	==History==		==History==
	===0.1 - Date 18 May 2006===		===0.1 - Date 18 May 2006===
-	Fixed wgExtensionCredits
-
	No Functional change.		No Functional change.
		+	*Fixed wgExtensionCredits
		+
	===0.1 - Date 17 May 2006===		===0.1 - Date 17 May 2006===
	First release		First release
	*Allows basic lyric notation		*Allows basic lyric notation
	*Optional CSS styling embedded in every page		*Optional CSS styling embedded in every page

Trevorp at 02:59, 18 May 2006

2006-05-18T02:59:26Z

←Older revision		Revision as of 02:59, 18 May 2006
Line 160:		Line 160:
	?>		?>
	</pre>		</pre>
		+
		+	==History==
		+	===0.1 - Date 18 May 2006===
		+	Fixed wgExtensionCredits
		+
		+	No Functional change.
		+	===0.1 - Date 17 May 2006===
		+	First release
		+	*Allows basic lyric notation
		+	*Optional CSS styling embedded in every page

Trevorp: /* Installation */

2006-05-18T02:55:27Z

Installation

←Older revision		Revision as of 02:55, 18 May 2006
Line 47:		Line 47:
	Insert the following line into the end of 'LocalSettings.php' (before the '?>')		Insert the following line into the end of 'LocalSettings.php' (before the '?>')
	require("extensions/lyric.php");		require("extensions/lyric.php");
		+
		+	To check to see if it is installed properly, visit your Version page, eg [[Special:Version]].
		+
		+	You should see the following items:
		+	*Extensions:
		+	**Parser hooks:
		+	***''[http://wiki.peacocktech.com/wiki/LyricExtension Lyric Extension (version 0.1)]'', Adds features allowing easy notation of lyrics in mediawiki, by [http://about.peacocktech.com/trevorp/ Trevor Peacock]
		+	**Extension functions:
		+	***LyricExtension
		+	*Hooks:
		+	**SkinTemplateSetupPageCss:LyricCss
		+
		+	The SkinTemplateSetupPageCss:LyricCss hook may be disabled, and if done so, will not appear.

	==Source Code==		==Source Code==

Trevorp: /* Details */

2006-05-18T02:51:30Z

Details

←Older revision		Revision as of 02:51, 18 May 2006
Line 3:		Line 3:
	==Details==		==Details==
	*Version 0.1		*Version 0.1
-	*Date 17 May 2006	+	*Date 18 May 2006
	*Tested on MediaWiki 1.6devel, PHP 5.0.5 (apache2handler)		*Tested on MediaWiki 1.6devel, PHP 5.0.5 (apache2handler)

Line 9:		Line 9:
	*Allows basic lyric notation		*Allows basic lyric notation
	*Optional CSS styling embedded in every page		*Optional CSS styling embedded in every page
		+
	==Usage==		==Usage==
	Once installed, simply surround lyrics with <nowiki><lyric></nowiki> tags. No indentation of lyrics is needed.		Once installed, simply surround lyrics with <nowiki><lyric></nowiki> tags. No indentation of lyrics is needed.

Trevorp: /* Source Code */

2006-05-18T02:51:04Z

Source Code

←Older revision		Revision as of 02:51, 18 May 2006
Line 53:		Line 53:
	#		#
	# Simple lyric parser extension for mediawiki.		# Simple lyric parser extension for mediawiki.
-	# Written by Trevor Peacock, 17 May 2006	+	# Written by Trevor Peacock, 18 May 2006
	# version 0.1		# version 0.1
	# Tested on MediaWiki 1.6devel, PHP 5.0.5 (apache2handler)		# Tested on MediaWiki 1.6devel, PHP 5.0.5 (apache2handler)
Line 77:		Line 77:
	#		#

-	$wgExtensionCredits["LyricExtension"]=array(	+	$wgExtensionCredits["parserhook"][]=array(
	'name' => 'Lyric Extension',		'name' => 'Lyric Extension',
	'version' => '0.1',		'version' => '0.1',
	'url' => 'http://wiki.peacocktech.com/wiki/LyricExtension',		'url' => 'http://wiki.peacocktech.com/wiki/LyricExtension',
-	'author' => '<a href="http://about.peacocktech.com/trevorp/">Trevor Peacock</a>',	+	'author' => '[http://about.peacocktech.com/trevorp/ Trevor Peacock]',
	'description' => 'Adds features allowing easy notation of lyrics in mediawiki' );		'description' => 'Adds features allowing easy notation of lyrics in mediawiki' );