Template:Infobox/Doc: Difference between revisions

From questden
Jump to navigationJump to search
mNo edit summary
m (Improve example)
Line 20: Line 20:
;specthreadNname:Name for corresponding special thread.
;specthreadNname:Name for corresponding special thread.
== Example ==
== Example ==
A quick reminder of MediaWiki template syntax:
A quick reminder of MediaWiki template syntax; whitespace is reasonably flexible either side of the pipes, so do whatever is most readable:
:<code><nowiki>{{InfoboxQuest|author=TestPattern|image=tozol_title.png|thread1=79880|disthread1=316424}}</nowiki></code>
<pre><nowiki>{{InfoboxQuest|author=TestPattern|image=tozol_title.png
|thread1=79880|thread2=94645
|disthread1=316424
|specthread1=156238|specthread1name=April Fool's Edition
}}</nowiki></pre>
= Maintenance notes =
= Maintenance notes =
* Depends on the automatic redirect from <code>/quest/</code> to <code>/questarch/</code> for archived threads (semantically, the <code>/quest/</code> version is considered its canonical URI). This allows the "current thread" to work without having to be flagged as special in any way.
* Depends on the automatic redirect from <code>/quest/</code> to <code>/questarch/</code> for archived threads (semantically, the <code>/quest/</code> version is considered its canonical URI). This allows the "current thread" to work without having to be flagged as special in any way.
* Depends on [[http://www.mediawiki.org/wiki/Help:Extension:ParserFunctions ParserFunctions extension]] to support optional parameters gracefully. This makes the code pretty hairy, so take care editing.
* Depends on [[http://www.mediawiki.org/wiki/Help:Extension:ParserFunctions ParserFunctions extension]] to support optional parameters gracefully. This makes the code pretty hairy, so take care editing.
* The maximum number of threads is limited by the implementation repeating the definition for each number. Unfortunately this is a common MediaWiki paradigm as it has no set handling in templates.
* The maximum number of threads is limited by the implementation repeating the definition for each number. Unfortunately this is a common MediaWiki paradigm as it has no set handling in templates.

Revision as of 22:14, 11 July 2010

This page is a user-namespaced test. Please don't use it on real pages; it's intended to be moved into place when it's ready.
This is a template documentation page. It is transcluded into place.

Purpose

Infobox/Doc by LionsPhil
0.png

This is the template for making a neat infobox for a quest. Docs will follow.

Usage

Parameters (all are optional):

Metadata

title
Title of the quest. Defaults to the current page name; normally you should leave it to do this.
author
Quest author; will be linked to as a wiki node, even if it has whitespace.
image
Quest image, without namespace. Will be thumbnailed to fit.

Threads

All thread parameters must be numbered, starting from 1. For example, thread1=500|thread2=600….

threadN
Post numbers for the threads of the quest.
disthreadN
Post numbers for discussion threads.

Specials

For example, 'April Fool' versions of quests.

specthreadN
Post numbers for any 'special' threads.
specthreadNboard
Board for corresponding 'special' thread; defaults to quest.
specthreadNname
Name for corresponding special thread.

Example

A quick reminder of MediaWiki template syntax; whitespace is reasonably flexible either side of the pipes, so do whatever is most readable:

{{InfoboxQuest|author=TestPattern|image=tozol_title.png
|thread1=79880|thread2=94645
|disthread1=316424
|specthread1=156238|specthread1name=April Fool's Edition
}}

Maintenance notes

  • Depends on the automatic redirect from /quest/ to /questarch/ for archived threads (semantically, the /quest/ version is considered its canonical URI). This allows the "current thread" to work without having to be flagged as special in any way.
  • Depends on [ParserFunctions extension] to support optional parameters gracefully. This makes the code pretty hairy, so take care editing.
  • The maximum number of threads is limited by the implementation repeating the definition for each number. Unfortunately this is a common MediaWiki paradigm as it has no set handling in templates.