Combine HTML Systems (including TOC and search indices)

Summary

Users want to integrate documentation extracted (as HTML output) from code with WebWorks.

Detailed Description

User uses Doxygen and JavaDoc to document their code (I will call this a 'doxygen' system). They currently use these tools to extract their comments into a self-contained HTML system with a built in search. Currently, the 'doxygen' system can only be included in the general file distribution. Relative links are then included on a page within the WebWorks system which launch the 'doxygen' system in a new browser window. However the system's TOC and Search indices cannot be added to the main WebWorks output.

This enhancement is to add a feature whereby users can combine a pre-existing HTML system (in this case, the 'doxygen' system) with the WebWorks 5 HTML system. Such combination would ensure that the new system's TOC showed up beneath a Heading 1 book in the TOC and its search was integrated into the WebWorks search index.

Use Cases

User creates a Project in Webworks with source Word files. User takes HTML output from Doxygen, and adds it to the WebWorks project file so that it's TOC will be reflected in the final output. User generates the WebWorks 5.0 HTML system, and WebWorks combines the 'doxygen' search index with its own search index.

Final product includes the 'doxygen' toc within a book in the TOC for the WebWorks 5.0 output. Final product will have one search index, made from the WebWorks Source Word files, and the 'doxygen' system's index.

Enhancements/Combine WebWorks 5.0 HTML output with external HTML system and combine search indices (last edited 2013-04-23 17:05:09 by AlexTemple)