Commits

Herbert Breunung committed 31410ec

rewrite docs on most important internals

  • Participants
  • Parent commits 5f556e3
  • Branches sp3

Comments (0)

Files changed (1)

File lib/Kephra/Internals.pod

 
 =head1 Kephra::Internals
 
-Just in case you want to touch the Kephra sources - this document explains
-you where to find what and how it does work together.
+If you want to touch the Kephra sources -
+this document explains where to find what and how does it all work together.
+In case you learn better by code - start at Kephra::API.
 
 
 =head2 NAMESPACES
 
+In each file is only one package with exactly the name as the files.
+
+With every directory you go deeper into the tree the modules will get more
+specific. Thats why the directory Kephra has only the most common tools
+and libraries.
+
+=over 4
+
+* API - API for plugins, most cross module calls, central data structures
+
+* App - visuals
+
+=over 4
+
+* Bar - visual units made of one widget
+
+* Editor - editor window helper
+
+* Panel - with sizer assembled visual parts
+
+* Part - functional units
+
+=back
+
+* Config - data
+
+=over 4
+
+* Default - built in fall back configs when certain files are in trouble
+
+=back
+
+* Document - document properties
+
+* Edit - text manipulation functions
+
+* Files - all sorts of IO
+
+* Plugins - namespace of users extentions
+
+
+=back
+
+
+
+
 
 If you want to leave the recommended ways as proposed by the API and call
 functions or data directly (or even better you want to help to develope Kephra) ...
 =head3 Explained In Detail
 
 
+=head2 Modules
+
 =head4 Kephra
 
 contains just the init process: