Appearance
Type a name in double square brackets and TekStacks turns it into a link to that equipment, person, place, page, file or change. The record links back to the pages that mention it.
Overview
In a documentation page, or in the What was done field of a change, write a name between [[ and ]]:
| You type | It links to |
|---|---|
[[Branch network standard]] | the documentation page with that title |
[[Firewall rule for Denver RDP]] | the change with that title |
[[backup-config.ps1]] | the file or snippet with that name |
[[IT-00042]] | the equipment with that asset tag |
[[West Branch]] | the location with that name |
[[Jane Doe]] | the employee with that name or email |
TekStacks checks in that order: a page title first, then a change, a file, an equipment tag, a location, and an employee. The first match wins. A name that matches nothing stays as plain text, and each reader only gets a link to something they are allowed to see.
Equipment, employee and location pages show a Documented in list of the pages that mention them, so you can go from a laptop or a branch office straight to its documentation.
Requirements
- Role: Write, archive and restore documentation to add links (Admin, Manager and Technician by default). Readers need permission to see the linked record.
Steps
- Edit a page.
- Type the name exactly as TekStacks shows it, inside double square brackets, such as
[[IT-00042]]. - Click Save. The name becomes a link.
Notes
Note: Brackets inside code blocks and inline code are left alone, since Mermaid diagrams use
[[ ]]for a shape.
Note: Documented in lists pages that contain the equipment's asset tag, or the employee's name or email, or the location's name, written in brackets. Archived pages are left out.
Troubleshooting
My link shows as plain text. The name does not match anything, or you cannot see what it names. Check the spelling against the record, such as the asset tag on the equipment page.
The link goes to the wrong record. A page title is checked before everything else. If a page has the same title as a location or a person, the link goes to the page. Rename one of them, or link with an asset tag or email instead.