38fcc662be 2010-11-10 kinaba: 38fcc662be 2010-11-10 kinaba: CanDyDOC is fileset for creating advanced documentation of programs written 38fcc662be 2010-11-10 kinaba: in D programming language. CanDyDOC adds some eye-candy and advanced navigation 38fcc662be 2010-11-10 kinaba: features to .html documents that are generated by D compiler and known as DDOC. 38fcc662be 2010-11-10 kinaba: Produced result is AJAX web-application that is compatible with all mainstream 38fcc662be 2010-11-10 kinaba: web browsers. 38fcc662be 2010-11-10 kinaba: 38fcc662be 2010-11-10 kinaba: This is a version 0.80. For latest release see 38fcc662be 2010-11-10 kinaba: http://trac.dsource.org/projects/helix/ 38fcc662be 2010-11-10 kinaba: 38fcc662be 2010-11-10 kinaba: CanDyDOC includes following files: 38fcc662be 2010-11-10 kinaba: - candy.ddoc 38fcc662be 2010-11-10 kinaba: File with DDOC macro definitions. You haven't to touch it. 38fcc662be 2010-11-10 kinaba: 38fcc662be 2010-11-10 kinaba: - modules.ddoc 38fcc662be 2010-11-10 kinaba: You should enumerate all modules that would be avaible for navigation 38fcc662be 2010-11-10 kinaba: here. 38fcc662be 2010-11-10 kinaba: 38fcc662be 2010-11-10 kinaba: - style.css 38fcc662be 2010-11-10 kinaba: Cascading style sheet file that defines look of produced documentation. 38fcc662be 2010-11-10 kinaba: You can leave this file without changes or adjust fonts, colors, etc 38fcc662be 2010-11-10 kinaba: here. See it for documentation. 38fcc662be 2010-11-10 kinaba: 38fcc662be 2010-11-10 kinaba: - ie56hack.css 38fcc662be 2010-11-10 kinaba: CSS file to force Internet Explorer 5/6 browser show documentation 38fcc662be 2010-11-10 kinaba: as it looks like in standard-compliant browsers. 38fcc662be 2010-11-10 kinaba: 38fcc662be 2010-11-10 kinaba: - tree.js 38fcc662be 2010-11-10 kinaba: JavaScript implementing tree control that looks like native one. 38fcc662be 2010-11-10 kinaba: 38fcc662be 2010-11-10 kinaba: - util.js 38fcc662be 2010-11-10 kinaba: Common cross-browser routines. 38fcc662be 2010-11-10 kinaba: 38fcc662be 2010-11-10 kinaba: - explorer.js 38fcc662be 2010-11-10 kinaba: Heart of every documentation's page. Controls generation, behaviour and 38fcc662be 2010-11-10 kinaba: navigation of a page. 38fcc662be 2010-11-10 kinaba: 38fcc662be 2010-11-10 kinaba: - numerous of image files in 'img' folder. 38fcc662be 2010-11-10 kinaba: 38fcc662be 2010-11-10 kinaba: How to use: 38fcc662be 2010-11-10 kinaba: 1) Put 'candydoc' directory in place where documentation will be. 38fcc662be 2010-11-10 kinaba: 2) Modify modules.ddoc file: enumerate all modules that should be avaible 38fcc662be 2010-11-10 kinaba: for navigation. 38fcc662be 2010-11-10 kinaba: 3) Modify style.css file if you want to change style of documentation. Or 38fcc662be 2010-11-10 kinaba: leave it unmodified to apply defaul theme. 38fcc662be 2010-11-10 kinaba: 4) Run documentation compilation with candy.ddoc and modules.ddoc specified 38fcc662be 2010-11-10 kinaba: on command line. 38fcc662be 2010-11-10 kinaba: 5) Enjoy a result :) 38fcc662be 2010-11-10 kinaba: 38fcc662be 2010-11-10 kinaba: Known bugs: 38fcc662be 2010-11-10 kinaba: - Explorer window doesn't work on Safari browser. 38fcc662be 2010-11-10 kinaba: - Scroll bar positions are not adjusted after explorer's tab change in Opera 38fcc662be 2010-11-10 kinaba: browser. So it is posible to see nothing on some tab: solution is to 38fcc662be 2010-11-10 kinaba: return to a previous tab, scroll it to top and then return back. 38fcc662be 2010-11-10 kinaba: - Overlapping of some elements when too few horizontal place avaible.