Template:About user/doc: Difference between revisions

From Our World of Text Wiki
Jump to navigation Jump to search
(Created documentation.)
 
(Added TemplateData.)
 
(6 intermediate revisions by the same user not shown)
Line 1: Line 1:
{{Tlc|About user}} makes the important distinction between a Wiki page about a user on OWOT and a user page. To use it, insert the template at the top of a page, and it will automatically create a hatnote that makes the distinction: {{Tlx|About user}} → {{About user}}
{{Tlx|About user}} makes the important distinction between a Wiki page about an OWOT user and a user page. To use it, [[MW:Transclusion|transclude]] the template at the top of Wiki pages about OWOT users and user pages, and it will automatically create a clarifying hatnote.
If the link is incorrect, you can manually specify the correct page name: {{Tlx|About user|owot}} → {{About user|owot}}
 
; On a Wiki page : {{Tlx|About user}} → {{About user}}
; On a user page : {{Tlx|About user}} → {{Hatnote|This is the [https://www.mediawiki.org/wiki/Help:User_page user page] of the user on this Wiki. For the page about the OWOT user, see [[{{PAGENAME}}]].}}
 
If the link is incorrect, you can manually specify the correct page name:
 
; On a Wiki page : {{Tlx|About user|Owot}} → {{About user|Owot}}
; On a user page : {{Tlx|About user|Owot}} → {{Hatnote|This is the [https://www.mediawiki.org/wiki/Help:User_page user page] of the user on this Wiki. For the page about the OWOT user, see [[Owot]].}}
 
== TemplateData ==
<templatedata>
{
"params": {
"1": {
"label": "Page name",
"description": "The page name of the article or the user page to link to if the default link is incorrect",
"example": "Owot",
"type": "wiki-page-name",
"default": "By default, this template will link to the article or user page with the same base page name (i.e., excluding namespace) as the page it is on."
}
},
"description": "This template creates a clarifying hatnote to distinguish between a Wiki page about an OWOT user and the corresponding user page on the Wiki.",
"format": "inline"
}
</templatedata>

Latest revision as of 18:16, 18 November 2024

{{About user}} makes the important distinction between a Wiki page about an OWOT user and a user page. To use it, transclude the template at the top of Wiki pages about OWOT users and user pages, and it will automatically create a clarifying hatnote.

On a Wiki page
{{About user}}
On a user page
{{About user}}

If the link is incorrect, you can manually specify the correct page name:

On a Wiki page
{{About user|Owot}}
On a user page
{{About user|Owot}}

TemplateData

This template creates a clarifying hatnote to distinguish between a Wiki page about an OWOT user and the corresponding user page on the Wiki.

Template parameters

This template prefers inline formatting of parameters.

ParameterDescriptionTypeStatus
Page name1

The page name of the article or the user page to link to if the default link is incorrect

Default
By default, this template will link to the article or user page with the same base page name (i.e., excluding namespace) as the page it is on.
Example
Owot
Page nameoptional