GNOME.org
 

[gegl] docs: webpage improvements

commit 23496386c5e46a44d66dda9767d975331df10d1c
Author: Øyvind Kolås <pippin gimp org>
Date:   Wed May 3 04:08:18 2017 +0200

    docs: webpage improvements

 docs/Makefile.am        |    2 +-
 docs/NEWS.txt           |    8 ++++-
 docs/development.txt    |    8 +++-
 docs/features.txt       |   23 +++---------
 docs/index.txt.in       |   93 ++++++++++++++---------------------------------
 tools/operations_html.c |    4 +-
 6 files changed, 49 insertions(+), 89 deletions(-)
---
diff --git a/docs/Makefile.am b/docs/Makefile.am
index 1c413cb..33933bb 100644
--- a/docs/Makefile.am
+++ b/docs/Makefile.am
@@ -14,7 +14,7 @@ sync-txt:
        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=index.html  abyss_policy.html bugzilla.html build.html commandline.html contribute.html 
copyright.html NEWS.html development.html editor.html environment.html features.html glossary.html 
hello-world.html journal.html operation-api.html source-overview.html gegl-chain.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 gegl-chain.html glossary.html 
hello-world.html index.html journal.html NEWS.html operation-api.html source-overview.html #ASC_DOC_HOTPATCH
 
 
 HTML_FILES = \
diff --git a/docs/NEWS.txt b/docs/NEWS.txt
index dd4a0bc..f8e7f63 100644
--- a/docs/NEWS.txt
+++ b/docs/NEWS.txt
@@ -1,6 +1,12 @@
-GEGL-0.3.16 (collected news up to 69e4a0960e2fe0067e4f6ef1330fdc4ed3e88c5f)
+GEGL-0.3.16
 -----------
 
+Documentation
+~~~~~~~~~~~~~
+
+Replaced dynamic client side js content with static operation gallery,
+incremental improvements to website content.
+
 Core
 ~~~~
 
diff --git a/docs/development.txt b/docs/development.txt
index c503958..2d6a2fc 100644
--- a/docs/development.txt
+++ b/docs/development.txt
@@ -4,9 +4,13 @@ Development
 image::images/GEGL.png[GEGL]
 *#Development#*
 
-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.
+This document describes some handy things to know when developing the gegl internals. The 
link:glossary.html[GEGL glossary] might help make sense of the terms used.
 
+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.
 
 == Setting up
 
diff --git a/docs/features.txt b/docs/features.txt
index fedc80e..81bec2a 100644
--- a/docs/features.txt
+++ b/docs/features.txt
@@ -1,5 +1,5 @@
-GEGL Feature List
------------------
+GEGL image processing
+---------------------
 
   - Floating point handling and processing and output of larger 8bit, 16bit
     integer and 32bit floating point per component buffers larger than RAM.
@@ -23,20 +23,9 @@ GEGL Feature List
      * Thread-safe reading/writing.
      * External tile-backends (allow wrapping other tiled buffer systems
        to use them through the GeglBuffer API).
-  - Operations
-      * PNG, JPEG, SVG, EXR, RAW, ffmpeg, v4l and other image sources.
-      * link:operations.html#category%20render[Pattern renderers]
-      * link:operations.html#category%20math[Arithmetic operations]
-      * link:operations.html#category%20porter-duff[porter duff compositing]
-      * SVG filter modes and full set of compositing ops from SVG-1.2 draft.
-      * Gaussian blur, bilateral-filter, symmetric nearest neighbour, linear
-      * blur, unsharp mask, pixelize and more.
-      * link:operations.html#category%20color[Color correction].
-      * Text rendering using cairo and http://pango.org/[pango].
-      * HDR exposure merging and tone mapping operations.
-      * Most operations operate in
-        http://en.wikipedia.org/wiki/ScRGB_color_space[scRGB] (using 32bit
-        floating point/HDR linear light RGBA), operations use babl formats to
-        specify whether data should be linearized for processing.
+     * Most operations operate in
+       http://en.wikipedia.org/wiki/ScRGB_color_space[scRGB] (using 32bit
+       floating point/HDR linear light RGBA), operations use babl formats to
+       specify whether data should be linearized for processing.
   - Bounding box based hit detection.
   - XML serialization format (not-finalized)
diff --git a/docs/index.txt.in b/docs/index.txt.in
index 667d6cb..987cf3f 100644
--- a/docs/index.txt.in
+++ b/docs/index.txt.in
@@ -7,73 +7,34 @@ GEGL
 
 image::images/GEGL.png[GEGL]
 
