projects / sixth-3d.git / commitdiff
? search:
summary | shortlog | log | commit | commitdiff | tree
raw | patch | inline | side by side (parent: 968fe6f)
refactored documentation structure
authorSvjatoslav Agejenko <svjatoslav@svjatoslav.eu>
Fri, 18 Jan 2019 23:48:30 +0000 (01:48 +0200)
committerSvjatoslav Agejenko <svjatoslav@svjatoslav.eu>
Fri, 18 Jan 2019 23:48:30 +0000 (01:48 +0200)
doc/index.html patch | blob | history
doc/index.org patch | blob | history

diff --git a/doc/index.html b/doc/index.html
index c777c9d..e266b86 100644 (file)
--- a/doc/index.html
+++ b/doc/index.html
@@ -2,14 +2,14 @@
 <html lang="en">
 <head>
 <title>Sixth 3D - 3D engine</title>
 <html lang="en">
 <head>
 <title>Sixth 3D - 3D engine</title>
-<!-- 2019-01-19 Sat 01:21 -->
+<!-- 2019-01-19 Sat 01:46 -->
 <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">
 <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;}
 <style type="text/css">
 footer {background-color: #111 !important;}
 pre {background-color: #111; color: #ccc;}
@@ -196,24 +196,14 @@ $(function() {
 <body>
 <div id="content" class="container">
 <div class="row"><div class="col-md-9"><h1 class="title">Sixth 3D - 3D engine</h1>
 <body>
 <div id="content" class="container">
 <div class="row"><div class="col-md-9"><h1 class="title">Sixth 3D - 3D engine</h1>
-<hr >
+
+<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 is a subproject of <a href="https://www3.svjatoslav.eu/projects/sixth/">Sixth</a>
 </li>
 
 <ul class="org-ul">
 <li>This is a subproject of <a href="https://www3.svjatoslav.eu/projects/sixth/">Sixth</a>
 </li>
 
-<li>Clone GIT repository using command:
-<pre class="example">
-git clone https://www2.svjatoslav.eu/git/sixth-3d.git
-
-</pre>
-</li>
-
-<li><a href="https://www2.svjatoslav.eu/gitweb/?p=sixth-3d.git;a=snapshot;h=HEAD;sf=tgz">Download latest snapshot in TAR GZ format</a>
-</li>
-
-<li>See <a href="https://www3.svjatoslav.eu/projects/sixth-3d/apidocs/">JavaDoc</a>.
-</li>
-
 <li>This program is free software: you can redistribute it and/or modify
 it under the terms of the <a href="https://www.gnu.org/licenses/lgpl.html">GNU Lesser General Public License</a> as
 published by the Free Software Foundation, either version 3 of the
 <li>This program is free software: you can redistribute it and/or modify
 it under the terms of the <a href="https://www.gnu.org/licenses/lgpl.html">GNU Lesser General Public License</a> as
 published by the Free Software Foundation, either version 3 of the
@@ -234,29 +224,54 @@ License, or (at your option) any later version.
 <li><a href="https://www.svjatoslav.eu/projects/">Other software projects hosted at svjatoslav.eu</a>
 </li>
 </ul>
 <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> Project description</h2>
-<div class="outline-text-2" id="text-1">
+<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=sixth-3d.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=sixth-3d.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/sixth-3d.git
+
+</pre>
+</li>
+
+<li>See <a href="https://www3.svjatoslav.eu/projects/sixth-3d/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> Project description</h2>
+<div class="outline-text-2" id="text-2">
 <ul class="org-ul">
 <li>See: <a href="https://www3.svjatoslav.eu/projects/sixth-3d-demos/">demos of current 3D engine capabilities</a>
 </li>
 </ul>
 
 <p>
 <ul class="org-ul">
 <li>See: <a href="https://www3.svjatoslav.eu/projects/sixth-3d-demos/">demos of current 3D engine capabilities</a>
 </li>
 </ul>
 
 <p>
-<a href="#sec-1-1">In software</a>, <a href="#sec-1-2">pure Java</a> realtime 3D rendering engine. With the final
+<a href="#sec-2-1">In software</a>, <a href="#sec-2-2">pure Java</a> realtime 3D rendering engine. With the final
 goal of becoming a platform for buildng 3D user interfaces and
 interactive data visualization for <a href="https://www3.svjatoslav.eu/projects/sixth/">project Sixth</a>.
 </p>
 
 <p>
 goal of becoming a platform for buildng 3D user interfaces and
 interactive data visualization for <a href="https://www3.svjatoslav.eu/projects/sixth/">project Sixth</a>.
 </p>
 
 <p>
-Sixth 3D can be also used as standalone <a href="#sec-3">3D engine in your project</a>.
+Sixth 3D can be also used as standalone <a href="#sec-4">3D engine in your project</a>.
 </p>
 </div>
 
 </p>
 </div>
 
-<div id="outline-container-sec-1-1" class="outline-3">
-<h3 id="sec-1-1"><a id="ID-d03013e5-931b-40ca-bc4b-e4b3f23b9a4e" name="ID-d03013e5-931b-40ca-bc4b-e4b3f23b9a4e"></a><span class="section-number-3">1.1</span> Justification for software rendering</h3>
-<div class="outline-text-3" id="text-1-1">
+<div id="outline-container-sec-2-1" class="outline-3">
+<h3 id="sec-2-1"><a id="ID-d03013e5-931b-40ca-bc4b-e4b3f23b9a4e" name="ID-d03013e5-931b-40ca-bc4b-e4b3f23b9a4e"></a><span class="section-number-3">2.1</span> Justification for software rendering</h3>
+<div class="outline-text-3" id="text-2-1">
 <p>
 3D rendering is done in software, 100% pure Java on CPU. At least for
 now. Modern CPU cores count keeps growing and therefore rendering by
 <p>
 3D rendering is done in software, 100% pure Java on CPU. At least for
 now. Modern CPU cores count keeps growing and therefore rendering by
@@ -276,9 +291,9 @@ pixel.
 </p>
 </div>
 </div>
 </p>
 </div>
 </div>
-<div id="outline-container-sec-1-2" class="outline-3">
-<h3 id="sec-1-2"><a id="ID-a11f7150-1b25-4ca4-a3c3-8c8bd1352bd4" name="ID-a11f7150-1b25-4ca4-a3c3-8c8bd1352bd4"></a><span class="section-number-3">1.2</span> Justification for Java</h3>
-<div class="outline-text-3" id="text-1-2">
+<div id="outline-container-sec-2-2" class="outline-3">
+<h3 id="sec-2-2"><a id="ID-a11f7150-1b25-4ca4-a3c3-8c8bd1352bd4" name="ID-a11f7150-1b25-4ca4-a3c3-8c8bd1352bd4"></a><span class="section-number-3">2.2</span> Justification for Java</h3>
+<div class="outline-text-3" id="text-2-2">
 <ul class="org-ul">
 <li>It is easy to refactor and experiment with.
 </li>
 <ul class="org-ul">
 <li>It is easy to refactor and experiment with.
 </li>
@@ -325,9 +340,9 @@ operating systems.
 </div>
 </div>
 
 </div>
 </div>
 
-<div id="outline-container-sec-2" class="outline-2">
-<h2 id="sec-2"><span class="section-number-2">2</span> API documentation</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> API documentation</h2>
+<div class="outline-text-2" id="text-3">
 <ul class="org-ul">
 <li>See <a href="https://www3.svjatoslav.eu/projects/sixth-3d/apidocs/">JavaDoc</a>.
 </li>
 <ul class="org-ul">
 <li>See <a href="https://www3.svjatoslav.eu/projects/sixth-3d/apidocs/">JavaDoc</a>.
 </li>
@@ -349,9 +364,9 @@ So far best resource is to download and explore source code for:
 </ul>
 </div>
 </div>
 </ul>
 </div>
 </div>
-<div id="outline-container-sec-3" class="outline-2">
-<h2 id="sec-3"><a id="ID-08f71987-90af-40dc-bb65-bac87db9e652" name="ID-08f71987-90af-40dc-bb65-bac87db9e652"></a><span class="section-number-2">3</span> Instructions to embed Sixth-3D in your project</h2>
-<div class="outline-text-2" id="text-3">
+<div id="outline-container-sec-4" class="outline-2">
+<h2 id="sec-4"><a id="ID-08f71987-90af-40dc-bb65-bac87db9e652" name="ID-08f71987-90af-40dc-bb65-bac87db9e652"></a><span class="section-number-2">4</span> Instructions to embed Sixth-3D in your project</h2>
+<div class="outline-text-2" id="text-4">
 <p>
 Maven *pom.xml* file snippet:
 </p>
 <p>
 Maven *pom.xml* file snippet:
 </p>
@@ -384,9 +399,9 @@ For API usage examples, see <a href="https://www3.svjatoslav.eu/projects/sixth-3
 </p>
 </div>
 </div>
 </p>
 </div>
 </div>
-<div id="outline-container-sec-4" class="outline-2">
-<h2 id="sec-4"><span class="section-number-2">4</span> <span class="label label-primary TODO">TODO</span> features to add</h2>
-<div class="outline-text-2" id="text-4">
+<div id="outline-container-sec-5" class="outline-2">
+<h2 id="sec-5"><span class="section-number-2">5</span> <span class="label label-primary TODO">TODO</span> features to add</h2>
+<div class="outline-text-2" id="text-5">
 <ul class="org-ul">
 <li>Partial region/frame repaint: when only one small object changed on
 the scene, it would be faster to re-render that specific area.
 <ul class="org-ul">
 <li>Partial region/frame repaint: when only one small object changed on
 the scene, it would be faster to re-render that specific area.
@@ -465,22 +480,27 @@ becomes visible.
 </div><div class="col-md-3"><nav id="table-of-contents">
 <div id="text-table-of-contents" class="bs-docs-sidebar">
 <ul class="nav">
 </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. Project description</a>
+<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. Project description</a>
 <ul class="nav">
 <ul class="nav">
-<li><a href="#sec-1-1">1.1. Justification for software rendering</a></li>
-<li><a href="#sec-1-2">1.2. Justification for Java</a></li>
+<li><a href="#sec-2-1">2.1. Justification for software rendering</a></li>
+<li><a href="#sec-2-2">2.2. Justification for Java</a></li>
 </ul>
 </li>
 </ul>
 </li>
-<li><a href="#sec-2">2. API documentation</a></li>
-<li><a href="#sec-3">3. Instructions to embed Sixth-3D in your project</a></li>
-<li><a href="#sec-4">4. features to add</a></li>
+<li><a href="#sec-3">3. API documentation</a></li>
+<li><a href="#sec-4">4. Instructions to embed Sixth-3D in your project</a></li>
+<li><a href="#sec-5">5. features to add</a></li>
 </ul>
 </div>
 </nav>
 </div></div></div>
 <footer id="postamble" class="">
 <div><p class="author">Author: Svjatoslav Agejenko</p>
 </ul>
 </div>
 </nav>
 </div></div></div>
 <footer id="postamble" class="">
 <div><p class="author">Author: Svjatoslav Agejenko</p>
-<p class="date">Created: 2019-01-19 Sat 01:21</p>
+<p class="date">Created: 2019-01-19 Sat 01:46</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>
 <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>
diff --git a/doc/index.org b/doc/index.org
index 904739d..b164b18 100644 (file)
--- a/doc/index.org
+++ b/doc/index.org
@@ -1,14 +1,17 @@
 #+TITLE: Sixth 3D - 3D engine
 
 #+TITLE: Sixth 3D - 3D engine
 
------
-- This is a subproject of [[https://www3.svjatoslav.eu/projects/sixth/][Sixth]]
-
-- Clone GIT repository using command:
-  : git clone https://www2.svjatoslav.eu/git/sixth-3d.git
-
-- [[https://www2.svjatoslav.eu/gitweb/?p=sixth-3d.git;a=snapshot;h=HEAD;sf=tgz][Download latest snapshot in TAR GZ format]]
+* (document settings) :noexport:
+** use dark style for TWBS-HTML exporter
+#+HTML_HEAD: <link href="https://bootswatch.com/3/darkly/bootstrap.min.css" rel="stylesheet">
+#+HTML_HEAD: <script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/1.11.3/jquery.min.js"></script>
+#+HTML_HEAD: <script src="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.3.5/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>
 
 
-- See [[https://www3.svjatoslav.eu/projects/sixth-3d/apidocs/][JavaDoc]].
+* General
+- This is a subproject of [[https://www3.svjatoslav.eu/projects/sixth/][Sixth]]
 
 - This program is free software: you can redistribute it and/or modify
   it under the terms of the [[https://www.gnu.org/licenses/lgpl.html][GNU Lesser General Public License]] as
 
 - This program is free software: you can redistribute it and/or modify
   it under the terms of the [[https://www.gnu.org/licenses/lgpl.html][GNU Lesser General Public License]] as
@@ -22,15 +25,15 @@
 
 - [[https://www.svjatoslav.eu/projects/][Other software projects hosted at svjatoslav.eu]]
 
 
 - [[https://www.svjatoslav.eu/projects/][Other software projects hosted at svjatoslav.eu]]
 
-* (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>
+** Source code
+- [[https://www2.svjatoslav.eu/gitweb/?p=sixth-3d.git;a=snapshot;h=HEAD;sf=tgz][Download latest snapshot in TAR GZ format]]
+
+- [[https://www2.svjatoslav.eu/gitweb/?p=sixth-3d.git;a=summary][Browse Git repository online]]
+
+- Clone Git repository using command:
+  : git clone https://www2.svjatoslav.eu/git/sixth-3d.git
+
+- See [[https://www3.svjatoslav.eu/projects/sixth-3d/apidocs/][JavaDoc]].
 
 * Project description
 + See: [[https://www3.svjatoslav.eu/projects/sixth-3d-demos/][demos of current 3D engine capabilities]]
 
 * Project description
 + See: [[https://www3.svjatoslav.eu/projects/sixth-3d-demos/][demos of current 3D engine capabilities]]
Unnamed repository; edit this file 'description' to name the repository.