Template:User in body of water/doc

This multiuse regional user master template creates a userbox that identifies the association of a user with a body of water and declares appropriate regional user categories when placed on the user page.

This template is most commonly invoked by one of the User interest Body of Water templates which supply the parameters for this template to function as a metatemplate.

Use

The complete syntax of this template is:

{{user in body of water|option=|water=|simple=|inflect=|the=|title=|adj=|main=|member=|nocat=|ci=|cp=|cion=|cpon=|align=|color=|image=|width=|border-c=|id=|id-a=|id-c=|id-w=|info=|info-c=|info-fc=|info-lh=|info-s=|wp-s=}}

where:

• option= the option number (default=1, see the Options table below)
• water= the requiwed body of water name as listed in Wikipedia
• simple= the simplified form of the body of water name if different (default={{{water|}}})
• inflect= the inflected form of the body of water name if different (default={{{water|}}})
• the=the places a "the " before the body of water name (default=null)
• wrap=wrap allows a multi-word water name to break between lines (default=null)
• title= the fully formatted water title to be used in the userbox (default={{#if:{{{the|}}}|the }}[[{{{water|}}}|'''{{#if:{{{wrap|}}}||<span style="white-space:nowrap">}}{{{inflect|{{{simple|{{{water|}}}}}}}}}{{#if:{{{wrap|}}}||</span>}}''']])
• activity= is an optional verb phrase for option 1 (default=is interested in)
• project= the root name of the responsible regional WikiProject (default={{{simple|{{{water|}}}}}})
• member= the type of regional WikiProject membership:
  • member=member (default)
  • member=participant
  • member=volunteer
  • member=other
• ci= the root name of the interest in body of water user category
• cp= the root name of the body of water WikiProject membership category
• cion=yes declares the user page a member of the interest in body of water user category
• cpon=yes declares the user page a member of the body of water WikiProject membership category
• nocat=true disables the declaration of any user categories

Options table

option	userbox example	default user categories
0	none	Option 0 allows user categories to be declared without displaying a userbox
1	This user is interested in the Southern Ocean.	ci
2	This user is concerned about the Southern Ocean.	ci
3	This user depends upon the Southern Ocean.	ci
4	This user uses water from the Southern Ocean.	ci
5	This user loves the Southern Ocean.	ci
6	This user lives near the Southern Ocean.	none
7	This user lives on an island in the Southern Ocean.
8	This user works on the Southern Ocean.
9	This user enjoys recreation on the Southern Ocean.
10	This user swam in the Southern Ocean.
11	This user has sailed the Southern Ocean.
12	This user has visited the Southern Ocean.
13	This user frequently visits the Southern Ocean.
14	This user wishes to visit the Southern Ocean.
15	This user plans to sail the Southern Ocean.
16	This user wishes to sail the Southern Ocean.
98	This user is a member of WikiProject Oceans.	cp & ci
99	This user is associated with the Southern Ocean.	none

Userbox override parameters

The following additional parameters may be used to override this template's default userbox settings:

• float= an optional horizontal float of the userbox:
  • float=left (default)
  • float=right
  • float=none
• bodyclass= an optional bodyclass
• info-class= an optional info-class
• align= an optional horizontal alignment of the userbox text:
  • align=left
  • align=center (default)
  • align=right
  • align=justify
• color= an optional userbox background color (default= #3377BB , see web colors)
• image= an optional userbox image (default=Flag of {{#if:{{{the|}}}|the }}{{{water|}}}.svg)
• width= an optional maximum width of the userbox image in pixels (default=null, i.e., limited only by image height of 45 pixels)
• border-c= an alternate userbox border color (default=#3377BB)
• d-s= an alternate demonym emphasis font size in pixels (default=11, used for options 55 and 56 only)
• id= an alternate text or image to the default flag image
• id-a= an alternate horizontal alignment of the id (default=left)
  • id-a=left (default)
  • id-a=center
  • id-a=right
• id-c= an alternate id background color (default=#3377BB)
• id-w= an alternate width of the id in pixels (default=45)
• info= an alternate userbox text (see the Options table above for the defaults)
• info-c= an alternate info background color (default=#3377BB)
• info-class= an optional info-class
• info-fc= an alternate info font color (default=white)
• info-lh= an alternate info line height (default=125%)
• info-s= an alternate info font size in pixels (default=10)

See Template:Userbox for other default userbox settings.

Restriction

• This template should be invoked from the user page. This template will only declare user categories from the user namespace.

See also

• This template invokes Template:Userbox.
• This template is invoked by multiuse regional user templates.
• This template is similar to Template:User in region.