View source for Template:User WP/based/doc

{{tsh|User WP/sub}}
This is a documentation subtemplate, displaying default informations about WikiProject userboxes based on {{tln|User WP}}.

== Usage ==
To create a new WikiProject userbox, copy-paste and edit the following sample from {{tln|User WP Templates}}:
 <nowiki>{{</nowiki>'''User WP'''|''{{bg|#cec|Templates}}''<nowiki>|{{{1|}}}|{{{2|}}}|nocat={{{nocat|}}}}}<noinclude>{{</nowiki>'''{{nowrap|User WP/based}}'''{{wbr}}|''{{bg|#cec|Templates}}''<nowiki>}}</noinclude></nowiki>
In this example, the documentation subtemplate is:
 <nowiki>{{</nowiki>'''{{nowrap|User WP/based}}'''{{wbr}}|''{{bg|#cec|Templates}}''<nowiki>}}</nowiki>

=== Parameters ===
# Set the 1st unnamed parameter as the project name (e.g. <code>{{bg|lightgreen|Templates}}</code>), '''required''' to categorise the userbox template and make other parameters work.
# Set the 2nd unnamed parameter to <code>{{bg|lightgreen|list}}</code>, <code>{{bg|lightgreen|break}}</code> or <code>{{bg|lightgreen|all}}</code> to include related informations and [[Template:User WP/subex|examples]]; if the project name is shorter than 15 characters, <code>{{bg|lightgreen|list}}</code> is the default.
# Set the 2nd or 3rd unnamed parameter to <code>{{bg|lightgreen|regional}}</code> to include the template in [[:Category:Regional WikiProject user templates]].
# <code>Section =</code> for the optional member list section (default is 'Participants').
# <code>Add =</code> for additional sections.

== Notes ==
* {{tlx|User WP/sub}} is a shortcut to this subtemplate, {{tlx|User WP/based}}, and can be used in its place.
* This subtemplate automatically includes {{tln|Documentation}}.

[[Category:Documentation shared content templates]]