From: Øyvind Kolås <pippin@gimp.org>
Date: Tue, 23 Jul 2019 09:13:20 +0000 (+0200)
Subject: docs: start adding a glossary
X-Git-Tag: archive/raspbian/1%0.1.106-3+rpi1^2~15^2~11^2~69
X-Git-Url: https://dgit.raspbian.org/?a=commitdiff_plain;h=829da3636b6c82500bb4a338490adf6ac73ad45a;p=babl.git

docs: start adding a glossary
---

diff --git a/docs/CMYK-static.html b/docs/CMYK-static.html
index 27cbe66..4730494 100644
--- a/docs/CMYK-static.html
+++ b/docs/CMYK-static.html
@@ -47,7 +47,7 @@ and float:</p>
   </dl>
 
 
-  <a href='graphics/index.html'><img class='BablFish' alt='/babl-0.1.67' title='babl-0.1.67' src='graphics/babl-48x48.png'/></a>
+  <a href='graphics/index.html'><img class='BablFish' alt='/babl' title='babl' src='graphics/babl-48x48.png'/></a>
   </div>
   </div>
 
diff --git a/docs/CMYK.html b/docs/CMYK.html
index 852c46a..25ea943 100644
--- a/docs/CMYK.html
+++ b/docs/CMYK.html
@@ -29,12 +29,13 @@
       <ul>
         <li><a href='index.html#Download'>&nbsp;&nbsp;Download</a></li>
         <li><a href='index.html#Features'>&nbsp;&nbsp;Features</a></li>
+        <li><a href='Reference.html'>&nbsp;&nbsp;Reference</a></li>
+        <li><a href='Glossary.html'>&nbsp;&nbsp;Glossary</a></li>
         <li><a href='ColorManagement.html'>&nbsp;&nbsp;Color Management</a></li>
         <li><a href='SymmetricAlpha.html'>&nbsp;&nbsp;Symmetric-Alpha</a></li>
         <li><a href='CMYK.html'>&nbsp;&nbsp;CMYK</a></li>
         <!--<li><a href='#Background'>Background</a></li>-->
         <li><a href='index.html#Usage'>&nbsp;&nbsp;Usage</a></li>
-        <li><a href='Reference.html'>&nbsp;&nbsp;Reference</a></li>
         <!--<li><a href='index.html#Data-types'>&nbsp;&nbsp;&nbsp;&nbsp;Data types</a></li>
         <li><a href='index.html#Color-models'>&nbsp;&nbsp;&nbsp;&nbsp;Color models</a></li>
         <li><a href='#Pixel-formats'>&nbsp;&nbsp;&nbsp;&nbsp;Pixel formats</a></li>-->
@@ -73,7 +74,7 @@ and float:</p>
   </dl>
 
 
-  <a href='graphics/index.html'><img class='BablFish' alt='/babl-0.1.67' title='babl-0.1.67' src='graphics/babl-48x48.png'/></a>
+  <a href='graphics/index.html'><img class='BablFish' alt='/babl' title='babl' src='graphics/babl-48x48.png'/></a>
   </div>
   </div>
 
diff --git a/docs/ColorManagement-static.html b/docs/ColorManagement-static.html
index 57c5516..5a8f913 100644
--- a/docs/ColorManagement-static.html
+++ b/docs/ColorManagement-static.html
@@ -50,7 +50,7 @@
 
   <p>Handling of <a href='CMYK.html'>CMYK is in a separate document</a>.</p>
 
-  <a href='graphics/index.html'><img class='BablFish' alt='/babl-0.1.67' title='babl-0.1.67' src='graphics/babl-48x48.png'/></a>
+  <a href='graphics/index.html'><img class='BablFish' alt='/babl' title='babl' src='graphics/babl-48x48.png'/></a>
   </div>
   </div>
 
diff --git a/docs/ColorManagement.html b/docs/ColorManagement.html
index aecef94..50c0460 100644
--- a/docs/ColorManagement.html
+++ b/docs/ColorManagement.html
@@ -25,12 +25,13 @@
       <ul>
         <li><a href='index.html#Download'>&nbsp;&nbsp;Download</a></li>
         <li><a href='index.html#Features'>&nbsp;&nbsp;Features</a></li>
