[KSS-checkins] r44762 - kukit/docs/introducing_kss/trunk
jvloothuis at codespeak.net
jvloothuis at codespeak.net
Thu Jul 5 23:37:09 CEST 2007
Author: jvloothuis
Date: Thu Jul 5 23:37:09 2007
New Revision: 44762
Modified:
kukit/docs/introducing_kss/trunk/1-kss-in-general.txt
kukit/docs/introducing_kss/trunk/2-kss-on-the-zope-server.txt
kukit/docs/introducing_kss/trunk/3-shipped-kss-plugins.txt
kukit/docs/introducing_kss/trunk/4-kss-in-plone.txt
kukit/docs/introducing_kss/trunk/5-extension-with-custom-plugins.txt
Log:
Removed numbering from all headers. This can (and should) be done by
the docutils writers, not in the document itself.
Modified: kukit/docs/introducing_kss/trunk/1-kss-in-general.txt
==============================================================================
--- kukit/docs/introducing_kss/trunk/1-kss-in-general.txt (original)
+++ kukit/docs/introducing_kss/trunk/1-kss-in-general.txt Thu Jul 5 23:37:09 2007
@@ -1,9 +1,8 @@
+KSS in general
+==============
-1. KSS in general
-=================
-
-1.1 Introduction
-----------------
+Introduction
+------------
KSS is an acronym for Kinetic Style Sheets. KSS is a client side
framework for implementing rich user interfaces with AJAX
@@ -131,8 +130,8 @@
and non-Pythonic web application frameworks as well.
-1.2 Architectural overview
---------------------------
+Architectural overview
+----------------------
In this section, we provide a high level overview of KSS' system
architecture.
@@ -264,8 +263,8 @@
the accompanying command plugin.
-1.3 Syntax and semantics of the KSS resource file
--------------------------------------------------
+Syntax and semantics of the KSS resource file
+---------------------------------------------
In this section we detail what a KSS resource file contains and how to use it.
@@ -884,8 +883,8 @@
second action with the same name.
-1.4 Getting information from the DOM (parameter providers)
-----------------------------------------------------------
+Getting information from the DOM (parameter providers)
+------------------------------------------------------
Actions must be executed with parameters. Although static
parameters can be sufficient for some application, most of the
@@ -995,8 +994,8 @@
The second parameter in ``kssAttr(widgetid, True)`` tells KSS to look
further in the parents of the node, until it finds the attribute.
-1.5 Introduction to commands
-----------------------------
+Introduction to commands
+------------------------
"KSS commands" serve a very important role in a KSS application.
They enable the application to use server-side code to instruct
@@ -1088,5 +1087,3 @@
</kukit:command>
</kukit:commands>
</body></html>
-
-
Modified: kukit/docs/introducing_kss/trunk/2-kss-on-the-zope-server.txt
==============================================================================
--- kukit/docs/introducing_kss/trunk/2-kss-on-the-zope-server.txt (original)
+++ kukit/docs/introducing_kss/trunk/2-kss-on-the-zope-server.txt Thu Jul 5 23:37:09 2007
@@ -1,6 +1,5 @@
-
-2. KSS on the Zope server
-=========================
+KSS on the Zope server
+======================
In this chapter we summarize how to write the application part that runs on
the Zope server side: the server actions.
@@ -13,8 +12,8 @@
funtionality of kss. The demos are also used for automatize
functional testing with Selenium.
-2.1. Installation
------------------
+Installation
+------------
For installing KSS on the Zope server side, please refer to
the release notes of the KSS version you are using.
@@ -22,8 +21,8 @@
installing Python modules and ZCML "slugs" into your
instance.
-2.2 Providing javascript code for the client
---------------------------------------------
+Providing javascript code for the client
+----------------------------------------
First of all we need to serve the javascript code that is
necessary for our application. This is done by the
@@ -119,8 +118,8 @@
comments that helps you learn about different caching
options, in case it becomes necessarry to change them.
-2.2 Specifying stylesheets
---------------------------
+Specifying stylesheets
+----------------------
Now that we have the javascript of KSS enabled in the pages, we
can start specifying one or more KSS stylesheets. The stylesheets,
@@ -140,8 +139,8 @@
these link definitions, fetch the stylesheets from the server,
and starts processing them.
-2.3 Debugging possibilities
----------------------------
+Debugging possibilities
+-----------------------
Debuggability, as mentioned before, is a core feature of
KSS. Besides the appearance of the server side errors in the
@@ -200,8 +199,8 @@
server and not filtered (by applying necessary settings to
the error_log tool).
-2.4 The KSS command response
-----------------------------
+The KSS command response
+------------------------
In this part we will work with browser views for
implementing out server actions. According to the current
@@ -271,8 +270,8 @@
are mentioned in the method's signature (widgetid and href,
in our example) will
-2.5 How to work TTW
--------------------
+How to work TTW
+---------------
Besides the above described method that involves the usage
of Zope views to define server actions, KSS also provides a
@@ -315,8 +314,8 @@
return renderKSSCommands()
-2.6 Server side event handling
-------------------------------
+Server side event handling
+--------------------------
When we talk about server side event handling, it is
important to note that we talk about "events" in the real
Modified: kukit/docs/introducing_kss/trunk/3-shipped-kss-plugins.txt
==============================================================================
--- kukit/docs/introducing_kss/trunk/3-shipped-kss-plugins.txt (original)
+++ kukit/docs/introducing_kss/trunk/3-shipped-kss-plugins.txt Thu Jul 5 23:37:09 2007
@@ -1,7 +1,5 @@
-
-
-3. Shipped KSS plugins
-======================
+Shipped KSS plugins
+===================
KSS plugins, the ones that come with the system
@@ -15,8 +13,8 @@
have an additional selector parameter, which is not present
at "global" commands.
-3.1. The "core" plugins
------------------------
+The "core" plugins
+------------------
Namespace: "core"
@@ -651,8 +649,8 @@
Return a all nodes in the parent chain which match
the given css selector.
-3.2 The "zope" plugins
-----------------------
+The "zope" plugins
+------------------
Namespace: "zope"
@@ -670,8 +668,8 @@
selected node.
-3.3 The "plone" plugins
------------------------
+The "plone" plugins
+-------------------
Namespace: "plone"
Modified: kukit/docs/introducing_kss/trunk/4-kss-in-plone.txt
==============================================================================
--- kukit/docs/introducing_kss/trunk/4-kss-in-plone.txt (original)
+++ kukit/docs/introducing_kss/trunk/4-kss-in-plone.txt Thu Jul 5 23:37:09 2007
@@ -1,12 +1,9 @@
+KSS in Plone
+============
-
-4. KSS in Plone
-===============
-
-
-4.1 Setup of KSS in Plone
--------------------------
+Setup of KSS in Plone
+---------------------
Earlier we learned what headers are needed to be put into the
page headers for KSS. With Plone the setup is even easier, thanks
@@ -42,13 +39,13 @@
there is nothing more to do then to sit back and enjoy KSS's
functionality everywhere in the portal.
-4.2 How to kssize existing widgets
-----------------------------------
+How to kssize existing widgets
+------------------------------
XXX
-4.3 What features are implemented with KSS in Plone
----------------------------------------------------
+What features are implemented with KSS in Plone
+-----------------------------------------------
We try to give a non-exhaustive report about what features are
implemented with kss:
Modified: kukit/docs/introducing_kss/trunk/5-extension-with-custom-plugins.txt
==============================================================================
--- kukit/docs/introducing_kss/trunk/5-extension-with-custom-plugins.txt (original)
+++ kukit/docs/introducing_kss/trunk/5-extension-with-custom-plugins.txt Thu Jul 5 23:37:09 2007
@@ -1,6 +1,5 @@
-
-5. Extension with custom plugins
-================================
+Extension with custom plugins
+=============================
KSS has a plugin architecture. Apart from the core that is
parsing the .kss files and binding them to nodes, communicating
@@ -15,8 +14,8 @@
To be able to do it, you must be familiar with javascript and
KSS.
-5.1 wrapping javascript on the client side
-------------------------------------------
+Wrapping javascript on the client side
+--------------------------------------
If we write a new plugin, first we need to create a javascript
file that will contain the code for our plugin.
@@ -26,8 +25,8 @@
kukit.myplugin = {};
-5.1.1. Creating an action
-"""""""""""""""""""""""""
+Creating an action
+"""""""""""""""""""
An action is a javascript method that is called when the action
is executed. It receives the parameters in a given form and it
@@ -35,16 +34,12 @@
-
-
-
-
-5.2 registering your plugin on the server and shipping with your product
-------------------------------------------------------------------------
+Registering your plugin on the server and shipping with your product
+--------------------------------------------------------------------
XXX
-5.3. Testing
-------------
+Testing
+-------
XXX
More information about the Kukit-checkins
mailing list