Difference between revisions of "Template:FromOther/doc"

From Moegirlpedia
Jump to: navigation, search
m (+.cn)
(Tag: Automation tool)
Line 1: Line 1:
 +
<includeonly>[[Category:Templates]][[zh:Template:FromOther]][[ja:Template:FromOther]]</includeonly>
 
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==

Revision as of 14:22, 27 February 2022

This is a page-top or section-top template used to mark pages originally from different wiki projects.

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=3.0|contribURL=https://en.wikipedia.org/w/index.php?title=Earth&action=history}}

which yields

The sect parameter

You can use |sect=sectto mark a section instead of the entire page.

{{FromOther|sect=sect|site=Chinese Moegirlpedia|originURL=https://zh.moegirl.org.cn/博丽灵梦#基本资料|origin=博丽灵梦#基本资料|copyright=cc|lsubtype=by-nc-sa|lver=3.0|contribURL=https://zh.moegirl.org.cn/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.

  1. 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 the lver 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=}}
  2. 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}}
  3. 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=}}
  4. Other licenses.
    • Let copyright be the name of the license (e.g. copyright=the Apache License), and use licenseURL to provide a link to the text of the license. Credit the contributors as required by the license.
    • Barebone: {{FromOther|copyright=|contribURL=}}

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.cn/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.cn/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>