Help display

Development
1

Is it currently possible to abuse plugin.json somehow to display simple help information on a module? Like open the notes plugin as a side panel and show it there?

  "modules": [
    {
      "slug": "MyModule",
      "name": "MyModule",
      "description": "DadaDiidadaDa",
      "tags": [],
      "help": {
        "blurp": "long story ...",
      }
    }
  ]

or the extended version,

  "modules": [
    {
      "slug": "MyModule",
      "name": "MyModule",
      "description": "DadaDiidadaDa",
      "tags": [],
      "help": {
        "blurp": "long story ...",
        "params":{
          "small knob": "turn right",
          "big knob": "turn right too, to 11"
        },
        "inputs":{
          "Start": "trigger"
        },
        "outputs":{
          "Volt": "high voltage"
        }
      }
    }
  ]
1 Like
2

There will be a manual field per plugin for the json, this will be implemented in v2.

"manualUrl": "https://.../..."

You can do so at the minute by adding a context menu option.

There is also tooltips for configParam

configParam(someParam, float, float, float, string, string, float, float, float);
configParam(someParam, min, max, default, label, unit, dislayBase, displayMultiplier, displayOffset);
1 Like
3

Every time I open my browser I get crackles as if standing in a meteorite rain :frowning: Most doc on modules is rather sparse and rightfully so, but sometimes I’d like to have more information than just a tooltip. Notes seems perfect for on Rack information display,

cheers

1 Like
4

I have an extra menu item on the context menu linking to a manual on GitHub on almost all of my modules.

1 Like
5

All Squinky Labs modules have had this for quite some time. It’s super easy to do in code. But does require you have a separate help page somewhere for each module.

1 Like