Difference between revisions of "Template:Merge/doc"

m (updating)
m
 
Line 1: Line 1:
−
{{documentation subpage}}
+
{{Documentation subpage}}
−
<!-- EDIT TEMPLATE DOCUMENTATION BELOW THIS LINE -->
+
<!-- PLEASE ADD CATEGORIES AT THE BOTTOM OF THIS PAGE, AND INTERWIKIS TO WIKIDATA -->
−
==Purpose==
 
−
This template will add tagged pages to {{clc|Articles to be merged}}.
 
  
−
==Usage==
+
== Which merge template should I use? ==
−
This template is to be placed on the top of all pages that are candidates for merging
+
{{strong|Do not use this tag on a [[BTW:Template|template]] or [[BTW:Categorization|category]]}}—instead see [[#When to use and when not to use|below]] for instructions.
  
−
*Place the bold at the top of the page(replacing "Article to be merged" with the article):
+
* To merge at least two page together at an unspecified location, use {{tlx|Merge|OtherPage}}
−
: '''<nowiki>{{Merge|Article to be merged}}</nowiki>'''
+
* To merge the contents of the tagged page {{em|into}} another page, use {{tlx|Merge to|DestinationPage}}
 +
* If the contents of another page should be merged into the tagged page, use {{tlx|Merge from|SourcePage}} &ndash; the opposite of {{tlx|Merge to}};
 +
* To suggest merging only some material from one page to another, use {{tlx|Merge portions from|SourcePage}} and {{tlx|Split portions|DestinationPage}}
  
−
<includeonly>
+
== Terminology ==
 +
''Source page'' is the page that content is merged from.
 +
 
 +
''Destination page'' or target page is the page that content is merged into.
 +
 
 +
''Other page'' is any page involved in a merger.
 +
 
 +
== When to use and when not to use==
 +
These templates are used primarily to identify potential merges that would benefit from discussion.  If it is obvious that a merge would be appropriate, then you may [[BTW:Be bold|boldly]] merge the pages yourself without tagging and without discussion.  Some editors also use these tags to mark pages that obviously require merging in the hope that someone else will merge the pages.
 +
 
 +
After adding the merge tag, you are expected to create a section on the talk page of the appropriate article (see below for details) explaining your rationale for the merge proposal. If the rationale is so obvious that it requires no explanation, then you should consider boldly merging the pages yourself, or explain on the talk page why you didn't do so yourself.
 +
 
 +
== How to use ==
 +
===Simple example===
 +
Tagging a single page, without specifying source or destination, is simple:
 +
 
 +
{{markup
 +
|<nowiki>{{Merge|OtherPage |date=</nowiki>{{CURRENTMONTHNAME}} {{CURRENTYEAR}}<nowiki> }}
 +
or
 +
{{Merge |OtherPage |{{subst:DATE}} }}</nowiki>
 +
|{{Mbox
 +
|name  = Merge
 +
|type  = move
 +
|image = [[File:Merge-arrows.svg|50px|alt=|link=]]
 +
|text  = It has been suggested that this {{#if:|section|{{#if:{{NAMESPACE}}|page|article}}}} be [[Wikipedia:Merging|merged]] with {{Pagelist|nspace=all|delim=''|OtherPage|||||||||||||||||||}}{{#if:|&nbsp;to ''[[:{{{target}}}|{{{target}}}]]''|}}. ([[:{{TALKPAGENAME}}|Discuss]]){{#if:October 2017|<small>'' Proposed since October 2017.''</small>}}
 +
}}{{Merge partner|OtherPage}}
 +
 
 +
}}
 +
 
 +
When you want to discuss a simple merge of one page into another, tag both source and destination page:
 +
{{markup
 +
|<nowiki>{{Merge to |DestinationPage |date=</nowiki>{{CURRENTMONTHNAME}} {{CURRENTYEAR}}<nowiki> }}
 +
or
 +
{{Merge to |DestinationPage |{{subst:DATE}} }}</nowiki>
 +
|{{Mbox
 +
|name = Merge to
 +
|demospace=
 +
|type = move
 +
|image=[[File:Merge-arrow.svg|alt=|link=]]
 +
|text=It has been suggested that this {{#if:|section|{{#if:{{NAMESPACE}}|page|article}}}} be [[Wikipedia:Merging|merged]] into {{#if:|&nbsp;''[[:{{NAMESPACE}}:{{{target}}}|{{{target}}}]]''|{{Pagelist|nspace=all|delim=''|DestinationPage|||||||||||||||||||}}}}. ([[{{TALKPAGENAME:DestinationPage}}|Discuss]]){{#if:October 2017|<small>'' Proposed since October 2017.''</small>}}
 +
}}{{Merge partner|DestinationPage}}
 +
 
 +
}}
 +
 
 +
{{markup
 +
|<nowiki>{{Merge from |SourcePage |date=</nowiki>{{CURRENTMONTHNAME}} {{CURRENTYEAR}}<nowiki> }}
 +
or
 +
{{Merge from |SourcePage |{{subst:DATE}} }}</nowiki>
 +
|{{Mbox
 +
| name  = Merge from
 +
| demospace=
 +
| type  = move
 +
| image = [[File:Mergefrom.svg|50px|alt=|link=]]
 +
| text  = It has been suggested that {{#ifeq:{{{multiplesections}}}|yes|multiple sections of&nbsp;}}{{Pagelist|nspace=all|delim=''|SourcePage|||||||||||||||||||}} be [[Wikipedia:Merging|merged]] into this {{#if:|section|{{#if:{{NAMESPACE}}|page|article}}}}. ([[{{TALKPAGENAME}}|Discuss]]){{#if:October 2017|<small>'' Proposed since October 2017.''</small>}}
 +
}}{{Merge partner|SourcePage}}
 +
 
 +
}}
 +
 
 +
This allows editors at both pages to see the proposed source and destination.
 +
 
 +
===Other options===
 +
By default, the {{Color|#002BB8|Discuss}} link on the template links to the top of the destination page's [[Help:Talk pages|talk page]]. To specify which section, or to name a different talk page entirely, use the {{para|discuss}} AKA {{para|talk}} parameter:
 +
 
 +
: {{tlx|{{BASEPAGENAME}} |OtherPage&nbsp;|discuss{{=}}Talk:OtherPage#Merger discussion&nbsp;|date{{=}}{{CURRENTMONTHNAME}} {{CURRENTYEAR}} }}
 +
 
 +
To name multiple pages to be merged, simply separate them with a vertical pipe. You can add up to 20 articles to be merged:
 +
 
 +
: {{tlx|{{BASEPAGENAME}} |OtherPage1&nbsp;|OtherPage2&nbsp;|OtherPage3&nbsp;|discuss{{=}}Talk:OtherPage#Merger discussion&nbsp;|date{{=}}{{CURRENTMONTHNAME}} {{CURRENTYEAR}} }}
 +
 
 +
{{#ifeq:{{BASEPAGENAME}}|Merge|To name multiple pages to merge {{em|into}} a single page, use the {{para|target}} parameter. For example, to merge the tagged page, as well as SourcePage1, SourcePage2, and SourcePage3 into DestinationPage, use:
 +
 
 +
: {{tlx|{{BASEPAGENAME}} |SourcePage1&nbsp;|SourcePage2&nbsp;|SourcePage3&nbsp;|target{{=}}DestinationPage&nbsp;|discuss{{=}}Talk:OtherPage#Merger discussion&nbsp;|date{{=}}{{CURRENTMONTHNAME}} {{CURRENTYEAR}} }}{{break}}|To name multiple pages to merge {{em|into}} a single page, use the {{para|target}} parameter, available only with the {{tlx|merge}} template.{{break}}}}<!-- ifeq end -->
 +
If you are placing the template in a section, you can use {{para|section|yes}} to change the wording to reflect this:
 +
: {{tlx|{{BASEPAGENAME}} |OtherPage&nbsp;|discuss{{=}}Talk:OtherPage#Merger discussion&nbsp;|date{{=}}{{CURRENTMONTHNAME}} {{CURRENTYEAR}}&nbsp;|section{{=}}yes}}
 +
 
 +
* {{strong|Do not link to the pages}} with square brackets.<br />For example, write {{Tlx|Merge|OtherPage}}, {{em|not}} <s>{{Tlx|Merge|&#91;&#91;OtherPage&#93;&#93;}}</s>.
 +
* The date {{em|might not}} be shown in the box. Do not be concerned about this. It is used when grouping tagged pages together into categories by date.
 +
* These templates will add tagged articles to [[:Category:Articles to be merged]], while non-articles (files, templates, etc.) will be added to [[:Category:Miscellany to be merged]].
 +
* For {{tlx|Merge}}, if you are specifying a merge of two or more pages in different namespaces, the template supports this via specification of the {{em|full}} page name, including the namespace prefix. {{para|nspace}} can take on namespace values, which fixes all params to the namespace specified.
 +
* Do not [[BTW:Substitution|<code>subst:</code>]] these templates.
 +
 
 +
==When to remove==
 +
There is no deadline for completing proposed merges. Pages that have been tagged for a long time (frequently more than one year) generally fall into these groups:
 +
 
 +
;Discussion supported the proposed merge, but no one did it yet:  Feel free to merge the pages yourself.
 +
;Discussion opposed merge, but nobody removed the tags:  Feel free to remove the tags yourself.
 +
;No discussion found:  Feel free to remove the tags if you believe the merge would be a poor choice, or to boldly merge the pages if you believe the merge would be appropriate.  Or feel free to start a discussion if you are uncertain or feel it would be controversial.
 +
 
 +
==TemplateData==
 +
{{#switch: {{PAGENAME}}
 +
|Merge/doc
 +
|Merge =
 +
{{TemplateData header|Merge}}
 +
<templatedata>
 +
{
 +
"description": "This is a hatnote template that proposes to merge the page it is applied to with one or more other pages.",
 +
"format": "block",
 +
"params": {
 +
"1": {
 +
"label": "Other page",
 +
"description": "This is the page with which this article should be merged. Note: 19 additional pages to merge can be added manually as optional parameters.",
 +
"type": "wiki-page-name",
 +
"required": true
 +
},
 +
"2": {
 +
"label": "Second page",
 +
"description": "Second page to be involved in the merger",
 +
"type": "wiki-page-name"
 +
},
 +
"3": {
 +
"label": "Third page",
 +
"description": "Third page to be involved in the merger",
 +
"type": "wiki-page-name"
 +
},
 +
"target": {
 +
"label": "Destination page",
 +
"description": "When listing several pages to merge, name one proposed destination page for the merger with this parameter.",
 +
"type": "wiki-page-name"
 +
},
 +
"date": {
 +
"label": "Month and year",
 +
"description": "The month and year that the template was placed (in full). \"{{subst:CURRENTMONTHNAME}} {{subst:CURRENTYEAR}}\" inserts the current month and year automatically.",
 +
"type": "line",
 +
"autovalue": "{{subst:CURRENTMONTHNAME}} {{subst:CURRENTYEAR}}",
 +
"example": "January 2013",
 +
"suggested": true
 +
},
 +
"discuss": {
 +
"label": "Discussion",
 +
"type": "wiki-page-name",
 +
"aliases": [
 +
"discussion"
 +
],
 +
"description": "Discussion related to the merge proposal; typically on the talk page of the destination page (default is ''Other page''). Insert the full page name (with namespace)."
 +
},
 +
"section": {
 +
"label": "Section",
 +
"type": "line",
 +
"description": "If you are placing the template in a section, set this parameter to \"yes\"."
 +
},
 +
"nspace": {
 +
"label": "Page(s) namespace",
 +
"type": "line",
 +
"description": "Optional namespace of the pages involved in the merger (though not the destination page, if specified). Default is \"all\", which allows specifying pages across multiple namespaces for merge. Can be customized according to the accepted nspace values at Template:Pagelist."
 +
}
 +
},
 +
"paramOrder": [
 +
"1",
 +
"2",
 +
"3",
 +
"target",
 +
"date",
 +
"discuss",
 +
"section",
 +
"nspace"
 +
]
 +
}
 +
</templatedata>
 +
}}
 +
{{#switch: {{PAGENAME}}
 +
|Merge/doc
 +
|Merge to =
 +
{{TemplateData header|Merge to}}
 +
<templatedata>
 +
{
 +
"description": "This is a hatnote template that proposes to merge the page it is applied into one or more specified pages. Use 'merge from' to tag the destination page(s).",
 +
"format": "inline",
 +
"params": {
 +
"1": {
 +
"label": "Destination page",
 +
"description": "This is the page into which this article should be merged. Note: 19 additional pages to merge into can be added manually as optional parameters.",
 +
"type": "wiki-page-name",
 +
"required": true
 +
},
 +
"2": {
 +
"label": "Second page",
 +
"description": "Second page that the article should be merged into",
 +
"type": "wiki-page-name"
 +
},
 +
"3": {
 +
"label": "Third page",
 +
"description": "Third page that the article should be merged into",
 +
"type": "wiki-page-name"
 +
},
 +
"date": {
 +
"label": "Month and year",
 +
"description": "The month and year that the template was placed (in full). \"{{subst:CURRENTMONTHNAME}} {{subst:CURRENTYEAR}}\" inserts the current month and year automatically.",
 +
"type": "line",
 +
"autovalue": "{{subst:CURRENTMONTHNAME}} {{subst:CURRENTYEAR}}",
 +
"example": "January 2013",
 +
"suggested": true
 +
},
 +
"discuss": {
 +
"label": "Discussion",
 +
"aliases": ["discussion"],
 +
"description": "Discussion related to the merge proposal; default is on the talk page of the destination page. Insert the full page name (with namespace).",
 +
"type": "wiki-page-name"
 +
},
 +
"section": {
 +
"label": "Section",
 +
"description": "If you are placing the template in a section, set this parameter to \"yes\".",
 +
"type": "line"
 +
}
 +
},
 +
"paramOrder": [
 +
"1",
 +
"2",
 +
"3",
 +
"date",
 +
"discuss",
 +
"section"
 +
]
 +
}
 +
</templatedata>
 +
}}
 +
{{#switch: {{PAGENAME}}
 +
|Merge/doc
 +
|Merge from =
 +
{{TemplateData header|Merge from}}
 +
<templatedata>
 +
{
 +
"description": "This is a hatnote template that proposes to merge one or more specified pages into the tagged page. Use 'merge to' to tag the source page(s).",
 +
"format": "inline",
 +
"params": {
 +
"1": {
 +
"label": "Source page",
 +
"description": "This is the page from which content should be merged into this article. Note: 19 additional pages to merge from can be added manually as optional parameters.",
 +
"type": "wiki-page-name",
 +
"required": true
 +
},
 +
"2": {
 +
"label": "Second page",
 +
"description": "Second page that should be merged into this article",
 +
"type": "wiki-page-name"
 +
},
 +
"3": {
 +
"label": "Third page",
 +
"description": "Third page that should be merged into this article",
 +
"type": "wiki-page-name"
 +
},
 +
"date": {
 +
"label": "Month and year",
 +
"description": "The month and year that the template was placed (in full). \"{{subst:CURRENTMONTHNAME}} {{subst:CURRENTYEAR}}\" inserts the current month and year automatically.",
 +
"type": "line",
 +
"autovalue": "{{subst:CURRENTMONTHNAME}} {{subst:CURRENTYEAR}}",
 +
"example": "January 2013",
 +
"suggested": true
 +
},
 +
"discuss": {
 +
"label": "Discussion",
 +
"aliases": ["discussion"],
 +
"description": "Discussion related to the merge proposal; default is on the talk page of the destination page. Insert the full page name (with namespace).",
 +
"type": "wiki-page-name"
 +
},
 +
"section": {
 +
"label": "Section",
 +
"description": "If you are placing the template in a section, set this parameter to \"yes\".",
 +
"type": "line"
 +
}
 +
},
 +
"paramOrder": [
 +
"1",
 +
"2",
 +
"3",
 +
"date",
 +
"discuss",
 +
"section"
 +
]
 +
}
 +
</templatedata>
 +
}}
 +
== See also ==
 +
{{distinguish|Template:Merged-from}}
 +
{{BattleTechWiki:Template index/Splitting/List|noheading=yes}}{{BattleTechWiki:Template index/Merging/List|noheading=yes}}<includeonly>{{sandbox other||
 
<!-- ADD CATEGORIES BELOW THIS LINE -->
 
<!-- ADD CATEGORIES BELOW THIS LINE -->
−
[[Category:Article Maintenance Templates|{{PAGENAME}}]]
+
[[Category:Merge templates]]
−
</includeonly>
+
}}</includeonly>

Latest revision as of 22:21, 17 April 2024

Which merge template should I use?[edit]

Do not use this tag on a template or category—instead see below for instructions.

  • To merge at least two page together at an unspecified location, use {{Merge|OtherPage}}
  • To merge the contents of the tagged page into another page, use {{Merge to|DestinationPage}}
  • If the contents of another page should be merged into the tagged page, use {{Merge from|SourcePage}} – the opposite of {{Merge to}};
  • To suggest merging only some material from one page to another, use {{Merge portions from|SourcePage}} and {{Split portions|DestinationPage}}

Terminology[edit]

Source page is the page that content is merged from.

Destination page or target page is the page that content is merged into.

Other page is any page involved in a merger.

When to use and when not to use[edit]

These templates are used primarily to identify potential merges that would benefit from discussion. If it is obvious that a merge would be appropriate, then you may boldly merge the pages yourself without tagging and without discussion. Some editors also use these tags to mark pages that obviously require merging in the hope that someone else will merge the pages.

After adding the merge tag, you are expected to create a section on the talk page of the appropriate article (see below for details) explaining your rationale for the merge proposal. If the rationale is so obvious that it requires no explanation, then you should consider boldly merging the pages yourself, or explain on the talk page why you didn't do so yourself.

How to use[edit]

Simple example[edit]

Tagging a single page, without specifying source or destination, is simple:

Markup Renders as 
{{Merge|OtherPage |date=May 2024 }}
or
{{Merge |OtherPage |{{subst:DATE}} }}

When you want to discuss a simple merge of one page into another, tag both source and destination page:

Markup Renders as 
{{Merge to |DestinationPage |date=May 2024 }}
or
{{Merge to |DestinationPage |{{subst:DATE}} }}
Markup Renders as 
{{Merge from |SourcePage |date=May 2024 }}
or
{{Merge from |SourcePage |{{subst:DATE}} }}

This allows editors at both pages to see the proposed source and destination.

Other options[edit]

By default, the Discuss link on the template links to the top of the destination page's talk page. To specify which section, or to name a different talk page entirely, use the |discuss= AKA |talk= parameter:

{{Merge|OtherPage |discuss=Talk:OtherPage#Merger discussion |date=May 2024}}

To name multiple pages to be merged, simply separate them with a vertical pipe. You can add up to 20 articles to be merged:

{{Merge|OtherPage1 |OtherPage2 |OtherPage3 |discuss=Talk:OtherPage#Merger discussion |date=May 2024}}

To name multiple pages to merge into a single page, use the |target= parameter. For example, to merge the tagged page, as well as SourcePage1, SourcePage2, and SourcePage3 into DestinationPage, use:

{{Merge|SourcePage1 |SourcePage2 |SourcePage3 |target=DestinationPage |discuss=Talk:OtherPage#Merger discussion |date=May 2024}}

If you are placing the template in a section, you can use |section=yes to change the wording to reflect this:

{{Merge|OtherPage |discuss=Talk:OtherPage#Merger discussion |date=May 2024 |section=yes}}
  • Do not link to the pages with square brackets.
    For example, write {{Merge|OtherPage}}, not {{Merge|[[OtherPage]]}}.
  • The date might not be shown in the box. Do not be concerned about this. It is used when grouping tagged pages together into categories by date.
  • These templates will add tagged articles to Category:Articles to be merged, while non-articles (files, templates, etc.) will be added to Category:Miscellany to be merged.
  • For {{Merge}}, if you are specifying a merge of two or more pages in different namespaces, the template supports this via specification of the full page name, including the namespace prefix. |nspace= can take on namespace values, which fixes all params to the namespace specified.
  • Do not subst: these templates.

When to remove[edit]

There is no deadline for completing proposed merges. Pages that have been tagged for a long time (frequently more than one year) generally fall into these groups:

Discussion supported the proposed merge, but no one did it yet
Feel free to merge the pages yourself.
Discussion opposed merge, but nobody removed the tags
Feel free to remove the tags yourself.
No discussion found
Feel free to remove the tags if you believe the merge would be a poor choice, or to boldly merge the pages if you believe the merge would be appropriate. Or feel free to start a discussion if you are uncertain or feel it would be controversial.

TemplateData[edit]

This is the TemplateData for this template used by TemplateWizard, VisualEditor and other tools.

TemplateData for Merge

This is a hatnote template that proposes to merge the page it is applied to with one or more other pages.

Template parameters

This template prefers block formatting of parameters.

ParameterDescriptionTypeStatus
Other page1

This is the page with which this article should be merged. Note: 19 additional pages to merge can be added manually as optional parameters.

Pagerequired
Second page2

Second page to be involved in the merger

Pageoptional
Third page3

Third page to be involved in the merger

Pageoptional
Destination pagetarget

When listing several pages to merge, name one proposed destination page for the merger with this parameter.

Pageoptional
Month and yeardate

The month and year that the template was placed (in full). "{{subst:CURRENTMONTHNAME}} {{subst:CURRENTYEAR}}" inserts the current month and year automatically.

Example
January 2013
Auto value
{{subst:CURRENTMONTHNAME}} {{subst:CURRENTYEAR}}
Linesuggested
Discussiondiscuss discussion

Discussion related to the merge proposal; typically on the talk page of the destination page (default is ''Other page''). Insert the full page name (with namespace).

Pageoptional
Sectionsection

If you are placing the template in a section, set this parameter to "yes".

Lineoptional
Page(s) namespacenspace

Optional namespace of the pages involved in the merger (though not the destination page, if specified). Default is "all", which allows specifying pages across multiple namespaces for merge. Can be customized according to the accepted nspace values at Template:Pagelist.

Lineoptional
This is the TemplateData for this template used by TemplateWizard, VisualEditor and other tools.

TemplateData for Merge to

This is a hatnote template that proposes to merge the page it is applied into one or more specified pages. Use 'merge from' to tag the destination page(s).

Template parameters

This template prefers inline formatting of parameters.

ParameterDescriptionTypeStatus
Destination page1

This is the page into which this article should be merged. Note: 19 additional pages to merge into can be added manually as optional parameters.

Pagerequired
Second page2

Second page that the article should be merged into

Pageoptional
Third page3

Third page that the article should be merged into

Pageoptional
Month and yeardate

The month and year that the template was placed (in full). "{{subst:CURRENTMONTHNAME}} {{subst:CURRENTYEAR}}" inserts the current month and year automatically.

Example
January 2013
Auto value
{{subst:CURRENTMONTHNAME}} {{subst:CURRENTYEAR}}
Linesuggested
Discussiondiscuss discussion

Discussion related to the merge proposal; default is on the talk page of the destination page. Insert the full page name (with namespace).

Pageoptional
Sectionsection

If you are placing the template in a section, set this parameter to "yes".

Lineoptional
This is the TemplateData for this template used by TemplateWizard, VisualEditor and other tools.

TemplateData for Merge from

This is a hatnote template that proposes to merge one or more specified pages into the tagged page. Use 'merge to' to tag the source page(s).

Template parameters

This template prefers inline formatting of parameters.

ParameterDescriptionTypeStatus
Source page1

This is the page from which content should be merged into this article. Note: 19 additional pages to merge from can be added manually as optional parameters.

Pagerequired
Second page2

Second page that should be merged into this article

Pageoptional
Third page3

Third page that should be merged into this article

Pageoptional
Month and yeardate

The month and year that the template was placed (in full). "{{subst:CURRENTMONTHNAME}} {{subst:CURRENTYEAR}}" inserts the current month and year automatically.

Example
January 2013
Auto value
{{subst:CURRENTMONTHNAME}} {{subst:CURRENTYEAR}}
Linesuggested
Discussiondiscuss discussion

Discussion related to the merge proposal; default is on the talk page of the destination page. Insert the full page name (with namespace).

Pageoptional
Sectionsection

If you are placing the template in a section, set this parameter to "yes".

Lineoptional

See also[edit]

Not to be confused with Template:Merged-from.

Splitting[edit]

Merging[edit]

Retrieved from "https://www.sarna.net/wiki/index.php?title=Template:Merge/doc&oldid=1068392"