Export a PDF Guide of Configurations for training crew, volunteers, clients

[davidjoshuaford]

Is this a feature relevant to companion itself, and not a module?

• [X] I believe this to be a feature for companion, not a module

Is there an existing issue for this?

• [X] I have searched the existing issues

Describe the feature

PROBLEM: DIFFICULT TO TRAIN PEOPLE ON CUSTOM CONFIGS

For large configurations, keeping track of what each button does to train a crew, volunteer, or client becomes as much manual work as designing the functions themselves. Plus with each small change to a configuration (moving buttons, changing actions or delay times) it's hard (ie very slow and laborious) to keep an accurate log in a separate document of what buttons do.

ADD A "DESCRIPTION" FIELD

The main field to add for each button would be a text based "Description" field under the name string. While the button name string is useful, often it has strange variables in it, and it would be cleaner to output a Description field. This should accept new lines, so that multi-actions can be clearly laid out in the description.

PDF PRINTED GUIDE

It would be amazingly helpful if Companion could output a PDF Guide for physical printing or sending digitally. This would included a screenshot of the page for reference, and in its most basic form a list underneath of the button number (0/1) and the text from the Description field. There would be options to modify:

• Which pages, or range of pages, to include in a PDF export
• Which rows/ columns to export
• Option to turn topbar on/off for export

Here are some mockups:

EXPORT ATTRIBUTES VIA CSV

Further, it would be great to be able to select what attributes you want to output for more details in a spreadsheet/ CSV format. These could include:

• PNG image of the button for reference
• Button number 0/0/0
• Button text string
• The addition of a "Description" field to add notes (formatting should accept new lines for clear layout)
• Relative Delays status
• Progress status
• Rotary action status
• Steps (including the custom names that can be added)
• Press Actions (list of actions added)
• Release Actions (list of actions added)
• Short Release (list of actions added)
• Release After... (list of actions)

HOVER FOR TOOL TIPS

Other ideas could be the "Description" field text appearing as a tooltip alongside the 0/0 button numbers when you hover over them in on the Buttons tab, or on the emulator.

THE BENEFIT

The benefit of storing the description in Companion on every button is that as profiles are chopped/changed/added to, the description of the button travels with that button.

Usecases

• useful for training other crew/volunteers/clients who are unfamiliar with the configuration you've created
• good note taking for reminding you about the function of a button when you haven't looked at it for a long time