Difference between revisions of "Template:FromOther/doc"

From Moegirlpedia
Jump to: navigation, search
m
(Changing category)
 
(6 intermediate revisions by 4 users not shown)
Line 1: Line 1:
 +
<includeonly>[[Category:Page-top 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==
−
*You may simply use <code><nowiki>{{FromOther}}</nowiki></code>:
+
You may simply use <code><nowiki>{{FromOther}}</nowiki></code>, but this is not recommended. Instead, you are encouraged to give credit whenever you can. <!--
−
:{{FromOther}}
+
 
−
*To notify from which site is the page is from, use <code><nowiki>{{FromOther|name of wiki}}</nowiki></code>. For example, <code><nowiki>{{FromOther|Wikipedia}}</nowiki></code> yields:
+
Two shortcuts were setup for Wikipedia and Moegirlpedia. See below for details.-->
−
:{{FromOther|Wikipedia}}
+
===Common usage===
−
*You should also provide the link to the exact page: <code><nowiki>{{FromOther|Chinese Moe Girl Pedia|[https://zh.moegirl.org/Template:Info Template:Info]}}</nowiki></code> yields
+
In most cases, you can use:
−
:{{FromOther|Chinese Moe Girl Pedia|[https://zh.moegirl.org/Template:Info Template:Info]}}
+
 
−
*Use <code>|sect=sect</code>to mark a section instead of the entire page. <code><nowiki>{{FromOther|sect=sect|Chinese Moe Girl Pedia|[https://zh.moegirl.org/博丽灵梦#基本资料 博丽灵梦#基本资料]}}</nowiki></code> yields
+
<code><nowiki>{{FromOther|site=|originURL=|origin=|copyright=cc|lsubtype=by-sa|lver=4.0|contribURL=}}</nowiki></code>
−
:{{FromOther|sect=sect|Chinese Moe Girl Pedia|[https://zh.moegirl.org/博丽灵梦#基本资料 博丽灵梦#基本资料]}}
+
 
−
==Template data==
+
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.  
−
<templatedata>
+
 
−
{
+
For works that have few contributors or no website detailing the contributors, you may use <code>contributors</code> instead of <code>contribURL</code>.
−
"params": {
+
 
−
"1": {
+
For example: If you are to reference "Earth" from English wikipedia, use
−
"label": "site",
+
<nowiki>{{FromOther|</nowiki>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'''}}</code>
−
"description": "The name of the original site",
+
which yields
−
"example": "Chinese Moe Girl Pedia",
+
{{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}}
−
"type": "string",
+
 
−
"suggested": true,
+
===The <code>sect</code> parameter===
−
"default": "another wiki project"
+
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.cn/博丽灵梦#基本资料'''|origin='''博丽灵梦#基本资料'''|copyright=cc|lsubtype=<span style="font-weight:bold;color:#F00;">by-nc-sa</span>|lver=3.0|contribURL='''https://zh.moegirl.org.cn/index.php?title=博丽灵梦&action=history'''}}
−
"2": {
+
yields
−
"label": "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}}
−
"description": "The page of the origin. Links should be provided.",
+
 
−
"example": "[https://zh.moegirl.org/Are_you_OK Are you OK]",
+
===The <code>copyright</code> parameter===
−
"type": "string",
+
Currently, the <code>copyright</code> parameter allows one to choose between three types of predefined license or define their own license.
−
"suggested": true
+
 
−
},
+
#Creative Commons.
−
"sect": {
+
#*<code>copyright=cc</code>.
−
"label": "is section",
+
#*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.
−
"description": "Use \"sect\" verbatim to mark a section as from another wiki project, instead of the entire page. All other inputs are ignored.",
+
#*The template will automatically generate link to the respective CC licenses with the above provided information; do not use <code>licenseURL</code>.
−
"example": "sect",
+
#*Special support is made for CC0 1.0. The license subtype is <code>zero</code>.
−
"type": "string",
+
#*Barebone: <code><nowiki>{{FromOther|copyright=cc|lsubtype=|lver=|contribURL=}}</nowiki></code>
−
"autovalue": ""
+
#Public Domain.
−
}
+
#*<code>copyright=pd</code>.  
−
},
+
#*Although it is not necessary to credit public domain material, it is a good gesture to do so.
−
"description": "Page-top (or section-top) notice for pages originally from a different wiki project. ",
+
#*Barebone: <code><nowiki>{{FromOther|copyright=pd}}</nowiki></code>
−
"paramOrder": [
+
#Agreement.
−
"1",
+
#*<code>copyright=agreement</code>.
−
"2",
+
#*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.
−
"sect"
+
#*Barebone: <code><nowiki>{{FromOther|copyright=agreement|contribURL=}}</nowiki></code>
−
],
+
#Other licenses.
−
"format": "inline"
+
#*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>
−
</templatedata>
 

Latest revision as of 15:58, 4 September 2023

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

Other Wiki This template was originally from Earth in English Wikipedia, used here under CC BY-SA 3.0; the names of contributors can be found here.

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

Other Wiki This section was originally from 博丽灵梦#基本资料 in Chinese Moegirlpedia, used here under CC BY-NC-SA 3.0; the names of contributors can be found here.

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=}}
Retrieved from "https://en.moegirl.org.cn/index.php?title=Template:FromOther/doc&oldid=39215"