Difference between revisions of "Template:Diaryquest/Documentation"

From GodWiki
Jump to: navigation, search
m
m (Promote Examples section to level 2)
 
(27 intermediate revisions by 3 users not shown)
Line 1: Line 1:
Inserts a [[Quest]] graphic which is extremely similar to the real one (or was at one time but has now been changed).
+
Inserts a [[Quest]] graphic which is extremely similar to the real one.
  
'''Parameters:'''
+
==Parameters==
 +
====Main Quest====
 +
;{{para|text|<var>quest title</var>}} : If this is set, a main Quest (with this title) will be included. (Default: 'look for a new quest' — or if {{para|side}} is set, omitted)
 +
:;{{para|number|<var>quest num.</var>}} : Main quest number. (Default: 1)
 +
:;{{para|status|<var>0</var>-<var>100</var>}} : Percentage of main quest completion, without the percent sign. (Default: 25)
 +
:;{{para|completed|yes}} : ''Optional'' If this parameter is specified as anything at all then the percentage of quest completion will automatically be set to 100% regardless of the other parameters and '(completed)' will appear.
 +
====Side Job====
 +
;{{para|side|<var>side job title</var>}} or {{para|sidejob|<var>side job title</var>}} : ''Optional'' If this is set, a Side Job (with this title) will be included (with or without a main Quest).
 +
:;{{para|time|<var>(HH:MM)</var>}} : ''Optional'' Time remaining on side job (Default: blank)
 +
:;{{para|side-status|<var>0</var>-<var>100</var>}} : Percentage of side job completion, without the percent sign. (Default: 25 or value of {{para|status}} if set)
 +
:;{{para|side-completed|yes}} : ''Optional'' If this parameter is specified as anything at all then the percentage of side job completion will automatically be set to 100% regardless of the other parameters.
 +
====Other====
 +
