Template:Adoption sign/doc

Purpose
The Adoption sign template has been created as a base template to create adoption signs to be used in the Adopt-A-Wiki Page Program. The template can be used directly in a page using the parameters explained below or if the adoption sign will be used more than once, to create a new template. For example.

New templates that are created using this base template will be automatically added to the Category:Adoption program templates. Common documentation for these derivative templates can be viewed/edited at Template:Adoption sign/society.

Usage
Create a new adoption sign by using the following code.

The sign can then be customised by using the two main parameters.

Parameters
There are two parameters that are used to create a custom adoption sign. In addition, another optional parameter, allows for custom text to be added underneath the main part of the sign. Set this to use a custom parameter in the main adoption sign template, using the code'' | custom_text =
 * logo : (optional) This is the filename of the image to be used as a logo inside the sign. If the parameter is not defined no logo is displayed and the text part of the sign will fill the complete width.
 * adopter : This is the text (can include wikicode) that will be displayed within the sign. If this parameter is not defined then the default text is This page is available for adoption.

Then on different pages, different custom text can be added as needed.


 * custom_text : (optional) Add addtional custom text to the adoption sign. Wiki markup allowed.

Examples
Note in these examples the lines have been broken so that the example remains visible. When used each parameter should be typed on a single row with no return until the next parameter/end of the table.