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