Talk:ThingDef/Standardized styling, default values, child tags

From RimWorld Wiki
Revision as of 12:33, 4 April 2015 by Alistaire (talk | contribs) (New thread: Standardized styling, default values, child tags)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

Looking at my previous XML documentations User:Alistaire/Tag:ThingDef and Dredmod Monster System Reference, and comparing it to the page in its current state:

  • The standard value names are lower case, which in my opinion makes it more readable and less crowded;
  • The default value of the value names is shown to help modders decide whether they have to add the tag;
  • An example is shown for modders to instantly copy into their mod;
  • A list of possible values is either linked to (ThingDef) or listed (Dredmod), as to deal with non-standard or limited possible string values;
  • Limits are shown on value names with limited values, such as "float (0.0 to 1.0)" for <fillPercent>;
  • Accepted values for the value name is directly next to the value name, so it's faster to look it up without having to read / skip the Description column;
  • Non-standard values have a seperate page that's linked to on the value itself, such as "defName" (ThingDef) and "sfx" (Dredmod);
  • Tags are formatted like <tag> instead of tag, to show it's a tag;
  • Element (This page) names are left-aligned instead of center-aligned, to improve readability;
  • Child tags are linked to instead of mentioned in the Value column.


The above points would improve the usability of the page a lot. I'm also in favour of making some kind of style guide for the entire Defs section.

Thoughts?