Help for config dialog?

Do you have questions about writing plugins or scripts in Python? Meet the coders here.
Post Reply
Bartman
Plugin Developer
Posts: 881
Joined: Sun Feb 12, 2006 9:03 am

Help for config dialog?

Post by Bartman » Thu Oct 01, 2009 9:18 pm

Is there a standard way to implement a help button on a config dialog for plugins or actions?

stottle
Plugin Developer
Posts: 636
Joined: Sun Apr 26, 2009 10:59 pm

Re: Help for config dialog?

Post by stottle » Thu Oct 01, 2009 10:53 pm

I haven't looked at it in much detail, but it looks like it applies to all classes with config dialogs. Check out HeaderBox.py (in eg\classes).

It adds a help hyperlink if "more help is available", which looks like the item's description is more than one paragragh.

Code: Select all

        description = item.GetDescription().strip()
        text = GetFirstParagraph(description)
...
        hasAdditionalHelp = (description != text)
...
        if hasAdditionalHelp:
            text += ' <a href="ShowMoreHelp">%s</a>' % eg.text.General.moreTag
        self.text = '<html><body bgcolor="%s" text="%s">%s</body></html>' % (
            self.GetBackgroundColour().GetAsString(wx.C2S_HTML_SYNTAX),
            self.GetForegroundColour().GetAsString(wx.C2S_HTML_SYNTAX),
            text
        )
Brett

Post Reply