Template:License/doc: Difference between revisions

From Valve Developer Community
Jump to navigation Jump to search
mNo edit summary
 
(23 intermediate revisions by the same user not shown)
Line 1: Line 1:
{{Doc/subpage}}Template used to indicate the license of a copyrighted work.
{{Doc/subpage}}Template for adding licensing notices. Mainly intended for use on files, but this template is applicable elsewhere.


== Copy and Paste ==
== Copy and Paste ==
{{CodeBlock|<nowiki>{{Copyright
{{CodeBlock|<nowiki>{{License
| license =
| type =
}}</nowiki>}}
}}</nowiki>}}
== Translations ==
The used strings are on [[/strings|strings subpage]]. Please follow the format to add translations for them.
You may also use the strings subpage in order to compartmentalize template code when possible.
== Testcases ==
Testcases for this template can be located on the [[/testcases|testcases subpage]].


== Parameters and Examples ==
== Parameters and Examples ==
Line 13: Line 21:
|-
|-
| align="center" | {{Code|style=2|{{Param|type}}}}
| align="center" | {{Code|style=2|{{Param|type}}}}
| String parameter for specifying the license
| String parameter for specifying the permission notice
| {{CodeBlock|margin=5px|<nowiki>| license = MIT</nowiki>}}
| {{CodeBlock|margin=5px|<nowiki>| type = MIT</nowiki>}}
|-
| align="center" | {{Code|style=2|{{Param|author}}}}
| For specifying an author in the event that it is possible
| {{CodeBlock|margin=5px|<nowiki>| author = Example</nowiki>}}
|-
| align="center" | {{Code|style=2|{{Param|version}}}}
| Parameter used to change the version of the permission notice if available
| {{CodeBlock|margin=5px|<nowiki>| version = 3.0</nowiki>}}
|-
| align="center" | {{Code|style=2|{{Param|region}}}}
| Parameter used to change to a region specific version of the permission notice if available.
| {{CodeBlock|margin=5px|<nowiki>| region = us</nowiki>}}
|}
|}
== Available License Notices ==
{{CodeBlock|src=Software Licenses|<nowiki>{{Copyright|license=MIT}}</nowiki>}}
{{Capsule|{{Copyright|license=MIT}}}}

Latest revision as of 13:17, 14 July 2023

Edit-copy.png
This is a documentation subpage for Template:License.
Don't forget to purge the contents of the base page upon creating or editing this subpage.

Template for adding licensing notices. Mainly intended for use on files, but this template is applicable elsewhere.

Copy and Paste

{{License | type = }}

Translations

The used strings are on strings subpage. Please follow the format to add translations for them.

You may also use the strings subpage in order to compartmentalize template code when possible.

Testcases

Testcases for this template can be located on the testcases subpage.

Parameters and Examples

Parameter Description Example
{{{type}}} String parameter for specifying the permission notice
| type = MIT
{{{author}}} For specifying an author in the event that it is possible
| author = Example
{{{version}}} Parameter used to change the version of the permission notice if available
| version = 3.0
{{{region}}} Parameter used to change to a region specific version of the permission notice if available.
| region = us