[chimerax-users] can now bundle user documentation with ChimeraX bundles

[Greg Couch]

Starting with the next daily build, it is possible to have documentation 
for the tools and commands in the bundle automatically integrated into 
the User's Manual index.  In the bundle_info.xml file, add the 
documentation to the DataFiles section, e.g.:

       <DataFiles>
    <DataFile>docs/user/commands/tutorial.html</DataFile>
    <DataFile>docs/user/tools/Tutorial_GUI.html</DataFile>
       </DataFiles>

As you can see above, the documentation is in a directory hierarchy that 
matches the hierarchy of the builtin documentation.  The file name for 
the tool should be the tool's name with underscore's replacing any 
spaces followed by .html. The file name for commands should be the the 
first word in the command name followed by .html.  If help is asked for 
a subcommand, then a named reference is made to the subcommand, i.e., 
/command/.html#/subcommand/.

     -- Greg

-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://plato.cgl.ucsf.edu/pipermail/chimerax-users/attachments/20180530/da262c9a/attachment.html>