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

Replace beanshell standard help system with a more extensible help system #28

Closed
stefanofornari opened this issue Nov 27, 2018 · 1 comment
Labels
enhancement New feature or request

Comments

@stefanofornari
Copy link
Owner

stefanofornari commented Nov 27, 2018

I'd like to be able to provide a flexible and simple help system for 3rd party commands or added commands. This is how it should work:

bsh.help shall point to a directory where the help text of the various commands will be stored, one file per command. The help file shall be named [command name].txt and follow the resource conversion of turning package namespaces into subfolders (e.g. help file com/acme/app/show.txt is for command com.acme.app.show).

A new command help() shall be provided. This lists all help files and print them all on the console's output stream. If help() is used with one or more string arguments, the help files of the given commands shall be printed.

bsh.help shall default to /help

This should replace the use of bsh.help. which quite limited in the length and formatting of the text.

@stefanofornari stefanofornari added the enhancement New feature or request label Nov 27, 2018
@stefanofornari stefanofornari changed the title Extensible help system Replace beanshell standard help system with a more extensible help system Nov 29, 2018
stefanofornari added a commit that referenced this issue Dec 5, 2018
@stefanofornari
Copy link
Owner Author

Implemented in v1.3.0

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

No branches or pull requests

1 participant