improved navigation between doc files

Author: KaiSchwarz-cnic

docs/apiconnector.html

@@ -5,7 +5,7 @@
 <!--
   generated by Pod::Simple::HTML v3.35,
   using Pod::Simple::PullParser v3.35,
-  under Perl v5.026000 at Mon Jul 23 08:27:35 2018 GMT.
+  under Perl v5.026000 at Mon Jul 23 08:50:47 2018 GMT.
 
  If you want to change this HTML document, you probably shouldn't do that
    by changing it directly.  Instead, see about changing the calling options
@@ -76,6 +76,28 @@ <h1><a class='u'
 
 <p>A helper utility module is also included for tasks like date handling and string encoding.</p>
 
+<h1><a class='u'
+name="AVAILABLE_SUBMODULES"
+>AVAILABLE SUBMODULES</a></h1>
+
+<p>We&#39;ve split our functionality into submodules to give this module a better structure.</p>
+
+<dl>
+<dt><a name="HEXONET::Apiconnector::Connection_-_API_Client_functionality."
+><a href="http://search.cpan.org/perldoc?HEXONET%3A%3AApiconnector%3A%3AConnection" class="podlinkpod"
+>HEXONET::Apiconnector::Connection</a> - API Client functionality.</a></dt>
+
+<dd>
+<dt><a name="HEXONET::Apiconnector::Response_-_API_Response_functionality."
+><a href="http://search.cpan.org/perldoc?HEXONET%3A%3AApiconnector%3A%3AResponse" class="podlinkpod"
+>HEXONET::Apiconnector::Response</a> - API Response functionality.</a></dt>
+
+<dd>
+<dt><a name="HEXONET::Apiconnector::Util_-_Bundle_of_Helper_methods."
+><a href="http://search.cpan.org/perldoc?HEXONET%3A%3AApiconnector%3A%3AUtil" class="podlinkpod"
+>HEXONET::Apiconnector::Util</a> - Bundle of Helper methods.</a></dt>
+</dl>
+
 <h1><a class='u'
 name="METHODS_HEXONET::Apiconnector"
 >METHODS HEXONET::Apiconnector</a></h1>

docs/connection.html

@@ -5,7 +5,7 @@
 <!--
   generated by Pod::Simple::HTML v3.35,
   using Pod::Simple::PullParser v3.35,
-  under Perl v5.026000 at Mon Jul 23 08:27:35 2018 GMT.
+  under Perl v5.026000 at Mon Jul 23 08:50:47 2018 GMT.
 
  If you want to change this HTML document, you probably shouldn't do that
    by changing it directly.  Instead, see about changing the calling options
@@ -41,6 +41,13 @@ <h1><a class='u'
 >METHODS HEXONET::Apiconnector::Connection</a></h1>
 
 <dl>
+<dt><a name="new(config)"
+><code>new(config)</code></a></dt>
+
+<dd>
+<p>Create an new API client instance with the given configuration data.
+Supported configuration data keys are: - login - your uid - password - your password - url - Backend API url to use; in general https://coreapi.1api.de/api/call.cgi - entity - Backend system entity; use &#34;54cd&#34; for LIVE system and &#34;1234&#34; for OT&#38;E system - user - to have a view into subuser account data - role - in case you want to login with a role user account that is directly under the given uid</p>
+
 <dt><a name="call(command,_config)"
 ><code>call(command,
 config)</code></a></dt>

docs/hexonet.html

@@ -5,7 +5,7 @@
 <!--
   generated by Pod::Simple::HTML v3.35,
   using Pod::Simple::PullParser v3.35,
-  under Perl v5.026000 at Mon Jul 23 08:27:35 2018 GMT.
+  under Perl v5.026000 at Mon Jul 23 08:50:47 2018 GMT.
 
  If you want to change this HTML document, you probably shouldn't do that
    by changing it directly.  Instead, see about changing the calling options
@@ -33,6 +33,18 @@ <h1><a class='u'
 <p>This module is just used as namespace package for any module provided by <a href="https://www.hexonet.net/" class="podlinkurl"
 >HEXONET</a> and does not provide any further functionality.</p>
 
