diff options
author | Øyvind Kolås <pippin@gimp.org> | 2012-11-19 21:01:28 +0100 |
---|---|---|
committer | Øyvind Kolås <pippin@gimp.org> | 2012-11-19 21:17:13 +0100 |
commit | f55d79f5e9dcd061acfa9a5a01f8afd05e58cad9 (patch) | |
tree | e0099cf3547cff6c6b3753b335bf70f99904776b /docs | |
parent | b20591e7eb3d8689f222a5775989b688b873d126 (diff) |
tweaks across doc buils system
Diffstat (limited to 'docs')
-rw-r--r-- | docs/Makefile.am | 4 | ||||
-rw-r--r-- | docs/copyright.txt | 2 | ||||
-rw-r--r-- | docs/development.txt | 3 | ||||
-rw-r--r-- | docs/features.txt | 4 | ||||
-rw-r--r-- | docs/gegl.css | 13 | ||||
-rw-r--r-- | docs/glossary.txt | 5 | ||||
-rw-r--r-- | docs/hello-world.txt.in (renamed from docs/hello-world.txt) | 5 | ||||
-rw-r--r-- | docs/index.txt | 51 | ||||
-rw-r--r-- | docs/index.txt.in | 51 | ||||
-rw-r--r-- | docs/operation-api.txt | 9 | ||||
-rw-r--r-- | docs/source-overview.txt | 4 |
11 files changed, 102 insertions, 49 deletions
diff --git a/docs/Makefile.am b/docs/Makefile.am index 27aebfff..7533739d 100644 --- a/docs/Makefile.am +++ b/docs/Makefile.am @@ -11,10 +11,10 @@ gtkdocexampledir = $(datadir)/gtk-doc/html/gegl/images/examples # run the sync-txt target after adding a text file sync-txt: - txts=ASC_DOC=`for a in *.txt;do echo -n ' '$$a|sed s/txt/html/;done;echo ''`;\ + txts=ASC_DOC="index.html "`for a in *.txt;do echo -n ' '$$a|sed s/txt/html/;done;echo ''`;\ txts=$$txts" #ASC_DOC_HOTPATCH";\ cat Makefile.am | sed "s/ASC\_DOC.*ASC_DOC_HOTPATCH/$$txts/" > /tmp/mktmp; cp /tmp/mktmp Makefile.am; -ASC_DOC= abyss_policy.html bugzilla.html build.html commandline.html contribute.html copyright.html development.html editor.html environment.html features.html glossary.html hello-world.html journal.html operation-api.html source-overview.html todo.html #ASC_DOC_HOTPATCH +ASC_DOC=index.html abyss_policy.html bugzilla.html build.html commandline.html contribute.html copyright.html development.html editor.html environment.html features.html glossary.html hello-world.html journal.html operation-api.html source-overview.html todo.html #ASC_DOC_HOTPATCH HTML_FILES = \ diff --git a/docs/copyright.txt b/docs/copyright.txt index bf3c8bca..66444b9f 100644 --- a/docs/copyright.txt +++ b/docs/copyright.txt @@ -14,5 +14,5 @@ http://www.ohloh.net/projects/4349/analyses/latest[over time] the following lists are are ordered chronologically according to when they are mentioned in the ChangeLog. -include::@top_srcdir@/AUTHORS[] +include::../AUTHORS[] diff --git a/docs/development.txt b/docs/development.txt index da728e1f..0b8be688 100644 --- a/docs/development.txt +++ b/docs/development.txt @@ -7,6 +7,7 @@ image::images/GEGL.png[GEGL] This document describes some handy things to know when developing the gegl internals. Parts of it is copy-paste of emails on the gegl developer list. + == Setting up === Ubuntu 8.10 @@ -237,4 +238,4 @@ This example will show how a new c/h file is converted into html using enscript Here is an automatically generated inheritance tree of the gobjects used by gegl: link:images/inheritance.png[GEGL inheritance tree] -Note that the operations are also gobjects, but they are not included in the inheritance tree.
\ No newline at end of file +Note that the operations are also gobjects, but they are not included in the inheritance tree. diff --git a/docs/features.txt b/docs/features.txt index 276324e3..52fa8faf 100644 --- a/docs/features.txt +++ b/docs/features.txt @@ -1,5 +1,5 @@ -Functionality Overview ----------------------- +GEGL Feature List +----------------- - Floating point handling and processing and output of larger 8bit, 16bit integer and 32bit floating point per component buffers larger than RAM. diff --git a/docs/gegl.css b/docs/gegl.css index 867cfc2d..bb292039 100644 --- a/docs/gegl.css +++ b/docs/gegl.css @@ -2,8 +2,6 @@ display: inline; } body { - margin-left: 12.5em; - margin-right: 2em; padding: 0; background-color: #fff; color: black; @@ -17,7 +15,10 @@ iframe { background-color: #aaa; } + img {max-width: 100%} div.content { + margin-left: auto; + margin-right: auto; padding: 1em; padding-right: 3em; padding-left: 2em; @@ -28,7 +29,7 @@ } h1 { margin-top: 0em; - } + } h1, h2, h3, h4{ color: #112266; } @@ -364,3 +365,9 @@ display: none; } } + + a{color:#44f;} + a:visited{color:#44f;} + + + diff --git a/docs/glossary.txt b/docs/glossary.txt index 142a2dd4..e74eca1a 100644 --- a/docs/glossary.txt +++ b/docs/glossary.txt @@ -1,5 +1,6 @@ -Glossary -~~~~~~~~ +GEGL Glossary +------------- + connection:: A link/pipe routing image flow between operations within the graph goes from an output pad to an input pad, in graph glossary this might also be diff --git a/docs/hello-world.txt b/docs/hello-world.txt.in index 13d2aa30..a99327cf 100644 --- a/docs/hello-world.txt +++ b/docs/hello-world.txt.in @@ -5,9 +5,10 @@ mandelbrot fractal. compile it with: $ gcc hello-world.c `pkg-config --libs --cflags gegl` -o hello-world -This example and others can be found in the examples subdir of the GEGL distribution. +This example and others can be found in the +link:http://git.gnome.org/browse/gegl/tree/examples/[examples subdir of the GEGL +distribution]. --------------------------- sys::[cat @top_srcdir@/examples/hello-world.c] --------------------------- - diff --git a/docs/index.txt b/docs/index.txt index 6fceca6f..da6c86c2 100644 --- a/docs/index.txt +++ b/docs/index.txt @@ -7,30 +7,53 @@ GEGL image::images/GEGL.png[GEGL] -link:operations.html[operations reference] -link:api.html[public API reference] *GEGL* (Generic Graphics Library) is a graph based image processing framework. -With GEGL you chain together image processing operations represented by nodes +With GEGL you chain together link:operations.html[image processing operations] represented by nodes into a graph. GEGL provides such operations for loading and storing images, adjusting colors, filtering in different ways, transforming and compositing images. -GEGL's programmer/user interface is a Directed Acyclic Graph of nodes. The DAG -expresses a processing chain of operations. A DAG, or any node in it, expresses -a composited and processed image. +link:operations.html[Operations reference gallery]:: + A page showcasing all the various gegl image processing operations. +link:features.html[GEGL Feature list]:: + The "feature list", a techinical specification of what GEGL can do. +link:glossary.html[GEGL glossary]:: + A cheat sheet of terms used in GEGL. +link:hello-world.html[hello world]:: + A small C example program source showing how the native C GEGL API can be used. -News -~~~~ -This website was built at the time of the previous GEGL tarball release and -is a snapshot of a corresponding documentation build. For information about -what might change on the way to the next release follow the following news -sources: +link:api.html[public API reference]:: + The public graph construction and manipulation API for doing image + processing. +link:api.html#GeglBuffer[GeglBuffer API reference]:: + GEGL contains a powerful raster buffer abstraction powered by + link:http://gegl.org/babl/[babl]. -http://git.gnome.org/cgit/gegl/log/[Change log]:: +link:operations-api.html[Extending GEGL with operations/plug-ins]:: + The API to create new image processing atoms for combination in the graph. +link:build.html[Getting sources, and building]:: + Links and information about various ways of getting a build environment for + GEGL. +link:images/inheritance.png[GEGL inheritance tree]:: + Generated class inheritance graph generated from runtime introspection. +link:bugzilla.html[bugzilla]:: + GEGL uses bugzilla for tracking issues, both bugs and desired new features. +link:copyright.html[Copyright]:: + Who made GEGL and under what conditions you can use it. +link:development.html[Further pointers for development]:: + Miscealanny notes about possible ways of building and developing with GEGL. + + +If you read this on the gegl.org website you are reading the snapshot of the +documentation generated for gegl at that point. For further information here +are some pointers to follow: + +http://git.gnome.org/browse/gegl/[GEGL source] and http://git.gnome.org/browse/babl/[babl source]:: + http://git.gnome.org/cgit/gegl/log/[commit log]:: For day to day fixes, contributions and changes. http://git.gnome.org/cgit/gegl/tree/NEWS[NEWS]:: - The NEWS file for a list of major new features (also contains older NEWS). + The NEWS file for a list across history of GEGL. http://bugzilla.gnome.org/buglist.cgi?product=GEGL&bug_status=NEW&bug_status=ASSIGNED&bug_status=REOPENED&bug_status=UNCONFIRMED&bug_status=NEEDINFO[bugzilla]:: for known and tracked issues with GEGL and perhaps see the http://blog.gmane.org/gmane.comp.video.gegl.devel?set_blog_all=yes[mail]:: diff --git a/docs/index.txt.in b/docs/index.txt.in index 07fb3a6b..aa3eeeef 100644 --- a/docs/index.txt.in +++ b/docs/index.txt.in @@ -7,30 +7,53 @@ GEGL image::images/GEGL.png[GEGL] -link:operations.html[operations reference] -link:api.html[public API reference] *GEGL* (Generic Graphics Library) is a graph based image processing framework. -With GEGL you chain together image processing operations represented by nodes +With GEGL you chain together link:operations.html[image processing operations] represented by nodes into a graph. GEGL provides such operations for loading and storing images, adjusting colors, filtering in different ways, transforming and compositing images. -GEGL's programmer/user interface is a Directed Acyclic Graph of nodes. The DAG -expresses a processing chain of operations. A DAG, or any node in it, expresses -a composited and processed image. +link:operations.html[Operations reference gallery]:: + A page showcasing all the various gegl image processing operations. +link:features.html[GEGL Feature list]:: + The "feature list", a techinical specification of what GEGL can do. +link:glossary.html[GEGL glossary]:: + A cheat sheet of terms used in GEGL. +link:hello-world.html[hello world]:: + A small C example program source showing how the native C GEGL API can be used. -News -~~~~ -This website was built at the time of the previous GEGL tarball release and -is a snapshot of a corresponding documentation build. For information about -what might change on the way to the next release follow the following news -sources: +link:api.html[public API reference]:: + The public graph construction and manipulation API for doing image + processing. +link:api.html#GeglBuffer[GeglBuffer API reference]:: + GEGL contains a powerful raster buffer abstraction powered by + link:http://gegl.org/babl/[babl]. -http://git.gnome.org/cgit/gegl/log/[Change log]:: +link:operations-api.html[Extending GEGL with operations/plug-ins]:: + The API to create new image processing atoms for combination in the graph. +link:build.html[Getting sources, and building]:: + Links and information about various ways of getting a build environment for + GEGL. +link:images/inheritance.png[GEGL inheritance tree]:: + Generated class inheritance graph generated from runtime introspection. +link:bugzilla.html[bugzilla]:: + GEGL uses bugzilla for tracking issues, both bugs and desired new features. +link:copyright.html[Copyright]:: + Who made GEGL and under what conditions you can use it. +link:development.html[Further pointers for development]:: + Miscealanny notes about possible ways of building and developing with GEGL. + + +If you read this on the gegl.org website you are reading the snapshot of the +documentation generated for gegl at that point. For further information here +are some pointers to follow: + +http://git.gnome.org/browse/gegl/[GEGL source] and http://git.gnome.org/browse/babl/[babl source]:: + http://git.gnome.org/cgit/gegl/log/[commit log]:: For day to day fixes, contributions and changes. http://git.gnome.org/cgit/gegl/tree/NEWS[NEWS]:: - The NEWS file for a list of major new features (also contains older NEWS). + The NEWS file for a list across history of GEGL. http://bugzilla.gnome.org/buglist.cgi?product=GEGL&bug_status=NEW&bug_status=ASSIGNED&bug_status=REOPENED&bug_status=UNCONFIRMED&bug_status=NEEDINFO[bugzilla]:: for known and tracked issues with GEGL and perhaps see the http://blog.gmane.org/gmane.comp.video.gegl.devel?set_blog_all=yes[mail]:: diff --git a/docs/operation-api.txt b/docs/operation-api.txt index a7d3a339..98d6beb8 100644 --- a/docs/operation-api.txt +++ b/docs/operation-api.txt @@ -4,8 +4,10 @@ An API to extend the functionality of GEGL with new image processing primitive, file loaders, export formats or similar. Each GEGL operation is defined in a .c file that gets turned into a single -shared object that is loaded. Each operation is a subclass of one of the -provided base classes: +shared object that is loaded. Take a look at +link:brightness-contrast.c.html[the brightness contrast operation] for a point +operation well sprinkled with comments as a starting point. Each operation is +a subclass of one of the provided base classes: link:gegl-operation.h.html[GeglOperation]:: The base operation class, which all the other base classes are derived @@ -63,6 +65,3 @@ link:gegl-operation-meta.h.html[GeglOperationMeta]:: To create your own operations you should start by looking for one that does approximatly what you already need. Copy it to a new .c source file, and replace the occurences of the filename (operation name in the source.) - -Take a look at link:brightness-contrast.c.html[the brightness contrast -operation] for a point operation well sprinkled with comments as a starting point. diff --git a/docs/source-overview.txt b/docs/source-overview.txt index baa90413..957a26e7 100644 --- a/docs/source-overview.txt +++ b/docs/source-overview.txt @@ -1,7 +1,5 @@ Source overview -~~~~~~~~~~~~~~~ -GEGL dirs -^^^^^^^^^ +--------------- Directories marked with ⊙ use GNU make extensions to include any .c file dropped into the directory in the build. |