Difference between revisions of "Template:Spoiler"
From Project: Gorgon Wiki
Gorgonzola (talk | contribs) m |
Gorgonzola (talk | contribs) (Tidying up Template documentation.) |
||
| Line 9: | Line 9: | ||
</div><noinclude> | </div><noinclude> | ||
| − | == Description == | + | ==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 <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. | ||
| + | |||
| + | ====Known issues==== | ||
| + | * <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. | ||
| + | |||
| + | ==Examples== | ||
| + | A basic spoiler like this may be better replaced with [[Template:Hint]]: | ||
<pre> | <pre> | ||
{{Spoiler| | {{Spoiler| | ||
| − | + | Sarina's clothes are not outside, but inside the [[Boarded up Basement]] dungeon. | |
}} | }} | ||
</pre> | </pre> | ||
| − | + | A more complex spoiler, we use definition lists because '''a table can not be included inside it''': | |
| − | + | <pre> | |
| − | + | {{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. | ||
| + | }} | ||
| + | </pre> | ||
[[Category:Formatting templates|Spoiler]] | [[Category:Formatting templates|Spoiler]] | ||
</noinclude> | </noinclude> | ||
Revision as of 08:00, 5 October 2014
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 behaviour 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.
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.
}}