-
-*GEGL* (Generic Graphics Library) is a graph based image processing framework.
-
-With GEGL you chain together link:operations/index.html[image processing operations]
-represented by nodes into a graph. GEGL provides operations for image loading
-and storing, color adjustments, and other different forms of image
-transformation, filtering and compositing. Some software using GEGL is
-link:http://www.gimp.org/[GNU Image Manipulation Program],
-link:http://www.imgflo.org/[imgflo],
-link:https://wiki.gnome.org/Apps/Photos[GNOME Photos] and
-link:https://github.com/the-grid/iconographer[iconographer].
-
-link:operations/index.html[Operations reference gallery]::
-  Documentation and visual test reference for most GEGL image processing
-  operations.
-link:features.html[GEGL Feature list]::
-  The "feature list", a technical specification of what GEGL can do.
-link:glossary.html[GEGL glossary]::
-  A cheat sheet of terms used in GEGL.
-link:commandline.html[Commandline reference]::
-  Documentation for using GEGL from the commandline with the gegl binary.
-
-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].
-
-link:operation-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]::
-  Miscellaneous 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://gegl.org/NEWS.html[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]::
-  The mailinglist archives for some discussion and announcement.
-
-GEGL development is discussed on IRC in #gegl (and sometimes in #gimp) on
-GIMPnet (irc.gimp.org).
+*GEGL* (Generic Graphics Library) is a data flow based image processing
+framework, providing floating point processing and non-destructive image
+processing capabilities to link:http://www.gimp.org/[GNU Image Manipulation Program] and other projects 
(link:http://www.imgflo.org/[imgflo], link:https://wiki.gnome.org/Apps/Photos[GNOME Photos],
+link:https://github.com/the-grid/iconographer[iconographer], ...)
+
+With GEGL you chain together processing link:operations/index.html[operations]
+to represent the desired image processing pipeline. GEGL provides operations
+for link:operations/GeglOperationSource.html[image loading] and 
+link:operations/GeglOperationSink.html[storing], link:operations/color.html[color adjustments], 
link:operations/artistic.html[GIMPs artistic] filters and more 
+forms of link:features.html[image processing] GEGL can also be used from the
+link:commandline.html[commandline].
+
+GEGL is link:copyright.html[Free Software], and both new functionality in
+link:operation-api.html[new operations] as well as relevant 
+link:development.html[development], enhancement
+requests, patches and bug reports for GEGL and link:http://gegl.org/babl/[babl] in 
link:bugzilla.html[bugzilla].
+
+Important links for following GEGL development:
+http://gegl.org/NEWS.html[GEGL NEWS file],
+http://git.gnome.org/browse/gegl/[GEGL source],
+http://git.gnome.org/browse/babl/[babl source],
+http://git.gnome.org/cgit/gegl/log/[GEGL commit log], 
+http://bugzilla.gnome.org/buglist.cgi?product=GEGL&bug_status=NEW&bug_status=ASSIGNED&bug_status=REOPENED&bug_status=UNCONFIRMED&bug_status=NEEDINFO[bugzilla],
+http://blog.gmane.org/gmane.comp.video.gegl.devel?set_blog_all=yes[mailing list archives] and IRC in #gegl 
(and #gimp) on GIMPnet (irc.gimp.org).
 
 You can subscribe to gegl-developer and view the archives
 http://mail.gnome.org/mailman/listinfo/gegl-developer-list[here]. The GEGL
-developer list is the appropriate place to ask development questions, and get
-more information about GEGL development in general. You can email this list at
-mailto:gegl-developer-list gnome org[].
+developer list or IRC as mentioned above is the appropriate place to ask
+development questions, and get more information about GEGL development in
+general. You can email this list at mailto:gegl-developer-list gnome org[].
 
-++++++++
-<div id='fnord'>fnord</div>
-++++++++
diff --git a/tools/operations_html.c b/tools/operations_html.c
index b9ee2f2..a83738e 100644
--- a/tools/operations_html.c
+++ b/tools/operations_html.c
@@ -387,9 +387,9 @@ GHashTable *seen_categories = NULL;
 const gchar *css = "@import url(../gegl.css); .categories{ clear:right;text-align: justify; line-height: 
1.6em; float:right; padding-left: 1em; padding-bottom: 1em ;width: 14em; } .categories a, .category 
{color:black; background:#eef; padding: 0.1em; padding-left0.2em; padding-right: 0.2em; border: 1px solid 
gray;} .description{margin-bottom:1em;}";
 
 const gchar *html_pre = "<html><head><title>GEGL operation %s</title>\n"
-                          "<style>%s%s</style></head><body>\n";
+                          "<style>%s%s</style></head><body><div id='content'>\n";
 const gchar *html_post =
-            "<div style='margin-top:3em;'><a href='../index.html'><img src='../images/GEGL.png' alt='GEGL' 
style='height: 4.0em;float:left; padding-right:0.5em;'/></a> This page is part of the online GEGL 
Documentation, GEGL is a data flow based image processing library/framework, made to fuel <a 
href='https://www.gimp.org/'>GIMPs</a> high-bit depth non-destructive editing future.</body></html></div>\n";
+            "<div style='margin-top:3em;'><a href='../index.html'><img src='../images/GEGL.png' alt='GEGL' 
style='height: 4.0em;float:left; padding-right:0.5em;'/></a> This page is part of the online GEGL 
Documentation, GEGL is a data flow based image processing library/framework, made to fuel <a 
href='https://www.gimp.org/'>GIMPs</a> high-bit depth non-destructive editing future.</div></body></html>\n";
 
 gint
 main (gint argc, gchar **argv)
[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]