[Yake-svn] SF.net SVN: yake: [1644] trunk/yake/documentation/manual
Status: Beta
Brought to you by:
psyclonist
Menu
▾
▴
[Yake-svn] SF.net SVN: yake: [1644] trunk/yake/documentation/manual
|
From: <psy...@us...> - 2007-03-15 15:30:19
|
Revision: 1644
http://svn.sourceforge.net/yake/?rev=1644&view=rev
Author: psyclonist
Date: 2007-03-15 08:30:15 -0700 (Thu, 15 Mar 2007)
Log Message:
-----------
updated manual (and .css)
Modified Paths:
--------------
trunk/yake/documentation/manual/yake-manual.css
trunk/yake/documentation/manual/yake-manual.txt
Modified: trunk/yake/documentation/manual/yake-manual.css
===================================================================
--- trunk/yake/documentation/manual/yake-manual.css 2007-03-15 15:29:58 UTC (rev 1643)
+++ trunk/yake/documentation/manual/yake-manual.css 2007-03-15 15:30:15 UTC (rev 1644)
@@ -124,11 +124,20 @@
margin-left:0%;
}
-/** Ordered lists. */
+/** Ordered lists */
div.orderedlist ol li p
{
margin: 0%;
}
+/** Itemized lists: */
+div.itemizedlist ul li p
+{
+ margin: 0%;
+}
+div.itemizedlist li
+{
+ margin-left: 2.5%; /** Reduce intendation from 5% */
+}
/** "List of tables" (right below "Table of contents") */
div.list-of-tables
@@ -171,6 +180,7 @@
div.informaltable table
{
+ width: 90%;
margin-left: 5%; /* align with paragraph text */
margin-right: 5%;
border: 1px solid gray;
@@ -194,6 +204,7 @@
border: 1px solid gray;
margin: 0;
/*padding: 0;*/
+ vertical-align: top;
}
/*--------- Tables in <section>s ----------------*/
Modified: trunk/yake/documentation/manual/yake-manual.txt
===================================================================
--- trunk/yake/documentation/manual/yake-manual.txt 2007-03-15 15:29:58 UTC (rev 1643)
+++ trunk/yake/documentation/manual/yake-manual.txt 2007-03-15 15:30:15 UTC (rev 1644)
@@ -261,6 +261,99 @@
and concepts. The latter introduce new functionality, possibly based on the other
libraries.
+List of libraries
+-----------------
+
+.. note::
+
+ The headers and sources of the libraries can be found in the correspondingly
+ named directories in ``yake/`` (headers) and ``src/`` (implementation) in
+ the Yake installation directory.
+
+Core library:
+
++--------------------+------------------------------------------------------------+
+| Library | Functionality |
++====================+============================================================+
+| base | types, containers, other templates, basic OS abstraction, |
+| | math, ... |
++--------------------+------------------------------------------------------------+
+
+Abstraction and extension libraries:
+
++--------------------+------------------------------------------------------------+
+| Library | Functionality |
++====================+============================================================+
+| base | Types, containers, other templates, basic OS abstraction, |
+| | math, ... |
++--------------------+------------------------------------------------------------+
+| data | abstract DOM model with XML backend |
++--------------------+------------------------------------------------------------+
+| graphics | graphics interface abstraction |
++--------------------+------------------------------------------------------------+
+| physics | * physics interface abstraction |
+| | * extended functionality like body affectors |
++--------------------+------------------------------------------------------------+
+| audio | interface abstraction for 3d audio |
++--------------------+------------------------------------------------------------+
+| scripting | basic scripting interface abstraction (VMs) |
++--------------------+------------------------------------------------------------+
+| input | * input interface abstraction |
+| | * data-driven action maps |
++--------------------+------------------------------------------------------------+
+
+Generic libraries:
+
++--------------------+------------------------------------------------------------+
+| Library | Functionality |
++====================+============================================================+
+| object | generic object and class id management |
++--------------------+------------------------------------------------------------+
+| msg | generic message posting / handling / subscription |
++--------------------+------------------------------------------------------------+
+
+Other libraries:
+
++--------------------+------------------------------------------------------------+
+| Library | Functionality |
++====================+============================================================+
+| ent | high-level objects (aka "entity") with properties, |
+| | events, scripting machines and more |
++--------------------+------------------------------------------------------------+
+| net | networking library: |
+| | |
+| | * packet connections |
+| | * event connections |
++--------------------+------------------------------------------------------------+
+| netsvc | network services: |
+| | |
+| | * service concept |
+| | * built-in services (client+server) |
+| | |
+| | - time synchronization |
+| | - communication / chat |
++--------------------+------------------------------------------------------------+
+| netrepsvc | object and value replication service |
++--------------------+------------------------------------------------------------+
+| model | implements model and submodel concept as well as model |
+| | links and model link loaders (from XML description) |
++--------------------+------------------------------------------------------------+
+| loader | various format parsers (dotModel, dotLink, dotScene ...) |
++--------------------+------------------------------------------------------------+
+| vehicle | library for generation of complex vehicles: |
+| | |
+| | * generic vehicle components: wheels, axles, thrusters ... |
+| | * customizable components |
+| | * data-driven vehicle design possible (dotVehicle) |
++--------------------+------------------------------------------------------------+
+| task | task management (may become generic library in the future) |
++--------------------+------------------------------------------------------------+
+| bindings.lua | Lua language bindings for Yake libraries |
++--------------------+------------------------------------------------------------+
+| raf | Application framework for Yake based applications |
++--------------------+------------------------------------------------------------+
+
+
base
----
@@ -308,15 +401,25 @@
file = create<File>("ftp"); // OK
file = create<File>("funky"); // FAILS as "funky" is not a registered with the factory's registry.
-::
-**TODO**
-* synopsis + basic example => OK
-* number of parameters for create<>(..)
-* boost::function for binding non-free functions and other function objects
-* other interesting uses
-* customizing the error handling policy
-* best practices + useful macros
+TODO::
+
+ * synopsis + basic example => OK
+ * number of parameters for create<>(..)
+
+ // specify signature for creation function:
+ Factory<String, FilePtr, FilePtr(*)(const String&)> fileFactory;
+ fileFactory.reg(...); // register product creators
+
+ FilePtr file = create<File>("native","/path/to/file.txt"); // OK
+ file = create<File>("ftp","ftp://my-server.tld/file.txt"); // OK
+ file = create<File>("ftp"); // FAILS expectedly as creator expects an argument.
+
+ * boost::function for binding non-free functions and other function objects
+ * other interesting uses
+ * customizing the error handling policy
+ * best practices + useful macros
+
Abstraction and extension layers
================================
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
|
