<html><head><meta http-equiv="Content-Type" content="text/html; charset=us-ascii"></head><body style="word-wrap: break-word; -webkit-nbsp-mode: space; line-break: after-white-space;" class="">Hi Tony,<div class=""><br class=""></div><div class=""> Mostly putting your ChimeraX plugin on the ChimeraX Toolshed (free app store) <a href="https://cxtoolshed.rbvi.ucsf.edu" class="">https://cxtoolshed.rbvi.ucsf.edu</a> makes it super simple for anyone using ChimeraX to install, just using menu Tools / More Tools... and pressing an install button.</div><div class=""><br class=""></div><div class=""> For plugins distributed on the Toolshed our plan is that the documentation in most cases would be included in the plugin in html format. The advantage of this is that as you make new versions of your plugin with new features the user who has your old version sees the documentation for that old version. This avoids confusion where the online documentation is not correct for all the old versions of your plugin. We have not yet been including documentation with the Toolshed plugins we create so it is rather untested right now (I think the ViewDockX plugin is the only one doing that), so your solution of having the Help menu entry go to your web site is fine.</div><div class=""><br class=""></div><div class=""><span class="Apple-tab-span" style="white-space:pre"> </span>Tom<br class=""><div><br class=""><blockquote type="cite" class=""><div class="">On Mar 27, 2020, at 11:08 AM, Greg Couch <<a href="mailto:gregc@cgl.ucsf.edu" class="">gregc@cgl.ucsf.edu</a>> wrote:</div><br class="Apple-interchange-newline"><div class="">
<meta http-equiv="Content-Type" content="text/html;
charset=windows-1252" class="">
<div class="">
<div class="moz-cite-prefix">As ChimeraX matures, we are really
hoping that you make your tool deliverable through the ChimeraX
Toolshed that is accessible via the Tools menu's "More Tools..."
option. Those tool bundles should be semantically versioned
releases and reasonably self contained. The github version should
be for development and may or may not need a ChimeraX daily build
to work. Making releases is more work, but will benefit users a
lot.<br class="">
</div>
<div class="moz-cite-prefix"><br class="">
</div>
<div class="moz-cite-prefix"> -- Greg<br class="">
</div>
<div class="moz-cite-prefix"><br class="">
</div>
<div class="moz-cite-prefix">On 3/27/2020 10:43 AM, Tom Goddard
wrote:<br class="">
</div>
<blockquote type="cite" cite="mid:CD75FC0D-9302-4A94-8F03-EED7C99F2C83@sonic.net" class="">
<meta http-equiv="Content-Type" content="text/html;
charset=windows-1252" class="">
Hi Tony,
<div class=""><br class="">
</div>
<div class=""> Seems like the simplest solution would if we made
the help command handle http/https urls so I added that, in
tonight's ChimeraX builds. So in our ToolInstance class you can
just define an attribute help = "<a href="https://github.com/" class="" moz-do-not-send="true">https://github.com/</a>..." so
the context menu Help button on your tool will show your web
site docs.</div>
<div class=""><br class="">
</div>
<div class=""><span class="Apple-tab-span" style="white-space:pre"> </span>Tom</div>
<div class=""><br class="">
<div class=""><br class="">
<blockquote type="cite" class="">
<div class="">On Mar 26, 2020, at 11:01 PM, Anthony James
Schaefer <<a href="mailto:tony.schaefer@uga.edu" class="" moz-do-not-send="true">tony.schaefer@uga.edu</a>>
wrote:</div>
<br class="Apple-interchange-newline">
<div class="">
<div style="font-style: normal; font-variant-caps: normal;
font-weight: normal; letter-spacing: normal; text-align:
start; text-indent: 0px; text-transform: none;
white-space: normal; word-spacing: 0px;
-webkit-text-stroke-width: 0px; text-decoration: none;
font-family: Calibri, Arial, Helvetica, sans-serif;
font-size: 12pt;" class=""><span style="font-family:
Arial, Helvetica, sans-serif;" class="">Hello,</span></div>
<div style="font-style: normal; font-variant-caps: normal;
font-weight: normal; letter-spacing: normal; text-align:
start; text-indent: 0px; text-transform: none;
white-space: normal; word-spacing: 0px;
-webkit-text-stroke-width: 0px; text-decoration: none;
font-family: Calibri, Arial, Helvetica, sans-serif;
font-size: 12pt;" class=""><br class="">
</div>
<div style="font-style: normal; font-variant-caps: normal;
font-weight: normal; letter-spacing: normal; text-align:
start; text-indent: 0px; text-transform: none;
white-space: normal; word-spacing: 0px;
-webkit-text-stroke-width: 0px; text-decoration: none;
font-family: Calibri, Arial, Helvetica, sans-serif;
font-size: 12pt;" class=""><span style="font-family:
Arial, Helvetica, sans-serif;" class="">can tools'
"Help" option in the context menu be changed to use
`ToolInstance.display_help` instead of running the
`help` command? I'd like to keep most of my
documentation on GitHub. The `help` command cannot
open URLs, so I thought I'd overwrite my tools'
`display_help` methods to use `open` instead. However,
I discovered this method isn't used anywhere.<span class="Apple-converted-space"> </span><br class="">
</span></div>
<div style="font-style: normal; font-variant-caps: normal;
font-weight: normal; letter-spacing: normal; text-align:
start; text-indent: 0px; text-transform: none;
white-space: normal; word-spacing: 0px;
-webkit-text-stroke-width: 0px; text-decoration: none;
font-family: Calibri, Arial, Helvetica, sans-serif;
font-size: 12pt;" class=""><br class="">
</div>
<div style="font-style: normal; font-variant-caps: normal;
font-weight: normal; letter-spacing: normal; text-align:
start; text-indent: 0px; text-transform: none;
white-space: normal; word-spacing: 0px;
-webkit-text-stroke-width: 0px; text-decoration: none;
font-family: Calibri, Arial, Helvetica, sans-serif;
font-size: 12pt;" class=""><span style="font-family:
Arial, Helvetica, sans-serif;" class="">I've tried
changing `_show_context_menu` in chimerax.ui.gui
(around line 2087) to
`help_action.triggered.connect(ti.display_help)`. It
seems to behave the same for all built-in tools.<span class="Apple-converted-space"> </span><br class="">
</span></div>
<div style="font-style: normal; font-variant-caps: normal;
font-weight: normal; letter-spacing: normal; text-align:
start; text-indent: 0px; text-transform: none;
white-space: normal; word-spacing: 0px;
-webkit-text-stroke-width: 0px; text-decoration: none;
font-family: Calibri, Arial, Helvetica, sans-serif;
font-size: 12pt;" class=""><span style="font-family:
Arial, Helvetica, sans-serif;" class=""><br class="">
</span></div>
<div style="font-style: normal; font-variant-caps: normal;
font-weight: normal; letter-spacing: normal; text-align:
start; text-indent: 0px; text-transform: none;
white-space: normal; word-spacing: 0px;
-webkit-text-stroke-width: 0px; text-decoration: none;
font-family: Calibri, Arial, Helvetica, sans-serif;
font-size: 12pt;" class=""><span style="font-family:
Arial, Helvetica, sans-serif;" class="">I understand
there might be reasons to not do this (<i class="">e.g.</i><span class="Apple-converted-space"> </span>users might
not be able to connect to the internet). I'd like to
keep stuff on GitHub because I can make a page on a
GitHub wiki page faster than an HTML doc. Regardless
of how tools' help pages get shown, I'd like to have
examples of what my bundle can do on the GitHub wiki.
To that end, my GitHub wiki could serve a dual
purpose: a showcase and documentation.</span><br class="">
</div>
<div style="font-style: normal; font-variant-caps: normal;
font-weight: normal; letter-spacing: normal; text-align:
start; text-indent: 0px; text-transform: none;
white-space: normal; word-spacing: 0px;
-webkit-text-stroke-width: 0px; text-decoration: none;
font-family: Calibri, Arial, Helvetica, sans-serif;
font-size: 12pt;" class=""><br class="">
</div>
<div style="font-style: normal; font-variant-caps: normal;
font-weight: normal; letter-spacing: normal; text-align:
start; text-indent: 0px; text-transform: none;
white-space: normal; word-spacing: 0px;
-webkit-text-stroke-width: 0px; text-decoration: none;
font-family: Calibri, Arial, Helvetica, sans-serif;
font-size: 12pt;" class=""><span style="font-family:
Arial, Helvetica, sans-serif;" class="">Best,</span></div>
<div style="font-style: normal; font-variant-caps: normal;
font-weight: normal; letter-spacing: normal; text-align:
start; text-indent: 0px; text-transform: none;
white-space: normal; word-spacing: 0px;
-webkit-text-stroke-width: 0px; text-decoration: none;
font-family: Calibri, Arial, Helvetica, sans-serif;
font-size: 12pt;" class=""><br class="">
</div>
<div style="font-style: normal; font-variant-caps: normal;
font-weight: normal; letter-spacing: normal; text-align:
start; text-indent: 0px; text-transform: none;
white-space: normal; word-spacing: 0px;
-webkit-text-stroke-width: 0px; text-decoration: none;
font-family: Calibri, Arial, Helvetica, sans-serif;
font-size: 12pt;" class=""><span style="font-family:
Arial, Helvetica, sans-serif;" class="">Tony</span><br class="">
</div>
<span style="caret-color: rgb(0, 0, 0); font-family:
Helvetica; font-size: 12px; font-style: normal;
font-variant-caps: normal; font-weight: normal;
letter-spacing: normal; text-align: start; text-indent:
0px; text-transform: none; white-space: normal;
word-spacing: 0px; -webkit-text-stroke-width: 0px;
text-decoration: none; float: none; display: inline
!important;" class="">_______________________________________________</span><br style="caret-color: rgb(0, 0, 0); font-family:
Helvetica; font-size: 12px; font-style: normal;
font-variant-caps: normal; font-weight: normal;
letter-spacing: normal; text-align: start; text-indent:
0px; text-transform: none; white-space: normal;
word-spacing: 0px; -webkit-text-stroke-width: 0px;
text-decoration: none;" class="">
<span style="caret-color: rgb(0, 0, 0); font-family:
Helvetica; font-size: 12px; font-style: normal;
font-variant-caps: normal; font-weight: normal;
letter-spacing: normal; text-align: start; text-indent:
0px; text-transform: none; white-space: normal;
word-spacing: 0px; -webkit-text-stroke-width: 0px;
text-decoration: none; float: none; display: inline
!important;" class="">ChimeraX-users mailing list</span><br style="caret-color: rgb(0, 0, 0); font-family:
Helvetica; font-size: 12px; font-style: normal;
font-variant-caps: normal; font-weight: normal;
letter-spacing: normal; text-align: start; text-indent:
0px; text-transform: none; white-space: normal;
word-spacing: 0px; -webkit-text-stroke-width: 0px;
text-decoration: none;" class="">
<a href="mailto:ChimeraX-users@cgl.ucsf.edu" style="font-family: Helvetica; font-size: 12px;
font-style: normal; font-variant-caps: normal;
font-weight: normal; letter-spacing: normal; orphans:
auto; text-align: start; text-indent: 0px;
text-transform: none; white-space: normal; widows: auto;
word-spacing: 0px; -webkit-text-size-adjust: auto;
-webkit-text-stroke-width: 0px;" class="" moz-do-not-send="true">ChimeraX-users@cgl.ucsf.edu</a><br style="caret-color: rgb(0, 0, 0); font-family:
Helvetica; font-size: 12px; font-style: normal;
font-variant-caps: normal; font-weight: normal;
letter-spacing: normal; text-align: start; text-indent:
0px; text-transform: none; white-space: normal;
word-spacing: 0px; -webkit-text-stroke-width: 0px;
text-decoration: none;" class="">
<span style="caret-color: rgb(0, 0, 0); font-family:
Helvetica; font-size: 12px; font-style: normal;
font-variant-caps: normal; font-weight: normal;
letter-spacing: normal; text-align: start; text-indent:
0px; text-transform: none; white-space: normal;
word-spacing: 0px; -webkit-text-stroke-width: 0px;
text-decoration: none; float: none; display: inline
!important;" class="">Manage subscription:</span><br style="caret-color: rgb(0, 0, 0); font-family:
Helvetica; font-size: 12px; font-style: normal;
font-variant-caps: normal; font-weight: normal;
letter-spacing: normal; text-align: start; text-indent:
0px; text-transform: none; white-space: normal;
word-spacing: 0px; -webkit-text-stroke-width: 0px;
text-decoration: none;" class="">
<a href="http://www.rbvi.ucsf.edu/mailman/listinfo/chimerax-users" style="font-family: Helvetica; font-size: 12px;
font-style: normal; font-variant-caps: normal;
font-weight: normal; letter-spacing: normal; orphans:
auto; text-align: start; text-indent: 0px;
text-transform: none; white-space: normal; widows: auto;
word-spacing: 0px; -webkit-text-size-adjust: auto;
-webkit-text-stroke-width: 0px;" class="" moz-do-not-send="true">http://www.rbvi.ucsf.edu/mailman/listinfo/chimerax-users</a></div>
</blockquote>
</div>
<br class="">
</div>
<br class="">
<fieldset class="mimeAttachmentHeader"></fieldset>
<pre class="moz-quote-pre" wrap="">_______________________________________________
ChimeraX-users mailing list
<a class="moz-txt-link-abbreviated" href="mailto:ChimeraX-users@cgl.ucsf.edu">ChimeraX-users@cgl.ucsf.edu</a>
Manage subscription:
<a class="moz-txt-link-freetext" href="http://www.rbvi.ucsf.edu/mailman/listinfo/chimerax-users">http://www.rbvi.ucsf.edu/mailman/listinfo/chimerax-users</a>
</pre>
</blockquote>
</div>
_______________________________________________<br class="">ChimeraX-users mailing list<br class=""><a href="mailto:ChimeraX-users@cgl.ucsf.edu" class="">ChimeraX-users@cgl.ucsf.edu</a><br class="">Manage subscription:<br class="">http://www.rbvi.ucsf.edu/mailman/listinfo/chimerax-users<br class=""></div></blockquote></div><br class=""></div></body></html>