Difference between revisions of "Template:Api repository link/doc"
From Roll20 Wiki
Andreas J. (Talk | contribs) m |
Andreas J. (Talk | contribs) m |
||
| Line 1: | Line 1: | ||
{{documentation subpage|override=api repository link/doc|Api repository link}} | {{documentation subpage|override=api repository link/doc|Api repository link}} | ||
| − | Links to a file on the [https://github.com/Roll20/roll20-api-scripts API Script Repository]. {{tlx|repo}} | + | Links to a file on the [https://github.com/Roll20/roll20-api-scripts API Script Repository]. {{tlx|api-gh}}, {{tlx|repo}} are simpler versions of this. |
== Parameters == | == Parameters == | ||
Revision as of 10:29, 26 September 2021
 |
This is a documentation subpage for Api repository link. It contains usage information, categories and other content that is not part of the original template page. |
Links to a file on the API Script Repository. {{api-gh}}, {{repo}} are simpler versions of this.
Parameters
| Name | Description |
|---|---|
| directory | Directory from the root of the repository that the file is located in. Defaults to the first anonymous parameter. |
| file | File within the directory to link to. Defaults to the second anonymous parameter.
|
| ext | File extension of the file to link to. Defaults to the third anonymous parameter. |
If ext is supplied, the link is guaranteed to link to a file; if file is not supplied (for example, {{api repository link|ext=js|Foo}}), the directory will be used for the file name as well.
Usage
| Wikitext | Output | Notes |
|---|---|---|
{{api repository link|Foo}}
|
Foo | This links to /tree/master/Foo
|
{{api repository link|Foo|Bar}}
|
Bar | This links to /blob/master/Foo/Bar
|
{{api repository link|Foo|ext=md}}
|
Foo | This links to /blob/master/Foo/Foo.md
|
{{api repository link|Foo|Bar|json}}
|
Bar | This links to /blob/master/Foo/Bar.json
|
