Enlightenment CVS committal
Author : dj2
Project : e17
Module : docs
Dir : e17/docs/cookbook
Modified Files:
README eflcookbook.xml
Log Message:
- move the recipies out into their individual files for easier maintenance
- remove the example from the top of every file as there is one in the README
- fixup the README to explain how to add recipies with the new directories.
===================================================================
RCS file: /cvsroot/enlightenment/e17/docs/cookbook/README,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -3 -r1.1 -r1.2
--- README 21 Feb 2004 07:45:56 -0000 1.1
+++ README 2 Jul 2004 22:17:44 -0000 1.2
@@ -13,7 +13,7 @@
as the popular O'Reilly cookbooks (example: http://cookbooks.oreilly.com/).
Any is free to contribute to this document, and as such is a perpetual
work-in-progress. The document is split into chapters, each covering
-a diffrent componant, or set of componants, that make up the collective
+a different component, or set of components, that make up the collective
EFL.
@@ -25,7 +25,7 @@
recipe is in the form of a problem (or task) and solution.
The key to a good recipe, just as a cooking recipe, is to be complete.
Whenever possible or practical you should include complete code
-examples, from the pre-proccessor directives (#include...) to the final
+examples, from the pre-processor directives (#include...) to the final
closing bracket, so that inexperienced or new coders aren't confused
by where your code snippet goes.
[ More here ]
@@ -40,9 +40,8 @@
important thing is to concentrate on the content.
In the xml/ directory are several XML files, which
-are individual chapters of the document. There is a commented
-out example of how to add a recipe in each file, but lets review
-the basics of DocBook/XML...
+are individual chapters of the document. There is an example
+of how to add a recipe below, but lets review the basics of DocBook/XML...
DocBook comes in a variety of flavors, including SGML
and XML. We're using XML, which if your new to XML in general, looks
@@ -50,8 +49,8 @@
each tag, there is no tag in XML which can stand alone without being
closed, so everything is done in open/close pairs. A <book> is made up
of <chapter>s which are made up of <para>graphs and <section>s, which are
-themeselves made up of <para>graphs. Each <section> and <chapter>
-can be given a <title>. Like HTML, certain charrectors are special
+themselves made up of <para>graphs. Each <section> and <chapter>
+can be given a <title>. Like HTML, certain characters are special
and can not be used literally, so the "&" symbol becomes "&", the
"<" symbol becomes "<", and the ">" symbol becomes ">".
@@ -60,14 +59,14 @@
<programlisting>, which works similarly to the HTML <pre> tag
to maintain program indentation, etc. <figure>s and <example>s are
special because they can have <title>s which are listed in figure index
-in the begining of the book. <figure>s can also include <graphic>s
+in the beginning of the book. <figure>s can also include <graphic>s
for screenshots. In the img/ directory you can place your graphics
to be included. Remember that because files in the xml/ directory
are included into the main DocBook/XML document in the root directory
-before being rendered that your refereances to images should
+before being rendered that your references to images should
be in the form "img/my_shot.png", not "../img/my_shot.png".
SVG, JPEG, PNG and other formats can be used in DocBook/XML, but
-for portablity purposes it is recommended that you confine yourself
+for portability purposes it is recommended that you confine yourself
to using PNG.
The framework of the document is in place, therefore
@@ -77,13 +76,43 @@
recipe. There should be 1 new section per recipe. Sub-sections
for a recipe can be used, but are discouraged.
+ Each individual section is written in a separate file to
+allow easier maintenance of the book. Each of these files resides
+in a directory related to the chapter in reference. So all ecore
+sections are in the ecore directory.
+
+ An individual section has a format as seen below. Once the section
+is written an entry needs to be made into the chapter xml file and
+an entry into the eflcookbook.xml file.
+
+ Into the eflcookbook.xml file you will need to add something
+like:
+
+ <!ENTITY ecore_ipc_intro SYSTEM "xml/ecore/ecore_ipc_intro.xml">
+
+This sets up an XML entity reference to your section. Then into the
+chapter file you will add an entry like:
+
+ &ecore_ipc_intro;
+
+Where you want the section to appear. The value is the 2nd parameter
+to the ENTITY tag above.
+
The following is an example of what you would add:
--------------------------------------------------------------------
<section>
+<sectioninfo>
+ <author>
+ <firstname>Ben</firstname>
+ <lastname>Rockwood</lastname>
+ <email>[EMAIL PROTECTED]</email>
+ </author>
+ <data>2 July 2004</data>
+</sectioninfo>
+
<title>Recipe: Simple Drag-N-Drop</title>
<!-- This is a DocBook/XML comment -->
-<!-- Recipe added by: Ben Rockwood -->
<para>
This is the first paragraph of the recipe about
@@ -111,7 +140,7 @@
</para>
<figure>
-<title>An illistration or screenshot </title>
+<title>An illustration or screenshot </title>
<graphic format='PNG' align='center' fileref='img/my_image.png' />
</figure>
@@ -132,17 +161,16 @@
--------------------------------------------------------------------
You can use as many <para>graphs as you need, and line breaks in the XML
-source, like XML, are unimportant. The only place your indentation/line-breaks
+source, like HTML, are unimportant. The only place your indentation/line-breaks
will matter is within the <programlisting> or <screen> tags. I'll point out
putting a slash at the end of a tag will close it at the same time, so
<para /> is functionally the same as <para></para>, as you see in the
<graphic>s tag above.
Thats it! Pretty simple. At least 90% of your recipe will
-be in <para>'s, and for the rest just follow the examples in each file,
-or refer back here. Don't bother trying to get fancy with your syntax;
-simplicity is best. Just remember to make sure you close all your tags,
-and you'll do fine.
+be in <para>'s, and for the rest just follow the example above.
+Don't bother trying to get fancy with your syntax; simplicity is best.
+Just remember to make sure you close all your tags, and you'll do fine.
@@ -166,7 +194,7 @@
http://docbook.org/xml/index.html
Install each of the above and modify the Makefile as needed to
-fit your enviroment. Gentoo installs of the XSL and DTDs are possbile, but
+fit your environment. Gentoo installs of the XSL and DTDs are possible, but
personally discouraged.
!!!!!!!!!!!!!NOTE!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
===================================================================
RCS file: /cvsroot/enlightenment/e17/docs/cookbook/eflcookbook.xml,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -3 -r1.3 -r1.4
--- eflcookbook.xml 2 Jul 2004 18:12:37 -0000 1.3
+++ eflcookbook.xml 2 Jul 2004 22:17:44 -0000 1.4
@@ -1,6 +1,8 @@
<?xml version='1.0' encoding="UTF-8"?>
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.3CR1//EN"
"file:///usr/share/sgml/docbook/xml-dtd-4.3CR1/docbookx.dtd" [
+
+ <!-- This is the main book info -->
<!ENTITY bookinfo SYSTEM "xml/bookinfo.xml">
<!ENTITY intro SYSTEM "xml/intro.xml">
<!ENTITY imlib_recipes SYSTEM "xml/imlib_recipes.xml">
@@ -12,6 +14,17 @@
<!ENTITY edje_edc_recipes SYSTEM "xml/edje_edc_recipes.xml">
<!ENTITY edje_recipes SYSTEM "xml/edje_recipes.xml">
<!ENTITY ewl_recipes SYSTEM "xml/ewl_recipes.xml">
+
+ <!-- ecore -->
+ <!ENTITY ecore_config_intro SYSTEM "xml/ecore/ecore_config_intro.xml">
+ <!ENTITY ecore_ipc_intro SYSTEM "xml/ecore/ecore_ipc_intro.xml">
+
+ <!-- evas -->
+ <!ENTITY evas_key_bindings SYSTEM "xml/evas/evas_key_bindings.xml">
+
+ <!-- esmart -->
+ <!ENTITY esmart_trans_intro SYSTEM "xml/esmart/esmart_trans_intro.xml">
+ <!ENTITY esmart_container_intro SYSTEM "xml/esmart/esmart_container_intro.xml">
]>
<book>
@@ -30,3 +43,4 @@
&ewl_recipes;
</book>
+
-------------------------------------------------------
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
