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

Parameters

Parameter	Description	Example and Preview
{{{width}}}	Table width.	See #Example and Preview.
{{{topindent}}}	Top indent for the entire table.
{{{borderColor}}}	Table border color.
{{{headerGradientColors}}}	The colors of the gradient for the background of the header.
{{{headerTextColor}}}	Text color of headers.
{{{buttonBG}}}	The color of the background behind the link button.
{{{buttonTextColor}}}	The color of the link button text.
{{{rowColor1}}}	Color of the first row of the table. Default value is #252525.
{{{rowColor2}}}	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.
{{{commentStyle}}}	Custom Comment CSS. Warning:Overwrites the original style!
{{{banner}}}	Software banner.
{{{bannerwidth}}}	Banner width.
{{{desc}}}	Software description.
{{{descwidth}}}	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.		{{{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.

Example and Preview

{{Software documentation index
| width = 750px

| borderColor		= #F2A52B4a
| buttonBG			= #2F2A26
| buttonTextColor	= #E3C798
| headerGradColors	= #594027,#312717

| comment = Gordon Freeman was here.

| banner = Placeholder for SDI banner.jpg
| bannerwidth = 566px

| desc = '''Sweet Tools''' is free software distributed through {{steamicon|1}} for creating cool games without any programming knowledge.
| descwidth = 550px

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

Gordon Freeman was here.

Sweet Tools is free software distributed through Steam for creating cool games without any programming knowledge.

Download and Installation · Release Notes

Introduction	Introduction to using this amazing toolkit.
Something about mapping
Level Design	Create levels with an incredibly cute map editor.
Materials	Learn how to add a character's face to a texture that will only be seen many years later.

See also

• {{DIP topicon}}