Difference between revisions of "Template:FromOther/doc"
m (Bug workaround for document-transclude) |
(Update) |
||
Line 1: | Line 1: | ||
This is a page-top or section-top template used to mark pages originally from different wiki projects. | This is a page-top or section-top template used to mark pages originally from different wiki projects. | ||
==Syntax== | ==Syntax== | ||
− | + | You may simply use <code><nowiki>{{FromOther}}</nowiki></code>, but this is not recommended. Instead, you are encouraged to give credit whenever you can. <!-- | |
− | + | ||
− | + | Two shortcuts were setup for Wikipedia and Moegirlpedia. See below for details.--> | |
− | + | ===Common usage=== | |
− | + | In most cases, you can use: | |
− | {{FromOther| | + | |
− | + | <code><nowiki>{{FromOther|site=|originURL=|origin=|copyright=cc|lsubtype=by-sa|lver=4.0|contribURL=}}</nowiki></code> | |
− | {{FromOther|sect=sect|Chinese | + | |
+ | You will provide the site name, a link to original page, the name of the page, and a link to a list of contributors. This particular template declares that the original page is shared under CC BY-SA 4.0. Make sure to check if the license is correct. | ||
+ | |||
+ | For works that have few contributors or no website detailing the contributors, you may use <code>contributors</code> instead of <code>contribURL</code>. | ||
+ | |||
+ | For example: If you are to reference "Earth" from English wikipedia, use | ||
+ | <nowiki>{{FromOther|</nowiki>site='''English Wikipedia'''|originURL='''https://en.wikipedia.org/wiki/Earth'''|origin='''Earth'''|copyright=cc|lsubtype=by-sa|lver=4.0|contribURL='''https://en.wikipedia.org/w/index.php?title=Earth&action=history'''}}</code> | ||
+ | which yields | ||
+ | {{FromOther|site=English Wikipedia|originURL=https://en.wikipedia.org/wiki/Earth|origin=Earth|copyright=cc|lsubtype=by-sa|lver=4.0|contribURL=https://en.wikipedia.org/w/index.php?title=Earth&action=history}} | ||
+ | |||
+ | ===The <code>sect</code> parameter=== | ||
+ | You can use <code>|sect=sect</code>to mark a section instead of the entire page. | ||
+ | <nowiki>{{FromOther|</nowiki>'''sect=sect'''|site='''Chinese Moegirlpedia'''|originURL='''https://zh.moegirl.org/博丽灵梦#基本资料'''|origin='''博丽灵梦#基本资料'''|copyright=cc|lsubtype=<span style="font-weight:bold;color:#F00;">by-nc-sa</span>|lver=4.0|contribURL='''https://zh.moegirl.org/index.php?title=博丽灵梦&action=history'''}} | ||
+ | yields | ||
+ | {{FromOther|sect=sect|site=Chinese Moegirlpedia|originURL=https://zh.moegirl.org/博丽灵梦#基本资料|origin=博丽灵梦#基本资料|copyright=cc|lsubtype=by-nc-sa|lver=4.0|contribURL=https://zh.moegirl.org/index.php?title=博丽灵梦&action=history}} | ||
+ | |||
+ | ===The <code>copyright</code> parameter=== | ||
+ | Currently, the <code>copyright</code> parameter allows one to choose between three types of predefined license or define their own license. | ||
+ | |||
+ | #Creative Commons. | ||
+ | #*<code>copyright=cc</code>. | ||
+ | #*You will also need to provide the license subtype (e.g. "BY", "BY-NC-SA", etc.) via the <code>lsubtype</code> parameter and the license version via the <code>lver</code> parameter. | ||
+ | #*The template will automatically generate link to the respective CC licenses with the above provided information; do not use <code>licenseURL</code>. | ||
+ | #*Special support is made for CC0 1.0. The license subtype is <code>zero</code>. | ||
+ | #*Barebone: <code><nowiki>{{FromOther|copyright=cc|lsubtype=|lver=|contribURL=}}</nowiki></code> | ||
+ | #Public Domain. | ||
+ | #*<code>copyright=pd</code>. | ||
+ | #*Although it is not necessary to credit public domain material, it is a good gesture to do so. | ||
+ | #*Barebone: <code><nowiki>{{FromOther|copyright=pd}}</nowiki></code> | ||
+ | #Agreement. | ||
+ | #*<code>copyright=agreement</code>. | ||
+ | #*This applies when a copyright holder(s) agree to release their copyrighted material for use by Moegirlpedia. Credit as usual, but use <code>licenseURL</code> to provide a link to the text of the agreement or proof of its existence if possible. | ||
+ | #*Barebone: <code><nowiki>{{FromOther|copyright=agreement|contribURL=}}</nowiki></code> | ||
+ | #Other licenses. | ||
+ | #*Let <code>copyright</code> be the name of the license (e.g. <code>copyright=the Apache License</code>), and use <code>licenseURL</code> to provide a link to the text of the license. Credit the contributors as required by the license. | ||
+ | #*Barebone: <code><nowiki>{{FromOther|copyright=|contribURL=}}</nowiki></code> | ||
==Template data== | ==Template data== | ||
<templatedata> | <templatedata> | ||
Line 15: | Line 50: | ||
"1": { | "1": { | ||
"label": "site", | "label": "site", | ||
− | "description": "The name of the original site", | + | "description": "The name of the original site.", |
− | "example": "Chinese | + | "example": "Chinese Moegirlpedia", |
"type": "string", | "type": "string", | ||
"suggested": true, | "suggested": true, | ||
− | "default": "another wiki project" | + | "default": "another wiki project", |
+ | "aliases": [ | ||
+ | "site" | ||
+ | ] | ||
}, | }, | ||
"2": { | "2": { | ||
Line 26: | Line 64: | ||
"example": "[https://zh.moegirl.org/Are_you_OK Are you OK]", | "example": "[https://zh.moegirl.org/Are_you_OK Are you OK]", | ||
"type": "string", | "type": "string", | ||
− | "suggested": true | + | "suggested": true, |
+ | "aliases": [ | ||
+ | "page" | ||
+ | ] | ||
}, | }, | ||
"sect": { | "sect": { | ||
Line 33: | Line 74: | ||
"example": "sect", | "example": "sect", | ||
"type": "string", | "type": "string", | ||
+ | "autovalue": "sect" | ||
+ | }, | ||
+ | "originURL": { | ||
+ | "description": "Alternate to \"page\". Provide the link to the origin page.", | ||
+ | "example": "https://zh.moegirl.org/Are_You_OK", | ||
+ | "type": "url", | ||
"autovalue": "" | "autovalue": "" | ||
+ | }, | ||
+ | "origin": { | ||
+ | "description": "Alternate to \"page\". Provide the name of the origin page; requires \"originURL\".", | ||
+ | "example": "Are You OK", | ||
+ | "type": "string" | ||
+ | }, | ||
+ | "copyright": { | ||
+ | "description": "Provide the copyright type. Use \"cc\" of Creative Commons, \"pd\" for public domain, \"agreement\" or agreements with the copyright holder, or license name for anything else.", | ||
+ | "example": "cc; pd; the Apache license;", | ||
+ | "type": "string", | ||
+ | "autovalue": "cc", | ||
+ | "suggested": true | ||
+ | }, | ||
+ | "lsubtype": { | ||
+ | "label": "license subtype", | ||
+ | "description": "Used presently with \"copyright=cc\" only. Provide the correct CC license subtype (e.g. \"BY-NC-SA\").", | ||
+ | "example": "BY-NC-SA; BY; zero; ", | ||
+ | "type": "string", | ||
+ | "autovalue": "BY-NC-SA", | ||
+ | "suggested": true | ||
+ | }, | ||
+ | "lver": { | ||
+ | "label": "license version", | ||
+ | "description": "Used presently with \"copyright=cc\" only. Provide the correct license version.", | ||
+ | "example": "3.0; 4.0;", | ||
+ | "type": "string", | ||
+ | "autovalue": "4.0", | ||
+ | "suggested": true | ||
+ | }, | ||
+ | "licenseURL": { | ||
+ | "description": "An URL to the license or agreement. Do not use if the license type is CC; template will handle linking.", | ||
+ | "type": "url", | ||
+ | "autovalue": "", | ||
+ | "label": "license URL" | ||
+ | }, | ||
+ | "contributors": { | ||
+ | "description": "A list of contributors. Use only when the contributors are few.", | ||
+ | "example": "John Doe; Anna Ivanova and Xiaogang Wang; AWikiUser et al.;", | ||
+ | "type": "string" | ||
+ | }, | ||
+ | "contribURL": { | ||
+ | "label": "contributor URL", | ||
+ | "description": "A link to the list of contributors. For wiki projects, this is usually the history page.", | ||
+ | "example": "https://zh.moegirl.org/index.php?title=Are_You_OK&actgion=history;", | ||
+ | "type": "url", | ||
+ | "suggested": true | ||
} | } | ||
}, | }, | ||
− | "description": "Page-top (or section-top) notice for pages originally from | + | "description": "Page-top (or section-top) notice for pages and materials originally from different contributors.", |
"paramOrder": [ | "paramOrder": [ | ||
"1", | "1", | ||
"2", | "2", | ||
− | "sect" | + | "sect", |
+ | "originURL", | ||
+ | "origin", | ||
+ | "copyright", | ||
+ | "lsubtype", | ||
+ | "lver", | ||
+ | "licenseURL", | ||
+ | "contributors", | ||
+ | "contribURL" | ||
], | ], | ||
"format": "inline" | "format": "inline" | ||
} | } | ||
</templatedata> | </templatedata> |
Revision as of 19:30, 8 February 2020
This is a page-top or section-top template used to mark pages originally from different wiki projects.
Contents
Syntax
You may simply use {{FromOther}}
, but this is not recommended. Instead, you are encouraged to give credit whenever you can.
Common usage
In most cases, you can use:
{{FromOther|site=|originURL=|origin=|copyright=cc|lsubtype=by-sa|lver=4.0|contribURL=}}
You will provide the site name, a link to original page, the name of the page, and a link to a list of contributors. This particular template declares that the original page is shared under CC BY-SA 4.0. Make sure to check if the license is correct.
For works that have few contributors or no website detailing the contributors, you may use contributors
instead of contribURL
.
For example: If you are to reference "Earth" from English wikipedia, use
{{FromOther|site=English Wikipedia|originURL=https://en.wikipedia.org/wiki/Earth|origin=Earth|copyright=cc|lsubtype=by-sa|lver=4.0|contribURL=https://en.wikipedia.org/w/index.php?title=Earth&action=history}}
which yields
The sect
parameter
You can use |sect=sect
to mark a section instead of the entire page.
{{FromOther|sect=sect|site=Chinese Moegirlpedia|originURL=https://zh.moegirl.org/博丽灵梦#基本资料|origin=博丽灵梦#基本资料|copyright=cc|lsubtype=by-nc-sa|lver=4.0|contribURL=https://zh.moegirl.org/index.php?title=博丽灵梦&action=history}}
yields
The copyright
parameter
Currently, the copyright
parameter allows one to choose between three types of predefined license or define their own license.
- Creative Commons.
copyright=cc
.- You will also need to provide the license subtype (e.g. "BY", "BY-NC-SA", etc.) via the
lsubtype
parameter and the license version via thelver
parameter. - The template will automatically generate link to the respective CC licenses with the above provided information; do not use
licenseURL
. - Special support is made for CC0 1.0. The license subtype is
zero
. - Barebone:
{{FromOther|copyright=cc|lsubtype=|lver=|contribURL=}}
- Public Domain.
copyright=pd
.- Although it is not necessary to credit public domain material, it is a good gesture to do so.
- Barebone:
{{FromOther|copyright=pd}}
- Agreement.
copyright=agreement
.- This applies when a copyright holder(s) agree to release their copyrighted material for use by Moegirlpedia. Credit as usual, but use
licenseURL
to provide a link to the text of the agreement or proof of its existence if possible. - Barebone:
{{FromOther|copyright=agreement|contribURL=}}
- Other licenses.
- Let
copyright
be the name of the license (e.g.copyright=the Apache License
), and uselicenseURL
to provide a link to the text of the license. Credit the contributors as required by the license. - Barebone:
{{FromOther|copyright=|contribURL=}}
- Let
Template data
<templatedata> { "params": { "1": { "label": "site", "description": "The name of the original site.", "example": "Chinese Moegirlpedia", "type": "string", "suggested": true, "default": "another wiki project", "aliases": [ "site" ] }, "2": { "label": "page", "description": "The page of the origin. Links should be provided.", "example": "Are you OK", "type": "string", "suggested": true, "aliases": [ "page" ] }, "sect": { "label": "is section", "description": "Use \"sect\" verbatim to mark a section as from another wiki project, instead of the entire page. All other inputs are ignored.", "example": "sect", "type": "string", "autovalue": "sect" }, "originURL": { "description": "Alternate to \"page\". Provide the link to the origin page.", "example": "https://zh.moegirl.org/Are_You_OK", "type": "url", "autovalue": "" }, "origin": { "description": "Alternate to \"page\". Provide the name of the origin page; requires \"originURL\".", "example": "Are You OK", "type": "string" }, "copyright": { "description": "Provide the copyright type. Use \"cc\" of Creative Commons, \"pd\" for public domain, \"agreement\" or agreements with the copyright holder, or license name for anything else.", "example": "cc; pd; the Apache license;", "type": "string", "autovalue": "cc", "suggested": true }, "lsubtype": { "label": "license subtype", "description": "Used presently with \"copyright=cc\" only. Provide the correct CC license subtype (e.g. \"BY-NC-SA\").", "example": "BY-NC-SA; BY; zero; ", "type": "string", "autovalue": "BY-NC-SA", "suggested": true }, "lver": { "label": "license version", "description": "Used presently with \"copyright=cc\" only. Provide the correct license version.", "example": "3.0; 4.0;", "type": "string", "autovalue": "4.0", "suggested": true }, "licenseURL": { "description": "An URL to the license or agreement. Do not use if the license type is CC; template will handle linking.", "type": "url", "autovalue": "", "label": "license URL" }, "contributors": { "description": "A list of contributors. Use only when the contributors are few.", "example": "John Doe; Anna Ivanova and Xiaogang Wang; AWikiUser et al.;", "type": "string" }, "contribURL": { "label": "contributor URL", "description": "A link to the list of contributors. For wiki projects, this is usually the history page.", "example": "https://zh.moegirl.org/index.php?title=Are_You_OK&actgion=history;", "type": "url", "suggested": true } }, "description": "Page-top (or section-top) notice for pages and materials originally from different contributors.", "paramOrder": [ "1", "2", "sect", "originURL", "origin", "copyright", "lsubtype", "lver", "licenseURL", "contributors", "contribURL" ], "format": "inline" } </templatedata>