Updated example links.
[javainspect.git] / doc / index.org
index 8fec2b9..085a858 100644 (file)
 
 - [[http://svjatoslav.eu/programs.jsp][other applications hosted at svjatoslav.eu]]
 
+* (document settings) :noexport:
+** use dark style for TWBS-HTML exporter
+#+HTML_HEAD: <link href="https://bootswatch.com/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>
+
 * General
 Goal: simplify/speed up understanding the computer program code by
 automatically visualizing its structure.
@@ -41,7 +51,7 @@ unimportant parts, JavaInspect produces GraphViz dot file that
 describes data to be visualized. Then launches GraphViz to generate
 bitmap graph in PNG format. By default on your Desktop directory.
 
-Note: GraphViz is developed and tested so far only on GNU Linux.
+Note: GraphViz is developed and tested so far only on GNU/Linux.
 
 * Example graphs
 + A very simple example:
@@ -52,7 +62,7 @@ Note: GraphViz is developed and tested so far only on GNU Linux.
 
     file:legend.png
 
-+ Example visualization of [[http://www2.svjatoslav.eu/gitbrowse/sixth/doc/][Sixth]] project: [[http://www2.svjatoslav.eu/projects/sixth/codegraphs/][architecture graphs]].
++ Example visualization of [[http://www2.svjatoslav.eu/gitbrowse/sixth-3d/doc/][Sixth 3D]] project: [[http://www2.svjatoslav.eu/gitbrowse/sixth-3d/doc/codeGraph/][architecture graphs]].
 
 * Usage
 Currently the only way to control JavaInspect is by using Java
@@ -154,7 +164,7 @@ Declare JavaInspect as dependency:
     <dependency>
         <groupId>eu.svjatoslav</groupId>
         <artifactId>javainspect</artifactId>
-        <version>1.5-SNAPSHOT</version>
+        <version>1.5</version>
     </dependency>
     ...
 </dependencies>
@@ -181,11 +191,10 @@ On Ubuntu/Debian use:
 #+BEGIN_SRC sh
 sudo apt-get install graphviz
 #+END_SRC
-* TODO
-- BUG: Should not hide references if there are too many of them to
-  classes if referring classes are not visible anyway because of
-  blacklist/whitelist rules. Basically reference counting should
-  exclude not visible classes.
+* TO DO
+- BUG: Should not hide references if there are too many of them to classes if
+  referring classes are not visible anyway because of blacklist/whitelist rules.
+  Basically reference counting should exclude not visible classes.
 - FEATURE: add dark theme
 - FEATURE: sort Class fields by alphabet
 - FEATURE: visualize also concrete field values so it could be used as