Template:Weekly site information/doc: Difference between revisions
Jump to navigation
Jump to search
Dat Hack3r (talk | contribs) m (Improved TemplateData description.) |
Dat Hack3r (talk | contribs) (Added {{Lua}}.) |
||
| (2 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
{{Tlx|Weekly site information}} generates | {{High priority}} | ||
{{Lua|Module:Weekly site information}} | |||
{{Tlx|Weekly site information}} generates links to Weekly Briefing Releases. To use it, [[MW:Transclusion|transclude]] the template, and it will automatically insert a link to the most recent Weekly Briefing Release, determined automatically according to the release schedule. If the most recent Weekly Briefing Release is unavailable, the template automatically links to the last existing release. | |||
* {{Tlx|Weekly site information}} → | * {{Tlx|Weekly site information}} → | ||
*: {{Weekly site information}} | *: {{Weekly site information}} | ||
By default, the link displays as "Weekly Site Information". To display custom text, pass the custom text as the first parameter: | |||
* {{Tlx|Weekly site information|Weekly Briefing}} → | * {{Tlx|Weekly site information|Weekly Briefing}} → | ||
*: {{Weekly site information|Weekly Briefing}} | *: {{Weekly site information|Weekly Briefing}} | ||
This template can also display a previous Weekly Briefing Release relative to the current Release using {{para|offset}}: | |||
* {{Tlx|Weekly site information|2=offset=-1}} → | |||
*: {{Weekly site information|offset=-1}} | |||
* {{Tlx|Weekly site information|Weekly Briefing|3=offset=-1}} → | |||
*: {{Weekly site information|Weekly Briefing|offset=-1}} | |||
== TemplateData == | == TemplateData == | ||
<templatedata> | <templatedata> | ||
{ | { | ||
"description": "This template generates | "description": "This template generates links to Weekly Briefing Releases.", | ||
"params": { | "params": { | ||
"1": { | "1": { | ||
| Line 20: | Line 29: | ||
"example": "Weekly Briefing", | "example": "Weekly Briefing", | ||
"default": "Weekly Site Information" | "default": "Weekly Site Information" | ||
}, | |||
"offset": { | |||
"label": "Offset", | |||
"description": "How many releases prior to the current one to link to.", | |||
"example": "-1", | |||
"type": "number", | |||
"default": "0" | |||
} | } | ||
}, | }, | ||
"format": "inline" | "format": "inline", | ||
"maps": { | |||
"a": {}, | |||
"asd": {} | |||
} | |||
} | } | ||
</templatedata> | </templatedata> | ||
Latest revision as of 14:02, 2 December 2024
 | This template is a high priority for maintenance as it is original to the OWOT Wiki and used in articles. As such, this template may contain bugs and it should be a top priority of template maintainers to quickly fix any issues that arise with it. Discuss breaking changes on the talk page before implementing them. |
 | This template uses Lua: |
{{Weekly site information}} generates links to Weekly Briefing Releases. To use it, transclude the template, and it will automatically insert a link to the most recent Weekly Briefing Release, determined automatically according to the release schedule. If the most recent Weekly Briefing Release is unavailable, the template automatically links to the last existing release.
By default, the link displays as "Weekly Site Information". To display custom text, pass the custom text as the first parameter:
{{Weekly site information|Weekly Briefing}}→
This template can also display a previous Weekly Briefing Release relative to the current Release using |offset=:
{{Weekly site information|offset=-1}}→{{Weekly site information|Weekly Briefing|offset=-1}}→
TemplateData
This template generates links to Weekly Briefing Releases.
| Parameter | Description | Type | Status | |
|---|---|---|---|---|
| Link text | 1 | Text to display for the generated link
| String | optional |
| Offset | offset | How many releases prior to the current one to link to.
| Number | optional |