Template:Issue/Documentation: Difference between revisions

Help

Latest revision as of 03:12, 3 December 2023

Template:Issue categorizes articles with open issues on the system GitHub.

It accepts a mandatory integer parameter, the issue number.

It has a second optional parameter, that alters the behavior if set to inline.

The basic behavior creates a foot note. Some text{{Issue|1}} here. returns:

Some text^{[git 1]} here.

...and...

If the second parameter is inline, such as It looks like {{Issue|1|inline}} insted., it returns:

It looks like GitHub Issue #1 instead.

@@ Line 3: / Line 3: @@
 ==Usage==
 It accepts a {{Parameter|mandatory|integer}}, the issue number.
+It has a second {{Parameter|optional}}, that alters the behavior if set to {{Code|inline}}.
 ==Returns==
-{{Code|<nowiki>Some text{{Issue|1}} here.</nowiki>}} returns: {{Return|Some text{{Issue|1}} here.}} ...and... {{Return|<references group="git" />}}
+The basic behavior creates a foot note. {{Code|<nowiki>Some text{{Issue|1}} here.</nowiki>}} returns: {{Return|Some text{{Issue|1}} here.}} ...and... {{Return|<references group="git" />}}
-==Note==
+If the second parameter is {{Code|inline}}, such as {{Code|<nowiki>It looks like {{Issue|1|inline}} insted.</nowiki>}}, it returns: {{Return|It looks like {{Issue|1|inline}} instead.}}
-In order for a parameter to appear in a {{Code|<nowiki><ref></nowiki>}}, it must be wrapped in a {{Code|<nowiki>{{#var}}</nowiki>}} statement, or the input won't be processed until ''after'' the reference tag is generated. That same variable is leveraged by {{Template|References}} to determine wether or not it should generate reference sections.