Difference between revisions of "Template:ReviewsComments"

[quality revision] [quality revision]
m
m
 

1 Usage[edit]

The ReviewsComments template is used to store, in a page, a comment about the content (mainly, but not only, within the scope of the review process): question, disagreement, request for improvement etc. It should be added just before the line that is the object of the comment.

It puts a message box with a "pink notepad" icon in the page.

Only logged-in users who have writing permissions, can see this box. However, do not put any confidential information in the parameters of this template.

Usage:  {{ReviewsComments | <comment>}}

Where <comment> is the mandatory comment message. It is recommended that reviewers sign their comment

  • either with their MediaWiki signature plus timestamp thanks to the ~~~~ markup (replaced when saving),
  • or with their name's trigram and the week number (e.g. JCT w920 -) in the comment message.

A custom button in the Wikitext editor toolbar allows to insert a review comment (with the MediaWiki signature):

Review comment button

2 Basic examples[edit]

You type You get
Comment and MediaWiki signature supplied
{{ReviewsComments | ~~~~ - The proposed command doesn't work: please propose another version}}
Comment and trigram supplied
{{ReviewsComments | JCT w920 - The proposed command doesn't work: please propose another version}}

3 More examples[edit]

You type You get
No comment supplied, no signature supplied
{{ReviewsComments}}
No comment supplied, signature supplied
{{ReviewsComments | JCT w920 -}}
Comment supplied with a long sentence, signature supplied
{{ReviewsComments | JCT w920 - The comment is a long sentence. Lorem ipsum: isdem diebus Apollinaris Domitiani gener, paulo ante agens palatii Caesaris curam, ad Mesopotamiam missus a socero per militares numeros immodice scrutabatur, an quaedam altiora meditantis iam Galli.}}
Check that the spaces before and after the message
BEFORE{{ReviewsComments | Check spaces}}AFTER<br>
BEFORE
{{ReviewsComments | Check spaces}}
AFTER

BEFOREAFTER
BEFORE

AFTER

4 Maintenance[edit]

This template is a template common to all ST wikis.
Modifications must be done into the WikiModel. They must be reviewed by all ST wikis maintainers.
When approved, the template can be pushed/merged towards all ST wikis.

5 Code[edit]

<noinclude>

==Usage==
The [[Template:ReviewsComments|ReviewsComments]] template is used '''to store, in a page, a comment about the content (mainly, but not only, within the scope of the review process)''': question, disagreement, request for improvement etc. It should be added just before the line that is the object of the comment.

It puts a message box with a "pink notepad" icon in the page.

'''Only logged-in users who have writing permissions, can see this box'''. {{Highlight|However, do not put any confidential information in the parameters of this template}}.

 Usage:  <nowiki>{{</nowiki>ReviewsComments | {{HighlightParam|<comment>}}}}
Where {{HighlightParam|<comment>}} is the '''mandatory''' comment message. It is recommended that reviewers sign their comment
* either with their MediaWiki signature plus timestamp thanks to the <code><nowiki>~~~~</nowiki></code> markup (replaced when saving),
* or with their name's trigram and the week number (e.g. <code>JCT w920 -</code>) in the comment message.

A custom button in the Wikitext editor toolbar allows to insert a review comment (with the MediaWiki signature):
[[File:Help_reviews_comments_button.png|thumb|950px|center|Review comment button]]

==Basic examples==
{| class="st-table"
! You type !! You get
|-
| Comment and MediaWiki signature supplied<pre style="white-space: pre-wrap;">

{{ReviewsComments | ~~~~ - The proposed command doesn't work: please propose another version}}</pre>

|
{{ReviewsComments | [[User:Jean Christophe Trotin|Jean Christophe Trotin]] ([[User talk:Jean Christophe Trotin|talk]]) 09:56, 13 January 2020 (CET) - The proposed command doesn't work: please propose another version}}
|-
| Comment and trigram supplied<pre style="white-space: pre-wrap;">

{{ReviewsComments | JCT w920 - The proposed command doesn't work: please propose another version}}</pre>

|
{{ReviewsComments | JCT w920 - The proposed command doesn't work: please propose another version}}
|}

==More examples==
{| class="st-table"
! You type !! You get
|-
| No comment supplied, no signature supplied<pre style="white-space: pre-wrap;">

{{ReviewsComments}}</pre>

|
{{ReviewsComments}}
|-
| No comment supplied, signature supplied<pre style="white-space: pre-wrap;">

{{ReviewsComments | JCT w920 -}}</pre>

|
{{ReviewsComments | JCT w920 -}}
|-
| Comment supplied with a long sentence, signature supplied<pre style="white-space: pre-wrap;">

{{ReviewsComments | JCT w920 - The comment is a long sentence. Lorem ipsum: isdem diebus Apollinaris Domitiani gener, paulo ante agens palatii Caesaris curam, ad Mesopotamiam missus a socero per militares numeros immodice scrutabatur, an quaedam altiora meditantis iam Galli.}}</pre>

|
{{ReviewsComments | JCT w920 - The comment is a long sentence. Lorem ipsum: isdem diebus Apollinaris Domitiani gener, paulo ante agens palatii Caesaris curam, ad Mesopotamiam missus a socero per militares numeros immodice scrutabatur, an quaedam altiora meditantis iam Galli.}}
|-
| Check that the spaces before and after the message<pre style="white-space: pre-wrap;">

BEFORE{{ReviewsComments | Check spaces}}AFTER<br>

BEFORE
{{ReviewsComments | Check spaces}}
AFTER</pre>

|
BEFORE{{ReviewsComments | Check spaces}}AFTER<br>

BEFORE
{{ReviewsComments | Check spaces}}
AFTER
|}

==Maintenance==
This template is a template common to all ST wikis. <br>

Modifications must be done into the [[stwikimodel:Template:ReviewsComments|WikiModel]]. They must be reviewed by all  ST wikis maintainers.<br>

When approved, the template can be pushed/merged towards all ST wikis.

==Code==</noinclude>{{#tag:secureTransclude||
src=ProtectedTemplate:ReviewsComments|
params={{{1|}}}
}}{{#set:Has reviews comments=true}}
Line 72: Line 72:
 
AFTER
 
AFTER
 
|}
 
|}
  +
  +
==Maintenance==
  +
This template is a template common to all ST wikis. <br>
  +
Modifications must be done into the [[stwikimodel:Template:ReviewsComments|WikiModel]]. They must be reviewed by all  ST wikis maintainers.<br>
  +
When approved, the template can be pushed/merged towards all ST wikis.
   
 
==Code==
 
==Code==