prefer HTTPS in documentation
[svjatoslav_commons.git] / doc / index.org
index cfb8b4b..fd1101a 100644 (file)
@@ -1,7 +1,7 @@
 #+TITLE: Svjatoslav Commons - Java library of commonly used functions
 
 -----
-- [[http://www2.svjatoslav.eu/gitweb/?p=svjatoslav_commons.git;a=snapshot;h=HEAD;sf=tgz][download latest snapshot]]
+- [[https://www2.svjatoslav.eu/gitweb/?p=svjatoslav_commons.git;a=snapshot;h=HEAD;sf=tgz][download latest snapshot]]
 
 - This program is free software; you can redistribute it and/or modify
   it under the terms of version 3 of the [[https://www.gnu.org/licenses/lgpl.html][GNU Lesser General Public
@@ -9,41 +9,66 @@
 
 - Program author:
   - Svjatoslav Agejenko
-  - Homepage: http://svjatoslav.eu
+  - Homepage: https://svjatoslav.eu
   - Email: mailto://svjatoslav@svjatoslav.eu
 
-- [[http://svjatoslav.eu/programs.jsp][other applications hosted at svjatoslav.eu]]
+- [[http://www.svjatoslav.eu/programs.jsp][other applications hosted at svjatoslav.eu]]
 
-* General
-Library contains:
+* (document settings) :noexport:
+** use dark style for TWBS-HTML exporter
+#+HTML_HEAD: <link href="https://bootswatch.com/4/darkly/bootstrap.min.css" rel="stylesheet">
+#+HTML_HEAD: <script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/1.11.2/jquery.min.js"></script>
+#+HTML_HEAD: <script src="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.3.1/js/bootstrap.min.js"></script>"
+#+HTML_HEAD: <style type="text/css">
+#+HTML_HEAD:   footer {background-color: #111 !important;}
+#+HTML_HEAD:   pre {background-color: #111; color: #ccc;}
+#+HTML_HEAD: </style>
+
+* Library contents
 - Commandline Interface helper
+  : eu.svjatoslav.commons.commandline.CLIHelper
 
 - Commandline arguments parser and validator.
+  : eu.svjatoslav.commons.commandline.parameterparser
 
 - Bit input and output streams.
+  : eu.svjatoslav.commons.data.BitInputStream
+  : eu.svjatoslav.commons.data.BitOutputStream
 
 - Slightly enhanced data input and output streams.
+  : eu.svjatoslav.commons.data.EnhancedDataInputStream
+  : eu.svjatoslav.commons.data.EnhancedDataOutputStream
 
 - Byte array to HEX string converter.
+  : eu.svjatoslav.commons.data.HexConverter
 
-- Utility that tries to quess user desktop directory.
+- Utility that tries to quess user desktop directory. (Quite ugly and
+  unreliable. Better solution is needed.)
+  : eu.svjatoslav.commons.file.CommonPathResolver
 
 - File path parser.
+  : eu.svjatoslav.commons.file.FilePathParser
 
 - File IO helper.
+  : eu.svjatoslav.commons.file.IOHelper
 
 - Graphical error dialog.
   - Reusable graphical dialog to capture and show program exceptions
     and associated program call stack traceback.
+    : eu.svjatoslav.commons.gui.dialog.ExceptionDialog
 
 - Primitive and simple component to add navigation menus to the web
   sites.
+  : eu.svjatoslav.commons.network.navigation
 
 - String tokenizer.
+  : eu.svjatoslav.commons.string.tokenizer
 
 - Improved String, optimized for dealing with prefixes and suffixes.
+  : eu.svjatoslav.commons.string.String2
 
 - Wildcards matcher. (?, *)
+  : eu.svjatoslav.commons.string.WildCardMatcher#match
 
 * Usage
 Instructions to embed svjatoslav-commons in your project as a library:
@@ -56,7 +81,7 @@ Maven pom.xml file snippet:
     <dependency>
         <groupId>eu.svjatoslav</groupId>
         <artifactId>svjatoslavcommons</artifactId>
-        <version>1.4</version>
+        <version>1.7</version>
     </dependency>
     ...
 </dependencies>