Difference between revisions of "Template:Spoiler"

From Project: Gorgon Wiki
Jump to: navigation, search
(Tidying up Template documentation.)
m
Line 12: Line 12:
 
Use this template to add a spoiler '''section''' to a page (for inline text use [[Template:Hint]] instead).
 
Use this template to add a spoiler '''section''' to a page (for inline text use [[Template:Hint]] instead).
  
This template replaces the tag provided by the <nowiki><spoiler></nowiki> extension. Originally it was intended to allow using tables (which the extension doesn't) but it turned out the template doesn't allow for it either. Still, it is recommended to use this template as we have more freedom to restyle it or change its behaviour down the line if we want to.
+
This template replaces the tag provided by the <nowiki><spoiler></nowiki> extension. Originally it was intended to allow using tables (which the extension doesn't) but it turned out the template doesn't allow for it either. Still, it is recommended to use this template as we have more freedom to restyle it or change its behavior down the line if we want to.
  
 
====Known issues====
 
====Known issues====
 
* <span style="color:red">Tables can not be formatted inside the template.</span> Suggest using definition lists as a workaround.
 
* <span style="color:red">Tables can not be formatted inside the template.</span> Suggest using definition lists as a workaround.
 
* Spoiler content shouldn't be too huge anyway. If you want to hide a long table of info in a page, consider adding a link to another page.
 
* Spoiler content shouldn't be too huge anyway. If you want to hide a long table of info in a page, consider adding a link to another page.
 +
== Alternate method ==
 +
While the examples suggested in this template work in most areas, the Template tag works if you wish to display alternative text than "Spoiler"
 +
<spoiler show="Text for the spoiler box goes here">
 +
Type things here. Quotes and Tables do not display correctly.
 +
</spoiler>
  
 
==Examples==
 
==Examples==

Revision as of 19:20, 4 August 2015

Spoiler!

Description

Use this template to add a spoiler section to a page (for inline text use Template:Hint instead).

This template replaces the tag provided by the <spoiler> extension. Originally it was intended to allow using tables (which the extension doesn't) but it turned out the template doesn't allow for it either. Still, it is recommended to use this template as we have more freedom to restyle it or change its behavior down the line if we want to.

Known issues

  • Tables can not be formatted inside the template. Suggest using definition lists as a workaround.
  • Spoiler content shouldn't be too huge anyway. If you want to hide a long table of info in a page, consider adding a link to another page.

Alternate method

While the examples suggested in this template work in most areas, the Template tag works if you wish to display alternative text than "Spoiler"

Text for the spoiler box goes here

Examples

A basic spoiler like this may be better replaced with Template:Hint:

{{Spoiler|
Sarina's clothes are not outside, but inside the [[Boarded up Basement]] dungeon.
}}

A more complex spoiler, we use definition lists because a table can not be included inside it:

{{Spoiler|
; Utility
: ''Word of Power: Cure Bovinity'' ... Speaking this word causes you to stop being a cow if you are one.
; Teleports
: ''Word of Power: Teleport to Crypt'' ... Speaking this word teleports you to the crypt beneath the town of Serbule.
}}