Template:UsersSpeak/doc

From the AARoads Wiki: Read about the road before you go
Jump to navigation Jump to search

UsersSpeak displays a box intended for use in the heading of a user language category page such as Category:User zh. It is not intended for use on User: pages.

Usage

{{UsersSpeak | 1=iso | 3=preamble | font=size | link=Language article | text=Link text }}

The first parameter is the ISO 639 code of the language represented. It is recommended but defaults to "und" for undefined. The second parameter is ignored. (It was previously used for the language name, which is now retrieved automatically.) The third parameter, if given, is text which appears in the top right section of the box. The following optional named parameters are supported:

  • A font size such as font=12; the default is 14-point. Note that this parameter expects a numeric size rather than a font name.
  • An article title such as link=Lebanese Arabic; the default is to retrieve this automatically from the ISO code.
  • Link text such as text=the Lebanese variety of Arabic; the default is the article title. |text= works only if |link= is used.

TemplateData

This is the TemplateData for this template used by TemplateWizard, VisualEditor and other tools. See a monthly parameter usage report for Template:UsersSpeak in articles based on its TemplateData.

TemplateData for UsersSpeak

<templatedata> { "description": "Display a box in the heading of a user language category page", "params": { "1": { "label": "1", "description": "The ISO 639 code of the language", "type": "number", "required": false, "example": "zh", "default": "und" }, "3": { "label": "3", "description": "Text for the top right section of the box", "type": "string", "required": false, "example": "这些用户会说中文。", "default": "(no text)" }, "font": { "label": "font", "description": "font size", "type": "number", "required": false, "example": "12", "default": "14" }, "link": { "label": "link", "description": "Article title", "type": "string", "required": false, "example": "Lebanese Arabic", "default": "(retrieved automatically)" }, "text": { "label": "text", "description": "Text displayed on article link", "type": "string", "required": false, "example": "the Lebanese variety of Arabic", "default": "(article title)" } }, "format": "inline" } </templatedata>