Generate a cross-reference?

handeyeco / deluge-shortcuts

Synthstrom Deluge: website with a searchable list of shortcuts

https://handeyeco.github.io/deluge-shortcuts/

Other

8 stars 1 forks source link

Generate a cross-reference? #1

Open jamiefaye opened 1 year ago

jamiefaye commented 1 year ago

It would help developers if we could generate a cross-reference table. This would be a list of each button and knob and would show all the combinations it participates in.

Something like:

X (Everything thaat uses the X knob)

press(X) View zoom level
hold(X) Change zoom level
turn(X) Scroll horizontal etc.

Tempo (everything that uses the Tempo knob)

turn(TEMPO) Change tempo.
hold(TEMPO) turn Temp etc.

press (everything that involves pressing something)

press(X) View zoom level
press(BACK) undo.
hold(SHIFT) press(BACK), redo.
hold(SHIFT)press(TEMPO) etc.

(and with permutations): press (X) hold(SHIFT) etc.

jamiefaye commented 1 year ago

I should add that I am most impressed with what you have done so far. Many thanks!

handeyeco commented 1 year ago

Shouldn't be too hard to script that from the shortcuts object. I'm just trying to decide which would be more useful: a node script to generate a cross-reference file or add a special search object (I'm trying to avoid adding a compilation step because I find it adds too much infra complexity for these kinds of weekend projects).

So I'm thinking either:

A node script devs could use: node cross-reference.js that generates JSON or TXT or something?
A special filter option on the site: uses:press uses:SHIFT. Maybe with the option to export filtered results?

jamiefaye commented 1 year ago

I would generate the X Ref entries in the browser. This should be relatively easy as the database is already there in memory. I would consider placing links everywhere I could using the # feature for local in-document destinations. Each term in a command entry could link to the XRef entry for that term, and each XRef entry would have a link-back to the original command description. You can avoid a separate build-step in the deployment script this way.

handeyeco commented 1 year ago

I haven't gotten all the way there, but I wanted to tweak some things before a vacation and I think I added some stuff that might be helpful to you.

Update the URL based on page/search, so it's easy to link to things
I roughed out some data on what "view" shortcuts are on
Ability to filter by "action" (example)
Ability to filter by "control" (example)
Ability to filter by "view" (example)
Multi-word searches now look for each word, not the whole string (example)
Exact search to allow whole string search (example)
Added an "About" page with a download of all shortcuts broken up by action/control/view as JSON (link)

This should set things up for an x ref at the UI level (and I kind of started by adding links to filtered shortcuts from the legend), but I won't be able to finish until after vacation.