EDDI icon indicating copy to clipboard operation
EDDI copied to clipboard

Auto-Generate Variables.md

Open Tkael opened this issue 2 years ago • 0 comments

What happens now

  • Variables.md is manually written.

What I'd like to happen

  1. Auto-generate variables.md
  2. Document variable types (string, object, integer, decimal, boolean, etc.)
  3. Document various objects that allow users to obtain invariant names
  4. Document the possible values of localized and invariant names
  5. Syntax highlighting should include and distinguish object properties

How it can happen

  1. Rewrite code to generate Variables.md dynamically. Either it will need to be generated via GeneratorTests.cs and will need to include all possible localizations of all possible values or it will need to be generated at point of use (in ScriptResolver.cs?) to report values for a specific culture (in which case Variables.md on the wiki would be limited to including just the English names?)
  2. This part is easily done if generated dynamically via MetaVariables.cs
  3. This part is easily done if generated dynamically via MetaVariables.cs
  4. Probably best done by modifying MetaVariables.cs to iterate through objects inheriting from ResourceBasedLocalizedEDName<T>, obtain each basename property, and obtaining localized values from those basename properties.
  5. Could perhaps be done using MetaVariables.cs

EDDI Version

4.0.1

Tkael avatar Apr 03 '22 21:04 Tkael