annotate doc/README @ 0:6ee11bf9e3ea

Initial revision
author jcid
date Sun, 07 Oct 2007 00:36:34 +0200
parents
children 094b63be5d0f
rev   line source
0
6ee11bf9e3ea Initial revision
jcid
parents:
diff changeset
1 README: Last update Oct 2007 --jcid
6ee11bf9e3ea Initial revision
jcid
parents:
diff changeset
2
6ee11bf9e3ea Initial revision
jcid
parents:
diff changeset
3 This documents need a review. They were current with dillo1 and
6ee11bf9e3ea Initial revision
jcid
parents:
diff changeset
4 now, with dillo2, most of them are obsolete, specially Dw*txt, but
6ee11bf9e3ea Initial revision
jcid
parents:
diff changeset
5 Dw2 is fully documented in html using doxygen.
6ee11bf9e3ea Initial revision
jcid
parents:
diff changeset
6
6ee11bf9e3ea Initial revision
jcid
parents:
diff changeset
7 The other documents will be reviewed when I have some time. They
6ee11bf9e3ea Initial revision
jcid
parents:
diff changeset
8 will give you an overview of what's going on but take them with a
6ee11bf9e3ea Initial revision
jcid
parents:
diff changeset
9 pinch of salt.
6ee11bf9e3ea Initial revision
jcid
parents:
diff changeset
10
6ee11bf9e3ea Initial revision
jcid
parents:
diff changeset
11 Of course I'd like to have these as doxygen files too!
6ee11bf9e3ea Initial revision
jcid
parents:
diff changeset
12 If somebody wants to make this convertion, please let me know
6ee11bf9e3ea Initial revision
jcid
parents:
diff changeset
13 to assign higher priority to updating these docs.
6ee11bf9e3ea Initial revision
jcid
parents:
diff changeset
14
6ee11bf9e3ea Initial revision
jcid
parents:
diff changeset
15 --
6ee11bf9e3ea Initial revision
jcid
parents:
diff changeset
16 Jorge.-
6ee11bf9e3ea Initial revision
jcid
parents:
diff changeset
17
6ee11bf9e3ea Initial revision
jcid
parents:
diff changeset
18 --------------------------------------------------------------------------
6ee11bf9e3ea Initial revision
jcid
parents:
diff changeset
19 FILE DESCRIPTION STATE
6ee11bf9e3ea Initial revision
jcid
parents:
diff changeset
20 --------------------------------------------------------------------------
6ee11bf9e3ea Initial revision
jcid
parents:
diff changeset
21 NC_design.txt Naming&Coding design (Be sure to Current
6ee11bf9e3ea Initial revision
jcid
parents:
diff changeset
22 read it before any other doc)
6ee11bf9e3ea Initial revision
jcid
parents:
diff changeset
23 Dillo.txt General overview of the program Current
6ee11bf9e3ea Initial revision
jcid
parents:
diff changeset
24 IO.txt Extensive introduction Current
6ee11bf9e3ea Initial revision
jcid
parents:
diff changeset
25 Cache.txt Informative description Current
6ee11bf9e3ea Initial revision
jcid
parents:
diff changeset
26 Images.txt Image handling and processing Current
6ee11bf9e3ea Initial revision
jcid
parents:
diff changeset
27 HtmlParser.txt A versatile parser Current
6ee11bf9e3ea Initial revision
jcid
parents:
diff changeset
28 Dw.txt The New Dillo Widget (Overview) Current
6ee11bf9e3ea Initial revision
jcid
parents:
diff changeset
29 DwRendering.txt Dw Rendering Abstraction Current
6ee11bf9e3ea Initial revision
jcid
parents:
diff changeset
30 DwWidget.txt The base object of Dw Current
6ee11bf9e3ea Initial revision
jcid
parents:
diff changeset
31 DwImage.txt Dillo Widget image handling Incomplete
6ee11bf9e3ea Initial revision
jcid
parents:
diff changeset
32 DwPage.txt Dillo Widget page (shortly) Incomplete
6ee11bf9e3ea Initial revision
jcid
parents:
diff changeset
33 DwStyle.txt Styles of Dillo Widgets Pending
6ee11bf9e3ea Initial revision
jcid
parents:
diff changeset
34 DwTable.txt Tables in dillo Current
6ee11bf9e3ea Initial revision
jcid
parents:
diff changeset
35 Imgbuf.txt Image buffers Pending
6ee11bf9e3ea Initial revision
jcid
parents:
diff changeset
36 Selection.txt Selections, and link activation Current (?)
6ee11bf9e3ea Initial revision
jcid
parents:
diff changeset
37 Cookies.txt Explains how to enable cookies Current
6ee11bf9e3ea Initial revision
jcid
parents:
diff changeset
38 Dpid.txt Dillo plugin daemon Current
6ee11bf9e3ea Initial revision
jcid
parents:
diff changeset
39 --------------------------------------------------------------------------
6ee11bf9e3ea Initial revision
jcid
parents:
diff changeset
40 [This documents cover dillo's internal working. They're NOT a user manual]
6ee11bf9e3ea Initial revision
jcid
parents:
diff changeset
41 --------------------------------------------------------------------------
6ee11bf9e3ea Initial revision
jcid
parents:
diff changeset
42
6ee11bf9e3ea Initial revision
jcid
parents:
diff changeset
43
6ee11bf9e3ea Initial revision
jcid
parents:
diff changeset
44 * Ah!, there's a small program (srch) within the src/ dir. It searches
6ee11bf9e3ea Initial revision
jcid
parents:
diff changeset
45 tokens within the whole code (*.[ch]). It has proven very useful.
6ee11bf9e3ea Initial revision
jcid
parents:
diff changeset
46 Ex: ./srch a_Image_write
6ee11bf9e3ea Initial revision
jcid
parents:
diff changeset
47 ./srch todo:
6ee11bf9e3ea Initial revision
jcid
parents:
diff changeset
48
6ee11bf9e3ea Initial revision
jcid
parents:
diff changeset
49 * Please submit your patches with 'diff -pru'.
6ee11bf9e3ea Initial revision
jcid
parents:
diff changeset
50
6ee11bf9e3ea Initial revision
jcid
parents:
diff changeset
51
6ee11bf9e3ea Initial revision
jcid
parents:
diff changeset
52 Happy coding!
6ee11bf9e3ea Initial revision
jcid
parents:
diff changeset
53 --Jcid