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

Edit your own pedia #66

Open
baconpaul opened this issue May 5, 2024 · 7 comments
Open

Edit your own pedia #66

baconpaul opened this issue May 5, 2024 · 7 comments

Comments

@baconpaul
Copy link
Owner

From Patreon

sweeterthananything

thank you so much chris and now paul! i have a small request for consideration: being able to add a little custom text with the wiki/wut section. since december or so i’ve been compiling and refining my personal 1-page AW cheatsheet, and some plugins have ended up with additional tidbits from their YT video or stream chat. of course it’s not the worst thing if i continue using my (soon much reduced!) cheatsheet, it’s just something tiny to suggest. and thinking it over, i guess that’s something we would want to be able to backup to a data/text file, and maybe that also could simplify the work for you by just having it display what we’ve edited into the text file ourselves rather than internal editing capability. regardless, thank you again.

baconpaul

Oh what an interesting request. The display is actually a text editor for accessibility reasons, which is read only by default but which can be made read-write. We ignore any edits though - it's only read-write because screen readers require it to be to navigate the text block well.

Oh darn it patreon comments use enter as post! So to add - i suppose I could use that to allow custom overrides which I store in the properties file. Let me think about how unwieldy that would be. We would want to display the override as having been edited and so on, and have a clear overrides option too. Needs a bit of thought. Definitely not going to have it for the video release tomorrow morning but I'll jot this convo into a GitHub issue for future consideration

@babyloniastudio
Copy link

Just want to comment that I would also love this feature! Sometimes Chris's descriptions, although lovely, can be packed with a little too much information. I wouldn't get rid of it, but I would love an option to put some text at the top for what is useful specifically to my own use cases.

@airwindows
Copy link
Collaborator

For what it's worth, though I'm focusing on the DSP plugin side right now, this is in line with how I would like people to approach their copies of Airwindopedia.

I have literal printed books from when I was a kid, on speaker design and building, which I FIERCELY ANNOTATED with all sorts of comments while trying to make sense of it all. It would be poetic justice for people to annotate the heck out of the Airwindopedia entries that are all I've got to offer, most days :)

@baconpaul
Copy link
Owner Author

Adding a “notes” field you can edit and it shows atop the pedia with a visual guide is probably the way to go

as with all things like user favorites the “where to save it” matters but we will just use documents

I’ll look this summer when I sweep the other non bug features

@airwindows
Copy link
Collaborator

Reiterating, I'm game for allowing the editing of the literal description text. Keeps it simpler with fewer fields and features and stuff on first glance, and many people won't want or need a notes field (I use literal paper for that and don't want it on my plugins, so I won't have a notes field on anything I directly make). I'm also going to be using the documents location for features, so having user notes live in Documents/Airwindows makes sense.

@BrokenGravityMusic
Copy link
Contributor

I would love if we could just have it as a custom-description-dir where the plugin would load extra docs, when choosing a new effect. It would simply prepend the custom description in front of the built-in description.

For example, on click on ToTape7; look in the custom-desc-dir for ToTape7.txt. If it's there, prepend it to the original text, eg with a horizontal line between them to visually separate them

This would also make it simple to share custom manual-pages between users.

@BrokenGravityMusic
Copy link
Contributor

I decided to give the code a shot myself, and there is now a pull request that implements loading of custom docs: #155

@baconpaul
Copy link
Owner Author

Yeah super cool I will review tomorrow. Thank you!

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

No branches or pull requests

4 participants