Contents
----------------------------------

1. About Panckoucke
   


2. The two parts of Panckoucke

   The public API
   

   The basic implementation
   

   
   
3. The API in more detail
   
4. Developing with the implementation
   

The public API
----------------------------------

The Panckoucke library comes with two parts (to clearly separate interfaces from the implementation). The first part contains the interfaces and classes that define the public API. These interfaces and classes are located beneath org.tm4j.tmnav.panckoucke.core.*, and are referenced throughout this document as the "core".

The basic data structure of panckoucke is the "Abstraction model" which is defined in org.tm4j.tmnav.panckoucke.core.abstraction.model. Furthermore Panckouce defines a "flow of control", which leads from selecting an element through the abstraction proccess onto the rendering of the generated model.

At last, for enabling applications to react on panckoucke without being tight too strong to the implementation, panckoucke comes with a simple event-model, located in org.tm4j.tmnav.panckoucke.core.

Please keep in mind that currently the API is still in developement phase. Massive changes to the Abstraction model and the Abstractor API are pending and will be implmented in the upcoming alphas. Also the event handling interfaces will be changed dramatically.

The basic implementation
----------------------------------

The second part of Panckoucke, descendants from org.tm4j.tmnav.panckoucke.impl.* , contains an implementation of the core API. Since panckoucke is designed to enable lightweight porting of tm4j navigations to different hosting applications, we decided to include a basic implementation into the distribution of panckoucke.

Naturally there is no need to use the implementation as a whole. Most developers will find parts which they can use. But we expect other parts to be customized very frequently, especially the Abstractors.