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

Description of toolbar macro is missing #256

Open
markkerrigan opened this issue Mar 1, 2020 · 1 comment
Open

Description of toolbar macro is missing #256

markkerrigan opened this issue Mar 1, 2020 · 1 comment

Comments

@markkerrigan
Copy link
Contributor

List of macros does not include toolbar macro.

The current tiddlers ToolbarButtons and ToolbarCommands do not provide a great description of how to customize the toolbar.

@YakovL
Copy link
Contributor

YakovL commented Jan 22, 2024

In fact, there's many more not mentioned there:

  • those that are usually used only in templates: annotations, backstage, edit, (view is present), message, tagChooser, toolbar;
  • those that are rarely used (since are present in backstage/sidebar): importTiddlers, options, plugins, upgrade; allTags;
  • option, refreshDisplay;
  • shouldn't be mentioned: deprecated: br, sync; to deprecate: gradient.

I'd probably start with option.

As for the toolbar, indeed the docs are not complete: although there's [[ToolbarButtons]] that's shown in [[Reference]], it doesn't explain how to edit [[ToolbarCommands]]. I think, the best option to deliver better docs here is to edit [[ToolbarButtons]]: switch the list to a table that also shows the names of the commands, and may be references/aggregates tiddlers tagged [[commands]]. Also, special symbols that define the toolbar(>, <, *, !; -command, +command) should be explained.

Moreover, the annotation of ToolbarCommands in TW itself should have a link to such a description.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants