Difference between revisions of "Template:Infobox software licence/doc"

From blackwiki
Jump to navigation Jump to search
imported>Kirkgaard
(document spdx id)
imported>Shkuru Afshar
 
(8 intermediate revisions by one other user not shown)
Line 2: Line 2:
 
<!-- EDIT TEMPLATE DOCUMENTATION BELOW THIS LINE -->
 
<!-- EDIT TEMPLATE DOCUMENTATION BELOW THIS LINE -->
  
This template creates an infobox useful for summarizing common characteristics of [[Free software|Free Software]] and [[Open-source software|Open Source Software]] [[software licence|licences]].
+
{{Format TemplateData|TOC=1|1=
 +
<templatedata>
 +
{
 +
"description": "This template creates an infobox useful for summarizing common characteristics of [[Free software|Free Software]] and [[Open-source software|Open Source Software]] [[software licence|licences]].",
 +
"params": {
 +
"name": {
 +
"description": "Name of the licence.",
 +
"type": "string"
 +
},
 +
"image": {
 +
"description": "Logo, mascot or emblem for licence.",
 +
"type": "wiki-file-name"
 +
},
 +
"caption": {
 +
"description": "Caption for the image.",
 +
"type": "string"
 +
},
 +
"author": {
 +
"description": "Person or an organization that created the licence.",
 +
"type": "string"
 +
},
 +
"version": {
 +
"description": "The version of the license.",
 +
"type": "string"
 +
},
 +
"copyright": {
 +
"description": "The copyright status of the software licence.",
 +
"type": "string"
 +
},
 +
"publisher": {
 +
"description": "Person or organization who published the licence or claims copyright on the licence itself.",
 +
"type": "string"
 +
},
 +
"date": {
 +
"description": "Date of publication of the licence.",
 +
"type": "string"
 +
},
 +
"spdx": {
 +
"description": "The [[SPDX]] identifier of the license. See the [https://spdx.org/licenses/ current license list] for valid values.",
 +
"type": "string",
 +
"default": "Fetched from Wikidata."
 +
},
 +
"Debian approved": {
 +
"description": "<code>Yes</code> if the licence is compatible with the [[Debian Free Software Guidelines]], <code>No</code> if not. [Information on whether a given licence meets this criterion may be found either at Debian's [http://wiki.debian.org/DFSGLicenses The DFSG and Software Licenses] or [http://www.debian.org/legal/licenses/ License information]. (Please read both, as licences in one list may not be in the other.)]",
 +
"type": "string"
 +
},
 +
"FSF approved": {
 +
"description": "<code>Yes</code> if the licence meets [[The Free Software Definition]], <code>No</code> if not. (Information on whether a given licence meets this criterion may be found at the FSF's [//www.gnu.org/licenses/license-list.html Various Licenses and Comments about Them].)",
 +
"type": "string",
 +
"aliases": [
 +
"Free Software"
 +
]
 +
},
 +
"OSI approved": {
 +
"description": "<code>Yes</code> if the [[Open Source Initiative]] has approved the licence, <code>No</code> if not. (Information on whether a given licence meets this criterion may be found either at the OSI's [http://www.opensource.org/licenses/alphabetical Alphabetical list] or the [http://www.opensource.org/licenses/category Categorical list].)",
 +
"type": "string"
 +
},
 +
"GPL compatible": {
 +
"description": "<code>Yes</code> if software licensed under the licence can be combined with software licensed under the [[GNU General Public License]], <code>No</code> if not. (Information on whether a given licence meets this criterion may be found at the FSF's [//www.gnu.org/licenses/license-list.html Various Licenses and Comments about Them].)",
 +
"type": "string"
 +
},
 +
"copyleft": {
 +
"description": "<code>Yes</code> if software licensed under the licence requires licensees to extend the same rights they received to others, <code>No</code> if not, or <code>Partial</code> if somewhere in the middle.",
 +
"type": "string"
 +
},
 +
"linking": {
 +
"description": "<code>Yes</code> if software licensed under the licence can be linked with software licensed under other licences, <code>No</code> if not.",
 +
"type": "string"
 +
},
 +
"website": {
 +
"description": "Either the website for the licence, or the canonical URL for the licence text itself.",
 +
"type": "string",
 +
"default": "Fetched from Wikidata."
 +
},
 +
"qid": {
 +
"description": "Wikidata item (QID) describing the license. Set to <code>none</code> to disable wikidata.",
 +
"default": "The QID linked to the page.",
 +
"type": "string"
 +
},
 +
"deprecated": {
 +
"description": "<code>Yes</code> if the publisher has declared this license deprecated, obsolete, or superseded.",
 +
"type": "string"
 +
}
 +
},
 +
"format": "block"
 +
}
 +
</templatedata>
 +
}}
  
