Template:HandbookLink/doc
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 is used to create an internal link inside of the Handbook. Its design intention is to point to the appropriate equivalent translated page, if it exists.
This template will only work within the Handbook namespace; it will not work correctly in any other place...
Parameters
The unnamed parameter should exclude the BASEPAGE name of "Handbook:" or "Parts:", but include the rest of the canonical path and, if applicable, the section name as well. For example:
{{HandbookLink|Blocks/Bootloader|section=#Debugging GRUB|Debugging GRUB}}
Link to a page that can automatically point to a translated page if it exists
| Parameter | Description | Type | Status | |
|---|---|---|---|---|
| Link | 1 | Internal Handbook link
| String | required |
| Section | section anchor | A section of an internal link with a preceding # to designate an anchor
| String | optional |
| Alternate text | 2 | Optional text to replace the page name; use for translations and other context
| String | suggested |
Rationale
To do
Usage
See the template's testcases:
Correct
{{HandbookLink|Blocks/Bootloader}}
{{HandbookLink|Blocks/Bootloader|Bootloader}}
{{HandbookLink|Blocks/Bootloader|section=#Debugging GRUB|Debugging GRUB}}