Mercurial > projects > dang

annotate docs/candydoc/CANDYDOC.txt @ 206:d3c148ca429b

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Major moving of files. all src now goes into src, all docs in docs.
author Anders Johnsen <skabet@gmail.com>
date Tue, 12 Aug 2008 18:14:56 +0200
parents doc/candydoc/CANDYDOC.txt@4c121c2aa844
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
200
4c121c2aa844 Added candydoc files for docs.
Anders Johnsen <skabet@gmail.com>
parents:
diff changeset
1
4c121c2aa844 Added candydoc files for docs.
Anders Johnsen <skabet@gmail.com>
parents:
diff changeset
2 CanDyDOC is fileset for creating advanced documentation of programs written
4c121c2aa844 Added candydoc files for docs.
Anders Johnsen <skabet@gmail.com>
parents:
diff changeset
3 in D programming language. CanDyDOC adds some eye-candy and advanced navigation
4c121c2aa844 Added candydoc files for docs.
Anders Johnsen <skabet@gmail.com>
parents:
diff changeset
4 features to .html documents that are generated by D compiler and known as DDOC.
4c121c2aa844 Added candydoc files for docs.
Anders Johnsen <skabet@gmail.com>
parents:
diff changeset
5 Produced result is AJAX web-application that is compatible with all mainstream
4c121c2aa844 Added candydoc files for docs.
Anders Johnsen <skabet@gmail.com>
parents:
diff changeset
6 web browsers.
4c121c2aa844 Added candydoc files for docs.
Anders Johnsen <skabet@gmail.com>
parents:
diff changeset
7
4c121c2aa844 Added candydoc files for docs.
Anders Johnsen <skabet@gmail.com>
parents:
diff changeset
8 This is a fork of the original candydoc, distributed with DSSS. For more
4c121c2aa844 Added candydoc files for docs.
Anders Johnsen <skabet@gmail.com>
parents:
diff changeset
9 information on DSSS and DSSS' fork of candydoc, see
4c121c2aa844 Added candydoc files for docs.
Anders Johnsen <skabet@gmail.com>
parents:
diff changeset
10 http://www.dsource.org/projects/dsss/
4c121c2aa844 Added candydoc files for docs.
Anders Johnsen <skabet@gmail.com>
parents:
diff changeset
11
4c121c2aa844 Added candydoc files for docs.
Anders Johnsen <skabet@gmail.com>
parents:
diff changeset
12 CanDyDOC includes following files:
4c121c2aa844 Added candydoc files for docs.
Anders Johnsen <skabet@gmail.com>
parents:
diff changeset
13 - candy.ddoc
4c121c2aa844 Added candydoc files for docs.
Anders Johnsen <skabet@gmail.com>
parents:
diff changeset
14 File with DDOC macro definitions. You haven't to touch it.
4c121c2aa844 Added candydoc files for docs.
Anders Johnsen <skabet@gmail.com>
parents:
diff changeset
15
4c121c2aa844 Added candydoc files for docs.
Anders Johnsen <skabet@gmail.com>
parents:
diff changeset
16 - modules.ddoc
4c121c2aa844 Added candydoc files for docs.
Anders Johnsen <skabet@gmail.com>
parents:
diff changeset
17 You should enumerate all modules that would be avaible for navigation
4c121c2aa844 Added candydoc files for docs.
Anders Johnsen <skabet@gmail.com>
parents:
diff changeset
18 here.
4c121c2aa844 Added candydoc files for docs.
Anders Johnsen <skabet@gmail.com>
parents:
diff changeset
19
4c121c2aa844 Added candydoc files for docs.
Anders Johnsen <skabet@gmail.com>
parents:
diff changeset
20 - style.css
4c121c2aa844 Added candydoc files for docs.
Anders Johnsen <skabet@gmail.com>
parents:
diff changeset
21 Cascading style sheet file that defines look of produced documentation.
4c121c2aa844 Added candydoc files for docs.
Anders Johnsen <skabet@gmail.com>
parents:
diff changeset
22 You can leave this file without changes or adjust fonts, colors, etc
4c121c2aa844 Added candydoc files for docs.
Anders Johnsen <skabet@gmail.com>
parents:
diff changeset
23 here. See it for documentation.
4c121c2aa844 Added candydoc files for docs.
Anders Johnsen <skabet@gmail.com>
parents:
diff changeset
24
4c121c2aa844 Added candydoc files for docs.
Anders Johnsen <skabet@gmail.com>
parents:
diff changeset
25 - ie56hack.css
4c121c2aa844 Added candydoc files for docs.
Anders Johnsen <skabet@gmail.com>
parents:
diff changeset
26 CSS file to force Internet Explorer 5/6 browser show documentation
4c121c2aa844 Added candydoc files for docs.
Anders Johnsen <skabet@gmail.com>
parents:
diff changeset
27 as it looks like in standard-compliant browsers.
4c121c2aa844 Added candydoc files for docs.
Anders Johnsen <skabet@gmail.com>
parents:
diff changeset
28
4c121c2aa844 Added candydoc files for docs.
Anders Johnsen <skabet@gmail.com>
parents:
diff changeset
29 - tree.js
4c121c2aa844 Added candydoc files for docs.
Anders Johnsen <skabet@gmail.com>
parents:
diff changeset
30 JavaScript implementing tree control that looks like native one.
4c121c2aa844 Added candydoc files for docs.
Anders Johnsen <skabet@gmail.com>
parents:
diff changeset
31
4c121c2aa844 Added candydoc files for docs.
Anders Johnsen <skabet@gmail.com>
parents:
diff changeset
32 - util.js
4c121c2aa844 Added candydoc files for docs.
Anders Johnsen <skabet@gmail.com>
parents:
diff changeset
33 Common cross-browser routines.
4c121c2aa844 Added candydoc files for docs.
Anders Johnsen <skabet@gmail.com>
parents:
diff changeset
34
4c121c2aa844 Added candydoc files for docs.
Anders Johnsen <skabet@gmail.com>
parents:
diff changeset
35 - explorer.js
4c121c2aa844 Added candydoc files for docs.
Anders Johnsen <skabet@gmail.com>
parents:
diff changeset
36 Heart of every documentation's page. Controls generation, behaviour and
4c121c2aa844 Added candydoc files for docs.
Anders Johnsen <skabet@gmail.com>
parents:
diff changeset
37 navigation of a page.
4c121c2aa844 Added candydoc files for docs.
Anders Johnsen <skabet@gmail.com>
parents:
diff changeset
38
4c121c2aa844 Added candydoc files for docs.
Anders Johnsen <skabet@gmail.com>
parents:
diff changeset
39 - numerous of image files in 'img' folder.
4c121c2aa844 Added candydoc files for docs.
Anders Johnsen <skabet@gmail.com>
parents:
diff changeset
40
4c121c2aa844 Added candydoc files for docs.
Anders Johnsen <skabet@gmail.com>
parents:
diff changeset
41 How to use:
4c121c2aa844 Added candydoc files for docs.
Anders Johnsen <skabet@gmail.com>
parents:
diff changeset
42 1) Put 'candydoc' directory in place where documentation will be.
4c121c2aa844 Added candydoc files for docs.
Anders Johnsen <skabet@gmail.com>
parents:
diff changeset
43 2) Modify modules.ddoc file: enumerate all modules that should be avaible
4c121c2aa844 Added candydoc files for docs.
Anders Johnsen <skabet@gmail.com>
parents:
diff changeset
44 for navigation.
4c121c2aa844 Added candydoc files for docs.
Anders Johnsen <skabet@gmail.com>
parents:
diff changeset
45 3) Modify style.css file if you want to change style of documentation. Or
4c121c2aa844 Added candydoc files for docs.
Anders Johnsen <skabet@gmail.com>
parents:
diff changeset
46 leave it unmodified to apply defaul theme.
4c121c2aa844 Added candydoc files for docs.
Anders Johnsen <skabet@gmail.com>
parents:
diff changeset
47 4) Run documentation compilation with candy.ddoc and modules.ddoc specified
4c121c2aa844 Added candydoc files for docs.
Anders Johnsen <skabet@gmail.com>
parents:
diff changeset
48 on command line.
4c121c2aa844 Added candydoc files for docs.
Anders Johnsen <skabet@gmail.com>
parents:
diff changeset
49 5) Enjoy a result :)
4c121c2aa844 Added candydoc files for docs.
Anders Johnsen <skabet@gmail.com>
parents:
diff changeset
50
4c121c2aa844 Added candydoc files for docs.
Anders Johnsen <skabet@gmail.com>
parents:
diff changeset
51 Known bugs:
4c121c2aa844 Added candydoc files for docs.
Anders Johnsen <skabet@gmail.com>
parents:
diff changeset
52 - Explorer window doesn't work on Safari browser.
4c121c2aa844 Added candydoc files for docs.
Anders Johnsen <skabet@gmail.com>
parents:
diff changeset
53 - Scroll bar positions are not adjusted after explorer's tab change in Opera
4c121c2aa844 Added candydoc files for docs.
Anders Johnsen <skabet@gmail.com>
parents:
diff changeset
54 browser. So it is posible to see nothing on some tab: solution is to
4c121c2aa844 Added candydoc files for docs.
Anders Johnsen <skabet@gmail.com>
parents:
diff changeset
55 return to a previous tab, scroll it to top and then return back.
4c121c2aa844 Added candydoc files for docs.
Anders Johnsen <skabet@gmail.com>
parents:
diff changeset
56 - Overlapping of some elements when too few horizontal place avaible.