User:N8wilson/Show FAQ/doc
This is a documentation subpage for User:N8wilson/Show FAQ. It may contain usage information, categories and other content that is not part of the original user template page. |
This template should only be used in a talk namespace. |
This may already be addressed in Q1 of the FAQ |
This may already be addressed in Q3 of the FAQ |
Add a {{sidebox}} to a discussion referencing a specific question in the {{FAQ}} for the corresponding talk page.
When replying to talk page discussions, this template can be used to indicate that the topic in question has already been addressed by the FAQ. If the /FAQ
subpage has been tagged with WP:LST section markers, the text of the question will be transcluded as well.
Usage
[edit]{{Show FAQ|1}}
This template should typically be placed immediately under a section heading on a line by itself. For example:
== Topic heading == {{Show FAQ|6}} First post within the topic made by the original editor who started the topic --timestamped signature :Another editor's response. This editor likely added the "Show FAQ" template as well. --timestamed signautre
If a FAQ needs to be included as part of a much longer discussion however, it may make sense to use the template closer to where it is actually referenced in that discussion.
Parameter
[edit]This template requires one parameter.
{{Show FAQ|1}}
The parameter indicates which question to reference in the FAQ. This is technically the "index" of the question as used by {{FAQ row}} but natural numbers are used by convention. To transclude the text of the question and corresponding answer instead of just showing a link, the section tags used on the /FAQ
page should be labeled with a value of Q<index>
as well.
The wikitext of a target question as written on the FAQ page might look like this:
<section begin=Q12>{{FAQ row |index=12 |q=Who can edit Wikipedia? |a=Anyone can! }}<section end=Q12>
Example: When a FAQ question has section tags
[edit]This may already be addressed in Q3 of the FAQ |
Somebody asked a question here that's already addressed in Q3. --timestamped signature
- Another editor makes ref to FAQ. --timestamped signature
- Perhaps discussion continues in a different direction. --timestamped signature
Example: When a FAQ question does not have section tags
[edit]This may already be addressed in Q2 of the FAQ |
Somebody asked a question here that's already addressed in Q2. --timestamped signature
- Something here to reference FAQ question 2. --timestamped signature
See Also
[edit]Similar templates:
- {{FAQ}} – basic, non-collapsed list
- {{FAQ row}} – collapsed questions
- {{FAQ group begin}} – groups questions
- {{FAQ group end}} – groups questions
- {{FAQ page}} – message to be placed on top of separate FAQ pages
- {{Round in circles}} – not a FAQ (but will link to one); warns against rehashing debates
- {{Circular definition}}