Mercurial > projects > dang
comparison doc/candydoc/CANDYDOC.txt @ 200:4c121c2aa844
Added candydoc files for docs.
author | Anders Johnsen <skabet@gmail.com> |
---|---|
date | Sun, 10 Aug 2008 17:09:41 +0200 |
parents | |
children |
comparison
equal
deleted
inserted
replaced
199:5e05c03d1558 | 200:4c121c2aa844 |
---|---|
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 fork of the original candydoc, distributed with DSSS. For more | |
9 information on DSSS and DSSS' fork of candydoc, see | |
10 http://www.dsource.org/projects/dsss/ | |
11 | |
12 CanDyDOC includes following files: | |
13 - candy.ddoc | |
14 File with DDOC macro definitions. You haven't to touch it. | |
15 | |
16 - modules.ddoc | |
17 You should enumerate all modules that would be avaible for navigation | |
18 here. | |
19 | |
20 - style.css | |
21 Cascading style sheet file that defines look of produced documentation. | |
22 You can leave this file without changes or adjust fonts, colors, etc | |
23 here. See it for documentation. | |
24 | |
25 - ie56hack.css | |
26 CSS file to force Internet Explorer 5/6 browser show documentation | |
27 as it looks like in standard-compliant browsers. | |
28 | |
29 - tree.js | |
30 JavaScript implementing tree control that looks like native one. | |
31 | |
32 - util.js | |
33 Common cross-browser routines. | |
34 | |
35 - explorer.js | |
36 Heart of every documentation's page. Controls generation, behaviour and | |
37 navigation of a page. | |
38 | |
39 - numerous of image files in 'img' folder. | |
40 | |
41 How to use: | |
42 1) Put 'candydoc' directory in place where documentation will be. | |
43 2) Modify modules.ddoc file: enumerate all modules that should be avaible | |
44 for navigation. | |
45 3) Modify style.css file if you want to change style of documentation. Or | |
46 leave it unmodified to apply defaul theme. | |
47 4) Run documentation compilation with candy.ddoc and modules.ddoc specified | |
48 on command line. | |
49 5) Enjoy a result :) | |
50 | |
51 Known bugs: | |
52 - Explorer window doesn't work on Safari browser. | |
53 - Scroll bar positions are not adjusted after explorer's tab change in Opera | |
54 browser. So it is posible to see nothing on some tab: solution is to | |
55 return to a previous tab, scroll it to top and then return back. | |
56 - Overlapping of some elements when too few horizontal place avaible. |