Difference between revisions of "Template:DRN-closednote/doc"

From blackwiki
Jump to navigation Jump to search
imported>KDS4444
m (formatting)
imported>KDS4444
(→‎Usage: replacing description of parameters with a JSON templatedata description)
Line 5: Line 5:
  
 
There are five parameters: the first is "name=", the second is "title=", the third is "reason=", the fourth is "cmt=", and the fifth is "sig=".
 
There are five parameters: the first is "name=", the second is "title=", the third is "reason=", the fourth is "cmt=", and the fifth is "sig=".
 +
 +
<templatedata>
 +
{
 +
"description": "This template creates a notice on a user's talk page notifying him/ her of the closure of a dispute which he/she either filed or in which was a major participant.",
 +
"params": {
 +
"first parameter": {
 +
"label": "title",
 +
"description": "This should be the title of the section of the DRN page where the discussion took place.  A direct link to this title will be created by the template: do not attempt to enclose it in double brackets yourself or to pipe it.",
 +
"required": false,
 +
"suggested": false,
 +
"deprecated": false,
 +
"aliases": [],
 +
"autovalue": "auto value",
 +
"default": "NO TITLE GIVEN",
 +
"type": "string",
 +
"example": "Talk:WrestleMania 33#Big Show VS. Shaq",
 +
},
 +
"second parameter": {
 +
"label": "reason",
 +
"description": "Provide the reason for closure in this parameter.  Do not begin with a capital letter and do not start with the word 'because', but do compose a complete sentence and be sure to end it with a period (.)",
 +
"required": false,
 +
"suggested": false,
 +
"deprecated": false,
 +
"aliases": [],
 +
"autovalue": "auto value",
 +
"default": "please see the case commentary for the specific reason.",
 +
"type": "string",
 +
"example": "the participants appear to have reached a consensus."
 +
},
 +
"third parameter": {
 +
"label": "cmt",
 +
"description": "This parameter allows the person leaving it to provide a specific comment.  It should begin with a capital letter and end with a period.",
 +
"required": false,
 +
"suggested": false,
 +
"deprecated": false,
 +
"aliases": [],
 +
"autovalue": "auto value",
 +
"default": "None",
 +
"type": "string",
 +
"example": "An [[WP:RfC|RfC]] is suggested."
 +
},
 +
"fourth parameter": {
 +
"label": "sig",
 +
"description": "Allows the template to generate the signature of the person leaving the message and places it within the template notice box.  It should be given as four tildes.",
 +
"required": false,
 +
"suggested": false,
 +
"deprecated": false,
 +
"aliases": [],
 +
"autovalue": "auto value",
 +
"default": "",
 +
"type": "string",
 +
"example": "~~~~"
 +
}
 +
},
 +
}
 +
</templatedata>
  
 
== Usage ==
 
== Usage ==
Place <nowiki>{{SUBST:DRN-closednote|name= |title= |reason= |cmt= |sig= }}</nowiki> on the user's talk page.
+
Place <nowiki>{{SUBST:DRN-closednote|title= |reason= |cmt= |sig= }}</nowiki> on the user's talk page.  
 
 
=== Parameters ===
 
* Fill in the "title="  parameter with the name of the DRN thread; the name must be alone to display properly (without <nowiki>[[WP:DRN/blah/blah]]</nowiki>).
 
* Fill in the "reason=" parameter with the reason for the close. Using a sentence or two is suggested; be brief. Note that "because" is followed by your reason, so there is no need to start with "because".
 
* Fill in the "cmt=" parameter for any additional comments you have for the user. If not inserted, it will display: None.
 
* Fill in the "sig=" parameter with <nowiki>~~~~</nowiki> to display your signature at the end of the main message.  
 
  
 
=== Example ===
 
=== Example ===

Revision as of 12:36, 20 February 2017

This is a template for use by DRN volunteers to quickly notify editors of their DRN case being closed, whether they are the filing party or a major party.

There are five parameters: the first is "name=", the second is "title=", the third is "reason=", the fourth is "cmt=", and the fifth is "sig=".

Syntax error in JSON.

Usage

Place {{SUBST:DRN-closednote|title= |reason= |cmt= |sig= }} on the user's talk page.

Example

{{Subst:DRN-closednote|title=ThreadNameHere|reason=there was no participation.|cmt=An [[WP:RfC|RfC]] is suggested.|sig=~~~~}}

This will display:

DRN case closed

25px This message template was placed here by Kharkiv07, a volunteer at the Dispute Resolution Noticeboard. You recently filed a request or were a major party in the DRN case titled "ThreadNameHere". The case is now closed: there was no participation. If you are unsatisfied with this outcome, you may refile the DRN request or open a thread on another noticeboard as appropriate. If you have any questions please feel free to contact this volunteer at his/ her talk page or at the DRN talk page. Thank you! --Kharkiv07 (T) 22:04, 22 July 2015 (UTC)

  • Additional comments by volunteer: An RfC is suggested.

Template series

  • {{DRN-closednote}}-For use on user talk pages to notify them of their case being closed
  • {{DRN}}—For use on article talk page to notify editors of active DRN discussion
  • {{DRN archive bottom}} and {{DRN archive top}}—To close and archive DRN discussions
  • {{DRN status}}—For use on DRN threads to provide involved disputants a 24-hour grace period and notice before closure to iron out any remaining issues (should always be subst:)
  • {{DRN-talk}}-For use on article/template talk pages to notify interested editors of active DRN discussion
  • {{DRN-notice}}—For use on user talk pages to notify involved editors of active DRN discussion