summaryrefslogtreecommitdiff
path: root/extensions/Spoilers/README.md
diff options
context:
space:
mode:
authorAlex Wu <paklongwu1006@gmail.com>2015-02-11 23:39:43 +0800
committerwushin <pasekei@gmail.com>2015-02-16 00:41:46 -0600
commitb2cf456b565a633b37b8501c9383977d8bbbbe07 (patch)
tree589950e696fdc194ca4ba63ddd72d746d60ef898 /extensions/Spoilers/README.md
parent03e3336b8915be1e0132c524bf71b7a2411a15c9 (diff)
downloadwebsite-b2cf456b565a633b37b8501c9383977d8bbbbe07.tar.gz
website-b2cf456b565a633b37b8501c9383977d8bbbbe07.tar.bz2
website-b2cf456b565a633b37b8501c9383977d8bbbbe07.tar.xz
website-b2cf456b565a633b37b8501c9383977d8bbbbe07.zip
The Spoilers extension adds a spoiler tag that will hide a block of text. The spoiler button's show/hide message can be customized for each set.
Diffstat (limited to 'extensions/Spoilers/README.md')
-rw-r--r--extensions/Spoilers/README.md21
1 files changed, 21 insertions, 0 deletions
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>
+```