Commits

Herbert Breunung committed 5f556e3

switching attention to internals doc

  • Participants
  • Parent commits f08e92a
  • Branches sp3

Comments (0)

Files changed (2)

File lib/Kephra/Internals.pod

-=head1 API
 
-=head2 Kephra::API
+=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.
+
+
+=head2 NAMESPACES
+
+
+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) ...
+here is an overview to the Kephra namespace organisation.
+
+Please note that the shorter the name is (shorter namespace chain),
+the more internal and general purpose the module is owning that name.
+For instance Kephra::File::Local serves as specialized subtask of Kephra::File.
+
+=head3 API
 
 The module Kephra::API is the best starting point to understand the inner workings.
 That's actually one design goal and purpose of this file, because it gives an
 under the hood during smaller release cycles. As long as the first version number
 (see L<Versioning>) does not change, nothing will be renamed or removed from the API.
 
+=head3 Explained In Detail
 
-=head1 NAMESPACES
 
-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) ...
-here is an overview to the Kephra namespace organisation.
-
-Please note that the shorter the name is (shorter namespace chain),
-the more internal and general purpose the module is owning that name.
-For instance Kephra::File::Local serves as specialized subtask of Kephra::File.
-
-
-* Kephra
+=head4 Kephra
 
 contains just the init process:
 setting dirs, loading libs, finding configs, start worker fork
 
-* Kephra::API
+=head4 Kephra::API
 
 interface to important internal functions all modules and plugins should use
 
 The modules in the Kephra::API::* namespace are services for a more sophisticated
 communication between the modules who do the real work.
 
-Kephra::API::Command
+=head4 Kephra::API::Command
 
 Also sort of API but more complex. Contains every call the user is able to make.
 Needed to protocol each call for monitoring, macros and other introspection
 based functions. Also helps to make simple menu and toolbar definitions.
 They just need to be a list of CommandIDs.
 
-Kephra::API::KeyMap
+
+=head4 Kephra::API::DocumentStash
+
+Kephra::API::Event
+
+
+=head4 Kephra::API::KeyMap
 
 handles the mapping from key kommbo to the command it triggeres for any 
 App::Dialog and App::Part
 
-Kephra::API::Event
 
 
 * Kephra::App

File lib/Kephra/Philosophy.pod

 
 =head2  DISCLAIMER
 
-Like platons politeia, this document descibes the ideal state of version 1.0.
+Like platons politeia, this document describes the ideal state of version 1.0.