Template:FAQ/doc: Difference between revisions

Template:FAQ/doc (view source)

27 bytes added , 22 April 2017

sync with devwiki. latest version for release 1.1

2,507

edits

@@ Line 1: / Line 1: @@
 ==Description==
-*This template returns the URL to the FAQ.
+*This template is not intended to be used directly. It provides the formatting for FAQ entries.
+*Please use the Templates: [[Template:UFAQ|UFAQ]] or [[Template:OFAQ|OFAQ]]
 ==Syntax==
+All parameters are required. The FAQ box will not be drawn if at least one of these parameters is missing.
 <pre>
 {{FAQ
-|version=
+|question  = <mandatory> The question.
-|page=
+|answer    = <mandatory> The answer to the question.
+|source    = <mandatory> A link where the answer is from.
+|reference = <mandatory> Who gave the answer.
+|icon      = <optional> The icon which is shown on the left side. Defaults to the descent D.
 }}
-</pre>
+</pre><noinclude>[[Category:Template documentation]]</noinclude>
-==Parameters==
-'''|version='''<br>
-Allowed values are:
-* |version = 1.2
-* |version = 1.5
-* |version = 1.6
-If no version is specified then the template returns the newest version and the page is added to the category [[Category::FAQProblems]]<br>
-If the specified version is not the newest version, it adds the page to the category [[Category::FAQProblems]]
-'''|page='''<br>
-This parameter is optional.<br>
-Allowed values are:
-* Number from 1 to whatever page exists in the FAQ.
-<noinclude>[[Category:Template documentation]]</noinclude>