Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Auto-Generate Variables.md #2338

Open
Tkael opened this issue Apr 3, 2022 · 0 comments
Open

Auto-Generate Variables.md #2338

Tkael opened this issue Apr 3, 2022 · 0 comments
Labels
9. enhancement The behaviour is as specified, but we would like to modify or extend the spec.

Comments

@Tkael
Copy link
Member

Tkael commented Apr 3, 2022

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 Tkael added the 9. enhancement The behaviour is as specified, but we would like to modify or extend the spec. label Apr 3, 2022
@Tkael Tkael changed the title Refresh Variables.md Refresh and enhance Variables.md Apr 3, 2022
@Tkael Tkael changed the title Refresh and enhance Variables.md Further enhance documentation Apr 3, 2022
@Tkael Tkael changed the title Further enhance documentation Auto-Generate Variables.md Aug 18, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
9. enhancement The behaviour is as specified, but we would like to modify or extend the spec.
Projects
None yet
Development

No branches or pull requests

1 participant