New Ted21 help system proposal

About Monkey 2 Forums Monkey 2 Projects New Ted21 help system proposal

This topic contains 3 replies, has 2 voices, and was last updated by  AdamStrange 2 years, 8 months ago.

Viewing 4 posts - 1 through 4 (of 4 total)
  • Author
    Posts
  • #2789

    AdamStrange
    Participant

    Here is my proposal for the new help system tab.

    As you can see, I’ve (again) taken a general concept from VisualStudio and ran with it.

    Basically the help tab will have secondary tab running down the left with further options:

    Search – to search the help docs for something – needs to be rebuilt

    Index – an index of all available commands, functions, methods, fields etc. currently being built

    modules – a list of modules and how they fit together – this is all we have at the moment

     

    Any thoughts?

    Attachments:
    #2797

    Danilo
    Participant

    For me the most important stuff is, when opening the help (menu or
    F1 or F1 on keyword/method), it should not switch away from code view.
    Means, help should (optional) open in an external window.
    Always switching away from code is annoying, and with a 3-displays-system,
    there is enough room to have the help window beside the IDE – while it may
    make more sense to use a Help-TAB on single-display (notebooks etc.)

    #2813

    AdamStrange
    Participant

    that’s a good point. I’ll keep that in mind for you. Thanks for that 😉

    #2857

    AdamStrange
    Participant

    help system finished and operational

    Need to work on F1 instant help next

    Here’s the combined faces of the Help system:

    • Modules gives the original modules help
    • Index gives an a-z index of all commands, vars, etc
    • Search gives results on what you type. It will find exact matches, suggest good and not so good matches along with different icons so you can tell which is which. Exact matches come first followed by good and then ok

    There is one thing that this new system highlights: The original help needs updating to add more information.

    I think that a talk with Mark about this is more appropriate?

    Attachments:
Viewing 4 posts - 1 through 4 (of 4 total)

You must be logged in to reply to this topic.