Template:Please see

Discussion at Template:Please see

 You are invited to join the discussion at Template:Please see. ~~~~

Template documentation[ view · edit · history · purge ]

This documentation is transcluded from Template:Please see/doc.

This template should be substituted using {{subst:please see}} instead of {{please see}}. Maintenance: Check for un-substituted usage.

This template is meant to be substituted on the talk pages of users whose attention you would like to draw to a discussion. Please read Commons:Canvassing before using this template. The location parameter is for the page at which the discussion is taking place. For the convenience of the recipient, be sure to link directly to the section header. The heading parameter should be a concise, neutral description of the heading under discussion. The more parameter is an option chance to add a little more discussion to the invitation. This template will automatically add your signature.

Do not include your signature, "~~~~", because that's already included in the code of the template.

Usage

• {{ subst:Please see | {{{1}}} }}
• {{ subst:Please see | location={{{location}}} }}
• {{ subst:Please see | {{{1}}} | section= {{{section}}}| piped= yes }}
• {{ subst:Please see | {{{1}}} | heading={{{heading}}} }}
• {{ subst:Please see | {{{1}}} | more={{{more}}} }}
• {{ subst:Please see | {{{1}}} | heading={{{heading}}} | more={{{more}}} }}
• {{ subst:Please see | location={{{location}}} | more={{{more}}} }}
• {{ subst:Please see | location={{{location}}} | heading={{{heading}}} | more={{{more}}} }}
• {{ subst:Please see | {{{1}}} | heading=no}}

Parameters

• |location= (REQUIRED): article at which the discussion is happening. If not labelled as "location," then uses the first parameter. If linking to a specific section, include the # and the section header in this part (e.g. |location=Talk:Main Page#Cabal)
  • |section= (OPTIONAL): optional section header for the location of the discussion
    • |piped= (OPTIONAL): if set to any value, this will pipe the link used to match the |section=
• |heading= (OPTIONAL): heading name for the user's talk page. If not labelled as "heading," then uses the second parameter. If there is no second parameter, then uses location. If value no is used, automatic heading is disabled.
• |more= (OPTIONAL): more discussion to add to the invitation.
• |noimage= (OPTIONAL): if set to any value, it will turn off the icon

Examples

Detailed example

For example, you wanted to discuss the deletion and redirecting of the article Pussycat to the article Cat. A discussion could take place at Talk:Pussycat#Let's delete Pussycat!; you could then place the wikitext {{subst:Please see | Talk:Pussycat#Let's delete Pussycat!}} in the Talk:Cat page. When the edit was saved, it would substitute it with the text:

==Discussion at Talk:Pussycat#Let's delete Pussycat!==
[[File:Farm-Fresh eye.png|15px|link=|alt=]] You are invited to join the discussion at [[Talk:Pussycat#Let's delete Pussycat!]]. Thanks. [[User:Example|Example]] ([[User talk:Example|talk]]) HH:MM, DD MONTH YEAR (UTC){{z48}}<!--Template:Please see-->

Example 1

{{subst:Please see | Talk:United States#Name }}

Becomes:

== Talk:United States#Name ==
You are invited to join the discussion at [[Talk:United States#Name]].  /Your signature/

Example 2

{{subst:Please see | Talk:United States#Name | Check this out}}

or

{{subst:Please see | Talk:United States#Name | heading=Check this out}}

or

{{subst:Please see | location= Talk:United States#Name | heading= Check this out}}

Becomes:

== Check this out ==
You are invited to join the discussion at [[Talk:United States#Name]].  /Your signature/

Example 3

{{subst:Please see | Talk:United States#Name | more=When was the country really settled? }}

Becomes:

== Talk:United States#Name ==
You are invited to join the discussion at [[Talk:United States#Name]]. ''When was the country really settled?'' /Your signature/

Redirects

• {{Pls}}
• {{See discussion}}

TemplateData

 Parameter text is empty

<templatedata>JSON</templatedata> ./. {{TemplateBox}}

TemplateData

TemplateData is a way to store information about template parameters (the description of those and of the whole template) for both humans and machines. It is used by VisualEditor and possibly other tools like Upload Wizard.

---

Existing template documentation
At Wikimedia Commons, it is recommended to use {{TemplateBox}} with either ‎useTemplateData=1 or ‎useTemplateData=only on the ‎/doc subpage and transcluding it with {{Documentation}} into the template. ‎<nowiki>-tags can be wrapped around the arguments, if required, to avoid templates being expanded.

Newly created template documentation and imports
Another option, especially for imported templates, or for users with JSON experience, is placing raw ‎<templatedata>-tags into the Wikitext of the template, as described in various Wikipediae.

Discussion
There is an ongoing discussion about that matter. Feel invited to comment if you are experienced in either way, your time permits and if you like to share your opinion or to make a suggestion.

---

Wikipedia's help about TemplateData • Commons-specific information

A template to be substituted on the talk pages of users whose attention you would like to draw to a discussion. Please read Commons:Canvassing before using this template.

Template parameters[Edit template data]

Parameter		Description	Type	Status
location	location 1	The exact location where the discussion is taking place. IF POSSIBLE, link directly to the heading of the talk thread.	Page name	required
section	section	The heading of the talk thread that you want them to see.	Page name	optional
piped	piped	Set this to any value to use the heading of the talk thread as a piped link Default	String	optional
heading	heading 2	The heading of the thread that will be started on the talk page of the user. If this parameter is not provided, then the default heading will be a copy of the link you provide. If value 'no' is provided, the template won't generate a heading.	String	optional
more	more	A description of the discussion that will be inserted BEFORE your signature and AFTER the "You are invited" sentence.	String	optional
noimage	noimage	Set this to any value to turn off the icon Default	String	optional