From Dark and Darker Wiki

(initial)
 
m (→‎Writing Descriptions: Scaling is still in its own column, WIP)
 
(10 intermediate revisions by the same user not shown)
Line 6: Line 6:
* IronMace changed the ability such that the ability no longer has that tag
* IronMace changed the ability such that the ability no longer has that tag


The error may be displayed as:
The error may be displayed as:<br>
<p style="color:#FF0000";>(No tag found, please [[ClassAbilityDocs|correct it]])</p>
{{Ability_Data|Achilles Strike|PhysicalBaseDamage}}
<br>


==How to fix==
==How to fix==
Recommended to edit from a PC rather than mobile.
Recommended to edit from a PC rather than mobile.


After signing in/creating a Wiki account, click the Pencil icon in the top right and click "Edit Source" from the class page, like [[Barbarian]].<br>
After signing in/creating a Wiki account, go to the [[Template:Ability_Data]] page, click the Pencil icon in the top right click "Edit Source".<br>


Press Ctrl+F and search for "|abilityname" like "|achillesstrike" (no spaces), at the very bottom of the page you will see data that looks like<br>
Press Ctrl+F (Windows) and search for "abilityname=" like "achillesstrike=" (no spaces), it should look like<br>
[[File:ClassTemplateDocs_Data.png|link=|x300px]]
[[File:ClassTemplateDocs_Data.png|link=|x300px]]
<br>
<br>


As seen above, Achilles Strike's most important tags that can be called are PhysicalBaseDamage, Scaling, HitslowDuration, and HitslowMoveSpeed. Now, in the table (towards the middle of the Class page) where the description for "Achilles Strike" is written, correct the <pre style="width:fit-content;">{{template call}}</pre> such that the tag is spelled correctly and in the correct place.
As seen above, Achilles Strike's most important tags that can be called are PhysicalBaseDamage, Scaling, HitslowDuration, and HitslowMoveSpeed. Note that this data as seen above is updated automatically by the Spells & Guns team. If an update just came out to Dark and Darker and a tag that should be there isn't quite yet, either add it there temporarily or await the automatic update.
As of writing this, Achilles Strike's description and scaling is written as
 
<pre><td> The next physical attack applies a debuff that lasts {{:Barbarian|AchillesStrike|HitslowDuration}}.
<br>Now in another tab go to the class page, [[Barbarian]], and once again click the pencil then "Edit Source". <br>
  During this debuff, the victim loses {{:Barbarian|AchillesStrike|HitslowMoveSpeed}},
 
  and any step they take will inflict {{:Barbarian|AchillesStrike|PhysicalBaseDamage}}. </td>
If a typo'd tag is added/removed that needs to be changed; view the wikitable (towards the middle of the Class page) where the information for "Achilles Strike" is called, and correct the <pre style="width:fit-content;">{{template call}}</pre>such that the tag is spelled correctly and in the correct place.<br>
<td> Damage per step: {{:Barbarian|AchillesStrike|Scaling}} </td>
 
<td> {{:Barbarian|AchillesStrike|SkillCooldown}} </td></pre>
As of writing this, Achilles Strike's description (important tags), scaling, and cooldown are called like
<pre><td> {{:Barbarian|desc=AchillesStrike}} </td>
<td> Damage per step: {{Ability_Data|AchillesStrike|Scaling}} </td>
<td> {{Ability_Data|AchillesStrike|SkillCooldown}} </td></pre>
<br>''Will be updated soon to use wikitable instead of >td<''
          
          
Which then appears as<br>
Which then appear as<br>
[[File:ClassTemplateDocs_Description.png|link=|x300px]]<br>
[[File:ClassTemplateDocs_Description.png|link=|x300px]]<br><br>
 
<br><br>Note that the manually written part of the description for a given ability is called by <pre>{{:Barbarian|AchillesStrike}}</pre><br>


If the description's phrasing is what needs adjusting, Ctrl+F (Windows) for "achillesstrike=". At the bottom of the page it will be written similarly as seen below. Adjust it as necessary. These phrasings are manually written and managed by the community.<br>
[[File:ClassTemplateDocs_Phrasing.png|link=|x300px]]<br>


==Case Sensitivity==
==Case Sensitivity==
Line 35: Line 44:
==Spaces==
==Spaces==
Spaces are never present in the ability name nor the tag name. "AchillesStrike" is a valid ability, "Achilles Strike" is not.
Spaces are never present in the ability name nor the tag name. "AchillesStrike" is a valid ability, "Achilles Strike" is not.
==Special Characters==
Apostrophes may be present in the ability name, like [[Bard]]'s Wanderer's Luck can be called as "Wanderer'sLuck".
No other special characters will be in the ability name.


==Examples==
==Examples==
How to call an ability's tag value:
How to call an ability's tag value:
<pre style="width:fit-content;">{{:Barbarian|AchillesStrike|PhysicalBaseDamage}}</pre>
<pre style="width:fit-content;">{{Ability_Data|AchillesStrike|PhysicalBaseDamage}}</pre>


{{:Barbarian|AchillesStrike|PhysicalBaseDamage}}
{{Ability_Data|AchillesStrike|PhysicalBaseDamage}}






If the ability doesn't exist:
If the ability doesn't exist:
<pre style="width:fit-content;">{{:Barbarian|Achilles Strike|PhysicalBaseDamage}}</pre>
<pre style="width:fit-content;">{{Ability_Data|Achilles Strike|PhysicalBaseDamage}}</pre>


