User:WubTheCaptain/BSD/Freedoom/doc

A custom license template for BSD 3-clause licensed files in Category:Freedoom.

The template automatically sets the following categories:

Usage

{{User:WubTheCaptain/BSD/Freedoom |year= |typos= }}

This is intended to workaround the shortcomings of the {{BSD}} template for license compliance, namely omission of name of the Freedoom project from clause 3. See Commons:Village pump/Copyright/Archive/2017/08 § BSD 3-clause-like license for concerns.

Template parameters

ParameterDescriptionDefaultStatus
1Copyright holderIgnored by this template, because of awkward edge-case side-effects to wording of clause 3 and disclaimer.Contributors to the Freedoom project.deprecated
versionVersion of the BSD license (number of clauses)Ignored by this template and always 3-clause BSD.3deprecated
yearCopyright yearYear(s) of the initial publication, as they appear in copying conditions. May be empty (if it's certain copyright years were not included), but not undefined. This behavior differs from Template:BSD.<YEAR>required
typosRetain typos?Whether Freedoom should be uncapitalized in few instances to freedoom like in copying conditions of old Freedoom releases. Should be set for old releases when they appear.nosuggested
Template data
<templatedata>JSON</templatedata> ./. {{TemplateBox}}
TemplateData

TemplateData is a way to store information about template parameters (the description of those and of the whole template) for both humans and machines. It is used by VisualEditor and possibly other tools like Upload Wizard.


Existing template documentation
At Wikimedia Commons, it is recommended to use {{TemplateBox}} with either ‎useTemplateData=1 or ‎useTemplateData=only on the ‎/doc subpage and transcluding it with {{Documentation}} into the template. ‎<nowiki>-tags can be wrapped around the arguments, if required, to avoid templates being expanded.

Newly created template documentation and imports
Another option, especially for imported templates, or for users with JSON experience, is placing raw ‎<templatedata>-tags into the Wikitext of the template, as described in various Wikipediae.

Discussion
There is an ongoing discussion about that matter. Feel invited to comment if you are experienced in either way, your time permits and if you like to share your opinion or to make a suggestion.


Wikipedia's help about TemplateDataCommons-specific information

A custom license template for BSD 3-clause licensed files of Freedoom.

Template parameters

This template prefers inline formatting of parameters.

ParameterDescriptionTypeStatus
Copyright holder1

Default
Contributors to the Freedoom project.
Stringdeprecated
Retain typos?typos

Whether "Freedoom" should be uncapitalized in few instances to "freedoom" like in copying conditions of old Freedoom releases. Should be set for old releases when they appear.

Default
no
Stringsuggested
Version of the BSD license (number of clauses)version

Default
3
Numberdeprecated
Copyright yearyear

Year(s) of the initial publication, as they appear in copying conditions. May be empty (if it's certain copyright years were not included), but not undefined. This behavior differs from the original BSD template.

Default
<strong class="error">&lt;YEAR&gt;</strong>
Stringrequired

Additional information

The template is intended to be used in the following namespaces: the File namespace

The template is intended to be used by the following user groups: all users

Placement: In the "Permission" parameter of the {{Information}} template (or the respective parameter of similar templates) or in the "Licensing" section

Relies on:
{{BSD/layout}}

See also

Localization

This template is not intended to be localized.