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

[IDEA] Inline document for filter operator and action widget #8154

Open
linonetwo opened this issue Apr 17, 2024 · 2 comments
Open

[IDEA] Inline document for filter operator and action widget #8154

linonetwo opened this issue Apr 17, 2024 · 2 comments

Comments

@linonetwo
Copy link
Contributor

Is your feature request related to a problem? Please describe.

I'm going to create a visual editor for filter expression (solves #5058 ) and action widget (for https://talk.tiddlywiki.org/t/plugin-idea-visualize-the-action-widgets-as-workflow-graph/9620/4 ).

I need to filter all filter operator tiddler, and show then on toolbox of visual editor, and display its usage and fields. So I need their documentation to be on their fields. (params can be find in JS export, but I hope they can have description about usages)

Describe the solution you'd like

Move docs from tw5-com to language plugins, and use lingo macro in description field of filter operator and action widget tiddler, so I can wikify the field to display it. And user can see translated description.

And on tw5-com, we use lingo macro to transclude the doc back to doc site. This will make language plugin expand a bit (296 KB for filters, 215 KB for widgets, from tw5-com edition's folder).

Describe alternatives you've considered

I can also copy paste all docs to my visual editor plugin, but it can easily outdated, and the plugin need to contain all i18n files, so it will be 500KB * N huge.

Additional context

Visual editor is cool, isn't it?

@linonetwo
Copy link
Contributor Author

See also #8230 @Jermolene

@Jermolene
Copy link
Owner

Hi @linonetwo I agree that it would be very useful to have programmatically integrated documentation for the core primitives.

What I would like to do is to repackage the reference documentation as a plugin so that people can have it available in their own wikis. We would use strict naming conventions so that it would be possible for tooling to extract structured documentation for a particular widget or filter operator. We would need to devise a scheme to allow for translated documentation plugins, and to allow the documentation to be extended by plugins.

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

No branches or pull requests

2 participants