Template:Confused/doc
From Gentoo Wiki
Jump to:navigation
Jump to:search
Note
This page is a template. It contains some standardized, often used text, which can be transcluded inside other pages. As this template is widely used in our wiki, it may be protected in which case only staff members can change it. Use the discussion page to propose enhancements or fixes, or to voice your opinion.
This page is a template. It contains some standardized, often used text, which can be transcluded inside other pages. As this template is widely used in our wiki, it may be protected in which case only staff members can change it. Use the discussion page to propose enhancements or fixes, or to voice your opinion.
This template can be used at the top of an article to distinguish it from superficially similar but unrelated article topics, such as (perhaps): LVM vs. LLVM, LXD vs. LXDE, and so forth. If the topics are closely related, then it is preferable to explicitly address their relationship early in the text of both articles (as seen at udev and eudev, for example) rather than using this template.
Parameters
| Parameter name | Required? | Default value | Description |
|---|---|---|---|
Anonymous parameter 1 |
Yes | (n/a) | link target |
The link target should exactly match a single article title and not be [[wikilinked]], since the linking is provided automatically by the template itself.
(Note: Eventually this template will allow for multiple link targets, but it doesn't yet.)
Usage
{{Confused|Page title}}
See the template's testcases:
Correct
One anonymous parameter: title of exisiting article
Creating a piped link
Wiki code
{{Confused|LXDE{{!}}the LXDE desktop environment}}
Main version
Not to be confused with the LXDE desktop environment.
Sandbox version
Not to be confused with the LXDE desktop environment.
↑ This how you could "explain" the link without needing to provide an explicit wikilink (which fails, as seen below).
Incorrect
No parameter (error message)
Wiki code
{{Confused}}
Main version
{{Confused template error}}
Parameter 1 not defined. For correct usage see Confused template's documentation on the
1 parameter.Sandbox version
{{Confused template error}}
Parameter 1 not defined. For correct usage see Confused template's documentation on the
1 parameter.
One anonymous parameter: wikilinked article title (reveals raw wikicode)
Trying to explain the link you're making (exposes raw wikicode)
↑ See the "Creating a piped link" example above for how to do this properly.