Merge pull request #11 from wushin/spoilers

Spoilers

12 files changed, 398 insertions, 0 deletions

diff --git a/extensions/Spoilers/LICENSE b/extensions/Spoilers/LICENSE
new file mode 100644
index 0000000..6600f1c
--- /dev/null
+++ b/extensions/Spoilers/LICENSE
@@ -0,0 +1,165 @@
+GNU LESSER GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+
+  This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+  0. Additional Definitions.
+
+  As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+  "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+  An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+  A "Combined Work" is a work produced by combining or linking an
+Application with the Library.  The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+  The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+  The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+  1. Exception to Section 3 of the GNU GPL.
+
+  You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+  2. Conveying Modified Versions.
+
+  If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+   a) under this License, provided that you make a good faith effort to
+   ensure that, in the event an Application does not supply the
+   function or data, the facility still operates, and performs
+   whatever part of its purpose remains meaningful, or
+
+   b) under the GNU GPL, with none of the additional permissions of
+   this License applicable to that copy.
+
+  3. Object Code Incorporating Material from Library Header Files.
+
+  The object code form of an Application may incorporate material from
+a header file that is part of the Library.  You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+   a) Give prominent notice with each copy of the object code that the
+   Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the object code with a copy of the GNU GPL and this license
+   document.
+
+  4. Combined Works.
+
+  You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+   a) Give prominent notice with each copy of the Combined Work that
+   the Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the Combined Work with a copy of the GNU GPL and this license
+   document.
+
+   c) For a Combined Work that displays copyright notices during
+   execution, include the copyright notice for the Library among
+   these notices, as well as a reference directing the user to the
+   copies of the GNU GPL and this license document.
+
+   d) Do one of the following:
+
+       0) Convey the Minimal Corresponding Source under the terms of this
+       License, and the Corresponding Application Code in a form
+       suitable for, and under terms that permit, the user to
+       recombine or relink the Application with a modified version of
+       the Linked Version to produce a modified Combined Work, in the
+       manner specified by section 6 of the GNU GPL for conveying
+       Corresponding Source.
+
+       1) Use a suitable shared library mechanism for linking with the
+       Library.  A suitable mechanism is one that (a) uses at run time
+       a copy of the Library already present on the user's computer
+       system, and (b) will operate properly with a modified version
+       of the Library that is interface-compatible with the Linked
+       Version.
+
+   e) Provide Installation Information, but only if you would otherwise
+   be required to provide such information under section 6 of the
+   GNU GPL, and only to the extent that such information is
+   necessary to install and execute a modified version of the
+   Combined Work produced by recombining or relinking the
+   Application with a modified version of the Linked Version. (If
+   you use option 4d0, the Installation Information must accompany
+   the Minimal Corresponding Source and Corresponding Application
+   Code. If you use option 4d1, you must provide the Installation
+   Information in the manner specified by section 6 of the GNU GPL
+   for conveying Corresponding Source.)
+
+  5. Combined Libraries.
+
+  You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+   a) Accompany the combined library with a copy of the same work based
+   on the Library, uncombined with any other library facilities,
+   conveyed under the terms of this License.
+
+   b) Give prominent notice with the combined library that part of it
+   is a work based on the Library, and explaining where to find the
+   accompanying uncombined form of the same work.
+
+  6. Revised Versions of the GNU Lesser General Public License.
+
+  The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+  Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+  If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.
diff --git a/extensions/Spoilers/README.md b/extensions/Spoilers/README.md
new file mode 100644
index 0000000..f4b7826
--- /dev/null
+++ b/extensions/Spoilers/README.md
@@ -0,0 +1,21 @@
+Spoilers
+========
+
+Mediawiki extension that allows for spoiler tags that will hide a block of text. The spoiler button's show/hide message can be customized for each set.
+
+Installation
+------------
+To install this extension, add the follwoing lines to the end of the LocalSettings.php file:
+```
+//Spoilers
+require("$IP/extensions/Spoilers/Spoilers.php");
+```
+
+Usage Example
+---------------------
+```
+<spoiler hide="hide_message">spoiler_text</spoiler>
+<spoiler show="show_message">spoiler_text</spoiler>
+<spoiler show="show_message" hide="hide_message">spoiler_text</spoiler>
+<spoiler>spoiler_text</spoiler>
+```
diff --git a/extensions/Spoilers/Spoilers.hooks.php b/extensions/Spoilers/Spoilers.hooks.php
new file mode 100644
index 0000000..a2a596a
--- /dev/null
+++ b/extensions/Spoilers/Spoilers.hooks.php
@@ -0,0 +1,51 @@
+<?php
+/**
+ * Spoilers
+ * Spoilers Hooks
+ *
+ * @author: Telshin
+ * @license: LGPLv3 http://opensource.org/licenses/lgpl-3.0.html
+ * @package: Spoilers
+ * @link: http://www.mediawiki.org/wiki/Extension:Spoilers
+ */
+class Spoilers {
+	/**
+	 * Sets up this extensions parser functions.
+	 *
+	 * @access		public
+	 * @param		Parser	$parser
+	 * @internal	param	\Parser $object object passed as a reference.
+	 * @return		boolean	true
+	 */
+	static public function onParserFirstCallInit( Parser &$parser ) {
+		$parser->setHook( "spoiler", "Spoilers::parseSpoilerTag" );
+		return true;
+	}
+
+	/**
+	 * Parses the <spoiler> tag.
+	 *
+	 * @access	public
+	 * @param	string	User input between <spoiler>
+	 * @param	array	Array of arguments from the opening spoiler tag.
+	 * @param	object	Mediawiki Parser Object
+	 * @param	object	PPFrame object
+	 * @return	string	HTML
+	 */
+	static public function parseSpoilerTag( $input, array $args, Parser $parser, PPFrame $frame ) {
+		$out = $parser->getOutput();
+		$out->addModules( 'ext.spoilers' );
+		$renderedInput = $parser->recursiveTagParse( $input );
+		$output =	"<div class='spoilers'>
+						<div class='spoilers-button-container'>
+							<span class='spoilers-button'>
+								<span class='spoilers-show'>" . ( $args['show'] ? htmlentities( $args['show'], ENT_QUOTES) : wfMessage('spoilers_show_default' )->text() ) . "</span>
+								<span class='spoilers-hide' style='display:none;'>" . ( $args['hide'] ? htmlentities( $args['hide'], ENT_QUOTES ) : wfMessage('spoilers_hide_default')->text() ) . "</span>
+							</span>
+						</div>
+						<div class='spoilers-body' style='display:none;'>{$renderedInput}</div>
+					</div>";
+		return $output;
+	}
+}
+?>
diff --git a/extensions/Spoilers/Spoilers.i18n.php b/extensions/Spoilers/Spoilers.i18n.php
new file mode 100644
index 0000000..a5e1460
--- /dev/null
+++ b/extensions/Spoilers/Spoilers.i18n.php
@@ -0,0 +1,36 @@
+<?php
+/**
+ * This is a backwards-compatibility shim, generated by:
+ * https://git.wikimedia.org/blob/mediawiki%2Fcore.git/HEAD/maintenance%2FgenerateJsonI18n.php
+ *
+ * Beginning with MediaWiki 1.23, translation strings are stored in json files,
+ * and the EXTENSION.i18n.php file only exists to provide compatibility with
+ * older releases of MediaWiki. For more information about this migration, see:
+ * https://www.mediawiki.org/wiki/Requests_for_comment/Localisation_format
+ *
+ * This shim maintains compatibility back to MediaWiki 1.17.
+ */
+$messages = array();
+if ( !function_exists( 'wfJsonI18nShimefa4e861731a8843' ) ) {
+	function wfJsonI18nShimefa4e861731a8843( $cache, $code, &$cachedData ) {
+		$codeSequence = array_merge( array( $code ), $cachedData['fallbackSequence'] );
+		foreach ( $codeSequence as $csCode ) {
+			$fileName = dirname( __FILE__ ) . "/i18n/$csCode.json";
+			if ( is_readable( $fileName ) ) {
+				$data = FormatJson::decode( file_get_contents( $fileName ), true );
+				foreach ( array_keys( $data ) as $key ) {
+					if ( $key === '' || $key[0] === '@' ) {
+						unset( $data[$key] );
+					}
+				}
+				$cachedData['messages'] = array_merge( $data, $cachedData['messages'] );
+			}
+
+			$cachedData['deps'][] = new FileDependency( $fileName );
+		}
+		return true;
+	}
+
+	$GLOBALS['wgHooks']['LocalisationCacheRecache'][] = 'wfJsonI18nShimefa4e861731a8843';
+}
+?>
diff --git a/extensions/Spoilers/Spoilers.php b/extensions/Spoilers/Spoilers.php
new file mode 100644
index 0000000..247cfe4
--- /dev/null
+++ b/extensions/Spoilers/Spoilers.php
@@ -0,0 +1,43 @@
+<?php
+/**
+ * Spoilers
+ * Spoilers Mediawiki Settings
+ *
+ * @author: Telshin
+ * @license: LGPLv3 http://opensource.org/licenses/lgpl-3.0.html
+ * @package: Spoilers
+ * @link: http://www.mediawiki.org/wiki/Extension:Spoilers
+ */
+ 
+/******************************************/
+/* Credits                                */
+/******************************************/
+$wgExtensionCredits['specialpage'][] = array (
+												'path'				=>	__FILE__,
+												'name'				=>	'Spoilers',
+												'author'			=>	'Tim Aldridge',
+												'descriptionmsg'	=>	'spoilers_description',
+												'version'			=>	'1.1',
+												'license-name'		=>	'LGPLv3'
+											);
+
+/******************************************/
+/* Language Strings, Page Aliases, Hooks  */
+/******************************************/
+$extDir = dirname( __FILE__ );
+
+$wgMessagesDirs['Spoilers']				= __DIR__ . '/i18n';
+$wgExtensionMessagesFiles['Spoilers']	= $extDir . "/Spoilers.i18n.php";
+
+$wgAutoloadClasses['Spoilers']			= $extDir . "/Spoilers.hooks.php";
+
+$wgResourceModules['ext.spoilers'] = array (
+											'styles'		=> array( 'css/spoilers.css' ),
+											'scripts'		=> array( 'js/spoilers.js' ),
+											'localBasePath'	=> __DIR__,
+											'remoteExtPath'	=> 'Spoilers',
+											'dependencies'	=> array()
+											);
+
+$wgHooks['ParserFirstCallInit'][]		= "Spoilers::onParserFirstCallInit";
+?>
diff --git a/extensions/Spoilers/css/spoilers.css b/extensions/Spoilers/css/spoilers.css
new file mode 100644
index 0000000..10da4b1
--- /dev/null
+++ b/extensions/Spoilers/css/spoilers.css
@@ -0,0 +1,25 @@
+div.spoilers-body {
+    border: 1px dashed #000;
+    background-color: #EEE;
+    padding: 3px;
+}
+
+.spoilers-button-container {
+    padding: 1px 0;
+}
+
+.spoilers-button {
+    background-color: #AAA;
+    background-repeat: no-repeat;
+    background-image: -webkit-linear-gradient(top, #EEE, #AAA);
+    background-image: -moz-linear-gradient(top, #EEE, #AAA);
+    background-image: linear-gradient(to bottom, #EEE, #AAA);
+    border: 1px solid #999;
+    border-radius: 5px;
+    padding: 3px 10px;
+    transition: 0.1s background-position linear;
+}
+
+.spoilers-button:hover {
+    background-position: 0 -6px;
+}
diff --git a/extensions/Spoilers/i18n/ar.json b/extensions/Spoilers/i18n/ar.json
new file mode 100644
index 0000000..3cfce01
--- /dev/null
+++ b/extensions/Spoilers/i18n/ar.json
@@ -0,0 +1,9 @@
+{
+	"@metadata": {
+		"authors": ["Kris Blair"]
+	},
+	"spoilers": "المفسدين",
+	"spoilers_description": "بطاقة المفسدين - &lt;spoiler show=\"showMessage\" hide=\"hideMessage\"&gt;انص المفسدين&lt;/spoiler&gt;",
+	"spoilers_show_default": "عرض المفسدين",
+	"spoilers_hide_default": "تجنب المفسدين"
+}
diff --git a/extensions/Spoilers/i18n/br.json b/extensions/Spoilers/i18n/br.json
new file mode 100644
index 0000000..e98fdb1
--- /dev/null
+++ b/extensions/Spoilers/i18n/br.json
@@ -0,0 +1,9 @@
+{
+	"@metadata": {
+		"authors": ["Kris Blair"]
+	},
+	"spoilers": "Spoilers",
+	"spoilers_description": "Tag de Spoiler - &lt;spoiler show=\"showMessage\" hide=\"hideMessage\"&gt;Texto de Spoiler&lt;/spoiler&gt;",
+	"spoilers_show_default": "Monstrar Spoiler",
+	"spoilers_hide_default": "Esconder Spoiler"
+}
diff --git a/extensions/Spoilers/i18n/en.json b/extensions/Spoilers/i18n/en.json
new file mode 100644
index 0000000..4d5c782
--- /dev/null
+++ b/extensions/Spoilers/i18n/en.json
@@ -0,0 +1,9 @@
+{
+	"@metadata": {
+		"authors": ["Tim Aldridge"]
+	},
+	"spoilers": "Spoilers",
+	"spoilers_description": "Spoiler Tag - &lt;spoiler show=\"showMessage\" hide=\"hideMessage\"&gt;Spoiler Text&lt;/spoiler&gt;",
+	"spoilers_show_default": "Show Spoiler",
+	"spoilers_hide_default": "Hide Spoiler"
+}
diff --git a/extensions/Spoilers/i18n/es.json b/extensions/Spoilers/i18n/es.json
new file mode 100644
index 0000000..f56ec74
--- /dev/null
+++ b/extensions/Spoilers/i18n/es.json
@@ -0,0 +1,9 @@
+{
+	"@metadata": {
+		"authors": ["Kris Blair"]
+	},
+	"spoilers": "Spoilers",
+	"spoilers_description": "Etiqueta Spoiler - &lt;spoiler show=\"showMessage\" hide=\"hideMessage\"&gt;Texto en Spoiler&lt;/spoiler&gt;",
+	"spoilers_show_default": "Mostrar Spoiler",
+	"spoilers_hide_default": "Ocultar Spoiler"
+}
diff --git a/extensions/Spoilers/i18n/fr.json b/extensions/Spoilers/i18n/fr.json
new file mode 100644
index 0000000..85ab276
--- /dev/null
+++ b/extensions/Spoilers/i18n/fr.json
@@ -0,0 +1,9 @@
+{
+	"@metadata": {
+		"authors": ["Kris Blair"]
+	},
+	"spoilers": "Spoilers",
+	"spoilers_description": "Balise de spoiler - &lt;spoiler show=\"showMessage\" hide=\"hideMessage\"&gt;Texte du spoiler&lt;/spoiler&gt;",
+	"spoilers_show_default": "Afficher le Spoiler",
+	"spoilers_hide_default": "Masquer le Spoiler"
+}
diff --git a/extensions/Spoilers/js/spoilers.js b/extensions/Spoilers/js/spoilers.js
new file mode 100644
index 0000000..b05bf86
--- /dev/null
+++ b/extensions/Spoilers/js/spoilers.js
@@ -0,0 +1,12 @@
+/**
+ * Created by Telshin on 10/22/13.
+ */
+$( '.spoilers-button' ).toggle( function() {
+    $( this ).parents( '.spoilers' ).find( '.spoilers-body' ).show();
+    $( this ).children( '.spoilers-show' ).hide();
+    $( this ).children( '.spoilers-hide' ).show();
+}, function() {
+    $( this ).parents( '.spoilers' ).find( '.spoilers-body' ).hide();
+    $( this ).children( '.spoilers-show' ).show();
+    $( this ).children( '.spoilers-hide' ).hide();
+});