+        <li><a href='Reference.html'>&nbsp;&nbsp;Reference</a></li>
+        <li><a href='Glossary.html'>&nbsp;&nbsp;Glossary</a></li>
         <li><a href='ColorManagement.html'>&nbsp;&nbsp;Color Management</a></li>
         <li><a href='SymmetricAlpha.html'>&nbsp;&nbsp;Symmetric-Alpha</a></li>
         <li><a href='CMYK.html'>&nbsp;&nbsp;CMYK</a></li>
         <!--<li><a href='#Background'>Background</a></li>-->
         <li><a href='index.html#Usage'>&nbsp;&nbsp;Usage</a></li>
-        <li><a href='Reference.html'>&nbsp;&nbsp;Reference</a></li>
         <!--<li><a href='index.html#Data-types'>&nbsp;&nbsp;&nbsp;&nbsp;Data types</a></li>
         <li><a href='index.html#Color-models'>&nbsp;&nbsp;&nbsp;&nbsp;Color models</a></li>
         <li><a href='#Pixel-formats'>&nbsp;&nbsp;&nbsp;&nbsp;Pixel formats</a></li>-->
@@ -76,7 +77,7 @@
 
   <p>Handling of <a href='CMYK.html'>CMYK is in a separate document</a>.</p>
 
-  <a href='graphics/index.html'><img class='BablFish' alt='/babl-0.1.67' title='babl-0.1.67' src='graphics/babl-48x48.png'/></a>
+  <a href='graphics/index.html'><img class='BablFish' alt='/babl' title='babl' src='graphics/babl-48x48.png'/></a>
   </div>
   </div>
 
diff --git a/docs/Glossary-static.html b/docs/Glossary-static.html
new file mode 100644
index 0000000..b10108e
--- /dev/null
+++ b/docs/Glossary-static.html
@@ -0,0 +1,94 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+<html>
+  <head>
+    <title>babl - glossary</title>
+    <meta http-equiv="content-type" content="text/html;charset=utf-8" />
+    <link rel="icon" href="graphics/babl-16x16.png" type="image/png" />
+    <link rel="shortcut icon" href="graphics/babl-16x16.png" type="image/png" />
+    <style type='text/css'>
+       @import url(babl.css);
+    </style>
+  </head>
+  <body>
+
+    <div class='print'>
+      <div class='print_title'>
+        <h1>Babl-0.1.67</h1>
+      </div>
+    </div>
+<!--TOC-->
+
+    <div class='paper'>
+  <div class='content'>
+
+  <h2>Glossary</h2>
+
+  <p>This vocabulary is meant as a guide to the concepts involved in babl to
+help with understanding of the code and APIs, and help continued development to
+keep the vocabulary small.</p>
+
+  <dl>
+
+    <dt><a name='alpha' href='#alpha'>Alpha</a></dt>
+    <dd>Alpha is the name used for transparency in computer programming, two main forms exist <a href='#associated_alpha'>associated alpha</a> and <a href='#separate_alpha'>separate alpha</a>.</dd>
+
+    <dt><a name='associated_alpha' href='#associated_alpha'>Associated alpha</a></dt>
+    <dd>Alpha in an additive light representation where each component has its
+own associated alpha. This representation is useful for avoiding color from
+empty pixels bleeding into surroundings. It is also able to represent emittance
+in addition to opacity.
+Babl uses <a href='SymmetricAlpha'>Symmetric alpha transformations</a> between <a href='#separate_alpha'>separate alpha</a> and associated alpha.</dd>
+
+
+    <dt><a name='BablFish' href='#BablFish'>BablFish</a></dt>
+    <dd>The objects used for processing pixels, it converts between two
+BablFormats, the first time a pair of formats are passed to
+babl_fish(format_in, format_out) a benchmark is run, and the fastest
+combination of conversions available in babl to achieve the conversion within
+configured accuracy is returned and cached for subsequent requests.</dd>
+
+    <dt><a name='BablFormat' href='#BablFormat'>BablFormat</a></dt>
+    <dd>The data type used to describe a pixel format encoding, it consists of the specific order of components.</dd>
+
+    <dt><a name='BablSpace' href='#BablSpace'>BablSpace</a></dt>
+    <dd>a BablSpace describes the specifics of a BablModel - current types of BablSpaces in use in babl are RGB and CMYK based ones; the space encodes the specific parameters like custom TRCs and Primaries.</dd>
+
+    <dt><a name='BablModel' href='#BablModel'>BablModel</a></dt>
+    <dd>In babl a model describes a specific family of color encodings - with its list of color components. For the RGB and Grayscale spaces, the model also specifies any nonlinearities as TRCs.</dd>
+
+    <dt><a name='CIE' href='#CIE'>CIE</a></dt>
+    <dt><a name='ICC_profile' href='#ICC_profile'>ICC Profile</a></dt>
+    <dt><a name='encoding' href='#encoding'>Encoding</a></dt>
+
+    <dt><a name='luminance' href='#luminance'>Luminance</a></dt>
+    <dd>The photometric measure of luminious intensity of per unit area of light. The luminance in babl is proportional to luminance - though it doesn't use the SI unit of candela per square meter.</dd>
+
+    <dt><a name='non_associated_alpha' href='#non_associated_alpha'>Non-associated alpha</a></dt>
+    <dd>deprecated term, see separate alpha</dd>
+
+    <dt><a name='premultiplied_alpha' href='#premultiplied_alpha'>Premultiplied alpha</a></dt>
+    <dd>deprecated term, see associated alpha</dd>
+
+    <dt><a name='separate_alpha' href='#separate_alpha'>Separate alpha</a></dt>
+    <dd>This representation of pixels has alpha as a fully separate component,
+that can be adjusted without affecting the color.
+Babl uses <a href='SymmetricAlpha'>Symmetric alpha transformations</a> between separate and <a href='#associated_alpha'>associated alpha</a>.</dd>
+
+    <dt><a name='trc' href='#trc'>TRC</a></dt>
+
+  </dl>
+
+  <a href='graphics/index.html'><img class='BablFish' alt='/babl' title='babl' src='graphics/babl-48x48.png'/></a>
+  </div>
+  </div>
+
+    <div class='graphic'>
+      <div class='print'>
+        <img src='graphics/babl-a4poster.png' alt=' '/>
+      </div>
+    </div>
+
+  </body>
+</html>
diff --git a/docs/Makefile.am b/docs/Makefile.am
index 26cb442..0d9266e 100644
--- a/docs/Makefile.am
+++ b/docs/Makefile.am
@@ -15,6 +15,7 @@ DIST_SUBDIRS= graphics
 HTML_FILES = index-static.html 	\
 	     index.html		\
 	     CMYK.html		\
