More techdocs changes... (#999)

* Techdocs website: add github link to header

* Fix HugeArrayLock documentation

* Correct description of sharedTokenDatabase key in INI

* Techdocs website: get just-the-docs template from support branch with all unreleased fixes for FreeGEOS

* Add screenshot to Techdocs  index and README

Author: mgroeber9110

README.md

@@ -3,6 +3,8 @@ This repository is the offical place to hold all the source codes around the PC/
 interface and its sophisticated applications. It is the source to build SDK and release version of PC/GEOS.
 It is the place to collaborate on further developments.
 
+![Screenshot showing a typical GEOS desktop](Techdocs/Markdown/Art/title-screenshot.png)
+
 The base of this repository is the source code used to build Breadbox Ensemble 4.13 reduced by some modules identified as critical in regard to the license choosen for the repository.
 
 While now the WATCOM is used to compile the C parts, the full SDK is available for Windows and Linux.

TechDocs/Markdown/Art/title-screenshot.png

@@ -2,7 +2,8 @@ source 'https://rubygems.org'
 
 gem "jekyll", "~> 4.4.1" # installed by `gem jekyll`
 
-gem "just-the-docs", github: "mgroeber9110/just-the-docs", branch: "1210-index-on-web-worker"
+# Private branch of JTD with unreleased fixes specifically for TechDocs 
+gem "just-the-docs", github: "mgroeber9110/just-the-docs", branch: "freegeos-techdocs"
 
 group :jekyll_plugins do
   gem "jekyll-github-metadata"

TechDocs/Markdown/Gemfile

@@ -8,8 +8,8 @@ GIT
 
 GIT
   remote: https://github.com/mgroeber9110/just-the-docs.git
-  revision: cee67f5dd5aff4e1606764506adee0f359af1909
-  branch: 1210-index-on-web-worker
+  revision: a61d22407374140b6fadaba868dc63f798d9fa7b
+  branch: freegeos-techdocs
   specs:
     just-the-docs (0.10.1)
       jekyll (>= 3.8.5)
@@ -35,7 +35,9 @@ GEM
       faraday-net_http (>= 2.0, < 3.1)
       ruby2_keywords (>= 0.0.4)
     faraday-net_http (3.0.2)
-    ffi (1.17.2)
+    ffi (1.17.2-arm64-darwin)
+    ffi (1.17.2-x64-mingw-ucrt)
+    ffi (1.17.2-x86_64-linux-gnu)
     forwardable-extended (2.6.0)
     http_parser.rb (0.8.0)
     i18n (1.14.7)
@@ -92,7 +94,7 @@ GEM
     pathutil (0.16.2)
       forwardable-extended (~> 2.6)
     public_suffix (5.0.3)
-    rake (13.3.0)
+    rake (13.3.1)
     rb-fsevent (0.11.2)
     rb-inotify (0.11.1)
       ffi (~> 1.0)

TechDocs/Markdown/Gemfile.lock

@@ -323,11 +323,12 @@ this element will be *numElem* bytes long.
             VMFileHandle    vmFile,
             VMBlockhandle   vmBlock,        /* Handle of directory block */
             dword           elemNum,        /* Element to lock */
-            void **         elemPtr);       /* Pointer to element is written 
+            void **         elemPtr,        /* Pointer to element is written 
                                              * here */
+            word *          elemSize);	    /* Size of element is written here */
 
 This routine locks an element in a Huge Array. It writes the element's 
-address to **elemPtr*. The dword returned indicates how many elements come 
+address to **elemPtr**. The dword returned indicates how many elements come 
 before and after the element in that block. The upper word indicates how 
 many elements come before the locked one, counting the locked element. The 
 lower word indicates how many elements come after the locked element, 

TechDocs/Markdown/Routines/rrouth_l.md

@@ -1366,9 +1366,11 @@ GEOS will look for a key called inixxx for the names of the files to be used.
 
 This key defines the location of the shared token database file. This key is 
 most useful in network situations, when many users may be sharing a single 
-token database.
+token database, or when splitting the installation into a pre-installed and
+a user-specific part. The location should be a pathname only and not include
+the filename of the token database.
 
-    sharedTokenDatabase = N:\NETFILES\TOKEN_DA.000
+    sharedTokenDatabase = N:\NETFILES
 
 ----------
 

TechDocs/Markdown/Tools/tini.md

@@ -16,6 +16,10 @@ nav_external_links:
   - title: "FreeGEOS on GitHub"
     url: https://github.com/bluewaysw/pcgeos
 
+aux_links:
+  "FreeGEOS on GitHub":
+    - "https://github.com/bluewaysw/pcgeos"
+
 # Jekyll plugins to simplify working with plain Markdown files
 # (copied from default jekyll-build-pages action)
 plugins:

TechDocs/Markdown/_config.yml

@@ -3,7 +3,9 @@ nav_order: 0
 ---
 ## #FreeGEOS technical documentation
 
-#FreeGEOS comes with extensive technical documentation that describes tools, programming languages and API calls from the perspective of an SDK user. This documentation can be found in the `TechDocs` folder and is available in Markdown format. Its starting point is the GEOS SDK 2.0, which provides good coverage of the major architectural building blocks of the system, and includes the most comprehensive technical writing. It was originally published as a multi-volume library of physical books.
+#FreeGEOS comes with extensive technical documentation that describes tools, programming languages and API calls from the perspective of an SDK user. This documentation can be found in the `TechDocs` folder and is available in Markdown format. It is based on the GEOS SDK 2.0, which provides good coverage of the major architectural building blocks of the system, and includes the most comprehensive technical writing. It was originally published as a multi-volume library of physical books.
+
+![Screenshot showing a typical GEOS desktop](Art/title-screenshot.png)
 
 Here are some entry points to the main volumes: