Difference between revisions of "Template:FAQ"

From SHA2017
Jump to: navigation, search
(explanation; collapsing)
Line 1: Line 1:
 
<noinclude>
 
<noinclude>
 
A (frequently) asked question, and its answer.
 
A (frequently) asked question, and its answer.
 +
==Where to put it==
 +
Put an FAQ-item in:
 +
* A subpage for your team or project (like: Team:Deco/FAQ)
 +
* The general FAQ list ([[FAQ/crowdsourced]])
 +
Sanity and Infodesk will maintain an approved general list at [[FAQ/approved]].
 +
: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 in this template, without these symbols:
 +
: <nowiki>| [ ] =</nowiki>
 
<pre><nowiki>
 
<pre><nowiki>
 
{{FAQ
 
{{FAQ
|q=
+
|q=(short question)
|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=draft/example/public}}
+
|status=(one of these: suggestion/draft/good for now/finalised)
 +
}}
 
</nowiki></pre>
 
</nowiki></pre>
todo: work out the status (draft/example/public are public to edit; an 'approved' should be set else for permission purposes)
+
==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
 +
|}
 
</noinclude>
 
</noinclude>
 
<includeonly>
 
<includeonly>
Line 22: Line 46:
 
}}
 
}}
 
=={{{q}}}==
 
=={{{q}}}==
<div class="answer">{{{a|''no answer yet given''}}}</div>
+
<div class="answer mw-collapsible">{{{a|''no answer yet given''}}}</div>
 
{{#if:{{{link|}}}|: {{{link|}}}
 
{{#if:{{{link|}}}|: {{{link|}}}
}}{| class="extra-data "
+
}}{| class="extra-data collapsible"
 
|-
 
|-
 
! Team
 
! Team

Revision as of 22:02, 2 October 2016

A (frequently) asked question, and its answer.

Where to put it

Put an FAQ-item in:

  • A subpage for your team or project (like: Team:Deco/FAQ)
  • The general FAQ list (FAQ/crowdsourced)

Sanity and Infodesk will maintain an approved general list at FAQ/approved.

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 in this template, without these symbols:

| [ ] =
{{FAQ
|q=(short question)
|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