Template:Please see/doc
This is a documentation subpage for Template:Please see. It may contain usage information, categories and other content that is not part of the original template page. |
If you plan to make breaking changes to this template, move it, or nominate it for deletion, please notify Twinkle's users and maintainers at Wikipedia talk:Twinkle as a courtesy, as the standard installation of Twinkle adds and removes this template. Thank you! |
This template is meant to be subst:ed on the talk pages of users whose attention you would like to draw to a discussion, or on the talk pages of other pages whose watchers might have an interest in the discussion. Please read Wikipedia: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 may be used for 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. These can be helpful when the section title alone might not sufficiently communicate what a discussion is about, as editors are more likely to take up an invite if this is made clear. Using an edit summary like Invite to [[Link to discussion|discussion on topic]]
can also help make invites more effective, as it allows recipients to follow them directly from their watchlist.
This template will automatically add your signature ("~~~~"), so please do not add it.
Afterwards, you may use {{subst:Notified}}
at the discussion page to inform the discussion participants of your notification.
Usage
[edit]{{ 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
[edit]|location=
(REQUIRED): the page 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): the 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 valueno
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
[edit]Detailed example
[edit]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)<!--Template:Please see-->
Example 1
[edit]{{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
[edit]{{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
[edit]{{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
[edit]- {{pls}}
- {{See discussion}}
TemplateData
[edit]TemplateData for Please see
A template to be substituted on the talk pages of users whose attention you would like to draw to a discussion. Please read Wikipedia:Canvassing before using this template.
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 | 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 | suggested |
more | more | A concise, neutral description of the discussion that will be inserted before your signature and after the "You are invited" sentence. | String | suggested |
noimage | noimage | Set this to any value to turn off the icon | Boolean | optional |
Keep underscore? | keepunderscore | Set to yes to override this template's attempt to remove underscores (_) that get left in when a discussion link is copied from a URL. | Boolean | optional |
Italicize page? | italicizepage | Italicizes the page name | Boolean | optional |
Italicize section? | italicizesection | Italicizes the section name | Boolean | optional |
See also
[edit]- {{Talkback}} – the original, large "you have new messages" notice to put on other users' talk pages
- {{subst:Mytalk}} – invokes the talkback template and automatically fills in your username
- {{Talkbacktiny}} – a somewhat smaller version of
{{Talkback}}
- {{Interwiki talkback}} – a "you have new messages" notice to put on other users' talk pages for interwiki purposes
- {{Whisperback}} – a less obtrusive template than
{{Talkback}}
, with more features and without the box - {{You've got mail}} – like
{{Talkback}}
but to notify of an offsite e-mail - {{Please see}} – similar to
{{Whisperback}}
, but notifying others of a topic they may wish to participate in- {{WikiProject please see}} – similar to
{{Please see}}
, but for use on WikiProject talk pages
- {{WikiProject please see}} – similar to
- {{Discussion notice}} – an alternative to
{{Please see}}
, similar to{{ANI-notice}}
- {{Usertalkback}} and {{Userwhisperback}} – notices for the top of one's own user talk page, so as to inform your interlocutors of your user discussion preferences
- {{FYI}} – icon box to give a visual hint to readers of talk page items
- {{Notified}} – disclosure indicating that a notification has been posted on another page
- {{Reply to}} – ping a user without posting on their talk page (uses the mentions notification)
- {{Response}} – to direct the attention of another user to a discussion on a specific talk page
- {{No talkback}} – opt-out of talkback messages from Twinkle