User:N8wilson/SeeFAQ/sandbox

Documentation[view] [edit] [history] [purge]

Refer members of a discussion back to a specific question in the FAQ. Where possible, include a copy of the question itself for easy reference.

Usage

{{SeeFAQ|4}}

Generates a link to the FAQ page targeting the question identified by the first parameter. If the corresponding question has been annotated with section tags, it will also be transcluded directly.

Examples

Refer to a question:

Please refer to Q2 of the FAQ.

Refer to a question that has been tagged with a <section> label

Please refer to Q3 of the FAQ.

Requirements

1. The FAQ page must actually exist. This means there should be a subpage named /FAQ below the root page name. Placing the FAQ below the root page allows references to questions continue to function even after discussions get archived.
2. [Optional] For deep links, this template expects the format used by {{FAQ row}} when referencing questions. That is to say for a question with the index value of 6 in the {{FAQ row}} template, this template creates a link to the FAQ with a reference to the question Q6.
3. [Optional] To include copies of the question, the /FAQ page should have each question (each {{FAQ row}}) wrapped with proper <section> begin and end tags. As above, the labels used for these tags should be of the form Q+index.

Caveats and Quirks

• Cannot change the "indent" level of transcluded Q+As. As far as this author knows, there's not a whole lot this template can do to accommodate this need without also forcing a change in the {{FAQ row}} template as well.
• Template should be placed at the end of a line of wikitext. Wikitext that follows this template is always "pushed" down below the template and will appear to be unindented. To continue comments after using this template, just start a new line at the same indent level like so:

Some initial comment ~~(signature)
:Some earlier reply ~~(other signature)
::Your initial comments leading to suggest that OP {{SeeFAQ|x}}
::Your concluding remarks with your signature ~~~~

The above documentation is transcluded from User:N8wilson/SeeFAQ/doc. (edit | history)
Editors can experiment in this template's sandbox (edit | diff) and testcases (create) pages.
Add categories to the /doc subpage. Subpages of this page.