=== Usage ===
+
== Usage ==
 
<pre style="overflow: auto">
 
<pre style="overflow: auto">
 
{{Infobox software licence
 
{{Infobox software licence
 
| name            =  
 
| name            =  
 
| image          =  
 
| image          =  
| caption        =
+
| caption        =  
 
| author          =  
 
| author          =  
 
| version        =  
 
| version        =  
 
| publisher      =  
 
| publisher      =  
 
| date            =  
 
| date            =  
| spdx            =
+
| spdx            =  
 
| OSI approved    = Yes or No or n/a
 
| OSI approved    = Yes or No or n/a
 
| Debian approved = Yes or No or n/a
 
| Debian approved = Yes or No or n/a
Line 21: Line 108:
 
| copyleft        = Yes or No or Partial
 
| copyleft        = Yes or No or Partial
 
| linking        = Yes or No
 
| linking        = Yes or No
| website        =
+
| website        =
 +
| deprecated      =  
 
}}
 
}}
 
</pre>
 
</pre>
  
=== Parameters ===
+
== Examples ==
All parameters are optional.
+
=== GPL 3.0 ===
 
 
; author: Person or an organization that created the licence.
 
; version: Version of the licence, if any.
 
; date: Date of publication of the licence.
 
; spdx: the [[SPDX]] identifier of the license. See the [https://spdx.org/licenses/ current license list] for valid values.
 
; OSI approved: <code>Yes</code> if the [[Open Source Initiative]] has approved the licence, <code>No</code> if not. (Information on whether a given licence meets this criterion may be found either at the OSI's [http://www.opensource.org/licenses/alphabetical Alphabetical list] or the [http://www.opensource.org/licenses/category Categorical list].)
 
; Debian approved: <code>Yes</code> if the licence is compatible with the [[Debian Free Software Guidelines]], <code>No</code> if not. [Information on whether a given licence meets this criterion may be found either at Debian's [http://wiki.debian.org/DFSGLicenses The DFSG and Software Licenses] or [http://www.debian.org/legal/licenses/ License information]. (Please read both, as licences in one list may not be in the other.)]
 
; FSF approved: <code>Yes</code> if the licence meets [[The Free Software Definition]], <code>No</code> if not. (Information on whether a given licence meets this criterion may be found at the FSF's [//www.gnu.org/licenses/license-list.html Various Licenses and Comments about Them].)
 
; GPL compatible: <code>Yes</code> if software licensed under the licence can be combined with software licensed under the [[GNU General Public License]], <code>No</code> if not. (Information on whether a given licence meets this criterion may be found at the FSF's [//www.gnu.org/licenses/license-list.html Various Licenses and Comments about Them].)
 
; copyleft: <code>Yes</code> if software licensed under the licence requires licensees to extend the same rights they received to others, <code>No</code> if not, or <code>Partial</code> if somewhere in the middle.
 
; linking: <code>Yes</code> if software licensed under the licence can be linked with software licensed under other licences, <code>No</code> if not.
 
; publisher: Person or organization who published the licence or claims copyright on the licence itself.
 
; name: Name of the licence.
 
; image: Logo, mascot or emblem for licence. Must take the form of an image reference (''e.g.'', <nowiki>[[Image:something.jpg]]</nowiki>).
 
; caption: Caption for the image.
 
; website: Either the website for the licence, or the canonical URL for the licence text itself.
 
 
 
=== Examples ===
 
==== GPL 3.0 ====
 
 
{{Infobox software licence
 
{{Infobox software licence
 
| name            = GNU General Public License
 
| name            = GNU General Public License
Line 61: Line 130:
 
| copyleft        = Yes
 
| copyleft        = Yes
 
| linking        = No
 
| linking        = No
| website        = [http://www.gnu.org/licenses/gpl.html www.gnu.org/licenses/gpl.html]
+
| website        = {{URL|http://www.gnu.org/licenses/gpl.html}}
 
}}
 
}}
  
Line 80: Line 149:
 
| copyleft        = Yes
 
| copyleft        = Yes
 
| linking        = No
 
| linking        = No
| website        = [http://www.gnu.org/licenses/gpl.html www.gnu.org/licenses/gpl.html]
+
| website        = {{URL|http://www.gnu.org/licenses/gpl.html}}
 
}}
 
}}
 
</syntaxhighlight>
 
</syntaxhighlight>
 
{{-}}
 
{{-}}
  
==== LGPL 1.0 ====
+
=== LGPL 1.0 ===
 
{{Infobox software licence
 
{{Infobox software licence
 
| name            = GNU Lesser General Public License
 
| name            = GNU Lesser General Public License
Line 119: Line 188:
 
}}
 
}}
 
</pre>
 
</pre>
 
==Template Data==
 
{{TemplateData header}}
 
 
<templatedata>
 
{
 
"description": "An infobox on software licences",
 
"params": {
 
"name": {
 
"description": "Name of the licence.",
 
"type": "string"
 
},
 
"image": {
 
"description": "Logo, mascot or emblem for licence.",
 
"type": "wiki-file-name"
 
},
 
"caption": {
 
"description": "Caption for the image.",
 
"type": "string"
 
},
 
"author": {
 
"description": "Person or an organization that created the licence.",
 
"type": "string"
 
},
 
"version": {
 
"description": "The version of the software.",
 
"type": "string"
 
},
 
"copyright": {
 
"description": "The copyright status of the software licence.",
 
"type": "string"
 
},
 
"publisher": {
 
"description": "Person or organization who published the licence or claims copyright on the licence itself.",
 
"type": "string"
 
},
 
"date": {
 
"description": "Date of publication of the licence.",
 
"type": "string"
 
},
 
"spdx": {
 
"description": "the SPDX identifier of the license.",
 
"type": "string"
 
},
 
"Debian approved": {
 
"description": "Yes if the licence is compatible with the Debian Free Software Guidelines, otherwise no.",
 
"type": "string"
 
},
 
"FSF approved": {
 
"description": "Yes if the licence meets The Free Software Definition, otherwise no.",
 
"type": "string"
 
},
 
"OSI approved": {
 
"description": "Yes if the Open Source Initiative has approved the licence, No if not.",
 
"type": "string"
 
},
 
"GPL compatible": {
 
"description": "Yes if software licensed under the licence can be combined with software licensed under the GNU General Public License, No if not.",
 
"type": "string"
 
},
 
"copyleft": {
 
"description": "Yes if software licensed under the licence requires licensees to extend the same rights they received to others, No if not, or Partial if somewhere in the middle.",
 
"type": "string"
 
},
 
"linking": {
 
"description": "Yes if software licensed under the licence can be linked with software licensed under other licences, No if not.",
 
"type": "string"
 
},
 
"website": {
 
"description": "The website of the licence, if it exists.",
 
"type": "string"
 
}
 
}
 
}
 
</templatedata>
 
  
 
<includeonly>{{Sandbox other||
 
<includeonly>{{Sandbox other||

Latest revision as of 04:48, 3 February 2021

This is the TemplateData documentation for this template used by VisualEditor and other tools; see the monthly parameter usage report for this template.

TemplateData for Infobox software licence

This template creates an infobox useful for summarizing common characteristics of Free Software and Open Source Software licences.

Template parameters

ParameterDescriptionTypeStatus
namename
Name of the licence.
Stringoptional
imageimage
Logo, mascot or emblem for licence.
Fileoptional
captioncaption
Caption for the image.
Stringoptional
authorauthor
Person or an organization that created the licence.
Stringoptional
versionversion
The version of the license.
Stringoptional
copyrightcopyright
The copyright status of the software licence.
Stringoptional
publisherpublisher
Person or organization who published the licence or claims copyright on the licence itself.
Stringoptional
datedate
Date of publication of the licence.
Stringoptional
spdxspdx
The SPDX identifier of the license. See the current license list for valid values.
Default
Fetched from Wikidata.
Stringoptional
Debian approvedDebian approved
Yes if the licence is compatible with the Debian Free Software Guidelines, No if not. [Information on whether a given licence meets this criterion may be found either at Debian's The DFSG and Software Licenses or License information. (Please read both, as licences in one list may not be in the other.)]
Stringoptional
FSF approvedFSF approved
Free Software
Yes if the licence meets The Free Software Definition, No if not. (Information on whether a given licence meets this criterion may be found at the FSF's Various Licenses and Comments about Them.)
Stringoptional
OSI approvedOSI approved
Yes if the Open Source Initiative has approved the licence, No if not. (Information on whether a given licence meets this criterion may be found either at the OSI's Alphabetical list or the Categorical list.)
Stringoptional
GPL compatibleGPL compatible
Yes if software licensed under the licence can be combined with software licensed under the GNU General Public License, No if not. (Information on whether a given licence meets this criterion may be found at the FSF's Various Licenses and Comments about Them.)
Stringoptional
copyleftcopyleft
Yes if software licensed under the licence requires licensees to extend the same rights they received to others, No if not, or Partial if somewhere in the middle.
Stringoptional
linkinglinking
Yes if software licensed under the licence can be linked with software licensed under other licences, No if not.
Stringoptional
websitewebsite
Either the website for the licence, or the canonical URL for the licence text itself.
Default
Fetched from Wikidata.
Stringoptional
qidqid
Wikidata item (QID) describing the license. Set to none to disable wikidata.
Default
The QID linked to the page.
Stringoptional
deprecateddeprecated
Yes if the publisher has declared this license deprecated, obsolete, or superseded.
Stringoptional

Format: block

Usage

{{Infobox software licence
| name            = 
| image           = 
| caption         = 
| author          = 
| version         = 
| publisher       = 
| date            = 
| spdx            = 
| OSI approved    = Yes or No or n/a
| Debian approved = Yes or No or n/a
| FSF approved    = Yes or No or n/a
| GPL compatible  = Yes or No
| copyleft        = Yes or No or Partial
| linking         = Yes or No
| website         = 
| deprecated      = 
}}

Examples

GPL 3.0

GNU General Public License
AuthorFree Software Foundation
Latest version3
PublisherFree Software Foundation, Inc.
Published29 June 2007
SPDX identifierGPL-3.0-only
Debian FSG compatibleYes
FSF approvedYes
OSI approvedYes
GPL compatibleYes
CopyleftYes
Linking from code with a different licenceNo
WebsiteTemplate:URL
{{Infobox software licence
| name            = GNU General Public License
| image           = 
| caption         = GNU GPLv3 Logo
| author          = [[Free Software Foundation]]
| version         = 3
| copyright       = Free Software Foundation, Inc.
| date            = 29 June 2007
| spdx            = GPL-3.0-only
| OSI approved    = Yes
| Debian approved = Yes
| FSF approved    = Yes
| GPL compatible  = Yes
| copyleft        = Yes
| linking         = No
| website         = {{URL|http://www.gnu.org/licenses/gpl.html}}
}}

LGPL 1.0

GNU Lesser General Public License
Heckert GNU white.svg
The GNU logo
AuthorFree Software Foundation
Latest version1.0
PublisherFree Software Foundation
Published1991
SPDX identifier{{#property:P2479|from=}}
Debian FSG compatibleYes
FSF approvedYes
OSI approvedYes
GPL compatibleYes
CopyleftYes
Linking from code with a different licenceYes
Website[Script error: No such module "If empty". ] 
{{Infobox software licence
| name            = GNU Lesser General Public License
| image           = [[Image:Heckert GNU white.svg|160px]]
| caption         = The GNU logo
| author          = [[Free Software Foundation]]
| version         = 1.0
| copyright       = Free Software Foundation
| date            = 1991
| OSI approved    = Yes
| Debian approved = Yes
| FSF approved    = Yes
| GPL compatible  = Yes
| copyleft        = Yes
| linking         = Yes
}}