Difference between revisions of "Template:PublicationRequestId"

[unchecked revision] [quality revision]
m
m
 

1 Usage[edit]

The PublicationRequestId template is used to store, in a page, the date and the identifier (ID) of the last publication request (PR) done to the technical writer team, through the technical literature management system (TLMS), for publishing this page. It should be added at the bottom of the page for which a PR has been done.

It puts a message box with a "light blue checked document" 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: {{PublicationRequestId | <TLMS PR ID> | <date> | <comment>}}

Where:

  • <TLMS PR ID> is the mandatory identifier of the publication request done in the TLMS
    • Auto is a special value for this parameter to indicate that the page has been automatically approved (no TLMS PR ID)
  • <date> is the date of the request in the YYYY-MM-DD format. It is a mandatory parameter, except if <TLMS PR ID> is Auto
  • <comment> is an optional comment. It is recommended to use this parameter to indicate at least the name of the technical writer who made the review

2 Basic examples[edit]

You type You get
Publication request: TLMS PR ID and date supplied
{{PublicationRequestId | 12345 | 2019-05-09 | AnneJ}}
Publication request: TLMS PR ID set with "Auto" and comment supplied
{{PublicationRequestId | Auto |  | Automatic approval based on the “Category model” article}}

3 More examples[edit]

You type You get
Publication request: no TLMS PR ID supplied, no date supplied
{{PublicationRequestId}}
Publication request: TLMS PR ID supplied, no date supplied
{{PublicationRequestId | 12345}}
Publication request: no TLMS PR ID supplied, date supplied
{{PublicationRequestId | | 2019-05-09}}
Publication request: TLMS PR ID supplied, date supplied, comment supplied
{{PublicationRequestId | 12345 | 2019-05-09 | AnneJ. Comment about this PR}}
Publication request: TLMS PR ID set with "Auto", no comment supplied
{{PublicationRequestId | Auto}}
Check that the spaces before and after the message
BEFORE{{PublicationRequestId | Auto}}AFTER<br>
BEFORE
{{PublicationRequestId | Auto}}
AFTER

BEFOREAFTER
BEFORE

AFTER

4 Code[edit]

<noinclude>

==Usage==
The [[Template:PublicationRequestId|PublicationRequestId]] template is used '''to store, in a page, the date and the identifier (ID) of the last publication request (PR) done to the technical writer team''', through the technical literature management system (TLMS), for publishing this page. It should be added at the bottom of the page for which a PR has been done.

It puts a message box with a "light blue checked document" 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>PublicationRequestId | {{HighlightParam|<TLMS PR ID>}} | {{HighlightParam|<date>}} | {{HighlightParam|<comment>}}}}
Where:
* {{HighlightParam|<TLMS PR ID>}} is the '''mandatory''' identifier of the publication request done in the TLMS
** {{HighlightParam|Auto}} is a special value for this parameter to indicate that the page has been automatically approved (no TLMS PR ID)
* {{HighlightParam|<date>}} is the date of the request in the <code>YYYY-MM-DD</code> format. It is a '''mandatory''' parameter, except if {{HighlightParam|<TLMS PR ID>}} is {{HighlightParam|Auto}}
* {{HighlightParam|<comment>}} is an '''optional''' comment. 
It is recommended to use this parameter '''to indicate at least the name of the technical writer''' who made the review
==Basic examples==
{| class="st-table"
! You type !! You get
|-
| Publication request: TLMS PR ID and date supplied<pre style="white-space: pre-wrap;">

{{PublicationRequestId | 12345 | 2019-05-09 | AnneJ}}</pre>

|
{{PublicationRequestId | 12345 | 2019-05-09 | AnneJ}}
|-
| Publication request: TLMS PR ID set with "Auto" and comment supplied<pre style="white-space: pre-wrap;">

{{PublicationRequestId | Auto |  | Automatic approval based on the “Category model” article}}</pre>

|
{{PublicationRequestId | Auto |  | Automatic approval based on the “Category model” article}}
|}