;{{para|title|<var>titlebar text</var>}}: ''Optional'' Text to use in the title bar (Default: 'Hero' for retro and superhero styles; 'Hero's Stats ↓' for hero style)
 +
;{{para|style|hero/retro}} : ''Optional'' If this parameter is omitted or set to '''default''', the template will use a modern style which closely resembles the current Godville web interface. (That same style can be explicitly selected by setting the parameter to '''superhero'''.) The previous default style is available by specifying '''<tt>style=hero</tt>'''. The other available style is '''<tt>style=retro</tt>'''. A few old, deprecated styles in different color schemes are no longer available.
  
* '''text''' - the Quest title. Default is 'look for a new quest'.
+
==Examples==
 +
;This code
 +
:<code><nowiki>{{Diaryquest | number = 42 | status = 24 | text = create an amazing template}}</nowiki></code>
 +
;Results in
 +
:{{Diaryquest | number = 42 | status = 24 | text = create an amazing template}}
  
* '''number''' - the quest number. Default is 1.
+
;This code
 +
:<code><nowiki>{{Diaryquest | style=superhero | completed = 1 | number = 50 | text = create an amazing superhero template| side = pick up a side hustle | time = (8:00) | side-status = 80}}</nowiki></code>
 +
;Results in
 +
:{{Diaryquest | style=superhero | completed = 1 | number = 50 | text = create an amazing superhero template |side = pick up a side hustle | time = (8:00) | side-status = 80}}
  
* '''status''' - the percentage of quest completion without the percent sign. Default is 25.
+
;This code
 +
:<code><nowiki>{{Diaryquest | sidejob = Create 3 GodWiki articles| side-completed = 1}}</nowiki></code>
 +
;Results in
 +
:{{Diaryquest | sidejob = Create 3 GodWiki articles| side-completed = 1}}
  
* '''completed''' - if this parameter is specified as anything at all then the percentage of quest completion will automatically be set to 100% regardless of the other parameters and '(completed)' will appear.
+
;This code
 +
:<code><nowiki>{{Diaryquest | style=hero | completed = yes | number = 42 | text = create an amazing hero template}}</nowiki></code>
 +
;Results in
 +
:{{Diaryquest | style=hero | completed = yes | number = 97 | text = create an amazing hero template}}
  
* '''style''' - If this parameter is left unspecified, it will default to the old deprecated 'hero' version but you might want the current 'super(hero)' version you actually see on your hero's page and there are quite a few styles available in the 'options' so you need to specify this parameter as one of the following:
+
;This code
-'''retro'''
+
:<code><nowiki>{{Diaryquest | style=retro | status = 34 | number = 42 | text = create an amazing retro template}}</nowiki></code>
 
+
;Results in
 
+
:{{Diaryquest | style=retro | status = 34 |number = 42 | text = create an amazing retro template}}
 
 
'''Example of Usage:'''
 
 
 
<nowiki>{{Diaryquest | number = 42 | text = create an amazing template | completed = most definitely in my opinion}}
 
{{Diaryquest | style=retro | number = 42 | text = create an amazing retro template | completed = most definitely in my opinion}}</nowiki>
 
 
 
 
 
'''Results in:'''
 
 
 
{{Diaryquest | number = 42 | text = create an amazing template | completed = most definitely in my opinion}}
 
{{Diaryquest | style=retro | number = 42 | text = create an amazing retro template | completed = most definitely in my opinion}}
 
  
 
<noinclude> [[Category:Templates/Documents|{{PAGENAME}}]]</noinclude>
 
<noinclude> [[Category:Templates/Documents|{{PAGENAME}}]]</noinclude>

Latest revision as of 16:28, 30 December 2018

Inserts a Quest graphic which is extremely similar to the real one.

Parameters

Main Quest

|text=quest title 
If this is set, a main Quest (with this title) will be included. (Default: 'look for a new quest' — or if |side= is set, omitted)
|number=quest num. 
Main quest number. (Default: 1)
|status=0-100 
Percentage of main quest completion, without the percent sign. (Default: 25)
|completed=yes 
Optional If this parameter is specified as anything at all then the percentage of quest completion will automatically be set to 100% regardless of the other parameters and '(completed)' will appear.

Side Job

|side=side job title or |sidejob=side job title 
Optional If this is set, a Side Job (with this title) will be included (with or without a main Quest).
|time=(HH:MM) 
Optional Time remaining on side job (Default: blank)
|side-status=0-100 
Percentage of side job completion, without the percent sign. (Default: 25 or value of |status= if set)
|side-completed=yes 
Optional If this parameter is specified as anything at all then the percentage of side job completion will automatically be set to 100% regardless of the other parameters.

Other

|title=titlebar text
Optional Text to use in the title bar (Default: 'Hero' for retro and superhero styles; 'Hero's Stats ↓' for hero style)
|style=hero/retro 
Optional If this parameter is omitted or set to default, the template will use a modern style which closely resembles the current Godville web interface. (That same style can be explicitly selected by setting the parameter to superhero.) The previous default style is available by specifying style=hero. The other available style is style=retro. A few old, deprecated styles in different color schemes are no longer available.

Examples

This code
{{Diaryquest | number = 42 | status = 24 | text = create an amazing template}}
Results in
Hero
Quest
#42
create an amazing template
This code
{{Diaryquest | style=superhero | completed = 1 | number = 50 | text = create an amazing superhero template| side = pick up a side hustle | time = (8:00) | side-status = 80}}
Results in
Hero
Quest
#50
create an amazing superhero template (completed)
Side Job
(8:00)
pick up a side hustle
This code
{{Diaryquest | sidejob = Create 3 GodWiki articles| side-completed = 1}}
Results in
Hero
Side Job
Create 3 GodWiki articles
This code
{{Diaryquest | style=hero | completed = yes | number = 42 | text = create an amazing hero template}}
Results in
Hero's Stats ↓
Quest
#97
create an amazing hero template (completed)
This code
{{Diaryquest | style=retro | status = 34 | number = 42 | text = create an amazing retro template}}
Results in
Hero
Quest
#42
create an amazing retro template