{{:Barbarian|Achilles Strike|PhysicalBaseDamage}}
{{Ability_Data|Achilles Strike|PhysicalBaseDamage}}






If the tag doesn't exist for that ability
If the tag doesn't exist for that ability
<pre style="width:fit-content;">{{:Barbarian|AchillesStrike|PhysicalDamage}}</pre>
<pre style="width:fit-content;">{{Ability_Data|AchillesStrike|PhysicalDamage}}</pre>
{{:Barbarian|AchillesStrike|PhysicalDamage}}
{{Ability_Data|AchillesStrike|PhysicalDamage}}
 
==Writing Descriptions==
See [[ClassAbilityDocs#HowToFix|How to Fix]] for how to edit the description.<br>
 
General guidelines for writing class descriptions:
* Keep it as similar to the in-game description as reasonably possible
* If the in-game description is lacking some information, it should still be included
* If the in-game description's phrasing may potentially lead to confusion, it should still be adjusted
* After any base damages/heals/shields, include the scaling afterwards in parenthesis, like {{Ability_Data|AchillesStrike|PhysicalBaseDamage}} ({{Ability_Data|AchillesStrike|Scaling}}). Most class pages still have Scaling in its own column, it's a WIP to move it to being right after the base amount in the actual description.
* Some tags may be called in the table rather than in the description, such as casting speed, which typically has its own column dedicated to it on each class page.
 
==Questions?==
Have any further questions? Feel free to reach out in the [https://discord.com/invite/wqRBSytTmP/ Spells and Guns discord's] wiki discussion channel!

Latest revision as of 03:41, 3 August 2024

Why is it broken?

The error mentioning that its broken can be displayed for a few reasons

  • The ability name was spelled incorrectly/typo'd
  • The ability' tag was spelled incorrectly/typo'd
  • IronMace changed the ability's name
  • IronMace changed the ability such that the ability no longer has that tag

The error may be displayed as:

No ability found for "Achilles Strike", please correct it


How to fix

Recommended to edit from a PC rather than mobile.

After signing in/creating a Wiki account, go to the Template:Ability_Data page, click the Pencil icon in the top right click "Edit Source".

Press Ctrl+F (Windows) and search for "abilityname=" like "achillesstrike=" (no spaces), it should look like
ClassTemplateDocs Data.png

As seen above, Achilles Strike's most important tags that can be called are PhysicalBaseDamage, Scaling, HitslowDuration, and HitslowMoveSpeed. Note that this data as seen above is updated automatically by the Spells & Guns team. If an update just came out to Dark and Darker and a tag that should be there isn't quite yet, either add it there temporarily or await the automatic update.


Now in another tab go to the class page, Barbarian, and once again click the pencil then "Edit Source".

If a typo'd tag is added/removed that needs to be changed; view the wikitable (towards the middle of the Class page) where the information for "Achilles Strike" is called, and correct the

{{template call}}

such that the tag is spelled correctly and in the correct place.

As of writing this, Achilles Strike's description (important tags), scaling, and cooldown are called like

<td> {{:Barbarian|desc=AchillesStrike}} </td>
<td> Damage per step: {{Ability_Data|AchillesStrike|Scaling}} </td>
<td> {{Ability_Data|AchillesStrike|SkillCooldown}} </td>


Will be updated soon to use wikitable instead of >td<

Which then appear as
ClassTemplateDocs Description.png



Note that the manually written part of the description for a given ability is called by

{{:Barbarian|AchillesStrike}}


If the description's phrasing is what needs adjusting, Ctrl+F (Windows) for "achillesstrike=". At the bottom of the page it will be written similarly as seen below. Adjust it as necessary. These phrasings are manually written and managed by the community.
ClassTemplateDocs Phrasing.png

Case Sensitivity

Template calls are not case sensitive, it can be full uppercase (BARBARIAN) or full lowercase (barbarian), but preferred to be propercase (Barbarian).

Spaces

Spaces are never present in the ability name nor the tag name. "AchillesStrike" is a valid ability, "Achilles Strike" is not.

Special Characters

Apostrophes may be present in the ability name, like Bard's Wanderer's Luck can be called as "Wanderer'sLuck".

No other special characters will be in the ability name.

Examples

How to call an ability's tag value:

{{Ability_Data|AchillesStrike|PhysicalBaseDamage}}

1 Physical Base Damage


If the ability doesn't exist:

{{Ability_Data|Achilles Strike|PhysicalBaseDamage}}

No ability found for "Achilles Strike", please correct it


If the tag doesn't exist for that ability

{{Ability_Data|AchillesStrike|PhysicalDamage}}

No tag found for "PhysicalDamage", please correct it

Writing Descriptions

See How to Fix for how to edit the description.

General guidelines for writing class descriptions:

  • Keep it as similar to the in-game description as reasonably possible
  • If the in-game description is lacking some information, it should still be included
  • If the in-game description's phrasing may potentially lead to confusion, it should still be adjusted
  • After any base damages/heals/shields, include the scaling afterwards in parenthesis, like 1 Physical Base Damage (50% Scaling). Most class pages still have Scaling in its own column, it's a WIP to move it to being right after the base amount in the actual description.
  • Some tags may be called in the table rather than in the description, such as casting speed, which typically has its own column dedicated to it on each class page.

Questions?

Have any further questions? Feel free to reach out in the Spells and Guns discord's wiki discussion channel!