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

Add Readme to plugin's bundled documentation #18

Open
mcascone opened this issue Jul 19, 2024 · 0 comments
Open

Add Readme to plugin's bundled documentation #18

mcascone opened this issue Jul 19, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@mcascone
Copy link
Owner

mcascone commented Jul 19, 2024

From the docs:

It is also possible (and strongly recommended) to add a user manual to the dsp script. It will be made available to the end user in the title bar, with an additional question mark icon (see the chapter about user interface for more details).

Both pdf and html manuals are supported for scripts loaded into Plug'n Script (whereas only pdf is supported for exported plug- ins).

Simply distribute the script with an html or pdf file in the same directory as the script, with the appropriate naming convention:the manual should have the same name as the script file, with the .html or .pdf extension. For example: myscript.cxx and myscript.pdf.

If no manual is provided, the help icon will not be visible in Plug'n Script or in the exported plug- in. Note: exported plug- ins currently support pdf manuals only.

@mcascone mcascone added the documentation Improvements or additions to documentation label Jul 19, 2024
@mcascone mcascone added this to the Production 1.0 milestone Jul 20, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant