Difference between revisions of "Template:FAQ"

From SHA2017
Jump to: navigation, search
 
(20 intermediate revisions by the same user not shown)
Line 1: Line 1:
 
<noinclude>
 
<noinclude>
 
A (frequently) asked question, and its answer.
 
A (frequently) asked question, and its answer.
<nowiki>
+
==Where to put it==
 +
Put an FAQ-item in:
 +
* A subpage for your team or project (like: [[Team:Infodesk/FAQ]])
 +
* The general FAQ list ([[FAQ/crowdsourced]])
 +
Note that an old list of FAQ entries still exists. Please more them from [[FAQ/assorted]] to your own team list.
 +
Sanity and Infodesk will maintain an approved, general list at [[FAQ/approved]]. Teams are responsible for maintaining correct answers on their own FAQ page.
 +
:As this is a semantic wiki, the questions and their answers you write on these pages will be queried and shown on other pages.
 +
==Format==
 +
Fill each FAQ-set with this template:
 +
<pre><nowiki>
 
{{FAQ
 
{{FAQ
|q=
+
|q=(short question; do not use | [ ] = )
|a=
+
|a=(if you know this)
|team=
+
|team=(the teams that are responsible for (parts of) the answer, comma separated)
|tags=
+
|tags=(relevant labels you can think of, comma separated)
|link=
+
|link=(a URL for more information)
 +
|status=(one of these: suggestion/draft/good for now/finalised)
 
}}
 
}}
</nowiki>
+
</nowiki></pre>
todo: comma seperated values (setting multiple smeantic values and creating bulleted list), set value for 'none given' (to make querying for empty values possible),  
+
==Statusses==
 +
As described above, you can set a status. They mean the following:
 +
{| class="wikitable"
 +
! suggestion
 +
| we should do something with this
 +
|-
 +
! draft
 +
| preliminary answer from team member
 +
|-
 +
! good for now
 +
| this is the answer we have as a team, given the current knowledge. But it will probably be updated.
 +
|-
 +
! finalised
 +
| the team thinks this answer won't change
 +
|}
 +
 
 +
==I don't get it==
 +
If you have questions about this FAQ format, please mail [[Team:Infodesk|Infodesk]].
 
</noinclude>
 
</noinclude>
 
<includeonly>
 
<includeonly>
{{#set:
+
{{#subobject:{{FULLPAGENAME}}/{{{q}}}
q={{{q}}}|a={{{a}}}|team={{{team}}}|tags={{{tags}}}|link={{{link}}}
+
|question={{{q}}}
 +
|answer={{{a|Waiting to be answered}}}
 +
|team={{{team|-}}}|+sep=,
 +
|tag={{{tags|-}}}|+sep=,
 +
|link={{{link|}}}
 +
|status={{{status|-}}}
 +
|source={{FULLPAGENAME}}
 
}}
 
}}
 
=={{{q}}}==
 
=={{{q}}}==
<div class="answer">{{{a|''no answer yet given''}}}</div>
+
<div class="answer mw-collapsible">{{{a|''no answer yet given''}}}</div>
{| class="extra-data wikitable"
+
{{#if:{{{link|}}}|: {{{link|}}}
 +
}}
 +
{| class="extra-data mw-collapsible collapsed wikitable"
 
|-
 
|-
! Team !! Tags
+
! Team
 +
! Tags
 
|-
 
|-
| {{{team|}}} | {{{tags|}}}
+
| {{{team|not yet assigned}}}
 +
| {{{tags|}}}
 
|}
 
|}
{{#if:{{{link|}}} }}
 
: {{{link|}}}
 
 
</includeonly>
 
</includeonly>

Latest revision as of 22:26, 1 November 2016

A (frequently) asked question, and its answer.

Where to put it

Put an FAQ-item in:

Note that an old list of FAQ entries still exists. Please more them from FAQ/assorted to your own team list. Sanity and Infodesk will maintain an approved, general list at FAQ/approved. Teams are responsible for maintaining correct answers on their own FAQ page.

As this is a semantic wiki, the questions and their answers you write on these pages will be queried and shown on other pages.

Format

Fill each FAQ-set with this template:

{{FAQ
|q=(short question; do not use | [ ] = )
|a=(if you know this)
|team=(the teams that are responsible for (parts of) the answer, comma separated)
|tags=(relevant labels you can think of, comma separated)
|link=(a URL for more information)
|status=(one of these: suggestion/draft/good for now/finalised)
}}

Statusses

As described above, you can set a status. They mean the following:

suggestion we should do something with this
draft preliminary answer from team member
good for now this is the answer we have as a team, given the current knowledge. But it will probably be updated.
finalised the team thinks this answer won't change

I don't get it

If you have questions about this FAQ format, please mail Infodesk.