Difference between revisions of "Template:Api repository link/doc"
From Roll20 Wiki
(→Usage) |
(→Parameters) |
||
| Line 11: | Line 11: | ||
|- | |- | ||
|| file | || file | ||
| − | || File within the <code>directory</code> to link to. Defaults to the | + | || File within the <code>directory</code> to link to. Defaults to the second anonymous parameter. |
|- | |- | ||
| − | || | + | || ext |
|| File extension of the file to link to. Defaults to the third anonymous parameter. | || File extension of the file to link to. Defaults to the third anonymous parameter. | ||
| − | |||
| − | |||
| − | |||
|} | |} | ||
| + | |||
| + | If <code>ext</code> is supplied, the link is guaranteed to link to a file; if <code>file</code> is ''not'' supplied (for example, <code><nowiki>{{api repository link|ext=js|Foo}}</nowiki></code>), the <code>directory</code> will be used for the file name as well. | ||
== Usage == | == Usage == | ||
Revision as of 17:31, 8 January 2015
Links to a file on the API Script Repository
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
|
