Enlightenment CVS committal
Author : dj2
Project : e17
Module : docs
Dir : e17/docs/cookbook/xml
Modified Files:
bookinfo.xml ecore_recipes.xml edb_eet_recipes.xml
edje_recipes.xml esmart_recipes.xml etox_recipes.xml
evas_recipes.xml imlib_recipes.xml intro.xml
Log Message:
- take the intro text off of the website and put it into the cookbook to
add a bit of meat to each section
===================================================================
RCS file: /cvsroot/enlightenment/e17/docs/cookbook/xml/bookinfo.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -3 -r1.1 -r1.2
--- bookinfo.xml 21 Feb 2004 07:45:56 -0000 1.1
+++ bookinfo.xml 2 Jul 2004 18:12:38 -0000 1.2
@@ -1,38 +1,35 @@
<bookinfo>
-
-<title>The EFL Cookbook</title>
-
-<authorgroup>
- <author>
- <surname>Various</surname>
+ <title>The EFL Cookbook</title>
+ <authorgroup>
+ <author>
+ <surname>Various</surname>
</author>
<editor>
- <firstname>Ben</firstname>
- <surname>Rockwood</surname>
- <othername>technikolor</othername>
- <affiliation>
- <orgname>The Enlightenment Project</orgname>
- <address> <email>[EMAIL PROTECTED]</email> </address>
- </affiliation>
+ <firstname>Ben</firstname>
+ <surname>Rockwood</surname>
+ <othername>technikolor</othername>
+ <affiliation>
+ <orgname>The Enlightenment Project</orgname>
+ <address> <email>[EMAIL PROTECTED]</email> </address>
+ </affiliation>
</editor>
-</authorgroup>
-
- <revhistory>
+ </authorgroup>
- <revision>
- <revnumber>v0.1</revnumber>
- <date>Feb 20th, 2004</date>
- <authorinitials>br</authorinitials>
- <revremark>Initial document</revremark>
- </revision>
-
- </revhistory>
+ <revhistory>
+ <revision>
+ <revnumber>v0.1</revnumber>
+ <date>Feb 20th, 2004</date>
+ <authorinitials>br</authorinitials>
+ <revremark>Initial document</revremark>
+ </revision>
+ </revhistory>
+
+ <abstract>
+ <para>
+ Stuff.
+ </para>
+ </abstract>
+</bookinfo>
- <abstract>
- <para>
- Stuff.
- </para>
- </abstract>
-</bookinfo>
===================================================================
RCS file: /cvsroot/enlightenment/e17/docs/cookbook/xml/ecore_recipes.xml,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -3 -r1.5 -r1.6
--- ecore_recipes.xml 15 Jun 2004 05:16:15 -0000 1.5
+++ ecore_recipes.xml 2 Jul 2004 18:12:38 -0000 1.6
@@ -41,9 +41,51 @@
<title>Ecore</title>
<para>
-Ecore provides a powerful event handling and modularized abstraction layer which
-ties and bind your applications various components together in a nearly seemless
-manner.
+What is Ecore? Ecore is the core event abstraction layer and X abstraction
+layer that makes doing selections, Xdnd, general X stuff, and event loops,
+timeouts and idle handlers fast, optimized, and convenient. It's a
+separate library so anyone can make use of the work put into Ecore to
+make this job easy for applications.
+</para>
+
+<para>
+Ecore is completely modular. At its base is the event handlers and
+timers, and initialization and shutdown functions. The abstraction
+modules for Ecore include:
+</para>
+
+<itemizedlist mark='bullet'>
+ <listitem>
+ Ecore X
+ </listitem>
+ <listitem>
+ Ecore FB
+ </listitem>
+ <listitem>
+ Ecore EVAS
+ </listitem>
+ <listitem>
+ Ecore TXT
+ </listitem>
+ <listitem>
+ Ecore Job
+ </listitem>
+ <listitem>
+ Ecore IPC
+ </listitem>
+ <listitem>
+ Ecore Con
+ </listitem>
+ <listitem>
+ Ecore Config
+ </listitem>
+</itemizedlist>
+
+<para>
+Ecore is so modular and powerful that it can be extremely useful even
+in non-graphics programing by itself. As an example, several web servers
+have been written that were based solely on Ecore and the Ecore_Con module
+for abstract socket communication.
</para>
<!--
@@ -57,6 +99,7 @@
<firstname>dan</firstname>
<surname>sinclair</surname>
<email>[EMAIL PROTECTED]</email>
+ <othername>dj2</othername>
</author>
<date>25 April 2004</date>
</sectioninfo>
@@ -176,6 +219,7 @@
<firstname>dan</firstname>
<surname>sinclair</surname>
<email>[EMAIL PROTECTED]</email>
+ <othername>dj2</othername>
</author>
<date>14 June 2004</date>
</sectioninfo>
===================================================================
RCS file: /cvsroot/enlightenment/e17/docs/cookbook/xml/edb_eet_recipes.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -3 -r1.1 -r1.2
--- edb_eet_recipes.xml 21 Feb 2004 07:45:56 -0000 1.1
+++ edb_eet_recipes.xml 2 Jul 2004 18:12:38 -0000 1.2
@@ -41,8 +41,51 @@
<title>EDB & EET</title>
<para>
-The libs.
+EDB is a database convenience library wrapped around the Berkeley DB 2.7.7 by
+Sleepycat Software. It is intended to make accessing database information portable,
+easy, fast and efficient.
</para>
+<para>
+EET is a tiny library designed to write arbitary chunks of data to a file and
+optionally compress each chunk (very much like a zip file) and allows for fast
+random-access reading of the file later on. It does not do zip as a zip itself
+has more complexity than is needed, and it was much simpler to impliment this once
here.
+</para>
+
+<para>
+EDB provides an excellent method of storing and retrieving application configuration
+information, although it can be used for more extensively than that.
+Ebits, the predecessor to Edje, even used EDB as a container for Ebits themes
+prior to EET. An Edb consists of a series of key/value pairs, which can consist of a
+variety of data types, including integers, floating point values, strings, and binary
+data. The simplified API provides simple, complete, and unified functions for
managing
+and accessing your database.
+</para>
+
+<para>
+In addition to the library, a variety of tools are available to access and
+modify your EDBs. The edb_ed tool provides a simple command line interface that can
+easily be scripted, especially useful for use with the GNU autotools suite. The
edb_vt_ed
+tool provides an easy to use curses interface. Finally, edb_gtk_ed provides an
elegant
+and easy GUI interface, especially useful for end user editing of configuration
+data contained in EDBs.
+</para>
+
+<para>
+Eet is extremely fast, small and simple. Eet files can be very small and highly
+compressed, making them very optimal for just sending across the internet without
+having to archive, compress or decompress and install them. They allow for
+lightning-fast random-acess reads once created, making them perfect for storing
+data that is written once (or rarely) and read many times, but the program does
+not want to have to read it all in at once.
+</para>
+
+<para>
+It also can encode and decode data structures in memory, as well as image data for
+saving to Eet files or sending across the network to other machines, or just writing
+to arbitary files on the system. All data is encoded in a platform independant way
+and can be written and read by any architecture.
+</para>
</chapter>
===================================================================
RCS file: /cvsroot/enlightenment/e17/docs/cookbook/xml/edje_recipes.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -3 -r1.1 -r1.2
--- edje_recipes.xml 21 Feb 2004 07:45:56 -0000 1.1
+++ edje_recipes.xml 2 Jul 2004 18:12:38 -0000 1.2
@@ -44,5 +44,46 @@
Edje is a complex graphical design and layout library.
</para>
+<para>
+It's purpose is to be a sequel to "Ebits" which to date has serviced the needs of
+Enlightenment development for version 0.17. The original design paramteres under
+which Ebits came about were a lot more restricted than the resulting use of
+them, thus Edje was born.
+</para>
+
+<para>
+Edje is a more complex layout engine compared to Ebits. It doesn't pretend to do
+containering and regular layout like a widget set. It still inherits the more
simplistic
+layout ideas behind Ebits, but it now does them a lot more cleanly, allowing for easy
+expansion, and the ability to cover much more ground than Ebits ever could. For the
+purposes of Enlightenment 0.17, Edje should serve all the purposes of creating visual
+elements (borders of windows, scrollbars, etc.) and allow the designer the ability to
+animate, layout and control the look and feel of any program using Edje as its basic
+GUI constructor. This library allows for multiple collections of Layouts in one file,
+sharing the same image database and thus allowing a whole theme to be conveneintly
+packaged into one file and shipped around.
+</para>
+
+<para>
+Edje, unlike Ebits, separates the layout and behavior logic. Edje files ship with an
+image database, used by all the parts in all the collections to source graphical
data.
+It has a directory of logical part names pointing to the part collection entry ID in
the
+file (thus allowing for multiple logical names to point to the same part collection,
+allowing for the sharing of data between display elements). Each part collection
consists
+of a list of visual parts, as well as a list of programs. A program is a
conditionally run
+program that if a particular event occurs (a button is pressed, a mouse enters or
leaves
+a part) will trigger an action that may affect other parts. In this way a part
collection
+can be "programmed" via its file so as to hilight buttons when the mouse passes over
them
+or show hidden parts when a button is clicked somewhere. The actions performed in
changing
+from one state to another are also allowed to transition over a period of time,
allowing animation.
+</para>
+
+<para>
+This separation and simplistic event driven style of programming can produce almost
any look
+and feel one could want for basic visual elements. Anything more complex is likely
+the domain of an application or widget set that may use Edje as a conveneient way of
+being able to configure parts of the display.
+</para>
</chapter>
+
===================================================================
RCS file: /cvsroot/enlightenment/e17/docs/cookbook/xml/esmart_recipes.xml,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -3 -r1.4 -r1.5
--- esmart_recipes.xml 7 May 2004 00:41:18 -0000 1.4
+++ esmart_recipes.xml 2 Jul 2004 18:12:38 -0000 1.5
@@ -56,6 +56,7 @@
<firstname>dan</firstname>
<surname>sinclair</surname>
<email>[EMAIL PROTECTED]</email>
+ <othername>dj2</othername>
</author>
<date>25 April 2004</date>
</sectioninfo>
@@ -329,6 +330,7 @@
<firstname>dan</firstname>
<surname>sinclair</surname>
<email>[EMAIL PROTECTED]</email>
+ <othername>dj2</othername>
</author>
<date>30 April 2004</date>
</sectioninfo>
===================================================================
RCS file: /cvsroot/enlightenment/e17/docs/cookbook/xml/etox_recipes.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -3 -r1.1 -r1.2
--- etox_recipes.xml 30 Jun 2004 17:44:48 -0000 1.1
+++ etox_recipes.xml 2 Jul 2004 18:12:38 -0000 1.2
@@ -41,10 +41,10 @@
<title>Etox</title>
<para>
-Etox provides a power library for manipulation and layout of text in your
-EVAS/EFL application, which Estyle provides a veritile text stylization
-library and toolset that can be used with or without Etox.
+Etox is a type setting and text layout library based on Evas. Etox helps you when
+it comes to displaying, moving, resizing, layering, clipping, aligning and
+coloring fonts in different styles, and more.
</para>
-
</chapter>
+
===================================================================
RCS file: /cvsroot/enlightenment/e17/docs/cookbook/xml/evas_recipes.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -3 -r1.1 -r1.2
--- evas_recipes.xml 21 Feb 2004 07:45:56 -0000 1.1
+++ evas_recipes.xml 2 Jul 2004 18:12:38 -0000 1.2
@@ -41,16 +41,24 @@
<title>EVAS</title>
<para>
-Evas is a hardware-accelerated canvas API for X-Windows that can draw anti-aliased
text, smooth super and sub-sampled images, alpha-blend, as well as drop down to using
normal X11 primitives such as pixmaps, lines and rectangles for speed if your CPU or
graphics hardware are too slow.
+Evas is a hardware-accelerated canvas API for X-Windows that can draw anti-aliased
text,
+smooth super and sub-sampled images, alpha-blend, as well as drop down to using
normal
+X11 primitives such as pixmaps, lines and rectangles for speed if your CPU or
graphics
+hardware are too slow.
</para>
<para>
-Evas abstracts any need to know much about what the characteristics of your XServer's
display are, what depth or what magic visuals etc, it has. The most you need to tell
Evas is how many colors (at a maximum) to use if the display is not a truecolor
display. By default it is suggested to use 216 colors (as this equates to a 6x6x6
color cube - exactly the same color cube Netscape, Mozilla, gdkrgb etc. use so colors
will be shared). If Evas can't allocate enough colors it keeps reducing the size of
the color cube until it reaches plain black and white. This way, it can display on
anything from a black and white only terminal to 16 color VGA to 256 color and all the
way up through 15, 16, 24 and 32bit color. Here are some screen shots of a demo Evas
application to show the rendering output in different situations
+Evas abstracts any need to know much about the characteristics of your XServer's
+display, what depth or what magic visuals, it has. The most you need to tell Evas is
+how many colors (at a maximum) to use if the display is not a truecolor display.
+By default it is suggested to use 216 colors (as this equates to a 6x6x6 color cube -
+exactly the same color cube Netscape, Mozilla, gdkrgb etc. use so colors will be
shared).
+If Evas can't allocate enough colors it keeps reducing the size of the color cube
until
+it reaches plain black and white. This way, it can display on anything from a black
+and white only terminal to 16 color VGA to 256 color and all the way up through
+15, 16, 24 and 32bit color.
</para>
-
-
-
<section>
<sectioninfo>
<firstname>Norman</firstname>
@@ -65,7 +73,5 @@
</section>
-
-
-
</chapter>
+
===================================================================
RCS file: /cvsroot/enlightenment/e17/docs/cookbook/xml/imlib_recipes.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -3 -r1.1 -r1.2
--- imlib_recipes.xml 21 Feb 2004 07:45:56 -0000 1.1
+++ imlib_recipes.xml 2 Jul 2004 18:12:38 -0000 1.2
@@ -41,8 +41,55 @@
<title>Imlib2</title>
<para>
-Imlib2 provides a powerful engine for image manipulation and rendering.
+Imlib2 is the successor to Imlib. It is not just a newer version - it is a completely
+new library. Imlib2 can be installed alongside Imlib 1.x without any problems since
+they are effectively different libraries - but they Have very similar functionality.
</para>
+<para>
+Imlib2 can do the following:
+</para>
+
+<itemizedlist mark='bullet'>
+ <listitem>Load image files from disk in one of many formats</listitem>
+ <listitem>Save images to disk in one of many formats</listitem>
+ <listitem>Render image data onto other images</listitem>
+ <listitem>Render images to an X-Windows drawable</listitem>
+ <listitem>Produce pixmaps and pixmap masks of Images</listitem>
+ <listitem>Apply filters to images</listitem>
+ <listitem>Rotate images</listitem>
+ <listitem>Accept RGBA Data for images</listitem>
+ <listitem>Scale images</listitem>
+ <listitem>Alpha blend Images on other images or drawables</listitem>
+ <listitem>Apply color correction and modification tables and factors to
images</listitem>
+ <listitem>Render images onto images with color correction and modification
tables</listitem>
+ <listitem>Render truetype anti-aliased text</listitem>
+ <listitem>Render truetype anti-aliased text at any angle</listitem>
+ <listitem>Render anti-aliased lines</listitem>
+ <listitem>Render rectangles</listitem>
+ <listitem>Render linear multi-colored gradients</listitem>
+ <listitem>Cache data intelligently for maximum performance</listitem>
+ <listitem>Allocate colors automatically</listitem>
+ <listitem>Allow full control over caching and color allocation</listitem>
+ <listitem>Provide highly optimized MMX assembly for core routines</listitem>
+ <listitem>Provide plug-in filter interface</listitem>
+ <listitem>Provide on-the-fly runtime plug-in image loading and saving
interface</listitem>
+ <listitem>Fastest image compositing, rendering and manipulation library for
X</listitem>
+</itemizedlist>
+
+<para>
+If what you want isn't in the list above somewhere then likely Imlib2 does not do it.
+If it does, it likely does it faster than any other library you can find (this
includes
+gdk-pixbuf, gdkrgb, etc.) primarily because of highly optimized code and a smart
subsystem
+that does the dirty work for you and picks up the pieces for you so you can be lazy
and
+let Imlib2 do all the optimizations for you.
+</para>
+
+<para>
+Imlib2 can run without a display, so it can be easily used for background image
+processing for web sites or servers - it only requires the X libraries to be
installed
+- that is all - it does not require an XServer to run unless you wish to display
images.
+</para>
</chapter>
+
===================================================================
RCS file: /cvsroot/enlightenment/e17/docs/cookbook/xml/intro.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -3 -r1.1 -r1.2
--- intro.xml 21 Feb 2004 07:45:56 -0000 1.1
+++ intro.xml 2 Jul 2004 18:12:38 -0000 1.2
@@ -1,14 +1,23 @@
<chapter>
-<title>Introduction</title>
+ <title>Introduction</title>
-<para>
-This book.......
-</para>
-
-
-<para>
-More intro.
-</para>
+ <para>
+ With the decision to re-write Enlightenment for DR17, came the decision to build
+ a support infrastructure that could support Enlightenment well into the future
+ and other projects needing a solid base of libraries. This formed the basis
+ of the Enlightenment Foundation Libraries (EFL).
+ </para>
+
+ <para>
+ The EFL has grown to encompass many of the features required by the window manager
development
+ and many of the applications that will be run on top of that WM. There are currently
+ libraries to handle transparency, configuration, video, core event loops, and
interface
+ abstraction.
+ </para>
+
+ <para>
+ This book is an attempt to be your road map through this foundation.
+ </para>
</chapter>
-------------------------------------------------------
This SF.Net email sponsored by Black Hat Briefings & Training.
Attend Black Hat Briefings & Training, Las Vegas July 24-29 -
digital self defense, top technical experts, no vendor pitches,
unmatched networking opportunities. Visit www.blackhat.com
_______________________________________________
enlightenment-cvs mailing list
[EMAIL PROTECTED]
https://lists.sourceforge.net/lists/listinfo/enlightenment-cvs
