ulf.schroeter Posted April 14, 2011 Share Posted April 14, 2011 Proposal Inclusion of UNIGINE documentation HTML source data into UNIGINE source SDK. Use Case It would be very useful for source SDK customers to be able to merge own documentation for customer-specific extensions (e.g. new object types, script libraries, etc) into UNIGINE documentation .chm file as a single documentation source. This could be done easily if UNIGINE documentation HTML source/project files would be available. Customer-specific modifications/extensions could be merged into UNIGINE HTML file/directory structure with version control system support and re-compiled into .chm BTW which HTML help editor tool is used by UNIGINE itself ? Link to comment
ulf.schroeter Posted April 14, 2011 Author Share Posted April 14, 2011 Having a look into Microsoft HTML Help tool its possible to decompile UNIGINE .chm file to HTML source data. Therefore it wouldn't be necessary to provide redundant source data, but it seems that at least a HTML help project .hhp file is required for re-compiling. This file is not available when decompiling .chm file. Link to comment
steve3d Posted April 14, 2011 Share Posted April 14, 2011 You don't need help tool to de-compile just use hh.exe to decompile, hh.exe should be available on every windows version Link to comment
binstream Posted April 15, 2011 Share Posted April 15, 2011 We have our documentation in XML files and have a number of XSLT filters to convert it into different formats: online XHTML version, local CHM... Right now we are working on integration of online version with this portal, if things will go well you'll get it working next week. We'll consider your request during the upcoming re-design of the documentation system. Link to comment
ulf.schroeter Posted April 15, 2011 Author Share Posted April 15, 2011 We'll consider your request during the upcoming re-design of the documentation system. thanks, Denis Link to comment
binstream Posted April 18, 2011 Share Posted April 18, 2011 By the way, here is the online version of Unigine reference manual: https://developer.unigine.com/forum/topic/478-online-documentation/ Link to comment
ulf.schroeter Posted April 19, 2011 Author Share Posted April 19, 2011 By the way, here is the online version of Unigine reference manual: https://developer.unigine.com/forum/topic/478-online-documentation/ yes, nice improvement. Link to comment
Recommended Posts