Template:Software documentation index

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.

Template Documentation [view] [edit]

Available doc translations

…

Table for use in software documentation indexes, such as Source SDK Index.

Usage

This template is usually written in a column. To use it, insert {{Software documentation index}} on the desired page and specify the parameters under the template name in the following format:

{{Software documentation index
| parameter 1 = value
| parameter 2 = value
}}

Parameters and Examples

Parameter	Description	Example	Preview
`{{{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 = Gordon Freeman was here.	See #Preview.
`{{{banner}}}`	Software banner.	\| banner = Placeholder for SDI banner.jpg
`{{{desc}}}`	Software description.	\| desc = '''Sweet Tools''' is free software distributed through {{steamicon\|1}}.
`{{{link<1-6>}}}`	Link above the table. Maximum 6.	\| link4 = '''[[Source SDK Release Notes\|Release Notes]]'''
`{{{toc}}}`	Table of Contents. Useful if the content is divided into headers.	\| toc = [[#Something about mapping\|[#Something about mapping]] · [[#Something about scripting\|[#Something about scripting]]
`{{{button<1-48>}}}`	The displayed name of the specified button.	\| button11 = Level design
`{{{button<1-48>link}}}`	Link to the page for the specified button.	\| button16link = Half-Life: Alyx Workshop Tools/Addon Sounds
`{{{button<1-48>desc}}}`	Description of the page linked to by the specified button.	\| button5desc = About creating cool maps
`{{{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.	\| button45header = Something about mapping
`{{{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.	\| button6redlink = true
`{{{button<2-48>radius}}}`	The radius of the table row with the button. Available values: default - empty. start - the default is specified for the first button. end - specify if the button is the last one.	\| button2radius = end
Style
`{{{topindent}}}`	Top indent for the entire table.	\| topindent = 2em
`{{{width}}}`	Table width.	\| width = 600px
`{{{bannerwidth}}}`	Banner width.	\| bannerwidth = 560px
`{{{descwidth}}}`	Software description width. Used when you need to make the text look nicer.	\| descwidth = 550px
`{{{commentStyle}}}`	Custom Comment CSS. Warning:Overwrites the original style!	\| commentStyle = background:#000; border-radius:.3em
`{{{borderColor}}}`	Table border color.	\| borderColor = #F2A52B4a
`{{{headerGradColors}}}`	The colors of the gradient for the background of the header.	\| headerGradColors = #594027,#312717
`{{{buttonTextColor}}}`	The color of the link button text.	\| buttonTextColor = #E3C798
`{{{buttonBG}}}`	The color of the background behind the link button.	\| buttonBG = #2F2A26
`{{{rowColor1}}}`	Color of the first row of the table. Default value is `#252525`.	\| rowColor1 = #303030
`{{{rowColor2}}}`	Color of the second row of the table. Default value is `#202020`.	\| rowColor1 = #252525

Preview

 
{{Software documentation index
| width				= 750px
| descwidth			= 550px
| bannerwidth		= 566px
| borderColor		= #F2A52B4a
| buttonBG			= #2F2A26
| buttonTextColor	= #E3C798
| headerGradColors	= #594027,#312717

| comment = Gordon Freeman was here.
| banner  = Placeholder for SDI banner.jpg
| desc	  = '''Sweet Tools''' is free software distributed through {{steamicon|1}} for creating cool games without any programming knowledge.

| link1 = '''[[#Example and Preview|Download and Installation]]'''
| link2 = '''[[#Example and Preview|Release Notes]]'''

| button1		= Introduction
| button1link 	= #Example and Preview
| button1desc 	= Introduction to using this amazing toolkit.

| button2		= Level Design
| button2link	= #Something about mapping
| button2desc	= Create [[Map (level design)|levels]] with an incredibly cute map editor.
| button2header	= Something about mapping

| button3		= Materials
| button3link	= #Something about mapping
| button3desc	= Learn how to add a character's face to a texture that will only be seen many years later.
| button3radius	= end
}}