Wikipedia>Voidxor: Remove second (and in my opinion, not really needed) example that was adding geographic coordinates to the upper right corner of this documentation page and all templates that transclude it.

2021-05-12T22:47:37Z

Remove second (and in my opinion, not really needed) example that was adding geographic coordinates to the upper right corner of this documentation page and all templates that transclude it.

New page

{{documentation subpage}}
This Yy series of [[Help:Template|templates]] can create a [[Help:Table|userbox table]] that displays a list of [[Wikipedia:Userboxes|userboxes]] along with their [[Help:Wikitext|Wikitext]] and the pages that invoke each userbox template. Templates also display boxes for [[Wikipedia:WikiProject|WikiProjects]], [[Wikipedia:Portal|portals]], and [[Wikipedia:Noticeboards|notice boards]].

The yy template series comprises the following nine templates:

<div style="text-align: center;">{{tlx|yytop}} {{tlx|yy}} {{tlx|yycat}} {{tlx|yytxt}} {{tlx|yytab}} {{tlx|yywp}} {{tlx|yyp}} {{tlx|yynb}} {{tlx|yybottom}}</div>

{{clear}}

==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.
'''<samp><nowiki>{{yytop|title|headers=}}</nowiki></samp>'''
where:
*'''<code>title</code>''' is the optional table title.
*'''<code>headers=</code>''' is the optional column headings switch.
**'''<code>headers=yes</code>''' creates three column headings (default)
**'''<code>headers=no</code>''' creates no column headings.

'''Example''' 
'''<code><nowiki>{{yytop|Userbox Templates}}</nowiki></code>''' creates: 
{{yytop|Userbox Templates}}
{{yybottom}}
{{clear}}

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#Editing|Wiki markup]]''''', '''''[[Wikipedia:Userboxes|userbox]]''''', and '''''[[Wikipedia:User pages|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.
'''<samp><nowiki>{{yy|template|par1|...|par12}}</nowiki></samp>'''
where:
*'''<code>template</code>''' is the required template name. 
*'''<code>par1|...|par12</code>''' are up to 12 optional template parameters.
A zero-width space <samp><code>&#8203;</code></samp> may be used to represent a missing parameter.

'''Example''' 
'''<code><nowiki>{{yy|User in New Zealand|5|comment=parameter: number from 1&nbsp;to&nbsp;64}}</nowiki></code>''' creates: 
{{yytop|headers=no}}
{{yy|User in New Zealand|5|comment=parameter: number from 1 to 64}}
{{yybottom}}
{{clear}}

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 [[Wikipedia:Category suppression|category suppression]] as [[Template:Usbk]].

==Template:Yycat==
[[Template:Yycat]] creates a reference to a category.
'''<samp><nowiki>{{yycat|category|link=}}</nowiki></samp>'''
where: 
*'''<code>category</code>''' is the required category name.
*'''<code>link=</code>''' is the optional link to the category. (default=no)

'''Example''' 
'''<code><nowiki>{{yycat|Wikipedians in South Africa|link=yes}}</nowiki></code>''' creates: 
{{yytop|headers=no}}
{{yycat|Wikipedians in South Africa|link}}
{{yybottom}}
{{clear}}

==Template:Yytxt==
[[Template:Yytxt]] creates a row of text in the table.
'''<samp><nowiki>{{yytop|txt1|txt2|txt3|opt=}}</nowiki></samp>'''
where: 
*'''<code>txt1</code>''' is the optional text for the table or first column. 
*'''<code>txt2</code>''' is the optional text for the second column 
*'''<code>txt3</code>''' is the optional text for the third column 
*'''<code>opt=</code>''' is the optional format parameter:
**'''<code>opt=1</code>''' creates a line of left-justified text (default)
**'''<code>opt=2</code>''' creates a line of table-centered text
**'''<code>opt=3</code>''' creates a line of right-justified text
**'''<code>opt=4</code>''' creates a line of left-justified text for each column
**'''<code>opt=5</code>''' creates a line of column-centered text for each column
**'''<code>opt=6</code>''' creates a line of right-justified text for each column
**'''<code>opt=7</code>''' recreates the column headings of Template:Yytop
If all three optional text parameters are blank or missing, a blank row will be inserted.

'''Example''' 
'''<code><nowiki>{{yytxt|Residence:}}</nowiki></code>''' creates: 
{{yytop|headers=no}}
{{yytxt|Residence:}}
{{yybottom}}
{{clear}}

[[Template:Usbkbreak]] centers text on only the first two columns and has no other options.

