Artifact 1ca7967fbd360bdd85ab60da8c3139fa27f4b894
1
2 CanDyDOC is fileset for creating advanced documentation of programs written
3 in D programming language. CanDyDOC adds some eye-candy and advanced navigation
4 features to .html documents that are generated by D compiler and known as DDOC.
5 Produced result is AJAX web-application that is compatible with all mainstream
6 web browsers.
7
8 This is a version 0.80. For latest release see
9 http://trac.dsource.org/projects/helix/
10
11 CanDyDOC includes following files:
12 - candy.ddoc
13 File with DDOC macro definitions. You haven't to touch it.
14
15 - modules.ddoc
16 You should enumerate all modules that would be avaible for navigation
17 here.
18
19 - style.css
20 Cascading style sheet file that defines look of produced documentation.
21 You can leave this file without changes or adjust fonts, colors, etc
22 here. See it for documentation.
23
24 - ie56hack.css
25 CSS file to force Internet Explorer 5/6 browser show documentation
26 as it looks like in standard-compliant browsers.
27
28 - tree.js
29 JavaScript implementing tree control that looks like native one.
30
31 - util.js
32 Common cross-browser routines.
33
34 - explorer.js
35 Heart of every documentation's page. Controls generation, behaviour and
36 navigation of a page.
37
38 - numerous of image files in 'img' folder.
39
40 How to use:
41 1) Put 'candydoc' directory in place where documentation will be.
42 2) Modify modules.ddoc file: enumerate all modules that should be avaible
43 for navigation.
44 3) Modify style.css file if you want to change style of documentation. Or
45 leave it unmodified to apply defaul theme.
46 4) Run documentation compilation with candy.ddoc and modules.ddoc specified
47 on command line.
48 5) Enjoy a result :)
49
50 Known bugs:
51 - Explorer window doesn't work on Safari browser.
52 - Scroll bar positions are not adjusted after explorer's tab change in Opera
53 browser. So it is posible to see nothing on some tab: solution is to
54 return to a previous tab, scroll it to top and then return back.
55 - Overlapping of some elements when too few horizontal place avaible.