1. Usage
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):
2. Basic examples
| 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
| 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 AFTER |
4. Maintenance
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.