Difference between revisions of "Template:Awaiting PR"

Revision as of 20:38, 23 January 2021

Template:Awaiting PR - Documentation

Implementation

Awaiting PR
| PRlink=
| PRname=
| DraftPage=

Usage

If there is a PR that has been approved or is about to be merged then this template should be applied directly above the section/article in which the PR will change content. This should not be used for every PR. Make sure to link directly to the github conversation page for the PR.

Variables

PRlink = The full external link to the PR in its raw form
PRname = The title of the PR on the PR's github page
DraftPage = The internal page on the wiki in which a draft has been started to replace the section this template is being applied. Namespace is only needed for non mainspace articles

Example

Awaiting PR
| PRlink=https://github.com/ParadiseSS13/Paradise/pull/15291 
| PRname=Supermatter Update
| DraftPage=User:Sirryan2002

This Section or Article is Awaiting a PR
Pull Request: Supermatter Update
Draft Page: User:Sirryan2002

This content of this article or section is outdated or is about to be outdated due to an ongoing Pull Request.

Example Pages

Supermatter Engine

To implement your own Documentation on another template page or to understand how to use the Documentation template, please see Template:Documentation

@@ Line 1: / Line 1: @@
+<includeonly>
 <div style="box-shadow: 0 0 .3em #999; border-radius: .2em; margin: 1em 0 1em 0; padding: 1px;">
 <div style="background: #FF66DD; border-radius: .2em; color: #FFF; padding: .4em .8em .5em;"><center>
 '''This Section or Article is Awaiting a PR<br>Pull Request:''' [{{{PRlink|https://github.com/ParadiseSS13/Paradise}}} {{{PRname|Paradise Github}}}] '''<br>Draft Page:''' {{{DraftPage}}} <br></center></div><div style="padding: 1em; background: #FFAAFF"><center>This content of this article or section is outdated or is about to be outdated due to an ongoing Pull Request.</center></div></div>
+[[Category:Awaiting PR]]</includeonly>
-<includeonly>[[Category:Awaiting PR]]</includeonly>
 <noinclude>
+{{Documentation
-==How to use this Template==
+| ImplementationCode=<pre>
-If there is a PR that is likely going to merge(you should confirm this with the coders) then you should apply this template above the article and draft article for the PR.
+Awaiting PR
+| PRlink=
-While the parameters are mostly straightforward, the "DraftPage" parameter refers to the location of a draft for the new PR. For example, if a new job was being added but the PR had not been merged yet then you may create that page ahead of time.
+| PRname=
+| DraftPage=
-This template takes 3 Parameters:
+</pre>
-# PRlink - This should be an external link to the PR
+| Usage= If there is a PR that has been approved or is about to be merged then this template should be applied directly above the section/article in which the PR will change content. This should not be used for every PR. Make sure to link directly to the github conversation page for the PR.
-# PRname - This should be the name of the PR
+| V1=PRlink | VD1=The full external link to the PR in its raw form
-# DraftPage - This should be the location of the page the PR is being drafted on it should be in this format=<nowiki>[[Namespace:PageName]]</nowiki>
+| V2=PRname | VD2=The title of the PR on the PR's github page
+| V3=DraftPage |VD3=The internal page on the wiki in which a draft has been started to replace the section this template is being applied. Namespace is only needed for non mainspace articles
-==Examples==
+| ExampleCode=<pre>
-<pre>
+Awaiting PR
-{{Awaiting PR
 | PRlink=https://github.com/ParadiseSS13/Paradise/pull/15291
 | PRname=Supermatter Update
 | DraftPage=User:Sirryan2002
-}}
 </pre>
-{{Awaiting PR
+|Example={{Awaiting PR
 | PRlink=https://github.com/ParadiseSS13/Paradise/pull/15291
 | PRname=Supermatter Update
-| DraftPage=[[User:Sirryan2002]]
+| DraftPage=User:Sirryan2002
+}}
+|ExamplePage1=Supermatter Engine
 }}
-[[Category:Templates]]
 </noinclude>