Template:Software documentation index/doc

This is a documentation subpage for Template:Software documentation index.
Don't forget to purge the contents of the base page upon creating or editing this subpage.

Purge base's cache

Table 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.

• header
• button

Examples and Parameters

Parameter	Description	Example	Preview
{{{width}}}	Table width.	{{Software documentation index| width = 750px }}	See #Preview.
{{{caption indent:top}}}	Indentation of the caption at the top.	{{Software documentation index| caption indent:top = 1em }}
{{{border color}}}	Table border color.	{{Software documentation index| border color = green }}
{{{header gradient colors}}}	The colors of the gradient for the background of the header.	{{Software documentation index | header gradient colors = blue 45%, yellow 55% }}
{{{header text color}}}	Text color of headers.	{{Software documentation index| header text color = red }}
{{{button bgcolor}}}	The color of the background behind the link button.	{{Software documentation index| button bgcolor = #000 }}
{{{button text color}}}	The color of the link button text.	{{Software documentation index| button text color = #FFF }}
{{{row color 1}}}	Color of the first row of the table. Default value is #252525.	{{Software documentation index| row color 1 = #303030 }}
{{{row color 2}}}	Color of the second row of the table. Default value is #202020.	{{Software documentation index| row color 2 = #252525 }}
{{{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.	{{Software documentation index| comment = This software loves donuts. }}
{{{comment style}}}	Custom Comment CSS. Warning:Overwrites the original style!	{{Software documentation index| comment style = width:750px; margin:0 auto }}
{{{banner}}}	Software banner.	{{Software documentation index| banner = Dota workshop about.png }}
{{{banner width}}}	Banner width. Used to create rounded borders.	{{Software documentation index| banner width = 566px }}
{{{desc}}}	Software description.	{{Software documentation index| banner width = 566px }}
{{{desc width}}}	Software description width. Used when you need to make the text look nicer.	{{Software documentation index| desc width = 550px }}
{{{link <1-6>}}}	Link above the table. Maximum 6.	{{Software documentation index | link 1 = '''[[SDK Installation/Download and installation]]''' }}
{{{toc}}}	Table of Contents. Useful if the content is divided into headers.	{{Software documentation index | toc = [[#Basics|Basics]] · [[#References|References]] }}
{{{button <1-48>}}}	The displayed name of the specified button.	{{Software documentation index| button 1 = Introduction }}
{{{button <1-48> link}}}	Link to the page for the specified button.	{{Software documentation index | button 8 link = :Category:Third Party Source Tools }}
{{{button <1-48> desc}}}	Description of the page linked to by the specified button.	{{Software documentation index | button 3 desc = Creating, organizing and releasing your {{source|1}} project. }}
{{{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.	{{Software documentation index| button 2 header = Basics }}
{{{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.	{{Software documentation index| button 5 redlink = true }}

Preview

See Counter-Strike 2 Workshop Tools.

See also

• {{DIP topicon}}