==Template:Yytab==
: ''See also [[Template:yytabcities]]—a shortcut for {{tlx|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.
'''<samp><nowiki>{{yytab</nowiki>|<var>name</var>|<var>page name</var>|desc=|image=|size=|alone=<nowiki>}}</nowiki></samp>'''
where:
*'''<code>name</code>''' (first positional argument) is the required name of a region, portal, noticeboard, WikiProject. (See [[Module:Portal/images]])
*'''<code>page name</code>''' (second positional argument) is the optional page name of the subtable. (default=Wikipedia:Userboxes/Location/'''<code>name</code>''')
*'''<code>desc=</code>''' is the optional description of the subtable. (default='''<code>name</code>''' userbox templates)
*'''<code>image=</code>''' is the optional image file. (default image file from [[Module:Portal/images]])
*'''<code>size=</code>''' is the optional image size. (default='''<code>x45px</code>''')
*'''<code>info-s=</code>''' is the optional font size. (default='''<code>9</code>''')
*'''<code>alone=</code>''' is the optional stand alone switch.
**'''<code>alone=no</code>''' pointer is part of a table. (default)
**'''<code>alone=yes</code>''' pointer in its own table.

'''Example''' 
'''<code><nowiki>{{yytab|Canada|alone=yes}}</nowiki></code>''' creates: 
{{yytab|Canada|alone=yes}}
{{clear}}

'''<code><nowiki>{{yytab|United Arab Emirates|info-s=8|alone=yes}}</nowiki></code>''' creates: 
{{yytab|United Arab Emirates|info-s=8|alone=yes}}
{{clear}}

Template:Yytab is somewhat similar to [[Template:usee]].

==Template:Yywp==
[[Template:Yywp]] creates a WikiProject box.
'''<samp><nowiki>{{yywp|wikiproject|group|type|label|folder=|size=}}</nowiki></samp>'''
where:
*'''<code>wikiproject</code>''' is the required WikiProject base name.
*'''<code>group</code>''' an optional project group base name if any.
*'''<code>type</code>''' an optional project group type if any.
*'''<code>label</code>''' an optional WikiProject box label. (default=WikiProject '''<code>wikiproject</code>''' or '''<code>group</code>''' '''<code>type</code>''')
*'''<code>folder=</code>''' is an optional WikiProject folder name.
*'''<code>size=</code>''' is the optional image size. (default='''<code>x45px</code>''')

'''Examples''' 
'''<code><nowiki>{{yywp|New South Wales}}</nowiki></code>''' creates: 
{{yytop|headers=no}}
{{yywp|New South Wales}}
{{yybottom}}
and '''<code><nowiki>{{yywp|California|Los Angeles|task force}}</nowiki></code>''' creates: 
{{yytop|headers=no}}
{{yywp|California|Los Angeles|task force}}
{{yybottom}}
{{clear}}

[[Template:WikiProject box]] creates a smaller standalone WikiProject box.

==Template:Yyp==
[[Template:Yyp]] creates a portal box.
'''<samp><nowiki>{{yyp|portal|size=}}</nowiki></samp>'''
where:
*'''<code>portal</code>''' is the required portal name.
*'''<code>size=</code>''' is the optional image size. (default='''<code>x45px</code>''')

'''Example''' 
'''<code><nowiki>{{yyp|South Africa}}</nowiki></code>''' creates: 
{{yytop|headers=no}}
{{yyp|South Africa}}
{{yybottom}}
{{clear}}

[[Template:Portal]] creates a smaller standalone portal box.

==Template:Yynb==
[[Template:Yynb]] creates a noticeboard box.
'''<samp><nowiki>{{yynb|noticeboard|size=}}</nowiki></samp>'''
where:
*'''<code>notice</code>''' is the required noticeboard base name.
*'''<code>size=</code>''' is the optional image size. (default='''<code>x45px</code>''')

'''Example''' 
'''<code><nowiki>{{yynb|Pakistan}}</nowiki></code>''' creates: 
{{yytop|headers=no}}
{{yynb|Pakistan}}
{{yybottom}}
{{clear}}

[[Template:Noticeboard box]] creates a smaller standalone notice board box.

==Template:Yybottom==
[[Template:Yybottom]] always comes last and completes the table.
'''<code><nowiki>{{yybottom|comment}}</nowiki></code>'''
where:
*'''<code>comment</code>''' 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: 
:<samp>'''<nowiki>{{yytop|[[Samoan Archipelago]]}}</nowiki>'''</samp> 
:<samp>'''<nowiki>{{yytxt|American Samoa:}}</nowiki>'''</samp> 
:<samp>'''<nowiki>{{yywp|Polynesia|American Samoa|work group}}</nowiki>'''</samp> 
:<samp>'''<nowiki>{{yy|User in American Samoa}}</nowiki>'''</samp> 
:<samp>'''<nowiki>{{yy|User wishes to visit|American Samoa}}</nowiki>'''</samp> 
:<samp>'''<nowiki>{{yy|User American Samoa WG}}</nowiki>'''</samp> 
:<samp>'''<nowiki>{{yytab|American Samoa|Wikipedia:Userboxes/Location/Oceania#American Samoa}}</nowiki>'''</samp> 
:<samp>'''<nowiki>{{yytxt|Samoa:}}</nowiki>'''</samp> 
:<samp>'''<nowiki>{{yy|User citizen Samoa}}</nowiki>'''</samp> 
:<samp>'''<nowiki>{{yy|User interest Samoa}}</nowiki>'''</samp> 
:<samp>'''<nowiki>{{yy|User WP Samoa}}</nowiki>'''</samp> 
:<samp>'''<nowiki>{{yytab|Samoa|Wikipedia:Userboxes/Location/Oceania#Samoa}}</nowiki>'''</samp> 
:<samp>'''<nowiki>{{yybottom|updated 2 October 2017}}</nowiki>'''</samp> 
creates the following table: 
{{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 14 October 2017}}

==See also==
{{WPbox|Userboxes}}
* Similar templates:
** {{tl|Usbk}}
** {{tl|Usbkbottom}}
** {{tl|Usbkbreak}}
** {{tl|Usbkext}}
** {{tl|Usbktop}}
** {{tl|Usbk/light}}
** {{tl|Usee}}
** {{tl|Xy}}
* See examples of yy userbox tables at [[Wikipedia:Userboxes/Location]].
* For help with these templates, please post a comment on the [[Template talk:{{ROOTPAGENAME}}|template talk page]].
{{WP:UBS}}
<includeonly>{{Sandbox other||
[[Category:Userbox arrangement templates]]
}}</includeonly>

Template:Yy/doc - Revision history

Wikipedia>Voidxor: Remove second (and in my opinion, not really needed) example that was adding geographic coordinates to the upper right corner of this documentation page and all templates that transclude it.