+	     Glossary.html	\
 	     ColorManagement.html \
 	     SymmetricAlpha.html \
 	     Reference.html
@@ -27,6 +28,7 @@ EXTRA_DIST= 			\
 	ColorManagement-static.html	\
 	Reference-static.html	\
 	CMYK-static.html	\
+	Glossary-static.html	\
 	SymmetricAlpha-static.html	\
 	COPYING			\
 	toc			\
@@ -52,6 +54,13 @@ CMYK.html: CMYK-static.html toc
 	$(SHELL) $(top_srcdir)/docs/tools/xml_insert.sh $@ TOC $(top_srcdir)/docs/toc
 	echo " [OK]"
 
+
+Glossary.html: Glossary-static.html toc
+	echo -n "HTML: $@"
+	cp $< $@ 
+	$(SHELL) $(top_srcdir)/docs/tools/xml_insert.sh $@ TOC $(top_srcdir)/docs/toc
+	echo " [OK]"
+
 ColorManagement.html: ColorManagement-static.html toc
 	echo -n "HTML: $@"
 	cp $< $@ 
diff --git a/docs/Reference-static.html b/docs/Reference-static.html
index 34b7b8c..e1c8dd9 100644
--- a/docs/Reference-static.html
+++ b/docs/Reference-static.html
@@ -6,7 +6,7 @@
 -->
 <html>
   <head>
-    <title>babl-0.1.67</title>
+    <title>babl</title>
     <meta http-equiv="content-type" content="text/html;charset=utf-8" />
 
     <link rel="icon" href="graphics/babl-16x16.png" type="image/png" />
@@ -94,7 +94,7 @@
       </li>
     </ul>-->
 
-        <a href='graphics/index.html'><img class='BablFish' alt='/babl-0.1.67' title='babl-0.1.67' src='graphics/babl-48x48.png'/></a>
+        <a href='graphics/index.html'><img class='BablFish' alt='/babl' title='babl' src='graphics/babl-48x48.png'/></a>
       </div>
     </div>
     <div class='graphic'>
