diff options
| -rw-r--r-- | Doxyfile | 4 | ||||
| -rw-r--r-- | devdoc/CCCwork.txt (renamed from doc/CCCwork.txt) | 0 | ||||
| -rw-r--r-- | devdoc/Cache.txt (renamed from doc/Cache.txt) | 0 | ||||
| -rw-r--r-- | devdoc/Dillo.txt (renamed from doc/Dillo.txt) | 0 | ||||
| -rw-r--r-- | devdoc/Dpid.txt (renamed from doc/Dpid.txt) | 0 | ||||
| -rw-r--r-- | devdoc/HtmlParser.txt (renamed from doc/HtmlParser.txt) | 0 | ||||
| -rw-r--r-- | devdoc/IO.txt (renamed from doc/IO.txt) | 0 | ||||
| -rw-r--r-- | devdoc/Images.txt (renamed from doc/Images.txt) | 0 | ||||
| -rw-r--r-- | devdoc/NC_design.txt (renamed from doc/NC_design.txt) | 0 | ||||
| -rw-r--r-- | devdoc/README | 51 | ||||
| -rw-r--r-- | devdoc/dw-changes.doc (renamed from doc/dw-changes.doc) | 0 | ||||
| -rw-r--r-- | devdoc/dw-example-screenshot.png (renamed from doc/dw-example-screenshot.png) | bin | 2264 -> 2264 bytes | |||
| -rw-r--r-- | devdoc/dw-floats-01.png (renamed from doc/dw-floats-01.png) | bin | 3410 -> 3410 bytes | |||
| -rw-r--r-- | devdoc/dw-grows.doc (renamed from doc/dw-grows.doc) | 0 | ||||
| -rw-r--r-- | devdoc/dw-images-and-backgrounds.doc (renamed from doc/dw-images-and-backgrounds.doc) | 0 | ||||
| -rw-r--r-- | devdoc/dw-layout-views.doc (renamed from doc/dw-layout-views.doc) | 0 | ||||
| -rw-r--r-- | devdoc/dw-layout-widgets.doc (renamed from doc/dw-layout-widgets.doc) | 0 | ||||
| -rw-r--r-- | devdoc/dw-line-breaking.doc (renamed from doc/dw-line-breaking.doc) | 0 | ||||
| -rw-r--r-- | devdoc/dw-map.doc (renamed from doc/dw-map.doc) | 0 | ||||
| -rw-r--r-- | devdoc/dw-out-of-flow-2.doc (renamed from doc/dw-out-of-flow-2.doc) | 0 | ||||
| -rw-r--r-- | devdoc/dw-out-of-flow-floats.doc (renamed from doc/dw-out-of-flow-floats.doc) | 0 | ||||
| -rw-r--r-- | devdoc/dw-out-of-flow.doc (renamed from doc/dw-out-of-flow.doc) | 0 | ||||
| -rw-r--r-- | devdoc/dw-overview.doc (renamed from doc/dw-overview.doc) | 0 | ||||
| -rw-r--r-- | devdoc/dw-size-of-widget.png (renamed from doc/dw-size-of-widget.png) | bin | 1749 -> 1749 bytes | |||
| -rw-r--r-- | devdoc/dw-style-box-model.png (renamed from doc/dw-style-box-model.png) | bin | 3889 -> 3889 bytes | |||
| -rw-r--r-- | devdoc/dw-style-length-absolute.png (renamed from doc/dw-style-length-absolute.png) | bin | 575 -> 575 bytes | |||
| -rw-r--r-- | devdoc/dw-style-length-percentage.png (renamed from doc/dw-style-length-percentage.png) | bin | 890 -> 890 bytes | |||
| -rw-r--r-- | devdoc/dw-style-length-relative.png (renamed from doc/dw-style-length-relative.png) | bin | 868 -> 868 bytes | |||
| -rw-r--r-- | devdoc/dw-textblock-collapsing-spaces-1-1.png (renamed from doc/dw-textblock-collapsing-spaces-1-1.png) | bin | 641 -> 641 bytes | |||
| -rw-r--r-- | devdoc/dw-textblock-collapsing-spaces-1-2.png (renamed from doc/dw-textblock-collapsing-spaces-1-2.png) | bin | 521 -> 521 bytes | |||
| -rw-r--r-- | devdoc/dw-textblock-collapsing-spaces-2-1.png (renamed from doc/dw-textblock-collapsing-spaces-2-1.png) | bin | 802 -> 802 bytes | |||
| -rw-r--r-- | devdoc/dw-textblock-collapsing-spaces-2-2.png (renamed from doc/dw-textblock-collapsing-spaces-2-2.png) | bin | 586 -> 586 bytes | |||
| -rw-r--r-- | devdoc/dw-usage.doc (renamed from doc/dw-usage.doc) | 0 | ||||
| -rw-r--r-- | devdoc/dw-viewport-with-scrollbar.png (renamed from doc/dw-viewport-with-scrollbar.png) | bin | 755 -> 755 bytes | |||
| -rw-r--r-- | devdoc/dw-viewport-without-scrollbar.png (renamed from doc/dw-viewport-without-scrollbar.png) | bin | 542 -> 542 bytes | |||
| -rw-r--r-- | devdoc/dw-widget-sizes.doc (renamed from doc/dw-widget-sizes.doc) | 0 | ||||
| -rw-r--r-- | devdoc/fltk-problems.doc (renamed from doc/fltk-problems.doc) | 0 | ||||
| -rw-r--r-- | devdoc/index.doc (renamed from doc/index.doc) | 0 | ||||
| -rw-r--r-- | devdoc/lout.doc (renamed from doc/lout.doc) | 0 | ||||
| -rw-r--r-- | devdoc/not-so-simple-container.png (renamed from doc/not-so-simple-container.png) | bin | 5738 -> 5738 bytes | |||
| -rw-r--r-- | devdoc/rounding-errors.doc (renamed from doc/rounding-errors.doc) | 0 | ||||
| -rw-r--r-- | devdoc/uml-legend.doc (renamed from doc/uml-legend.doc) | 0 | ||||
| -rw-r--r-- | doc/Dw.txt | 11 | ||||
| -rw-r--r-- | doc/Makefile.am | 44 | ||||
| -rw-r--r-- | doc/README | 54 |
45 files changed, 60 insertions, 104 deletions
@@ -852,7 +852,7 @@ EXAMPLE_RECURSIVE = NO # that contain images that are to be included in the documentation (see the # \image command). -IMAGE_PATH = doc +IMAGE_PATH = devdoc # The INPUT_FILTER tag can be used to specify a program that doxygen should # invoke to filter for each input file. Doxygen will invoke the filter program @@ -1298,7 +1298,7 @@ QHP_NAMESPACE = # The default value is: doc. # This tag requires that the tag GENERATE_QHP is set to YES. -QHP_VIRTUAL_FOLDER = doc +QHP_VIRTUAL_FOLDER = devdoc # If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom # filter to add. For more information please see Qt Help Project / Custom diff --git a/doc/CCCwork.txt b/devdoc/CCCwork.txt index 1ea5d20e..1ea5d20e 100644 --- a/doc/CCCwork.txt +++ b/devdoc/CCCwork.txt diff --git a/doc/Cache.txt b/devdoc/Cache.txt index 4e885df2..4e885df2 100644 --- a/doc/Cache.txt +++ b/devdoc/Cache.txt diff --git a/doc/Dillo.txt b/devdoc/Dillo.txt index a63c9588..a63c9588 100644 --- a/doc/Dillo.txt +++ b/devdoc/Dillo.txt diff --git a/doc/Dpid.txt b/devdoc/Dpid.txt index 6c418f57..6c418f57 100644 --- a/doc/Dpid.txt +++ b/devdoc/Dpid.txt diff --git a/doc/HtmlParser.txt b/devdoc/HtmlParser.txt index 2eb8be63..2eb8be63 100644 --- a/doc/HtmlParser.txt +++ b/devdoc/HtmlParser.txt diff --git a/doc/IO.txt b/devdoc/IO.txt index cd62a4f5..cd62a4f5 100644 --- a/doc/IO.txt +++ b/devdoc/IO.txt diff --git a/doc/Images.txt b/devdoc/Images.txt index 62082e48..62082e48 100644 --- a/doc/Images.txt +++ b/devdoc/Images.txt diff --git a/doc/NC_design.txt b/devdoc/NC_design.txt index 380787f6..380787f6 100644 --- a/doc/NC_design.txt +++ b/devdoc/NC_design.txt diff --git a/devdoc/README b/devdoc/README new file mode 100644 index 00000000..9736a32b --- /dev/null +++ b/devdoc/README @@ -0,0 +1,51 @@ +README: Last update Jul 2009 + +These documents cover dillo's internals. +For user help, see http://www.dillo.org/dillo3-help.html + +-------------------------------------------------------------------------- + +These documents need a review. +*.txt were current with Dillo1, but many have since become more or + less out-of-date. +*.doc are doxygen source for the Dillo Widget (dw) component, and + were written for Dillo2. + +They will give you an overview of what's going on, but take them +with a pinch of salt. + + Of course I'd like to have *.txt as doxygen files too! +If somebody wants to make this conversion, please let me know +to assign higher priority to updating these docs. + +-- +Jorge.- + + -------------------------------------------------------------------------- + FILE DESCRIPTION STATE + -------------------------------------------------------------------------- + NC_design.txt Naming&Coding design (Be sure to Current + read it before any other doc) + Dillo.txt General overview of the program Current + IO.txt Extensive introduction Current + Cache.txt Informative description Current + Images.txt Image handling and processing Current + HtmlParser.txt A versatile parser Current + Dw.txt The New Dillo Widget (Overview) Current + Imgbuf.txt Image buffers Pending + Selection.txt Selections, and link activation Current (?) + Cookies.txt Explains how to enable cookies Current + Dpid.txt Dillo plugin daemon Current + -------------------------------------------------------------------------- + + + * BTW, there's a small program (srch) within the src/ dir. It searches + tokens within the whole code (*.[ch]). It has proven very useful. + Ex: ./srch a_Image_write + ./srch todo: + + * Please submit your patches with 'hg diff'. + + + Happy coding! + --Jcid diff --git a/doc/dw-changes.doc b/devdoc/dw-changes.doc index 7050df9a..7050df9a 100644 --- a/doc/dw-changes.doc +++ b/devdoc/dw-changes.doc diff --git a/doc/dw-example-screenshot.png b/devdoc/dw-example-screenshot.png Binary files differindex 94f272ab..94f272ab 100644 --- a/doc/dw-example-screenshot.png +++ b/devdoc/dw-example-screenshot.png diff --git a/doc/dw-floats-01.png b/devdoc/dw-floats-01.png Binary files differindex 116d36b3..116d36b3 100644 --- a/doc/dw-floats-01.png +++ b/devdoc/dw-floats-01.png diff --git a/doc/dw-grows.doc b/devdoc/dw-grows.doc index a0304ef9..a0304ef9 100644 --- a/doc/dw-grows.doc +++ b/devdoc/dw-grows.doc diff --git a/doc/dw-images-and-backgrounds.doc b/devdoc/dw-images-and-backgrounds.doc index 8f07766a..8f07766a 100644 --- a/doc/dw-images-and-backgrounds.doc +++ b/devdoc/dw-images-and-backgrounds.doc diff --git a/doc/dw-layout-views.doc b/devdoc/dw-layout-views.doc index d1118489..d1118489 100644 --- a/doc/dw-layout-views.doc +++ b/devdoc/dw-layout-views.doc diff --git a/doc/dw-layout-widgets.doc b/devdoc/dw-layout-widgets.doc index e0215562..e0215562 100644 --- a/doc/dw-layout-widgets.doc +++ b/devdoc/dw-layout-widgets.doc diff --git a/doc/dw-line-breaking.doc b/devdoc/dw-line-breaking.doc index 14ab97c4..14ab97c4 100644 --- a/doc/dw-line-breaking.doc +++ b/devdoc/dw-line-breaking.doc diff --git a/doc/dw-map.doc b/devdoc/dw-map.doc index aebeb7da..aebeb7da 100644 --- a/doc/dw-map.doc +++ b/devdoc/dw-map.doc diff --git a/doc/dw-out-of-flow-2.doc b/devdoc/dw-out-of-flow-2.doc index d9d70565..d9d70565 100644 --- a/doc/dw-out-of-flow-2.doc +++ b/devdoc/dw-out-of-flow-2.doc diff --git a/doc/dw-out-of-flow-floats.doc b/devdoc/dw-out-of-flow-floats.doc index 53c6b220..53c6b220 100644 --- a/doc/dw-out-of-flow-floats.doc +++ b/devdoc/dw-out-of-flow-floats.doc diff --git a/doc/dw-out-of-flow.doc b/devdoc/dw-out-of-flow.doc index ea4a52bc..ea4a52bc 100644 --- a/doc/dw-out-of-flow.doc +++ b/devdoc/dw-out-of-flow.doc diff --git a/doc/dw-overview.doc b/devdoc/dw-overview.doc index 0c4ffb53..0c4ffb53 100644 --- a/doc/dw-overview.doc +++ b/devdoc/dw-overview.doc diff --git a/doc/dw-size-of-widget.png b/devdoc/dw-size-of-widget.png Binary files differindex dbdbe0c4..dbdbe0c4 100644 --- a/doc/dw-size-of-widget.png +++ b/devdoc/dw-size-of-widget.png diff --git a/doc/dw-style-box-model.png b/devdoc/dw-style-box-model.png Binary files differindex bf2fb1f1..bf2fb1f1 100644 --- a/doc/dw-style-box-model.png +++ b/devdoc/dw-style-box-model.png diff --git a/doc/dw-style-length-absolute.png b/devdoc/dw-style-length-absolute.png Binary files differindex 9ea28cad..9ea28cad 100644 --- a/doc/dw-style-length-absolute.png +++ b/devdoc/dw-style-length-absolute.png diff --git a/doc/dw-style-length-percentage.png b/devdoc/dw-style-length-percentage.png Binary files differindex b1ad79c9..b1ad79c9 100644 --- a/doc/dw-style-length-percentage.png +++ b/devdoc/dw-style-length-percentage.png diff --git a/doc/dw-style-length-relative.png b/devdoc/dw-style-length-relative.png Binary files differindex ee79b1a9..ee79b1a9 100644 --- a/doc/dw-style-length-relative.png +++ b/devdoc/dw-style-length-relative.png diff --git a/doc/dw-textblock-collapsing-spaces-1-1.png b/devdoc/dw-textblock-collapsing-spaces-1-1.png Binary files differindex d528dfb2..d528dfb2 100644 --- a/doc/dw-textblock-collapsing-spaces-1-1.png +++ b/devdoc/dw-textblock-collapsing-spaces-1-1.png diff --git a/doc/dw-textblock-collapsing-spaces-1-2.png b/devdoc/dw-textblock-collapsing-spaces-1-2.png Binary files differindex 483e79d1..483e79d1 100644 --- a/doc/dw-textblock-collapsing-spaces-1-2.png +++ b/devdoc/dw-textblock-collapsing-spaces-1-2.png diff --git a/doc/dw-textblock-collapsing-spaces-2-1.png b/devdoc/dw-textblock-collapsing-spaces-2-1.png Binary files differindex 0a03ea80..0a03ea80 100644 --- a/doc/dw-textblock-collapsing-spaces-2-1.png +++ b/devdoc/dw-textblock-collapsing-spaces-2-1.png diff --git a/doc/dw-textblock-collapsing-spaces-2-2.png b/devdoc/dw-textblock-collapsing-spaces-2-2.png Binary files differindex b89c6254..b89c6254 100644 --- a/doc/dw-textblock-collapsing-spaces-2-2.png +++ b/devdoc/dw-textblock-collapsing-spaces-2-2.png diff --git a/doc/dw-usage.doc b/devdoc/dw-usage.doc index a23920b8..a23920b8 100644 --- a/doc/dw-usage.doc +++ b/devdoc/dw-usage.doc diff --git a/doc/dw-viewport-with-scrollbar.png b/devdoc/dw-viewport-with-scrollbar.png Binary files differindex 7ac62de3..7ac62de3 100644 --- a/doc/dw-viewport-with-scrollbar.png +++ b/devdoc/dw-viewport-with-scrollbar.png diff --git a/doc/dw-viewport-without-scrollbar.png b/devdoc/dw-viewport-without-scrollbar.png Binary files differindex 8aa20fec..8aa20fec 100644 --- a/doc/dw-viewport-without-scrollbar.png +++ b/devdoc/dw-viewport-without-scrollbar.png diff --git a/doc/dw-widget-sizes.doc b/devdoc/dw-widget-sizes.doc index a82d3b99..a82d3b99 100644 --- a/doc/dw-widget-sizes.doc +++ b/devdoc/dw-widget-sizes.doc diff --git a/doc/fltk-problems.doc b/devdoc/fltk-problems.doc index df4f1f14..df4f1f14 100644 --- a/doc/fltk-problems.doc +++ b/devdoc/fltk-problems.doc diff --git a/doc/index.doc b/devdoc/index.doc index 59de8cd8..59de8cd8 100644 --- a/doc/index.doc +++ b/devdoc/index.doc diff --git a/doc/lout.doc b/devdoc/lout.doc index 4e1503c6..4e1503c6 100644 --- a/doc/lout.doc +++ b/devdoc/lout.doc diff --git a/doc/not-so-simple-container.png b/devdoc/not-so-simple-container.png Binary files differindex 0af067b5..0af067b5 100644 --- a/doc/not-so-simple-container.png +++ b/devdoc/not-so-simple-container.png diff --git a/doc/rounding-errors.doc b/devdoc/rounding-errors.doc index a442033e..a442033e 100644 --- a/doc/rounding-errors.doc +++ b/devdoc/rounding-errors.doc diff --git a/doc/uml-legend.doc b/devdoc/uml-legend.doc index 54004ccd..54004ccd 100644 --- a/doc/uml-legend.doc +++ b/devdoc/uml-legend.doc diff --git a/doc/Dw.txt b/doc/Dw.txt deleted file mode 100644 index f6909380..00000000 --- a/doc/Dw.txt +++ /dev/null @@ -1,11 +0,0 @@ -Last update: Oct 2008 - -================ -Dw: Dillo Widget -================ - -Dw is the internal widget library for rendering HTML. It has excellent -documentation. - - Just run "doxygen" and browse the html/ directory! - diff --git a/doc/Makefile.am b/doc/Makefile.am index 71c7c32d..7b40d0a2 100644 --- a/doc/Makefile.am +++ b/doc/Makefile.am @@ -1,48 +1,10 @@ dist_doc_DATA = user_help.html man_MANS = dillo.1 EXTRA_DIST = \ - index.doc \ - lout.doc \ - dw-map.doc \ - dw-overview.doc \ - dw-usage.doc \ - dw-layout-views.doc \ - dw-layout-widgets.doc \ - dw-widget-sizes.doc \ - dw-changes.doc \ - dw-images-and-backgrounds.doc \ - dw-out-of-flow.doc \ - dw-out-of-flow-2.doc \ - fltk-problems.doc \ - rounding-errors.doc \ - uml-legend.doc \ - dw-line-breaking.doc \ - dw-example-screenshot.png \ - dw-viewport-without-scrollbar.png \ - dw-viewport-with-scrollbar.png \ - dw-size-of-widget.png \ - dw-style-box-model.png \ - dw-style-length-absolute.png \ - dw-style-length-percentage.png \ - dw-style-length-relative.png \ - dw-textblock-collapsing-spaces-1-1.png \ - dw-textblock-collapsing-spaces-1-2.png \ - dw-textblock-collapsing-spaces-2-1.png \ - dw-textblock-collapsing-spaces-2-2.png \ - dw-floats-01.png \ - not-so-simple-container.png \ - Cache.txt \ - Cookies.txt \ - Dillo.txt \ - Dw.txt \ - HtmlParser.txt \ - IO.txt \ - Images.txt \ - NC_design.txt \ - Dpid.txt \ - CCCwork.txt \ README \ - dillo.1.in + Cookies.txt \ + dillo.1.in \ + user_help.html dillo.1: $(srcdir)/dillo.1.in Makefile sed 's%/usr/local%${prefix}%g' < $(srcdir)/dillo.1.in > dillo.1 @@ -1,51 +1,5 @@ -README: Last update Jul 2009 +Last update: June 2015 -These documents cover dillo's internals. -For user help, see http://www.dillo.org/dillo3-help.html - --------------------------------------------------------------------------- - -These documents need a review. -*.txt were current with Dillo1, but many have since become more or - less out-of-date. -*.doc are doxygen source for the Dillo Widget (dw) component, and - were written for Dillo2. - -They will give you an overview of what's going on, but take them -with a pinch of salt. - - Of course I'd like to have *.txt as doxygen files too! -If somebody wants to make this conversion, please let me know -to assign higher priority to updating these docs. - --- -Jorge.- - - -------------------------------------------------------------------------- - FILE DESCRIPTION STATE - -------------------------------------------------------------------------- - NC_design.txt Naming&Coding design (Be sure to Current - read it before any other doc) - Dillo.txt General overview of the program Current - IO.txt Extensive introduction Current - Cache.txt Informative description Current - Images.txt Image handling and processing Current - HtmlParser.txt A versatile parser Current - Dw.txt The New Dillo Widget (Overview) Current - Imgbuf.txt Image buffers Pending - Selection.txt Selections, and link activation Current (?) - Cookies.txt Explains how to enable cookies Current - Dpid.txt Dillo plugin daemon Current - -------------------------------------------------------------------------- - - - * BTW, there's a small program (srch) within the src/ dir. It searches - tokens within the whole code (*.[ch]). It has proven very useful. - Ex: ./srch a_Image_write - ./srch todo: - - * Please submit your patches with 'hg diff'. - - - Happy coding! - --Jcid +This directory contains user documentation. Developer documentation is +only stored in the Hg repository at <http://hg.dillo.org/dillo/>, in +the directory "devdoc", but not part of the tarball. |
