View source for Template:Userwhisperback/doc

{{Documentation subpage}}
<!-- Add categories where indicated at the bottom of this page and interwikis at Wikidata -->
{{TOC right}}

==Usage==
'''<CODE><NOWIKI>{{</NOWIKI>{{BASEPAGENAME}}<NOWIKI>}}</NOWIKI></CODE>''' is a template intended to be placed at the very top of your user talk page and/or your user talk page's /Editnotice subpage, so as to inform your interlocutors of your user discussion preferences (whether you prefer to maintain discussions on a single user talk page or fragment them across two, etc.).

Its main difference with the various similar templates is that it is customizable for its content, while following [[Wikipedia:Talk page templates|the official talk page guidelines]] for its aspect.

==Notes==
* By default, it follows the scheme of answering on the same page a discussion was started so as to avoid talk fragmentation, and notifying the other party with the {{tl|Whisperback}} template, but options allow to express other preferences.
* Contrary to a lot of similar templates that use various color schemes, this one follows the official guideline on talk page boxes and will self-adapt to your interlocutor's skins.
* Optionally, you can also duplicate this template at the very top of your user page.
* Preferably, '''do not [[WP:SUBST|subst:]]''' this template in order to automatically benefit from its improvements.

==Options==
For each option, the '''default value''' is displayed in bold and automatically assumed if the field is left blank.

; you
: Explain what you should do if I left you a message:
:* '''whisperback''' : please answer on ''your'' talk page, then place {{tl|Whisperback}} on my talk.
:* notify : please answer on ''your'' talk page, then notify my talk page.
:* watched : please answer on ''your'' talk page, as I am watching it.
:* other : please answer on ''my'' talk page, else inform me.

; me
: Explain what I will do if you leave me a message:
:* '''whisperback''' : I will answer on ''my'' talk page, then place {{tl|Whisperback}} on your talk.
:* notify : I will answer on ''my'' talk page, then notify your talk page.
:* watched : I will answer on ''my'' talk page, so please add it to your watchlist.
:* other : I will answer on ''your'' talk page, unless you request otherwise.

The value of "you" and "me" do not necessarily have to be the same, but should of course be consistent: either you chose both "other" (for suggesting discussions fragmented across both talk pages), or you chose a combination of the three first values (for suggesting discussions that stay on the page they started, and how the other party will know that you answered).

; hint
: Defines if the mandatory parameters for the whisperback template should be shown:
:* '''yes''' : the usage examples are included, such as {{tlp|Whisperback|<u>''your&nbsp;username''</u>}}.
:* no : only the short references to {{tl|Whisperback}} are provided.

; small
: Define the size and position of the box:
:* '''no''' : the regular sized centered box is used.
:* yes : the template will shrink to a small, right-aligned floating box.

; runon
: Defines how the three sentences are displayed:
:* '''no''' : as three bullet items.
:* yes : as a runon text.