diff --git a/docs/SymmetricAlpha-static.html b/docs/SymmetricAlpha-static.html
index 4aca2d3..395c3e3 100644
--- a/docs/SymmetricAlpha-static.html
+++ b/docs/SymmetricAlpha-static.html
@@ -88,7 +88,7 @@ associated_to_separate_rgba (const float *associated_rgba,
 
 
 
-  <a href='graphics/index.html'><img class='BablFish' alt='/babl-0.1.67' title='babl-0.1.67' src='graphics/babl-48x48.png'/></a>
+  <a href='graphics/index.html'><img class='BablFish' alt='/babl' title='babl' src='graphics/babl-48x48.png'/></a>
   </div>
   </div>
 
diff --git a/docs/SymmetricAlpha.html b/docs/SymmetricAlpha.html
index df667c8..838b5cc 100644
--- a/docs/SymmetricAlpha.html
+++ b/docs/SymmetricAlpha.html
@@ -29,12 +29,13 @@
       <ul>
         <li><a href='index.html#Download'>&nbsp;&nbsp;Download</a></li>
         <li><a href='index.html#Features'>&nbsp;&nbsp;Features</a></li>
+        <li><a href='Reference.html'>&nbsp;&nbsp;Reference</a></li>
+        <li><a href='Glossary.html'>&nbsp;&nbsp;Glossary</a></li>
         <li><a href='ColorManagement.html'>&nbsp;&nbsp;Color Management</a></li>
         <li><a href='SymmetricAlpha.html'>&nbsp;&nbsp;Symmetric-Alpha</a></li>
         <li><a href='CMYK.html'>&nbsp;&nbsp;CMYK</a></li>
         <!--<li><a href='#Background'>Background</a></li>-->
         <li><a href='index.html#Usage'>&nbsp;&nbsp;Usage</a></li>
-        <li><a href='Reference.html'>&nbsp;&nbsp;Reference</a></li>
         <!--<li><a href='index.html#Data-types'>&nbsp;&nbsp;&nbsp;&nbsp;Data types</a></li>
         <li><a href='index.html#Color-models'>&nbsp;&nbsp;&nbsp;&nbsp;Color models</a></li>
         <li><a href='#Pixel-formats'>&nbsp;&nbsp;&nbsp;&nbsp;Pixel formats</a></li>-->
@@ -114,7 +115,7 @@ associated_to_separate_rgba (const float *associated_rgba,
 
 
 
-  <a href='graphics/index.html'><img class='BablFish' alt='/babl-0.1.67' title='babl-0.1.67' src='graphics/babl-48x48.png'/></a>
+  <a href='graphics/index.html'><img class='BablFish' alt='/babl' title='babl' src='graphics/babl-48x48.png'/></a>
   </div>
   </div>
 
diff --git a/docs/meson.build b/docs/meson.build
index 7dba677..ac2b3c4 100644
--- a/docs/meson.build
+++ b/docs/meson.build
@@ -85,6 +85,22 @@ CMYK_html = custom_target('CMYK.html',
   build_by_default: true,
 )
 
+
+Glossary_html = custom_target('Glossary.html',
+  input : [
+    'Glossary-static.html',
+    'toc',
+  ],
+  output: [ 'Glossary.html', ],
+  command: [
+    env_bin,
+    'cp', '@INPUT0@', '@OUTPUT@',
+    '&&', xml_insert, '@OUTPUT@', 'TOC', '@INPUT1@',
+  ],
+  build_by_default: true,
+)
+
+
 ColorManagement_html = custom_target('ColorManagement.html',
   input : [
     'ColorManagement-static.html',
diff --git a/docs/toc b/docs/toc
index 1a5cb4f..ec3685a 100644
--- a/docs/toc
+++ b/docs/toc
@@ -5,12 +5,13 @@
       <ul>
         <li><a href='index.html#Download'>&nbsp;&nbsp;Download</a></li>
         <li><a href='index.html#Features'>&nbsp;&nbsp;Features</a></li>
+        <li><a href='Reference.html'>&nbsp;&nbsp;Reference</a></li>
+        <li><a href='Glossary.html'>&nbsp;&nbsp;Glossary</a></li>
         <li><a href='ColorManagement.html'>&nbsp;&nbsp;Color Management</a></li>
         <li><a href='SymmetricAlpha.html'>&nbsp;&nbsp;Symmetric-Alpha</a></li>
         <li><a href='CMYK.html'>&nbsp;&nbsp;CMYK</a></li>
         <!--<li><a href='#Background'>Background</a></li>-->
         <li><a href='index.html#Usage'>&nbsp;&nbsp;Usage</a></li>
-        <li><a href='Reference.html'>&nbsp;&nbsp;Reference</a></li>
         <!--<li><a href='index.html#Data-types'>&nbsp;&nbsp;&nbsp;&nbsp;Data types</a></li>
         <li><a href='index.html#Color-models'>&nbsp;&nbsp;&nbsp;&nbsp;Color models</a></li>
         <li><a href='#Pixel-formats'>&nbsp;&nbsp;&nbsp;&nbsp;Pixel formats</a></li>-->