From 52baa8a3ff6c681d771b6ed4037c354eb8a69e6b Mon Sep 17 00:00:00 2001 From: Svjatoslav Agejenko Date: Sun, 1 Mar 2015 22:03:10 +0200 Subject: [PATCH] updated documentation --- doc/index.html | 276 +++++++++++++++++++++++++++++++++++++++++++------ doc/index.org | 58 +++++++++++ doc/usage.html | 49 --------- 3 files changed, 300 insertions(+), 83 deletions(-) create mode 100644 doc/index.org delete mode 100755 doc/usage.html diff --git a/doc/index.html b/doc/index.html index 84a17aa..ca5ad74 100755 --- a/doc/index.html +++ b/doc/index.html @@ -1,44 +1,252 @@ - - + + + - -Svjatoslav Commons +Svjatoslav Commons - Java library of commonly used functions + + + + + + + -

Svjatoslav Commons - Java library of commonly used functions

- Download -    - Online homepage -    - Other applications hosted on svjatoslav.eu - 
-Library author:
-    Svjatoslav Agejenko
-    Homepage: http://svjatoslav.eu
-    Email: svjatoslav@svjatoslav.eu
+

+
Svjatoslav Commons - Java library of commonly used functions

+

+
Table of Contents

+

+
+

+

+

+
 
+

+
1 General

+

+

 Library contains:
-    * Wildcards matcher.
-        (?, *)
-        
-    * Commandline arguments parsing, validating, help generating library. 
-   
-    * File path parser.
-   
-    * Graphical error dialog.
-    
-        Reusable graphical dialog to capture and show program exceptions
-        and associated program call stack traceback.
-
-    * Primitive URL parameters encoder / decoder.
-
-Instructions to embed svjatoslav-commons in your project as a library.  
+

+
    
+
  • Wildcards matcher. (?, *)
+
    • 
+
+
  • Commandline arguments parser and validator.
+
    • 
+
+
  • File path parser.
+
    • 
+
+
  • Graphical error dialog.
+
      
+
    • Reusable graphical dialog to capture and show program exceptions
+and associated program call stack traceback.
+
      • 
+
    
+
    • 
+
+
  • Primitive URL parameters encoder / decoder.
+
    • 
+

+

+

+
+
+

+
2 Usage

+

+

+Instructions to embed svjatoslav-commons in your project as a library:
+

+
+

+Maven pom.xml file snippet:
+

+
+

+
+
<dependencies>
+    ...
+    <dependency>
+        <groupId>eu.svjatoslav</groupId>
+        <artifactId>svjatoslavcommons</artifactId>
+        <version>1.4</version>
+    </dependency>
+    ...
+</dependencies>
+
 
+<repositories>
+    ...
+    <repository>
+        <id>svjatoslav.eu</id>
+        <name>Svjatoslav repository</name>
+        <url>http://www2.svjatoslav.eu/maven/</url>
+    </repository>
+    ...
+</repositories>
 

+

+

+

+

+

+
Author: Svjatoslav Agejenko

+
Created: 2015-03-01 Sun 19:03

+
Emacs 24.4.1 (Org mode 8.2.10)

+
Validate

+

 
-
\ No newline at end of file
+
diff --git a/doc/index.org b/doc/index.org
new file mode 100644
index 0000000..4d7cb24
--- /dev/null
+++ b/doc/index.org
@@ -0,0 +1,58 @@
+#+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]]
+
+- 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
+  License]] or later as published by the Free Software Foundation.
+
+- Program author:
+  - Svjatoslav Agejenko
+  - Homepage: http://svjatoslav.eu
+  - Email: mailto://svjatoslav@svjatoslav.eu
+
+- [[http://svjatoslav.eu/programs.jsp][other applications hosted at svjatoslav.eu]]
+
+* General
+Library contains:
+- Wildcards matcher. (?, *)
+
+- Commandline arguments parser and validator.
+
+- File path parser.
+
+- Graphical error dialog.
+  - Reusable graphical dialog to capture and show program exceptions
+    and associated program call stack traceback.
+
+- Primitive URL parameters encoder / decoder.
+
+
+* Usage
+Instructions to embed svjatoslav-commons in your project as a library:
+
+Maven pom.xml file snippet:
+
+#+BEGIN_SRC xml
+
+    ...
+    
+        eu.svjatoslav
+        svjatoslavcommons
+        1.4
+    
+    ...
+
+
+
+
+    ...
+    
+        svjatoslav.eu
+        Svjatoslav repository
+        http://www2.svjatoslav.eu/maven/
+    
+    ...
+
+#+END_SRC
diff --git a/doc/usage.html b/doc/usage.html
deleted file mode 100755
index 6866a2c..0000000
--- a/doc/usage.html
+++ /dev/null
@@ -1,49 +0,0 @@
-
-
-
-
-Insert title here
-
-
-
-
-Maven pom.xml file snippet:
-
-
-
-

-
-    <dependencies>
-
-        ...
-        
-        <dependency>
-            <groupId>eu.svjatoslav</groupId>
-            <artifactId>svjatoslavcommons</artifactId>
-            <version>1.2</version>
-        </dependency>
-
-        ...
-
-    </dependencies>
-
-    <repositories>
-    
-        ...
-    
-        <repository>
-            <id>svjatoslav.eu</id>
-            <name>Svjatoslav repository</name>
-            <url>http://www2.svjatoslav.eu/maven/</url>
-        </repository>
-        
-        ...
-        
-    </repositories>
-

-

-
-
-
-
-
\ No newline at end of file
-- 
2.20.1