Template:FAQ: Difference between revisions
SimpleArrows (talk | contribs) mNo edit summary |
SimpleArrows (talk | contribs) mNo edit summary |
||
Line 1: | Line 1: | ||
<includeonly>{| class="banner mw-collapsible mw-collapsed" style="border-color: {{#switch: {{FULLPAGENAME}} | <includeonly>{| class="banner mw-collapsible mw-collapsed" style="border-color: {{#switch: {{FULLPAGENAME}} | ||
|User talk:SimpleArrows = | |User talk:SimpleArrows = indianred | ||
|#default = SlateGrey }}; width: 99%; padding: 5px; min-height: 50px; line-height: 1;" | |#default = SlateGrey }}; width: 99%; padding: 5px; min-height: 50px; line-height: 1;" | ||
|<h3 style="font-family: inherit; font-weight: bold; font-size: 13px; border: none; margin: 0; padding: 0; line-height: 1;">{{{2}}}</h3> | |<h3 style="font-family: inherit; font-weight: bold; font-size: 13px; border: none; margin: 0; padding: 0; line-height: 1;">{{{2}}}</h3> | ||
Line 8: | Line 8: | ||
|question = <span style="color: green; font-weight: bold; font-size: 13px;">Answer:</span><br>{{{3}}} }} | |question = <span style="color: green; font-weight: bold; font-size: 13px;">Answer:</span><br>{{{3}}} }} | ||
|}</includeonly><noinclude>[[Category: Banner Templates]] | |}</includeonly><noinclude>[[Category: Banner Templates]] | ||
<templatedata> | |||
{ | |||
"params": { | |||
"1": { | |||
"label": "Type", | |||
"description": "Determines the type of FAQ box it is. The \"issue\" type will fill the box with spaces for a cause and solution. The \"question\" type will fill the box with a space for an answer to a question.", | |||
"example": "issue", | |||
"type": "string", | |||
"suggestedvalues": [ | |||
"issue", | |||
"question" | |||
], | |||
"required": true | |||
}, | |||
"2": { | |||
"label": "Header", | |||
"description": "Depending on the type, the header can either be an issue or a question.", | |||
"example": "Error \"Please insert Red Faction CD 2\"", | |||
"type": "string", | |||
"required": true | |||
}, | |||
"3": { | |||
"label": "Cause/Answer", | |||
"description": "If the FAQ type is \"issue\", this parameter is seen as the cause, which is where an explanation of why the issue (written in the header) is happening. If the FAQ type is \"question\", this parameter is seen as the answer to the question (written in the header).", | |||
"example": "This issue occurs when launching Red Faction (particularly in full screen mode) on some new hardware.", | |||
"type": "string", | |||
"required": true | |||
}, | |||
"4": { | |||
"label": "Solution", | |||
"description": "This parameter is only used when the FAQ type is \"issue\", do not use it if the type is \"question\". The information written in this parameter is the solution to the issue (written in the header).", | |||
"example": "All commonly-used community versions resolve this issue - we recommend using Dash Faction for maximum compatibility with new hardware and operating systems. You may need to launch the community version you choose in \"windowed\" or \"stretched\" mode as opposed to full screen mode to resolve this issue.", | |||
"type": "string" | |||
} | |||
}, | |||
"description": "Creates a banner-styled box for use on FAQ pages, allowing for solutions and answers to questions.", | |||
"paramOrder": [ | |||
"1", | |||
"2", | |||
"3", | |||
"4" | |||
], | |||
"format": "inline" | |||
} | |||
</templatedata> | |||
<pre>{{FAQ|TYPE|HEADER|CAUSE_OR_ANSWER|SOLUTION}}</pre> | |||
'''Usage (issue):''' | |||
<pre>{{FAQ| issue | Error "Please insert Red Faction CD 2" | You're running Red Faction version 1.0, 1.1, or 1.2, and those versions require CD 2 be in your CD-ROM drive for the game to launch. | Official version 1.21, as well as all commonly-used [[RF Clients#Community-Made|community versions of Red Faction]] resolve this issue and allow you to launch the game without CD 2 in your CD-ROM drive. | |||
}}</pre> | |||
'''Output:''' | |||
{{FAQ|issue|Error "Please insert Red Faction CD 2"|You're running Red Faction version 1.0, 1.1, or 1.2, and those versions require CD 2 be in your CD-ROM drive for the game to launch.|Official version 1.21, as well as all commonly-used [[RF Clients#Community-Made|community versions of Red Faction]] resolve this issue and allow you to launch the game without CD 2 in your CD-ROM drive.}} | |||
<hr> | |||
'''Usage (question):''' | |||
<pre>{{FAQ| question | Where can I get a copy of Red Faction? | Red Faction is available for purchase as a digital download or physical copy (CD).<br>'''Digital Download:''' | |||
*[https://store.steampowered.com/app/20530/Red_Faction Steam] | |||
*[https://www.gog.com/game/red_faction GoG] | |||
}}</pre> | |||
'''Output:''' | |||
{{FAQ| question | Where can I get a copy of Red Faction? | Red Faction is available for purchase as a digital download or physical copy (CD).<br>'''Digital Download:''' | |||
*[https://store.steampowered.com/app/20530/Red_Faction Steam] | |||
*[https://www.gog.com/game/red_faction GoG] | |||
}} | |||
<hr> | |||
'''FAQ Page Columns:''' | |||
The FAQ box is intended for use in a column which allows for more boxes to be used in a smaller amount of space. This method only allows for 2 columns on a page. | |||
Wrap the boxes in a column div as follows to make the first column: | |||
<pre><div class="column">FAQ_BOXES_HERE</div></pre> | |||
To make the second column, do the same thing you did for the first column to another collection of FAQ boxes. | |||
<pre><div class="column"> | |||
FIRST_COLUMN_BOXES | |||
</div> | |||
<div class="column"> | |||
SECOND_COLUMN_BOXES | |||
</div> | |||
</pre> | |||
If content is going to be placed after the 2 columns, another div is needed to make sure the formatting of the content isn't affected by the columns. Add this code after the end of the 2 column divs (do not put any content into this div): | |||
<pre><div style="clear: both;"></div></pre> | |||
</noinclude> | </noinclude> |
Revision as of 11:48, 4 February 2024
Creates a banner-styled box for use on FAQ pages, allowing for solutions and answers to questions.
Parameter | Description | Type | Status | |
---|---|---|---|---|
Type | 1 | Determines the type of FAQ box it is. The "issue" type will fill the box with spaces for a cause and solution. The "question" type will fill the box with a space for an answer to a question.
| String | required |
Header | 2 | Depending on the type, the header can either be an issue or a question.
| String | required |
Cause/Answer | 3 | If the FAQ type is "issue", this parameter is seen as the cause, which is where an explanation of why the issue (written in the header) is happening. If the FAQ type is "question", this parameter is seen as the answer to the question (written in the header).
| String | required |
Solution | 4 | This parameter is only used when the FAQ type is "issue", do not use it if the type is "question". The information written in this parameter is the solution to the issue (written in the header).
| String | optional |
{{FAQ|TYPE|HEADER|CAUSE_OR_ANSWER|SOLUTION}}
Usage (issue):
{{FAQ| issue | Error "Please insert Red Faction CD 2" | You're running Red Faction version 1.0, 1.1, or 1.2, and those versions require CD 2 be in your CD-ROM drive for the game to launch. | Official version 1.21, as well as all commonly-used [[RF Clients#Community-Made|community versions of Red Faction]] resolve this issue and allow you to launch the game without CD 2 in your CD-ROM drive. }}
Output:
Error "Please insert Red Faction CD 2" |
Cause: You're running Red Faction version 1.0, 1.1, or 1.2, and those versions require CD 2 be in your CD-ROM drive for the game to launch. Solution: Official version 1.21, as well as all commonly-used community versions of Red Faction resolve this issue and allow you to launch the game without CD 2 in your CD-ROM drive. |
Usage (question):
{{FAQ| question | Where can I get a copy of Red Faction? | Red Faction is available for purchase as a digital download or physical copy (CD).<br>'''Digital Download:''' *[https://store.steampowered.com/app/20530/Red_Faction Steam] *[https://www.gog.com/game/red_faction GoG] }}
Output:
Where can I get a copy of Red Faction? |
Answer: Red Faction is available for purchase as a digital download or physical copy (CD). Digital Download: |
FAQ Page Columns:
The FAQ box is intended for use in a column which allows for more boxes to be used in a smaller amount of space. This method only allows for 2 columns on a page.
Wrap the boxes in a column div as follows to make the first column:
<div class="column">FAQ_BOXES_HERE</div>
To make the second column, do the same thing you did for the first column to another collection of FAQ boxes.
<div class="column"> FIRST_COLUMN_BOXES </div> <div class="column"> SECOND_COLUMN_BOXES </div>
If content is going to be placed after the 2 columns, another div is needed to make sure the formatting of the content isn't affected by the columns. Add this code after the end of the 2 column divs (do not put any content into this div):
<div style="clear: both;"></div>