Template:User Russian city/adoc
This is a helper template to generate documentation for userbox templates. Use this template in conjunction with Template:User Russian city.
Usage
How to create /doc subpage?
- Click
[create]link from the userbox page - Copy code from the section below
- Replace all code with the copied code (boilerplate like {{Documentation subpage}},
<includeonly>...</includeonly>, and {{Sandbox other}} will be automatically created or transcluded) - Publish page
Code
Code to create a userbox documentation subpage:
{{subst:User Russian city/adoc/boilerplate|city=city name|image2=right box filename|verb1=custom verb phrase for documentation example}}
- for example:
{{subst:User Russian city/adoc/boilerplate|city=Moscow|image2=Moscow Business Center 5073-84.jpg|verb1=comes from}}
Code above was used to create example documentation page Template:User Russian city/example/doc (with categorization manually removed afterwards). After the subpage /doc has been created, you can add additional parameters, described in section "Parameters" below.
Parameters
|1=city name- First positional parameter is city name. Required.
|image1=filename|image2=filename- Custom left and right images for examples. Optional.
|usage=extra text- Additional text to be shown in the "Usage" section. Optional.
|example-row=extra example- Additional row to add to the big table of examples. Use this if userbox supports some custom parameters. Optional. Example of usage can be seen on page Template:User Nizhny Novgorod/doc. Due to mixing of template and table syntax, usage of
{{!}}is required for separation of table cells. |verb1=custom verb|verb2=custom verb- Custom verbs for examples. Optional.
|usercategory2=custom category- Custom category, if userbox doesn't use the default category "Users in <city name>". Optional.
|usercategory3=category- Additional user category. Optional.