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

A "notes" section in the button editor #760

Open
officialmattsnyder opened this issue Jul 30, 2019 · 8 comments
Open

A "notes" section in the button editor #760

officialmattsnyder opened this issue Jul 30, 2019 · 8 comments
Labels
area/gui GUI / Webapp related area/internal Related to an internal action or function of Companion. Enhancement New feature or request Good first issue Good for newcomers Idea Nice to have Would be nice, but not high priority.
Milestone

Comments

@officialmattsnyder
Copy link

Describe the feature
A simple text box in the button editor to be used to write and store notes for future button editing. This would be especially helpful for buttons with more extensive action sequences. Possibly even an option for notes on each individual action?

Is this platform dependent (windows, mac, ..)?
nope

If documentation is required to implement, do you know where to find it?
n/a

Usecases
This is really just about clarifying things for my future self. I'll frequently run into things where I have an action that triggers some random slide or cue somewhere and I can't remember what's on that slide. A notes box would let me type something like "This does X" so that I can quickly remember what it's all doing after the fact.

@josephdadams
Copy link
Member

This would actually be really nice. +1

@willosof willosof added Enhancement New feature or request Good first issue Good for newcomers area/gui GUI / Webapp related Idea area/internal Related to an internal action or function of Companion. Nice to have Would be nice, but not high priority. TODO labels Aug 21, 2019
@stevespaw
Copy link

+1 For leaving notes about things like delay timings !!

@gitgonow
Copy link

Because of the complexity of some of my buttons, having the ability to add some sort of a comment would save many hours. Hopefully this is coming soon...

@MyNameisStitch
Copy link

I'd also like to see this, perhaps a small text box above the Delay field or make the name of the function editable once it's added to the button editor

@sbswin
Copy link

sbswin commented Sep 27, 2022

Please implement for buttons, triggers, variables and even connections and surfaces. The first three can be used to implement complex function and being able to add and change notes as you go would help considerably when you return to the implementation some weeks later.

@Julusian Julusian modified the milestones: v3.0, v3.1 May 16, 2023
@Julusian Julusian modified the milestones: v3.2, v3.3 Jan 7, 2024
@Julusian Julusian modified the milestones: v3.3, v3.4 May 16, 2024
@Coupe70
Copy link

Coupe70 commented Aug 24, 2024

Maybe I'm late to the party, but just in case...
As comments in actions are there in the meantime and might solve the problem for many buttons:
Would it be an option to create a "comment action" that only contains a text field and that you can add to a button only when needed?
That way a comment field would not eat up space on EVERY button.
Or at least make the comment field only being created when you click a comment icon, like with the note feature in actions?

@Julusian Julusian modified the milestones: v3.4, v3.5 Aug 28, 2024
@Lukeb873
Copy link

+1 for this feature as well. We used Ross talk with our switcher to fire custom commands. While the button label helps identify what it does a notes section for Bank 8 Custom Command 9 really means would be nice. Then we could add further notes about what this does without checking Ross Dashboard. I also see the benefit in some of my larger buttons having notes to be able to check

@ChrisSW58
Copy link

ChrisSW58 commented Jan 25, 2025

Extending this ability, it would be great to have the ability to not only hold notes at the button level but ideally at the project, trigger and variable level. Can capture the "standards" used and the thinking behind the implementation.

@Julusian Julusian modified the milestones: v3.5, v3.6 Feb 1, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/gui GUI / Webapp related area/internal Related to an internal action or function of Companion. Enhancement New feature or request Good first issue Good for newcomers Idea Nice to have Would be nice, but not high priority.
Projects
Status: No status
Development

No branches or pull requests