==More examples==
{| class="st-table"
! You type !! You get
|-
| Publication request: no TLMS PR ID supplied, no date supplied<pre style="white-space: pre-wrap;">

{{PublicationRequestId}}</pre>

|
{{PublicationRequestId}}
|-
| Publication request: TLMS PR ID supplied, no date supplied<pre style="white-space: pre-wrap;">

{{PublicationRequestId | 12345}}</pre>

|
{{PublicationRequestId | 12345}}
|-
| Publication request: no TLMS PR ID supplied, date supplied<pre style="white-space: pre-wrap;">

{{PublicationRequestId | | 2019-05-09}}</pre>

|
{{PublicationRequestId | | 2019-05-09}}
|-
| Publication request: TLMS PR ID supplied, date supplied, comment supplied<pre style="white-space: pre-wrap;">

{{PublicationRequestId | 12345 | 2019-05-09 | AnneJ. Comment about this PR}}</pre>

|
{{PublicationRequestId | 12345 | 2019-05-09 | AnneJ. Comment about this PR}}
|-
| Publication request: TLMS PR ID set with "Auto", no comment supplied<pre style="white-space: pre-wrap;">

{{PublicationRequestId | Auto}}</pre>

|
{{PublicationRequestId | Auto}}
|-
| Check that the spaces before and after the message<pre style="white-space: pre-wrap;">

BEFORE{{PublicationRequestId | Auto}}AFTER<br>

BEFORE
{{PublicationRequestId | Auto}}
AFTER</pre>

|
BEFORE{{PublicationRequestId | Auto}}AFTER<br>

BEFORE
{{PublicationRequestId | Auto}}
AFTER
|}

==Code==</noinclude>{{#tag:secureTransclude||
src=ProtectedTemplate:PublicationRequestId|
params={{{1|}}}  {{!}}  {{{2|}}} {{!}}  {{{3|}}}
}}
Line 12: Line 12:
 
** {{HighlightParam|Auto}} is a special value for this parameter to indicate that the page has been automatically approved (no TLMS PR ID)
 
** {{HighlightParam|Auto}} is a special value for this parameter to indicate that the page has been automatically approved (no TLMS PR ID)
 
* {{HighlightParam|<date>}} is the date of the request in the <code>YYYY-MM-DD</code> format. It is a '''mandatory''' parameter, except if {{HighlightParam|<TLMS PR ID>}} is {{HighlightParam|Auto}}
 
* {{HighlightParam|<date>}} is the date of the request in the <code>YYYY-MM-DD</code> format. It is a '''mandatory''' parameter, except if {{HighlightParam|<TLMS PR ID>}} is {{HighlightParam|Auto}}
* {{HighlightParam|<comment>}} is an '''optional''' comment. It is recommended to use this parameter '''to indicate at least the name of the technical writer''' who made the review
+
* {{HighlightParam|<comment>}} is an '''optional''' comment.
   
 
==Basic examples==
 
==Basic examples==
Line 20: Line 20:
 
| Publication request: TLMS PR ID and date supplied
 
| Publication request: TLMS PR ID and date supplied
 
<pre style="white-space: pre-wrap;">
 
<pre style="white-space: pre-wrap;">
{{PublicationRequestId | 12345 | 2019-05-09 | AnneJ}}
+
{{PublicationRequestId | 12345 | 2019-05-09 |}}
 
</pre>
 
</pre>
 
|
 
|
{{PublicationRequestId | 12345 | 2019-05-09 | AnneJ}}
+
{{PublicationRequestId | 12345 | 2019-05-09 |}}
 
|-
 
|-
 
| Publication request: TLMS PR ID set with "Auto" and comment supplied
 
| Publication request: TLMS PR ID set with "Auto" and comment supplied
Line 60: Line 60:
 
| Publication request: TLMS PR ID supplied, date supplied, comment supplied
 
| Publication request: TLMS PR ID supplied, date supplied, comment supplied
 
<pre style="white-space: pre-wrap;">
 
<pre style="white-space: pre-wrap;">
{{PublicationRequestId | 12345 | 2019-05-09 | AnneJ. Comment about this PR}}
+
{{PublicationRequestId | 12345 | 2019-05-09 | Comment about this PR}}
 
</pre>
 
</pre>
 
|
 
|
{{PublicationRequestId | 12345 | 2019-05-09 | AnneJ. Comment about this PR}}
+
{{PublicationRequestId | 12345 | 2019-05-09 | Comment about this PR}}
 
|-
 
|-
 
| Publication request: TLMS PR ID set with "Auto", no comment supplied
 
| Publication request: TLMS PR ID set with "Auto", no comment supplied