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

Generate key combo Markdown #5

Draft
wants to merge 13 commits into
base: main
Choose a base branch
from
Draft

Generate key combo Markdown #5

wants to merge 13 commits into from

Conversation

nrichards
Copy link
Owner

@nrichards nrichards commented May 6, 2024

Write all the key combos having images as a series of tables, organizing the combos into columns. Automatically extract this information from existing formatted button-sequence markdown.

  • Tables are identified by nearest heading
  • Columns will be labeled with category names. Names will be one of handful of well-known labels, such as "Performance" and "Editing". Combos will be fuzzy-matched using keywords found in the combo's description, which are ad-hoc associated with those labels.
  • README has updated instructions

Inspiration

* Add print_markdown_tree for debug
* Add write_seqs_md.py for generating a leadsheet, dumps debug currently
* Minor refactorings
* Add `--md-seqs-out-file` param to trigger feature
* Add a variety of helper API to generate the doc contents
* Require named params for longer ButtonSequence ctor
* Add delayed init to ButtonSequence to populate description
* Fix tables output, format was corrupted
* Remove prototyping clutter
* Start collecting category labels and keywords
* Use self-documenting code style, aka ginormous fn names
* Tidy
@nrichards nrichards self-assigned this May 6, 2024
* Tweak debugging util to print nicer, and temporarily break on exceptions
* Refactor writing to smaller functions
* Start updating README
* Collect args
* Define button categorization patterns
* Fix default CSV filename
* Using @DataClass to simplify some classes
* Add class to store CSV's category labels and sections
* Passes around categories in-order for future heuristic matching
* Support comments ('#') in categories CSV
* Uses the categories CSV
* Extracts Sections from button sequences
* Lower-cases the CSV category keywords
* Add helper data-functions to core datatype ButtonSequence, because it's convenient. Could use an injectable data store instead.
* Refactor common string formatting
* Cleanup dead code
* Center columns
* Use Heading for title
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant