Tk-App Documentation

CGSoup · November 6, 2019, 6:20pm

Can I ‘override’ the default Documentation and Help & Support links for a tk-app?

I want the links to point to an internal Wiki not the Integrations User Guide/Shotgun Help Center.

tk-app_docs

I thought I remember seeing this somewhere but I can’t seem to find it now.

Daniel

tannaz · November 6, 2019, 11:15pm

Hey Daniel!

It’s not exposed as a setting, but if you’re writing your own app, there’s a support_url property on the AppDescriptor object that you can set.

Some links and things:

Here’s the documentation for the support_url property
Here it is in the code:

github.com

shotgunsoftware/tk-core/blob/7fa48f908bb251f6cee92f0ca826a5fcdbadb081/python/tank/descriptor/descriptor.py#L338-L348


@property
def support_url(self):
    """
    A url that points at a support web page associated with this item.
    If not url has been defined, ``None`` is returned.
    """
    meta = self._get_manifest()
    support_url = meta.get("support_url")
    if support_url is None:
        support_url = "https://support.shotgunsoftware.com"
    return support_url

I don’t see any instances in our own apps where it’s being overridden, otherwise I’d share an example here
Finally, I’ll point out that the tk-multi-publish2 app does things a bit differently – there is a configuration setting called help_url.
Here it is in the app’s manifest:

github.com

shotgunsoftware/tk-multi-publish2/blob/master/info.yml#L74-L81


help_url:
    type: str
    description:
      "The url to open when the 'help' button is clicked in the publisher.
       The url should typically lead to a page that outlines the studio's
       publishing workflow. If no url is provided, the help button will
       not be displayed."
    default_value: ""

and it’s used here:

github.com

shotgunsoftware/tk-multi-publish2/blob/ada00c9ef88d6ac46cdb49e10692c808be345476/python/tk_multi_publish2/dialog.py#L159-L165


help_url = self._bundle.get_setting("help_url")
if help_url:
    # connect the help button to the help url provided in the settings
    self.ui.help.clicked.connect(lambda: self._open_url(help_url))
else:
    # no url. hide the button!
    self.ui.help.hide()

Hope that helps! Let us know if you have any other questions.

CGSoup · November 7, 2019, 12:19am

Nope. That does it for now.

Added both to info.yml and working great!

documentation_url: “http://www.documentation.site”
support_url: “http://www.support.site”

Thanks again,
Daniel