+<h1><a class='u'
+name="AVAILABLE_MODULES"
+>AVAILABLE MODULES</a></h1>
+
+<p>Up to now we provide the following modules:</p>
+
+<dl>
+<dt><a name="HEXONET::Apiconnector_-_Connector_Library_for_our_Backend_API."
+><a href="http://search.cpan.org/perldoc?HEXONET%3A%3AApiconnector" class="podlinkpod"
+>HEXONET::Apiconnector</a> - Connector Library for our Backend API.</a></dt>
+</dl>
+
 <h1><a class='u'
 name="AUTHOR"
 >AUTHOR</a></h1>

docs/response.html

@@ -5,7 +5,7 @@
 <!--
   generated by Pod::Simple::HTML v3.35,
   using Pod::Simple::PullParser v3.35,
-  under Perl v5.026000 at Mon Jul 23 08:27:35 2018 GMT.
+  under Perl v5.026000 at Mon Jul 23 08:50:47 2018 GMT.
 
  If you want to change this HTML document, you probably shouldn't do that
    by changing it directly.  Instead, see about changing the calling options
@@ -31,15 +31,24 @@ <h1><a class='u'
 
 <p>This package provides any functionality that you need to deal with Backend API responses.</p>
 
-<p>The Response object itself can be instantiated by bytes array (basically the plaintext response from the Backend API,
-or by a hast format (an already parsed response).
+<p>The Response object itself can be instantiated by bytes array (basically the plaintext response from the Backend API),
+or by a hash format (an already parsed response).
 But the latter case is more for internal use.</p>
 
 <h1><a class='u'
 name="METHODS_HEXONET::Apiconnector::Response"
 >METHODS HEXONET::Apiconnector::Response</a></h1>
 
 <dl>
+<dt><a name="new(response)"
+><code>new(response)</code></a></dt>
+
+<dd>
+<p>Create an new Response object using the given Backend API response data.
+This can be a bytes array (basically the plaintext response from the Backend API),
+or by a hash format (an already parsed response returned by method as_list_hash).
+The latter case is more for internal use.</p>
+
 <dt><a name="as_string()"
 ><code>as_string()</code></a></dt>
 

docs/util.html

@@ -5,7 +5,7 @@
 <!--
   generated by Pod::Simple::HTML v3.35,
   using Pod::Simple::PullParser v3.35,
-  under Perl v5.026000 at Mon Jul 23 08:27:35 2018 GMT.
+  under Perl v5.026000 at Mon Jul 23 08:50:47 2018 GMT.
 
  If you want to change this HTML document, you probably shouldn't do that
    by changing it directly.  Instead, see about changing the calling options

lib/HEXONET.pm

@@ -20,6 +20,16 @@ HEXONET - Namespace package for any module provided by L<HEXONET|https://www.hex
 This module is just used as namespace package for any module provided by L<HEXONET|https://www.hexonet.net/>
 and does not provide any further functionality.
 
+=head1 AVAILABLE MODULES
+
+Up to now we provide the following modules:
+
+=over 4
+
+=item L<HEXONET::Apiconnector> - Connector Library for our Backend API.
+
+=back
+
 =head1 AUTHOR
 
 HEXONET GmbH

lib/HEXONET/Apiconnector.pm

@@ -67,6 +67,20 @@ It provides a short hand method (HEXONET::Apiconnector::connect) to instantiate
 
 A helper utility module is also included for tasks like date handling and string encoding.
 
+=head1 AVAILABLE SUBMODULES
+
+We've split our functionality into submodules to give this module a better structure.
+
+=over 4
+
+=item L<HEXONET::Apiconnector::Connection> - API Client functionality.
+
+=item L<HEXONET::Apiconnector::Response> - API Response functionality.
+
+=item L<HEXONET::Apiconnector::Util> - Bundle of Helper methods.
+
+=back
+
 =head1 METHODS HEXONET::Apiconnector
 
 =over 4