Changed license to CC0
[svjatoslav_commons.git] / doc / index.html
index c850b47..9ec1008 100644 (file)
@@ -2,14 +2,14 @@
 <html lang="en">
 <head>
 <title>Svjatoslav Commons - Java library of commonly used functions</title>
-<!-- 2017-11-29 Wed 23:58 -->
+<!-- 2020-05-01 Fri 23:39 -->
 <meta charset="utf-8">
 <meta name="viewport" content="width=device-width, initial-scale=1">
 <meta name="generator" content="Org-mode">
 <meta name="author" content="Svjatoslav Agejenko">
-<link href="https://bootswatch.com/4/darkly/bootstrap.min.css" rel="stylesheet">
-<script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/1.11.2/jquery.min.js"></script>
-<script src="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.3.1/js/bootstrap.min.js"></script>"
+<link href="https://bootswatch.com/3/darkly/bootstrap.min.css" rel="stylesheet">
+<script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/1.11.3/jquery.min.js"></script>
+<script src="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.3.5/js/bootstrap.min.js"></script>
 <style type="text/css">
 footer {background-color: #111 !important;}
 pre {background-color: #111; color: #ccc;}
@@ -196,89 +196,168 @@ $(function() {
 <body>
 <div id="content" class="container">
 <div class="row"><div class="col-md-9"><h1 class="title">Svjatoslav Commons - Java library of commonly used functions</h1>
-<hr >
-<ul class="org-ul">
-<li><a href="http://www2.svjatoslav.eu/gitweb/?p=svjatoslav_commons.git;a=snapshot;h=HEAD;sf=tgz">download latest snapshot</a>
-</li>
 
-<li>This program is free software; you can redistribute it and/or modify
-it under the terms of version 3 of the <a href="https://www.gnu.org/licenses/lgpl.html">GNU Lesser General Public
-License</a> or later as published by the Free Software Foundation.
+<div id="outline-container-sec-1" class="outline-2">
+<h2 id="sec-1"><span class="section-number-2">1</span> General</h2>
+<div class="outline-text-2" id="text-1">
+<ul class="org-ul">
+<li>This program is free software: released under Creative Commons Zero
+(CC0) license
 </li>
 
 <li>Program author:
 <ul class="org-ul">
 <li>Svjatoslav Agejenko
 </li>
-<li>Homepage: <a href="http://svjatoslav.eu">http://svjatoslav.eu</a>
+<li>Homepage: <a href="https://svjatoslav.eu">https://svjatoslav.eu</a>
 </li>
 <li>Email: <a href="mailto://svjatoslav@svjatoslav.eu">mailto://svjatoslav@svjatoslav.eu</a>
 </li>
 </ul>
 </li>
 
-<li><a href="http://www.svjatoslav.eu/programs.jsp">other applications hosted at svjatoslav.eu</a>
+<li><a href="https://www.svjatoslav.eu/projects/">Other software projects hosted at svjatoslav.eu</a>
 </li>
 </ul>
+</div>
 
-<div id="outline-container-sec-1" class="outline-2">
-<h2 id="sec-1"><span class="section-number-2">1</span> General</h2>
-<div class="outline-text-2" id="text-1">
-<p>
-Library contains:
-</p>
+<div id="outline-container-sec-1-1" class="outline-3">
+<h3 id="sec-1-1"><span class="section-number-3">1.1</span> Source code</h3>
+<div class="outline-text-3" id="text-1-1">
 <ul class="org-ul">
+<li><a href="https://www2.svjatoslav.eu/gitweb/?p=svjatoslav_commons.git;a=snapshot;h=HEAD;sf=tgz">Download latest snapshot in TAR GZ format</a>
+</li>
+
+<li><a href="https://www2.svjatoslav.eu/gitweb/?p=svjatoslav_commons.git;a=summary">Browse Git repository online</a>
+</li>
+
+<li>Clone Git repository using command:
+<pre class="example">
+git clone https://www2.svjatoslav.eu/git/svjatoslav_commons.git
+
+</pre>
+</li>
+
+<li>See <a href="https://www3.svjatoslav.eu/projects/svjatoslav_commons/apidocs/">JavaDoc</a>.
+</li>
+</ul>
+</div>
+</div>
+</div>
+
+<div id="outline-container-sec-2" class="outline-2">
+<h2 id="sec-2"><span class="section-number-2">2</span> Library contents</h2>
+<div class="outline-text-2" id="text-2">
+<ul class="org-ul">
+<li>See <a href="https://www3.svjatoslav.eu/projects/svjatoslav_commons/apidocs/">JavaDoc</a>.
+</li>
+
 <li>Commandline Interface helper
+<pre class="example">
+eu.svjatoslav.commons.commandline.CLIHelper
+
+</pre>
 </li>
 
 <li>Commandline arguments parser and validator.
+<pre class="example">
+eu.svjatoslav.commons.commandline.parameterparser
+
+</pre>
 </li>
 
 <li>Bit input and output streams.
+<pre class="example">
+eu.svjatoslav.commons.data.BitInputStream
+eu.svjatoslav.commons.data.BitOutputStream
+
+</pre>
 </li>
 
 <li>Slightly enhanced data input and output streams.
+<pre class="example">
+eu.svjatoslav.commons.data.EnhancedDataInputStream
+eu.svjatoslav.commons.data.EnhancedDataOutputStream
+
+</pre>
 </li>
 
 <li>Byte array to HEX string converter.
+<pre class="example">
+eu.svjatoslav.commons.data.HexConverter
+
+</pre>
 </li>
 
-<li>Utility that tries to quess user desktop directory.
+<li>Utility that tries to quess user desktop directory. (Quite ugly and
+unreliable. Better solution is needed.)
+<pre class="example">
+eu.svjatoslav.commons.file.CommonPathResolver
+
+</pre>
 </li>
 
 <li>File path parser.
+<pre class="example">
+eu.svjatoslav.commons.file.FilePathParser
+
+</pre>
 </li>
 
 <li>File IO helper.
+<pre class="example">
+eu.svjatoslav.commons.file.IOHelper
+
+</pre>
 </li>
 
 <li>Graphical error dialog.
 <ul class="org-ul">
 <li>Reusable graphical dialog to capture and show program exceptions
 and associated program call stack traceback.
+<pre class="example">
+eu.svjatoslav.commons.gui.dialog.ExceptionDialog
+
+</pre>
 </li>
 </ul>
 </li>
 
 <li>Primitive and simple component to add navigation menus to the web
 sites.
+<pre class="example">
+eu.svjatoslav.commons.network.navigation
+
+</pre>
 </li>
 
 <li>String tokenizer.
+<pre class="example">
+eu.svjatoslav.commons.string.tokenizer
+
+</pre>
 </li>
 
 <li>Improved String, optimized for dealing with prefixes and suffixes.
+<pre class="example">
+eu.svjatoslav.commons.string.String2
+
+</pre>
 </li>
 
 <li>Wildcards matcher. (?, *)
+<pre class="example">
+eu.svjatoslav.commons.string.WildCardMatcher#match
+
+</pre>
 </li>
 </ul>
 </div>
 </div>
 
-<div id="outline-container-sec-2" class="outline-2">
-<h2 id="sec-2"><span class="section-number-2">2</span> Usage</h2>
-<div class="outline-text-2" id="text-2">
+<div id="outline-container-sec-3" class="outline-2">
+<h2 id="sec-3"><span class="section-number-2">3</span> Usage</h2>
+<div class="outline-text-2" id="text-3">
 <p>
 Instructions to embed svjatoslav-commons in your project as a library:
 </p>
@@ -294,7 +373,7 @@ Maven pom.xml file snippet:
     &lt;<span style="color: #A6E22E;">dependency</span>&gt;
         &lt;<span style="color: #A6E22E;">groupId</span>&gt;eu.svjatoslav&lt;/<span style="color: #A6E22E;">groupId</span>&gt;
         &lt;<span style="color: #A6E22E;">artifactId</span>&gt;svjatoslavcommons&lt;/<span style="color: #A6E22E;">artifactId</span>&gt;
-        &lt;<span style="color: #A6E22E;">version</span>&gt;1.5&lt;/<span style="color: #A6E22E;">version</span>&gt;
+        &lt;<span style="color: #A6E22E;">version</span>&gt;1.7&lt;/<span style="color: #A6E22E;">version</span>&gt;
     &lt;/<span style="color: #A6E22E;">dependency</span>&gt;
     ...
 &lt;/<span style="color: #A6E22E;">dependencies</span>&gt;
@@ -316,16 +395,21 @@ Maven pom.xml file snippet:
 </div><div class="col-md-3"><nav id="table-of-contents">
 <div id="text-table-of-contents" class="bs-docs-sidebar">
 <ul class="nav">
-<li><a href="#sec-1">1. General</a></li>
-<li><a href="#sec-2">2. Usage</a></li>
+<li><a href="#sec-1">1. General</a>
+<ul class="nav">
+<li><a href="#sec-1-1">1.1. Source code</a></li>
+</ul>
+</li>
+<li><a href="#sec-2">2. Library contents</a></li>
+<li><a href="#sec-3">3. Usage</a></li>
 </ul>
 </div>
 </nav>
 </div></div></div>
 <footer id="postamble" class="">
 <div><p class="author">Author: Svjatoslav Agejenko</p>
-<p class="date">Created: 2017-11-29 Wed 23:58</p>
-<p class="creator"><a href="http://www.gnu.org/software/emacs/">Emacs</a> 25.1.1 (<a href="http://orgmode.org">Org-mode</a> 8.2.10)</p>
+<p class="date">Created: 2020-05-01 Fri 23:39</p>
+<p class="creator"><a href="http://www.gnu.org/software/emacs/">Emacs</a> 26.1 (<a href="http://orgmode.org">Org-mode</a> 9.1.9)</p>
 </div>
 </footer>
 </body>