Artifact 1ca7967fbd360bdd85ab60da8c3139fa27f4b894:
0000: 0d 0a 43 61 6e 44 79 44 4f 43 20 69 73 20 66 69 ..CanDyDOC is fi
0010: 6c 65 73 65 74 20 66 6f 72 20 63 72 65 61 74 69 leset for creati
0020: 6e 67 20 61 64 76 61 6e 63 65 64 20 64 6f 63 75 ng advanced docu
0030: 6d 65 6e 74 61 74 69 6f 6e 20 6f 66 20 70 72 6f mentation of pro
0040: 67 72 61 6d 73 20 77 72 69 74 74 65 6e 0d 0a 69 grams written..i
0050: 6e 20 44 20 70 72 6f 67 72 61 6d 6d 69 6e 67 20 n D programming
0060: 6c 61 6e 67 75 61 67 65 2e 20 43 61 6e 44 79 44 language. CanDyD
0070: 4f 43 20 61 64 64 73 20 73 6f 6d 65 20 65 79 65 OC adds some eye
0080: 2d 63 61 6e 64 79 20 61 6e 64 20 61 64 76 61 6e -candy and advan
0090: 63 65 64 20 6e 61 76 69 67 61 74 69 6f 6e 0d 0a ced navigation..
00a0: 66 65 61 74 75 72 65 73 20 74 6f 20 2e 68 74 6d features to .htm
00b0: 6c 20 64 6f 63 75 6d 65 6e 74 73 20 74 68 61 74 l documents that
00c0: 20 61 72 65 20 67 65 6e 65 72 61 74 65 64 20 62 are generated b
00d0: 79 20 44 20 63 6f 6d 70 69 6c 65 72 20 61 6e 64 y D compiler and
00e0: 20 6b 6e 6f 77 6e 20 61 73 20 44 44 4f 43 2e 0d known as DDOC..
00f0: 0a 50 72 6f 64 75 63 65 64 20 72 65 73 75 6c 74 .Produced result
0100: 20 69 73 20 41 4a 41 58 20 77 65 62 2d 61 70 70 is AJAX web-app
0110: 6c 69 63 61 74 69 6f 6e 20 74 68 61 74 20 69 73 lication that is
0120: 20 63 6f 6d 70 61 74 69 62 6c 65 20 77 69 74 68 compatible with
0130: 20 61 6c 6c 20 6d 61 69 6e 73 74 72 65 61 6d 0d all mainstream.
0140: 0a 77 65 62 20 62 72 6f 77 73 65 72 73 2e 0d 0a .web browsers...
0150: 0d 0a 54 68 69 73 20 69 73 20 61 20 76 65 72 73 ..This is a vers
0160: 69 6f 6e 20 30 2e 38 30 2e 20 46 6f 72 20 6c 61 ion 0.80. For la
0170: 74 65 73 74 20 72 65 6c 65 61 73 65 20 73 65 65 test release see
0180: 0d 0a 68 74 74 70 3a 2f 2f 74 72 61 63 2e 64 73 ..http://trac.ds
0190: 6f 75 72 63 65 2e 6f 72 67 2f 70 72 6f 6a 65 63 ource.org/projec
01a0: 74 73 2f 68 65 6c 69 78 2f 0d 0a 0d 0a 43 61 6e ts/helix/....Can
01b0: 44 79 44 4f 43 20 69 6e 63 6c 75 64 65 73 20 66 DyDOC includes f
01c0: 6f 6c 6c 6f 77 69 6e 67 20 66 69 6c 65 73 3a 0d ollowing files:.
01d0: 0a 20 20 20 20 2d 20 63 61 6e 64 79 2e 64 64 6f . - candy.ddo
01e0: 63 0d 0a 20 20 20 20 20 20 20 20 46 69 6c 65 20 c.. File
01f0: 77 69 74 68 20 44 44 4f 43 20 6d 61 63 72 6f 20 with DDOC macro
0200: 64 65 66 69 6e 69 74 69 6f 6e 73 2e 20 59 6f 75 definitions. You
0210: 20 68 61 76 65 6e 27 74 20 74 6f 20 74 6f 75 63 haven't to touc
0220: 68 20 69 74 2e 0d 0a 0d 0a 20 20 20 20 2d 20 6d h it..... - m
0230: 6f 64 75 6c 65 73 2e 64 64 6f 63 0d 0a 20 20 20 odules.ddoc..
0240: 20 20 20 20 20 59 6f 75 20 73 68 6f 75 6c 64 20 You should
0250: 65 6e 75 6d 65 72 61 74 65 20 61 6c 6c 20 6d 6f enumerate all mo
0260: 64 75 6c 65 73 20 74 68 61 74 20 77 6f 75 6c 64 dules that would
0270: 20 62 65 20 61 76 61 69 62 6c 65 20 66 6f 72 20 be avaible for
0280: 6e 61 76 69 67 61 74 69 6f 6e 0d 0a 20 20 20 20 navigation..
0290: 20 20 20 20 68 65 72 65 2e 0d 0a 0d 0a 20 20 20 here.....
02a0: 20 2d 20 73 74 79 6c 65 2e 63 73 73 0d 0a 20 20 - style.css..
02b0: 20 20 20 20 20 20 43 61 73 63 61 64 69 6e 67 20 Cascading
02c0: 73 74 79 6c 65 20 73 68 65 65 74 20 66 69 6c 65 style sheet file
02d0: 20 74 68 61 74 20 64 65 66 69 6e 65 73 20 6c 6f that defines lo
02e0: 6f 6b 20 6f 66 20 70 72 6f 64 75 63 65 64 20 64 ok of produced d
02f0: 6f 63 75 6d 65 6e 74 61 74 69 6f 6e 2e 0d 0a 20 ocumentation...
0300: 20 20 20 20 20 20 20 59 6f 75 20 63 61 6e 20 6c You can l
0310: 65 61 76 65 20 74 68 69 73 20 66 69 6c 65 20 77 eave this file w
0320: 69 74 68 6f 75 74 20 63 68 61 6e 67 65 73 20 6f ithout changes o
0330: 72 20 61 64 6a 75 73 74 20 66 6f 6e 74 73 2c 20 r adjust fonts,
0340: 63 6f 6c 6f 72 73 2c 20 65 74 63 0d 0a 20 20 20 colors, etc..
0350: 20 20 20 20 20 68 65 72 65 2e 20 53 65 65 20 69 here. See i
0360: 74 20 66 6f 72 20 64 6f 63 75 6d 65 6e 74 61 74 t for documentat
0370: 69 6f 6e 2e 0d 0a 0d 0a 20 20 20 20 2d 20 69 65 ion..... - ie
0380: 35 36 68 61 63 6b 2e 63 73 73 0d 0a 20 20 20 20 56hack.css..
0390: 20 20 20 20 43 53 53 20 66 69 6c 65 20 74 6f 20 CSS file to
03a0: 66 6f 72 63 65 20 49 6e 74 65 72 6e 65 74 20 45 force Internet E
03b0: 78 70 6c 6f 72 65 72 20 35 2f 36 20 62 72 6f 77 xplorer 5/6 brow
03c0: 73 65 72 20 73 68 6f 77 20 64 6f 63 75 6d 65 6e ser show documen
03d0: 74 61 74 69 6f 6e 0d 0a 20 20 20 20 20 20 20 20 tation..
03e0: 61 73 20 69 74 20 6c 6f 6f 6b 73 20 6c 69 6b 65 as it looks like
03f0: 20 69 6e 20 73 74 61 6e 64 61 72 64 2d 63 6f 6d in standard-com
0400: 70 6c 69 61 6e 74 20 62 72 6f 77 73 65 72 73 2e pliant browsers.
0410: 0d 0a 0d 0a 20 20 20 20 2d 20 74 72 65 65 2e 6a .... - tree.j
0420: 73 0d 0a 20 20 20 20 20 20 20 20 4a 61 76 61 53 s.. JavaS
0430: 63 72 69 70 74 20 69 6d 70 6c 65 6d 65 6e 74 69 cript implementi
0440: 6e 67 20 74 72 65 65 20 63 6f 6e 74 72 6f 6c 20 ng tree control
0450: 74 68 61 74 20 6c 6f 6f 6b 73 20 6c 69 6b 65 20 that looks like
0460: 6e 61 74 69 76 65 20 6f 6e 65 2e 0d 0a 0d 0a 20 native one.....
0470: 20 20 20 2d 20 75 74 69 6c 2e 6a 73 0d 0a 20 20 - util.js..
0480: 20 20 20 20 20 20 43 6f 6d 6d 6f 6e 20 63 72 6f Common cro
0490: 73 73 2d 62 72 6f 77 73 65 72 20 72 6f 75 74 69 ss-browser routi
04a0: 6e 65 73 2e 0d 0a 0d 0a 20 20 20 20 2d 20 65 78 nes..... - ex
04b0: 70 6c 6f 72 65 72 2e 6a 73 0d 0a 20 20 20 20 20 plorer.js..
04c0: 20 20 20 48 65 61 72 74 20 6f 66 20 65 76 65 72 Heart of ever
04d0: 79 20 64 6f 63 75 6d 65 6e 74 61 74 69 6f 6e 27 y documentation'
04e0: 73 20 70 61 67 65 2e 20 43 6f 6e 74 72 6f 6c 73 s page. Controls
04f0: 20 67 65 6e 65 72 61 74 69 6f 6e 2c 20 62 65 68 generation, beh
0500: 61 76 69 6f 75 72 20 61 6e 64 0d 0a 20 20 20 20 aviour and..
0510: 20 20 20 20 6e 61 76 69 67 61 74 69 6f 6e 20 6f navigation o
0520: 66 20 61 20 70 61 67 65 2e 0d 0a 0d 0a 20 20 20 f a page.....
0530: 20 2d 20 6e 75 6d 65 72 6f 75 73 20 6f 66 20 69 - numerous of i
0540: 6d 61 67 65 20 66 69 6c 65 73 20 69 6e 20 27 69 mage files in 'i
0550: 6d 67 27 20 66 6f 6c 64 65 72 2e 0d 0a 0d 0a 48 mg' folder.....H
0560: 6f 77 20 74 6f 20 75 73 65 3a 0d 0a 20 20 20 20 ow to use:..
0570: 31 29 20 50 75 74 20 27 63 61 6e 64 79 64 6f 63 1) Put 'candydoc
0580: 27 20 64 69 72 65 63 74 6f 72 79 20 69 6e 20 70 ' directory in p
0590: 6c 61 63 65 20 77 68 65 72 65 20 64 6f 63 75 6d lace where docum
05a0: 65 6e 74 61 74 69 6f 6e 20 77 69 6c 6c 20 62 65 entation will be
05b0: 2e 0d 0a 20 20 20 20 32 29 20 4d 6f 64 69 66 79 ... 2) Modify
05c0: 20 6d 6f 64 75 6c 65 73 2e 64 64 6f 63 20 66 69 modules.ddoc fi
05d0: 6c 65 3a 20 65 6e 75 6d 65 72 61 74 65 20 61 6c le: enumerate al
05e0: 6c 20 6d 6f 64 75 6c 65 73 20 74 68 61 74 20 73 l modules that s
05f0: 68 6f 75 6c 64 20 62 65 20 61 76 61 69 62 6c 65 hould be avaible
0600: 0d 0a 20 20 20 20 20 20 20 66 6f 72 20 6e 61 76 .. for nav
0610: 69 67 61 74 69 6f 6e 2e 0d 0a 20 20 20 20 33 29 igation... 3)
0620: 20 4d 6f 64 69 66 79 20 73 74 79 6c 65 2e 63 73 Modify style.cs
0630: 73 20 66 69 6c 65 20 69 66 20 79 6f 75 20 77 61 s file if you wa
0640: 6e 74 20 74 6f 20 63 68 61 6e 67 65 20 73 74 79 nt to change sty
0650: 6c 65 20 6f 66 20 64 6f 63 75 6d 65 6e 74 61 74 le of documentat
0660: 69 6f 6e 2e 20 4f 72 0d 0a 20 20 20 20 20 20 20 ion. Or..
0670: 6c 65 61 76 65 20 69 74 20 75 6e 6d 6f 64 69 66 leave it unmodif
0680: 69 65 64 20 74 6f 20 61 70 70 6c 79 20 64 65 66 ied to apply def
0690: 61 75 6c 20 74 68 65 6d 65 2e 0d 0a 20 20 20 20 aul theme...
06a0: 34 29 20 52 75 6e 20 64 6f 63 75 6d 65 6e 74 61 4) Run documenta
06b0: 74 69 6f 6e 20 63 6f 6d 70 69 6c 61 74 69 6f 6e tion compilation
06c0: 20 77 69 74 68 20 63 61 6e 64 79 2e 64 64 6f 63 with candy.ddoc
06d0: 20 61 6e 64 20 6d 6f 64 75 6c 65 73 2e 64 64 6f and modules.ddo
06e0: 63 20 73 70 65 63 69 66 69 65 64 0d 0a 20 20 20 c specified..
06f0: 20 20 20 20 6f 6e 20 63 6f 6d 6d 61 6e 64 20 6c on command l
0700: 69 6e 65 2e 0d 0a 20 20 20 20 35 29 20 45 6e 6a ine... 5) Enj
0710: 6f 79 20 61 20 72 65 73 75 6c 74 20 3a 29 0d 0a oy a result :)..
0720: 0d 0a 4b 6e 6f 77 6e 20 62 75 67 73 3a 0d 0a 20 ..Known bugs:..
0730: 20 20 20 2d 20 45 78 70 6c 6f 72 65 72 20 77 69 - Explorer wi
0740: 6e 64 6f 77 20 64 6f 65 73 6e 27 74 20 77 6f 72 ndow doesn't wor
0750: 6b 20 6f 6e 20 53 61 66 61 72 69 20 62 72 6f 77 k on Safari brow
0760: 73 65 72 2e 0d 0a 20 20 20 20 2d 20 53 63 72 6f ser... - Scro
0770: 6c 6c 20 62 61 72 20 70 6f 73 69 74 69 6f 6e 73 ll bar positions
0780: 20 61 72 65 20 6e 6f 74 20 61 64 6a 75 73 74 65 are not adjuste
0790: 64 20 61 66 74 65 72 20 65 78 70 6c 6f 72 65 72 d after explorer
07a0: 27 73 20 74 61 62 20 63 68 61 6e 67 65 20 69 6e 's tab change in
07b0: 20 4f 70 65 72 61 0d 0a 20 20 20 20 20 20 62 72 Opera.. br
07c0: 6f 77 73 65 72 2e 20 53 6f 20 69 74 20 69 73 20 owser. So it is
07d0: 70 6f 73 69 62 6c 65 20 74 6f 20 73 65 65 20 6e posible to see n
07e0: 6f 74 68 69 6e 67 20 6f 6e 20 73 6f 6d 65 20 74 othing on some t
07f0: 61 62 3a 20 73 6f 6c 75 74 69 6f 6e 20 69 73 20 ab: solution is
0800: 74 6f 0d 0a 20 20 20 20 20 20 72 65 74 75 72 6e to.. return
0810: 20 74 6f 20 61 20 70 72 65 76 69 6f 75 73 20 74 to a previous t
0820: 61 62 2c 20 73 63 72 6f 6c 6c 20 69 74 20 74 6f ab, scroll it to
0830: 20 74 6f 70 20 61 6e 64 20 74 68 65 6e 20 72 65 top and then re
0840: 74 75 72 6e 20 62 61 63 6b 2e 0d 0a 20 20 20 20 turn back...
0850: 2d 20 4f 76 65 72 6c 61 70 70 69 6e 67 20 6f 66 - Overlapping of
0860: 20 73 6f 6d 65 20 65 6c 65 6d 65 6e 74 73 20 77 some elements w
0870: 68 65 6e 20 74 6f 6f 20 66 65 77 20 68 6f 72 69 hen too few hori
0880: 7a 6f 6e 74 61 6c 20 70 6c 61 63 65 20 61 76 61 zontal place ava
0890: 69 62 6c 65 2e 0d 0a ible...