Difference between revisions of "Template:PatchNoteStatus/doc"

From EVE University Wiki
Jump to: navigation, search
(Wrote initial docs for the template)
 
(Added category and improved docs - has a todo that will be resolved after technical review and implementation into the custom converter)
 
(2 intermediate revisions by the same user not shown)
Line 3: Line 3:
  
 
; Syntax
 
; Syntax
−
: {{T|User:Arin Mara/Sandbox/Patch Notes/Template:Patch note status|status|patch note text}}
+
: {{T|PatchNoteStatus|status|patch note text}}
 
:; Parameters
 
:; Parameters
 
::; status : Sets the status of the patch note. Set as one of the following:
 
::; status : Sets the status of the patch note. Set as one of the following:
−
:::* To Do - determine if the patch note contains knowledge that should be added to the UniWiki.
+
:::* '''To Be Determined''' - it is unknown if the patch note contains knowledge that should be added to the UniWiki. Once determined, change the status to either '''To Do''' or '''Ignore'''
−
:::* Ignore - the patch note is irrelevant; examples include new music, minor graphical changes or other patch notes that contain little to no knowledge.
+
:::* '''To Do''' - patch note contains knowledge that should be added to the UniWiki. Once completed, change the status to '''Done'''
−
:::* Done - the patch note's knowledge has been added to the UniWiki.
+
:::* '''Done''' - patch note has been added into the UniWiki
−
::; patch note text : Patch note text that is being assigned a status.
+
:::* '''Ignore''' - patch note is irrelevant as it contains little to no useful knowledge. Examples include notes about music, minor UI changes or game settings
 +
::; patch note text : Patch note text that has a status
  
 
; Sample
 
; Sample
−
:<code><nowiki>{{User:Arin Mara/Sandbox/Patch Notes/Template:Patch note status|to do|Patch note has a To Do status.}}</nowiki></code>
+
:<code><nowiki>{{PatchNoteStatus|tbd|Patch note has a To Be Determined status.}}</nowiki></code>
−
:: gives... {{User:Arin Mara/Sandbox/Patch Notes/Template:Patch note status|to do|This patch note has a To Do status.}}
+
:: gives... {{PatchNoteStatus|tbd|Patch note has a To Be Determined status.}}
  
−
:<code><nowiki>{{User:Arin Mara/Sandbox/Patch Notes/Template:Patch note status|ignore|Patch note has an Ignore status.}}</nowiki></code>
+
:<code><nowiki>{{PatchNoteStatus|to do|Patch note has a To Do status.}}</nowiki></code>
−
:: gives... {{User:Arin Mara/Sandbox/Patch Notes/Template:Patch note status|ignore|This patch note has an Ignore status.}}
+
:: gives... {{PatchNoteStatus|to do|This patch note has a To Do status.}}
  
−
:<code><nowiki>{{User:Arin Mara/Sandbox/Patch Notes/Template:Patch note status|done|Patch note has a Done status.}}</nowiki></code>
+
:<code><nowiki>{{PatchNoteStatus|ignore|Patch note has an Ignore status.}}</nowiki></code>
−
:: gives... {{User:Arin Mara/Sandbox/Patch Notes/Template:Patch note status|done|This patch note has a Done status.}}
+
:: gives... {{PatchNoteStatus|ignore|Patch note has an Ignore status.}}
  
−
:<code><nowiki>{{User:Arin Mara/Sandbox/Patch Notes/Template:Patch note status|bad status|Patch note that has a bad status.}}</nowiki></code>
+
:<code><nowiki>{{PatchNoteStatus|done|Patch note has a Done status.}}</nowiki></code>
−
:: gives... {{User:Arin Mara/Sandbox/Patch Notes/Template:Patch note status|bad status|This is a patch note that has a bad status.}}
+
:: gives... {{PatchNoteStatus|done|Patch note has a Done status.}}
 +
 
 +
:<code><nowiki>{{PatchNoteStatus|bad status|Patch note that has a bad status.}}</nowiki></code>
 +
:: gives... {{PatchNoteStatus|bad status|Patch note that has a bad status.}}
  
 
; See also:
 
; See also:
 
: * ToDo link to the patch notes once published
 
: * ToDo link to the patch notes once published
  
−
<!-- ToDo add categories once published
+
<includeonly>[[Category:Maintenance templates]]</includeonly>
−
<includeonly>[[Category:Template]]</includeonly>
 
 
<noinclude>[[Category:Template documentation]]</noinclude>
 
<noinclude>[[Category:Template documentation]]</noinclude>
−
-->
 

Latest revision as of 17:31, 16 January 2024

Description
This template is used to indicate the status of a patch note.
Syntax
{{PatchNoteStatus|<status>|<patch note text>}}
Parameters
status
Sets the status of the patch note. Set as one of the following:
  • To Be Determined - it is unknown if the patch note contains knowledge that should be added to the UniWiki. Once determined, change the status to either To Do or Ignore
  • To Do - patch note contains knowledge that should be added to the UniWiki. Once completed, change the status to Done
  • Done - patch note has been added into the UniWiki
  • Ignore - patch note is irrelevant as it contains little to no useful knowledge. Examples include notes about music, minor UI changes or game settings
patch note text
Patch note text that has a status
Sample
{{PatchNoteStatus|tbd|Patch note has a To Be Determined status.}}
gives... Question.png To Be Determined   - Patch note has a To Be Determined status.
{{PatchNoteStatus|to do|Patch note has a To Do status.}}
gives... Small Info.png To Do   - This patch note has a To Do status.
{{PatchNoteStatus|ignore|Patch note has an Ignore status.}}
gives... Chatchannel.png Ignore - Patch note has an Ignore status.
{{PatchNoteStatus|done|Patch note has a Done status.}}
gives... Tick.png Updated - Patch note has a Done status.
{{PatchNoteStatus|bad status|Patch note that has a bad status.}}
gives... Possible values: To Be Determined, To Do, Ignore, Done - Patch note that has a bad status.
See also
* ToDo link to the patch notes once published
Retrieved from "https://wiki.eveuniversity.org/index.php?title=Template:PatchNoteStatus/doc&oldid=211871"