Template:Yy/doc
This is a documentation subpage for Template:Yy. It contains usage information, categories and other content that is not part of the original template page. |
This Yy series of templates can create a userbox table that displays a list of userboxes along with their Wikitext and the pages that invoke each userbox template. Templates also display boxes for WikiProjects, portals, and notice boards.
The yy template series comprises the following nine templates:
Template:Yytop
Template:Yytop always comes first to create the three column headings and to size the columns. Template:Yytop may also be used to create a centered table title.
{{yytop|title|headers=}}
where:
title
is the optional table title.headers=
is the optional column headings switch.headers=yes
creates three column headings (default)headers=no
creates no column headings.
Example
{{yytop|Userbox Templates}}
creates:
Wikitext | userbox | where used |
---|
Template:Yytop is very similar to Template:Usbktop except:
- Template:Yytop default sizes the three columns to 390, 250, and 80 pixels respectively.
Template:Usbktop does no default column sizing. - Template:Yytop places the linked labels Wiki markup, userbox, and where used centered at the top of each column.
Template:Usbktop places the labels Code and Result left justified at the top of the first two columns only. - Template:Yytop may be used to create a centered table title.
Template:Yy
Template:Yy creates a single table row with the template Wiki markup, the template box, and a link to the list of pages that link to the called template.
{{yy|template|par1|...|par12}}
where:
template
is the required template name.par1|...|par12
are up to 12 optional template parameters.
A zero-width space ​
may be used to represent a missing parameter.
Example
{{yy|User in New Zealand|5|comment=parameter: number from 1 to 64}}
creates:
{{User in New Zealand
|
|
linked pages parameter: number from 1 to 64 |
Template:Yy is similar to Template:Usbk except:
- Template:Yy will pass up to 12 parameters to the called template.
Template:Usbk will pass no more than three parameters to the called template. - Template:Yy forces all cells to align to the left.
Template:Usbk uses the default object alignment. - Template:Yy uses the same category suppression as Template:Usbk.
Template:Yycat
Template:Yycat creates a reference to a category.
{{yycat|category|link=}}
where:
category
is the required category name.link=
is the optional link to the category. (default=no)
Example
{{yycat|Wikipedians in South Africa|link=yes}}
creates:
[[Category:Wikipedians in South Africa]] | none | linked pages |
Template:Yytxt
Template:Yytxt creates a row of text in the table.
{{yytop|txt1|txt2|txt3|opt=}}
where:
txt1
is the optional text for the table or first column.txt2
is the optional text for the second columntxt3
is the optional text for the third columnopt=
is the optional format parameter:opt=1
creates a line of left-justified text (default)opt=2
creates a line of table-centered textopt=3
creates a line of right-justified textopt=4
creates a line of left-justified text for each columnopt=5
creates a line of column-centered text for each columnopt=6
creates a line of right-justified text for each columnopt=7
recreates the column headings of Template:Yytop
If all three optional text parameters are blank or missing, a blank row will be inserted.
Example
{{yytxt|Residence:}}
creates:
Residence: |
Template:Usbkbreak centers text on only the first two columns and has no other options.
Template:Yytab
- See also Template:yytabcities—a shortcut for
{{yytab}}
for location related userboxes.
Template:Yytab creates a pointer to another table. Template:Yytab may be used to break an overly large table into subtables.
{{yytab|name|page name|desc=|image=|size=|alone=}}
where:
name
(first positional argument) is the required name of a region, portal, noticeboard, WikiProject. (See Module:Portal/images)page name
(second positional argument) is the optional page name of the subtable. (default=Wikipedia:Userboxes/Location/name
)desc=
is the optional description of the subtable. (default=name
userbox templates)image=
is the optional image file. (default image file from Module:Portal/images)size=
is the optional image size. (default=x45px
)info-s=
is the optional font size. (default=9
)alone=
is the optional stand alone switch.alone=no
pointer is part of a table. (default)alone=yes
pointer in its own table.
Example
{{yytab|Canada|alone=yes}}
creates:
See Wikipedia:Userboxes/ |
Script error: No such module "userbox". |
{{yytab|United Arab Emirates|info-s=8|alone=yes}}
creates:
See Wikipedia:Userboxes/ |
Script error: No such module "userbox". |
Template:Yytab is somewhat similar to Template:usee.
Template:Yywp
Template:Yywp creates a WikiProject box.
{{yywp|wikiproject|group|type|label|folder=|size=}}
where:
wikiproject
is the required WikiProject base name.group
an optional project group base name if any.type
an optional project group type if any.label
an optional WikiProject box label. (default=WikiProjectwikiproject
orgroup
type
)folder=
is an optional WikiProject folder name.size=
is the optional image size. (default=x45px
)
Examples
{{yywp|New South Wales}}
creates:
[[Wikipedia:WikiProject New South Wales]] | Script error: No such module "userbox". | linked pages |
and {{yywp|California|Los Angeles|task force}}
creates:
[[Wikipedia:WikiProject California/Los Angeles task force]] | Script error: No such module "userbox". | linked pages |
Template:WikiProject box creates a smaller standalone WikiProject box.
Template:Yyp
Template:Yyp creates a portal box.
{{yyp|portal|size=}}
where:
portal
is the required portal name.size=
is the optional image size. (default=x45px
)
Example
{{yyp|South Africa}}
creates:
{{Portal:South Africa}} | Script error: No such module "userbox". | linked pages |
Template:Portal creates a smaller standalone portal box.
Template:Yynb
Template:Yynb creates a noticeboard box.
{{yynb|noticeboard|size=}}
where:
notice
is the required noticeboard base name.size=
is the optional image size. (default=x45px
)
Example
{{yynb|Pakistan}}
creates:
{{Wikipedia talk:Notice board for Pakistan-related topics}} | Script error: No such module "userbox". | linked pages |
Template:Noticeboard box creates a smaller standalone notice board box.
Template:Yybottom
Template:Yybottom always comes last and completes the table.
{{yybottom|comment}}
where:
comment
is an optional comment to appear at the bottom right of the table.
Template:Usbkbottom is similar to Template:Yybottom but does not permit a comment line.
Table example
The following Wiki markup:
- {{yytop|[[Samoan Archipelago]]}}
- {{yytxt|American Samoa:}}
- {{yywp|Polynesia|American Samoa|work group}}
- {{yy|User in American Samoa}}
- {{yy|User wishes to visit|American Samoa}}
- {{yy|User American Samoa WG}}
- {{yytab|American Samoa|Wikipedia:Userboxes/Location/Oceania#American Samoa}}
- {{yytxt|Samoa:}}
- {{yy|User citizen Samoa}}
- {{yy|User interest Samoa}}
- {{yy|User WP Samoa}}
- {{yytab|Samoa|Wikipedia:Userboxes/Location/Oceania#Samoa}}
- {{yybottom|updated 2 October 2017}}
creates the following table:
Wikitext | userbox | where used | ||
---|---|---|---|---|
American Samoa: | ||||
[[Wikipedia:WikiProject Polynesia/American Samoa work group]] | Script error: No such module "userbox". | linked pages | ||
{{User in American Samoa}}
|
|
linked pages | ||
{{User wishes to visit
|
Script error: No such module "For nowiki". | linked pages | ||
{{User American Samoa WG}}
|
|
linked pages | ||
See Wikipedia:Userboxes/ |
Script error: No such module "userbox". | |||
Samoa: | ||||
{{User citizen Samoa}}
|
|
linked pages | ||
{{User interest Samoa}}
|
|
linked pages | ||
{{User WP Samoa}}
|
|
linked pages | ||
See Wikipedia:Userboxes/ |
Script error: No such module "userbox". | |||
updated 14 October 2017 |
See also
- Similar templates:
- {{Usbk}}
- {{Usbkbottom}}
- {{Usbkbreak}}
- {{Usbkext}}
- {{Usbktop}}
- {{Usbk/light}}
- {{Usee}}
- {{Xy}}
- See examples of yy userbox tables at Wikipedia:Userboxes/Location.
- For help with these templates, please post a comment on the template talk page.