Cross referencing javascript packages in handbook

This commit is contained in:
Philip Sargent 2021-03-21 21:46:21 +00:00
parent 824dea8a7d
commit d0a41d386c
3 changed files with 29 additions and 10 deletions

View File

@ -24,10 +24,13 @@ p {
<p>See index to the full list of these scripts at <a href="scriptsother.html">Other Scripts</a>. This page only documents a sub-set which is not more fully documented elsewhere. <p>See index to the full list of these scripts at <a href="scriptsother.html">Other Scripts</a>. This page only documents a sub-set which is not more fully documented elsewhere.
<p>[This page should be split so that the obsolete stuff is recorded but doesn't get in the way.] <p>[This page should be split so that the obsolete stuff is recorded but doesn't get in the way.]
<h4 id="js">Javascript</h4>
<p>See <a href="serverconfig.html#js">the Expo server page</a> for what javascript packages are used by some troggle pages (CaveView, jquery etc.).
<h4 id="makefile">Makefiles</h4> <h4 id="makefile">Makefiles</h4>
<p>In :expoweb:/noinfo/ <p>In :expoweb:/noinfo/
<p>This coordinates running very essential updates but also includes redundant and obsolete stuff. It <span style="color:red">needs some serious attention</span>. <p>This may be obsolete. It used to coordinate running essential updates but also definitely includes redundant stuff. It <span style="color:red">needs some serious attention</span>.
<p>It coordinates producing the 3d surveys used in the cave description pages, updates the area pages, runs the folk script, runs the QM list generation within each of the cave pages that needs it, runs svxtrace, and reports on everything usign "bigbro" which we don't have any other reference to. <p>It coordinates producing the 3d surveys used in the cave description pages, updates the area pages, runs the folk script, runs the QM list generation within each of the cave pages that needs it, runs svxtrace, and reports on everything using "bigbro" which we don't have any other reference to. (Generation of the .3d files as required is now done by troggle.)
<h4 id="wallets">Wallets</h4> <h4 id="wallets">Wallets</h4>
<p><a href="../survey/onlinewallet.html">Online wallets</a> are initially maintained using the <a href="/expofiles/surveyscans/wallets.py">wallets.py</a> script, but troggle also directly imports all the expofiles/surveyscans/ directories of scanned survey notes and produces <a href="/survey_scans/">reports</a> on then. <p><a href="../survey/onlinewallet.html">Online wallets</a> are initially maintained using the <a href="/expofiles/surveyscans/wallets.py">wallets.py</a> script, but troggle also directly imports all the expofiles/surveyscans/ directories of scanned survey notes and produces <a href="/survey_scans/">reports</a> on then.

View File

@ -34,6 +34,7 @@
<li><a href="scriptscurrent.html#cavestats">cavestats</a> and <a href="scriptscurrent.html#cavestats">smklengths </a> extract overall lengths and depths from all the survex files <li><a href="scriptscurrent.html#cavestats">cavestats</a> and <a href="scriptscurrent.html#cavestats">smklengths </a> extract overall lengths and depths from all the survex files
<li><a href="scriptscurrent.html#summ">summarizecave.sh</a> gets .3d file contents using survex <li><a href="scriptscurrent.html#summ">summarizecave.sh</a> gets .3d file contents using survex
<li><a href="scriptscurrent.html#tabular">caves-tabular.html</a> a re-sortable table of cave data <li><a href="scriptscurrent.html#tabular">caves-tabular.html</a> a re-sortable table of cave data
<li><a href="scriptscurrent.html#js">JavaScript</a> packages are used by some troggle pages. See <a href="serverconfig.html#js">the Expo server page</a>.
<li><a href="scriptscurrent.html#makefile">Makefile</a> coordinates running many of these scripts (needs maintenance) <li><a href="scriptscurrent.html#makefile">Makefile</a> coordinates running many of these scripts (needs maintenance)
</ul> </ul>

View File

@ -52,21 +52,33 @@ expoweb (repo)
<p>The handbook illustrates the i/t/l idiom whereby an image file (i) is displayed with a paragraph of text as an HTML file (l) and there is a thumbnail image (t) which is included in another document, e.g. see <a href="../../1623/walkin.htm">the photographic guide to the walk from the toll road car park</a>. <p>The handbook illustrates the i/t/l idiom whereby an image file (i) is displayed with a paragraph of text as an HTML file (l) and there is a thumbnail image (t) which is included in another document, e.g. see <a href="../../1623/walkin.htm">the photographic guide to the walk from the toll road car park</a>.
<h4 id="js">CSS and JavaScript</a></h3>
<p>The <var>expoweb</var> repo contains all the HTML files and basic CSS files. The <var>troggle</var> repo contains the HTML templates, CSS and some javscript for the troggle report pages generated dynamically. There are also javascript packages installed directly on the operating system which are used by some <var>expoweb</var> pages: <var>CaveScript</var> for showing 3D views of cave centreline data and <var>openlayers</var> for geographic mapping integration. These javascript packages are only documented in the configuration instructions, see below.
<h3 id="what">Server configuration: software</a></h3> <h3 id="what">Server configuration: software</a></h3>
<ul> <ul>
<li>apache webserver <li>apache webserver *
<li>MySQL database <li>MySQL/MariaDB database *
<li>packaged javascript *
<li>expofiles *
<li>cgit (live webpage showing git status of repos) <li>cgit (live webpage showing git status of repos)
<li>Makefile <li>Makefile (obsolete?)
<li>bins <li>bins
<li>expofiles
<li>ssh
<li>cron <li>cron
<li>xapian (search function) <li>xapian (search function)
<li>boe <li>boe
</ul> </ul>
* These are essential to make troggle work at all.
<p>The server configuration scripts are in <var>troggle/debian/serversetup</var> and are also
documented with notes in <var>troggle/README.txt</var>. It is intended that the full documentation will
be copied here in due course and that fully automated server setup scripts will be developed
<ul>
<li>to create a development server running locally on a personal machine
<li>to install the master system following a new operating system install on the public server
</ul>
<p>The folder structure on the server is as shown below. It is all <p>The folder structure on the server is as shown below. It is all
in the user folder for the user <var>expo</var> i.e. in in the user folder for the user <var>expo</var> i.e. in
@ -142,7 +154,10 @@ expo
└── webphotos └── webphotos
└── ...</textarea></code> └── ...</textarea></code>
<p><var>expofiles</var> contains many important folders: <h4 id="expofiles">expofiles</a></h3>
<p><var>expofiles</var> contains ~40GB of files which are published by the webserver but which are not parsed by troggle. 28GB of these are photographs in <var>/expofiles/photos/</var> and there are over 4GB of scanned images of surveys in <var>/expofiles/surveyscans/</var>. There is a cleaned, complete copy of the documentation for the <var>tunnelX</var> cave plan drawing package in <var>/expofiles/tunnelwiki/</var>.
<p>
<code><textarea id="folders" rows="30" cols="40"> <code><textarea id="folders" rows="30" cols="40">
expofiles expofiles
@ -286,7 +301,7 @@ expofiles
│   ├── 2017 │   ├── 2017
│   ├── 2018 │   ├── 2018
│   ├── 2019 │   ├── 2019
│   ├── 2020 │   ├── 2021
│   └── 90Surveybookkh │   └── 90Surveybookkh
├── terrain ├── terrain
├── training-info ├── training-info
@ -331,7 +346,7 @@ expofiles
├── 2017 ├── 2017
├── 2018 ├── 2018
├── 2019 ├── 2019
└── 2020</textarea></code> └── 2021</textarea></code>
<h3>cron</h3> <h3>cron</h3>
<p>The server runs it's hourly, daily and weekly scripts using the anacron system. In <p>The server runs it's hourly, daily and weekly scripts using the anacron system. In