|
|
| Line 1: |
Line 1: |
| {{todo|Please check this template for quality. It was made rather quickly and is currently being tested rather than ready for use.}} | | {{todo|Please check this template for quality. It was made rather quickly and is currently being tested rather than ready for use.}} |
| | {{todo|Remove spaces from parameters.}} |
|
| |
|
| {{Documentation}} | | {{Documentation}} |
Revision as of 08:06, 7 September 2025
Todo: Please check this template for quality. It was made rather quickly and is currently being tested rather than ready for use.
Todo: Remove spaces from parameters.
Available doc translations
…
EnglishTable for use in software documentation indexes, such as Source SDK Index.
Components
This template uses components to simplify working with repetitive code. Below is a list of all components included in the template.
Parameters
| Parameter
|
Description
|
Example and Preview
|
{{{width}}}
|
Table width.
|
See #Example and Preview.
|
{{{topindent}}}
|
Top indent for the entire table.
|
{{{border color}}}
|
Table border color.
|
{{{header gradient colors}}}
|
The colors of the gradient for the background of the header.
|
{{{header text color}}}
|
Text color of headers.
|
{{{button bgcolor}}}
|
The color of the background behind the link button.
|
{{{button text color}}}
|
The color of the link button text.
|
{{{row color 1}}}
|
Color of the first row of the table.
Default value is #252525.
|
{{{row color 2}}}
|
Color of the second row of the table.
Default value is #202020.
|
{{{comment}}}
|
Comment above the software banner.
 Note:Created mainly for the to-do list, so that it doesn't look too bad next to the table. |
{{{comment style}}}
|
Custom Comment CSS.
 Warning:Overwrites the original style! |
{{{banner}}}
|
Software banner.
|
{{{banner width}}}
|
Banner width.
|
{{{desc}}}
|
Software description.
|
{{{desc width}}}
|
Software description width. Used when you need to make the text look nicer.
|
{{{link <1-6>}}}
|
Link above the table. Maximum 6.
|
{{{toc}}}
|
Table of Contents. Useful if the content is divided into headers.
|
{{{button <1-48>}}}
|
The displayed name of the specified button.
|
{{{button <1-48> link}}}
|
Link to the page for the specified button.
|
{{{button <1-48> desc}}}
|
Description of the page linked to by the specified button.
|
{{{button <1-48> header}}}
|
Adds a heading above the specified button. This is useful if the software page prefers an option without redirects to guide pages, such as the page about level design in Source.
|
{{{button <1-48> redlink}}}
|
If the page does not exist, use this parameter to remove the custom link color.  Important:The custom color should not replace red links, so as not to confuse the user. |
Example and Preview
{{Software documentation index
| width = 750px
| border color = #F2A52B4a
| button bgcolor = #2F2A26
| button text color = #E3C798
| header gradient colors = #594027,#312717
| comment = Gordon Freeman was here.
| banner = Placeholder for SDI banner.jpg
| banner width = 566px
| desc = '''Sweet Tools''' is free software distributed through {{steamicon|1}} for creating cool games without any programming knowledge.
| desc width = 550px
| link 1 = '''[[#Example and Preview|Download and Installation]]'''
| link 2 = '''[[#Example and Preview|Release Notes]]'''
| button 1 = Introduction
| button 1 link = #Example and Preview
| button 1 desc = Introduction to using this amazing toolkit.
| button 2 = Level Design
| button 2 link = #Something about mapping
| button 2 desc = Create [[Map (level design)|levels]] with an incredibly cute map editor.
| button 2 header = Something about mapping
| button 3 = Materials
| button 3 link = #Something about mapping
| button 3 desc = Learn how to add a character's face to a texture that will only be seen many years later.
}}
See also