; icon
: Selects an optional icon for the left side:
:* '''none''' : keeps maximum space to prevent lines wrapping. (On a standard 1024 display with average browser fontsize, adding an icon can make the three sentences wrap to six lines on your interlocutors' screen).
:* blank : [[Image:No image.svg|30px]] (empty icon-sized placeholder)
:* plus : [[Image:B plus.svg|30px]] (plus, add new message)
:* lang : [[Image:Nuvola apps edu languages.svg|30px]] (language, talk)
:* info : [[Image:Info talk.png|30px]] (for your information)
:* attn : [[Image:Emblem-important.svg|30px]] (attention please)
:* stop : [[Image:Stop hand nuvola.svg|30px]] (stop, warning)
:* frag : [[Image:Merge-split-transwiki default.svg|30px]] (fragmented discussion)
:* ''anyfile.img'' : any valid image filename.

; iconalt
: Defines the icon's alternative text (displayed in text-only, or as tooltip):
:* '''User talk''' : default short and relevant text.
:* ''Any text'' : should satisfy text-only browsers and the blind.

; iconcell
: Defines the attribute or CSS style of the icon's table cell:
:* '''[none]''' : put the icon in the middle of its column
:* valign=top : put the icon at the top of its column
:* valign=bottom : put the icon at the bottom of its column

; iconsize1
: Defines the size of the icon when in regular mode:
:* '''50px''' : standard (as per [[Wikipedia:Talk page templates]]).
:* ''anysizepx'' : such as "40px" (only px, no other units recognized).

; iconsize2
: Defines the size of the icon when in small mode:
:* '''30px''' : standard (as per [[Wikipedia:Talk page templates]]).
:* ''anysizepx'' : such as "20px" (only px, no other units recognized).

; hidenew
: Defines if the "Leave me a new message" line will be hidden:
:* '''no''' : normal mode at the top of a user/talk page.
:* yes : advanced use inside User:YourName/editintro (see [[#Editintro]] below).

Most values are case-insensitive ("watched" or "WAtChEd" work the same), except when it matters (such as a custom icon filename).

==Examples==
{{Main list|Template:{{BASEPAGENAME}}/testcases}}
{{{{BASEPAGENAME}}|small=yes}}
{{{{BASEPAGENAME}}|you=other|me=other|small=yes|runon=yes|icon=frag|iconcell=valign=bottom}}

* The regular version (with default values) can be seen at the top of this page.
* The <CODE><NOWIKI>{{</NOWIKI>{{BASEPAGENAME}}<NOWIKI>|small=yes}}</NOWIKI></CODE> version (with default values) can be seen at the right side of this section. It is inserted at the top of the section, just below the heading and before this bullet list. The text that follows will wrap next to it. In this version, the items of the regular version are merged into a single sentence, without the bullets. Just below is the code <CODE><NOWIKI>{{</NOWIKI>{{BASEPAGENAME}}<NOWIKI>|you=other|me=other</NOWIKI><!--SPACE--> <NOWIKI>|small=yes|runon=yes</NOWIKI><!--SPACE--><NOWIKI> |icon=frag|iconcell=valign=bottom}}</NOWIKI></CODE> for a fragmented discussion preference. (You can skip the two next paragraphs, they are a dummy Latin text for showing how text flow around the small template.) {{Lorem ipsum|2|:: ''|''}}
* Live examples of the regular version with default values can be seen at [[User:Komusou]] and [[User talk:Komusou]].

==Editintro==
(This is a special case for advanced users.)

* The "&editintro=" option of wiki URLs allows to customize the text that will appear above the inputbox in edit mode. If you create a user subpage at User:YourName/editintro (all-lowercase "editintro"), the template will autodetect it and use it as the editintro for its "Leave me a new message" link. However, a user can set the editintro page manually using the "editintro" parameter. Regardless of which technique is used, the template will check if the page exists before including it as the editintro.

* If you wish, you can also reuse a copy of the template in your /editintro subpage. The only change is to add the option "hidenew=yes". This is not required, but cosmetic: for someone who is already in edit mode to write you a message, it'd look silly to show him again a "Leave me a new message" link, so the option will hide it for your editintro.

* More importantly, if you use elsewhere on Wikipedia a direct link to "create a new message on my talk page", the person using it would bypass your talk page and not see your user discussion preferences. The copy of the template in your editintro remedy this.

* This would be even more useful in the future if it becomes possible to make such a link in the custom user signature. (Currently, external URLs are forbidden, and wiki markup does not seem to allow using the special options without an external URL.)

* Example of such a link, code and result:

: {{Pre|<NOWIKI>
<SPAN CLASS="plainlinks">[//en.wikipedia.org/w/index.php?title=User_talk:Komusou&action=edit&section=new&editintro=User:Komusou/editintro Leave a new message to Komusou.]</SPAN>
</NOWIKI>}}

: <SPAN CLASS="plainlinks">[//en.wikipedia.org/w/index.php?title=User_talk:Komusou&action=edit&section=new&editintro=User:Komusou/editintro Leave a new message to Komusou.]</SPAN>

==Technical==
Before changing the template's code or text, please bear in mind some points that should be preserved:

* The box follows the standards from the [[Wikipedia:Talk page templates]] guideline (such as the mandated background color, width, <CODE>small=</CODE> implementation, icon size, etc.), which automatically derive from a class that will self-adapt to each user's skin. The visual aspects and colors should thus not be changed, because it would hardcode colors that may look good on your own skin but could be poor on the screen of people using other skins.
* The template is designed so that you can also place it on your user page (if wanted) in addition to your talk page, and it stays functional, that is:
** The new message URL is constructed with TALKPAGENAME so as to work in both cases.
** The texts say "on my talk page" rather than "here" so as to be valid in both cases.
* The template is designed to have three short sentences that stay on a single line each, on as many screen configuration as possible:
** The icon has been removed by default on purpose to limit line wraps.
** The sentences have been kept concise rather than verbose.

==See also==
{{Talkback see also}}
{{Userspace disclaimers}}

<includeonly>{{sandbox other||
<!-- Categories below this line; interwikis at Wikidata -->
[[Category:User talk header templates]]
}}</includeonly>