Template:User talk rules/doc

From Wikipedia, the free encyclopedia

Usage[edit]

This template generates custom talk page rules (such as those shown above) and transcludes wikibreak templates. If archiving, please put the archive box into your talk page manually. Do not substitute this template if you can avoid it, as it uses ParserFunctions.

{{User talk rules
 |bringhere= y/n
 |diffsplease= y/n
 |archive= y/n
 |archivebot= archive bot name/self
 |illreplyhere= y/n
 |iwontwatchmoved= y/n
 |inattentive= y/n
 |iwatch= y/n
 |end= end text
 |bar= y/n
}}

Parameters[edit]

All parameters are optional. If they are all left out it will default to the text shown above. The following parameters are supported:

  • bringhere - Set to "y" to tell that it's okay to bring other discussions to your talk page. Defaults to "n", i.e., don't bring them here.
  • diffsplease - By default, the template asks users to use diffs. Set to "n" to only ask for quotes.
  • archive - Set to "y" if you (or a bot) archive your talk page.
  • archivebot - If a bot archives your talk page, set this to the name of the bot without the "User:" prefix. If you set it to "self", the template assumes that you don't use a bot.
  • illreplyhere - If you reply to other people's comments (posted on your page) on other talk pages, instead of your own (please consider not doing this, it's annoying), set this to "n".
  • iwontwatchmoved - If you will continue to watch a talk page after the discussion has migrated elsewhere, set this to "n". This does not specifically recommend unmigrating the discussion, rather, it suppresses a sentence about not watching for it.
  • inattentive - Set to "y" if you don't check your watchlist regularly
  • iwatch - Set to "y" if you watch most of the talk pages you comment on.
  • end - Adds text (or in theory, any content that doesn't disrupt the template) to the end, before "thank you."
  • bar - Set to "n" to suppress the separator at the end.

Deprecated parameters[edit]

Note: Because these parameters reduce the flexibility of your templates, they are no longer recommended. Instead, simply add the templates before this template; this increases flexibility considerably. They have been struck out to make this obvious, though they still work for backwards compatibility.

  • wikibreakt You can put a name ("{{" etc. aren't part of the name) of a Wikibreak template here (actually, you can use any template, but don't make it relative, make it absolute). Recommended for short term templates like {{wikibreak}}.
  • Unnamed parameter 1 - you can use this as a parameter to wikibreakt. If wikibreakt is not used, this becomes a parameter to wikibreakt2.
  • wikibreakt2 Identical to previous parameter and designed to place a second template. You really shouldn't have more than two, and additional templates are not supported. Recommended for (semi) permanent templates like {{busy}}.
  • Unnamed parameter 2 - this is like parameter 1 except that it should only be used if wikibreakt is defined. It will be a parameter for wikibreakt2. if wikibreakt is undefined, this parameter does nothing. For simplicity's sake, when using a template, simply follow it with a pipe and the parameter, if you want to use a parameter. An important exception is when you want to use wikibreakt with no parameters and wikibreakt2 with a parameter. In that case you should prefix the parameter with "2=". These have been designed to be used in that fashion, and the preceding scenario is the only case in which they do not work. Remember, you can only use one parameter per template.

Tips and tricks[edit]

In general, be creative with wikibreakt, for example:

  • Make wikibreakt2 an archive box, using auto=yes. It looks great.
  • Put the entire thing between {{Hidden begin}} and {{Hidden end}}. It then won't look ugly to add {{Usertalkheader}} before the block. This way, you can have your nice short header, and also have lots of content.
  • Be creative, if you know ParserFunctions, maybe copy it to a user sub page and modify it (modify it right here, if you can make it backward compatible), and take advantage of wikibreakt and end. Play with it. Remember, wikibreakt is not just for wikibreak templates.