implement docs-versions

2sic · Nov 23, 2023 · 7304626 · 7304626
1 parent bdde505
commit 7304626
Show file tree

Hide file tree

Showing 1,053 changed files with 9,607 additions and 4,217 deletions.
diff --git a/2sxc Docs Generator/docs-versions.md b/2sxc Docs Generator/docs-versions.md
@@ -1,19 +1,44 @@
-<img src="assets/logos/vcurrent/500.png" width="250px" align="right" class="float-right">
+<img src="assets/logos/vcurrent/500.png" width="100px" align="right" class="float-right">
+
+<script>
+  // get url parameters version and path
+  var urlParams = new URLSearchParams(window.location.search);
+  var version = urlParams.get('version');
+  var path = urlParams.get('path');
+</script>
 
 # 2sxc Documentation Versions
 
-* [Docs of Latest Version v16](https://docs.2sxc.org)
-* Docs of ... todo
+This page is a hub to all the documentation versions.
+It should help users find older/newer versions of the documentation.
 
+This page was created 2023-11 and is still WIP.
+As of now, there is only 1 documentation which is the latest,
+but future releases will start creating separated documentations.
 
-This is an experimental page WIP 2023-11
+> [!TIP]
+> <strong>You came from</strong><br>
+> Version: <script>document.write(version);</script><br>
+> Path: <code><script>document.write(path);</script></code><br>
+> ...this path may or may not exist in other versions
 
-Goal is to have old versions of the documentation available and linked from here.
 
-Old versions must always link here as well - so to <https://go.2sxc.org/docs-versions> to help users find other versions.
+## Latest Documentation
+
+* [Docs Home](https://docs.2sxc.org)
+* <script>document.write('<a target="_blank" href="https://docs.2sxc.org' + path + '">...with original path <code>' + path + '</code></a>');</script>
 
+## Previous Documentation Versions
 
+_as of now there are no previous documentation versions_
 
 ---
 
-Shortlink: <https://go.2sxc.org/docs-versions>
+## Internal Notes / Information
+
+This is an experimental page WIP 2023-11
+Goal is to have old versions of the documentation available and linked from here.
+Old versions must always link here using the short-link below.
+
+* Shortlink: <https://go.2sxc.org/docs-versions>
+* Expected url parameters: `version` and `path`
diff --git a/2sxc Docs Generator/templates/2sxc/layout/xxx-_master.tmpl b/2sxc Docs Generator/templates/2sxc/layout/xxx-_master.tmpl
@@ -0,0 +1,57 @@
+{{!Licensed to the .NET Foundation under one or more agreements. The .NET Foundation licenses this file to you under the MIT license.}}
+{{!include(/^styles/.*/)}}
+{{!include(/^fonts/.*/)}}
+{{!include(favicon.ico)}}
+{{!include(logo.svg)}}
+{{!include(search-stopwords.json)}}
+<!DOCTYPE html>
+<!--[if IE]><![endif]-->
+<html {{#_lang}}lang="{{_lang}}"{{/_lang}}>
+  {{>partials/head}}
+  {{^redirect_url}}
+  <body data-spy="scroll" data-target="#affix" data-offset="120">
+    <div id="wrapper">
+      <header>
+        {{^_disableNavbar}}
+        {{>partials/navbar}}
+        {{/_disableNavbar}}
+        {{^_disableBreadcrumb}}
+        {{>partials/breadcrumb}}
+        {{/_disableBreadcrumb}}
+      </header>
+      {{#_enableSearch}}
+      <div class="container body-content">
+        {{>partials/searchResults}}
+      </div>
+      {{/_enableSearch}}
+      <div role="main" class="container body-content hide-when-search">
+      {{^_disableToc}}
+        {{>partials/toc}}
+        <div class="article row grid-right">
+      {{/_disableToc}}
+      {{#_disableToc}}
+        <div class="article row grid">
+        {{/_disableToc}}
+          {{#_disableAffix}}
+          <div class="col-md-12">
+          {{/_disableAffix}}
+          {{^_disableAffix}}
+          <div class="col-md-10">
+          {{/_disableAffix}}
+            <article class="content wrap" id="_content" data-uid="{{uid}}">
+                {{!body}}
+            </article>
+          </div>
+          {{^_disableAffix}}
+          {{>partials/affix}}
+          {{/_disableAffix}}
+        </div>
+      </div>
+      {{^_disableFooter}}
+      {{>partials/footer}}
+      {{/_disableFooter}}
+    </div>
+    {{>partials/scripts}}
+  </body>
+  {{/redirect_url}}
+</html>
diff --git a/2sxc Docs Generator/templates/2sxc/partials/breadcrumb.tmpl.partial b/2sxc Docs Generator/templates/2sxc/partials/breadcrumb.tmpl.partial
@@ -0,0 +1,15 @@
+{{!Licensed to the .NET Foundation under one or more agreements. The .NET Foundation licenses this file to you under the MIT license.}}
+{{! from https://github.com/dotnet/docfx/blob/main/templates/default/partials/breadcrumb.tmpl.partial }}
+
+<div class="subnav navbar navbar-default">
+  <div class="container hide-when-search" id="xxx-breadcrumb">
+    <a class="navbar-right version-button" style="padding: 10px 0 0 0;" href="https://go.2sxc.org/docs-versions" target="_blank">
+      v16 <span class="glyphicon glyphicon-menu-down"></span>
+    </a>
+    <div id="breadcrumb">
+      <ul class="breadcrumb">
+        <li>{{_tocTitle}}</li>
+      </ul>
+    </div>
+  </div>
+</div>
diff --git a/2sxc Docs Generator/templates/2sxc/partials/xxx-navbar.tmpl.partial b/2sxc Docs Generator/templates/2sxc/partials/xxx-navbar.tmpl.partial
@@ -0,0 +1,23 @@
+{{!Licensed to the .NET Foundation under one or more agreements. The .NET Foundation licenses this file to you under the MIT license.}}
+{{! Copied 2023-11-23 from https://github.com/dotnet/docfx/blob/main/templates/default/partials/navbar.tmpl.partial }}
+
+<nav id="autocollapse" class="navbar navbar-inverse ng-scope" role="navigation">
+  <div class="container">
+    <div class="navbar-header">
+      <button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar">
+        <span class="sr-only">Toggle navigation</span>
+        <span class="icon-bar"></span>
+        <span class="icon-bar"></span>
+        <span class="icon-bar"></span>
+      </button>
+      {{>partials/logo}}
+    </div>
+    <div class="collapse navbar-collapse" id="navbar">
+      <form class="navbar-form navbar-right" role="search" id="search">
+        <div class="form-group">
+          <input type="text" class="form-control" id="search-query" placeholder="{{__global.search}}" autocomplete="off">
+        </div>
+      </form>
+    </div>
+  </div>
+</nav>
diff --git a/2sxc Docs Generator/templates/2sxc/styles/2sxc-scripts.js b/2sxc Docs Generator/templates/2sxc/styles/2sxc-scripts.js
@@ -1,20 +1,24 @@
 // Activate featherlite for quick lightboxes
 $(document).ready(function() {
-    //find all images, but not the logo, and add the lightbox
-    $('img').not('#logo').not('.for-link').each(function() {
-      var $img = $(this);
-      // debug
-      console.log('img', $img);
-      var filename = $img.attr('src')
-      //add cursor
-      $img.css('cursor','zoom-in');
-      $img.css('cursor','-moz-zoom-in');
-      $img.css('cursor','-webkit-zoom-in');
+  //find all images, but not the logo, and add the lightbox
+  $('img').not('#logo').not('.for-link').each(function() {
+    var $img = $(this);
+    // debug
+    console.log('img', $img);
+    var filename = $img.attr('src')
+    //add cursor
+    $img.css('cursor','zoom-in');
+    $img.css('cursor','-moz-zoom-in');
+    $img.css('cursor','-webkit-zoom-in');
 
-      //add featherlight
-      $img.attr('alt', filename);
-      $img.featherlight(filename);
+    //add featherlight
+    $img.attr('alt', filename);
+    $img.featherlight(filename);
   });
+
+  // attach current link to the version box
+  const vButton = $('.version-button');
+  vButton.attr('href', vButton.attr('href') + '?version=16.09&path=' + window.location.pathname);
 });
 
 // Fancybox

diff --git a/2sxc Docs Generator/templates/2sxc/styles/main.css b/2sxc Docs Generator/templates/2sxc/styles/main.css
@@ -423,3 +423,11 @@ svg:hover .svg-highlight {
 .svg-highlight.prepared {
   visibility: hidden;
 }
+
+/* Special version button */
+.version-button {
+  padding: 4px 12px 4px 12px !important;
+  border: 1px solid #337AB7;
+  border-radius: 5px;
+  margin: 5px -55px 0 0;
+}
diff --git a/docs/abyss/_abyss-info.html b/docs/abyss/_abyss-info.html
@@ -87,10 +87,15 @@
         </nav>
 
         <div class="subnav navbar navbar-default">
-          <div class="container hide-when-search" id="breadcrumb">
-            <ul class="breadcrumb">
-              <li></li>
-            </ul>
+          <div class="container hide-when-search" id="xxx-breadcrumb">
+            <a class="navbar-right version-button" style="padding: 10px 0 0 0;" href="https://go.2sxc.org/docs-versions" target="_blank">
+              v16 <span class="glyphicon glyphicon-menu-down"></span>
+            </a>
+            <div id="breadcrumb">
+              <ul class="breadcrumb">
+                <li></li>
+              </ul>
+            </div>
           </div>
         </div>
       </header>

diff --git a/docs/abyss/advanced.html b/docs/abyss/advanced.html
@@ -87,10 +87,15 @@
         </nav>
 
         <div class="subnav navbar navbar-default">
-          <div class="container hide-when-search" id="breadcrumb">
-            <ul class="breadcrumb">
-              <li></li>
-            </ul>
+          <div class="container hide-when-search" id="xxx-breadcrumb">
+            <a class="navbar-right version-button" style="padding: 10px 0 0 0;" href="https://go.2sxc.org/docs-versions" target="_blank">
+              v16 <span class="glyphicon glyphicon-menu-down"></span>
+            </a>
+            <div id="breadcrumb">
+              <ul class="breadcrumb">
+                <li></li>
+              </ul>
+            </div>
           </div>
         </div>
       </header>

diff --git a/docs/abyss/architecture/controllers.html b/docs/abyss/architecture/controllers.html
@@ -87,10 +87,15 @@
         </nav>
 
         <div class="subnav navbar navbar-default">
-          <div class="container hide-when-search" id="breadcrumb">
-            <ul class="breadcrumb">
-              <li></li>
-            </ul>
+          <div class="container hide-when-search" id="xxx-breadcrumb">
+            <a class="navbar-right version-button" style="padding: 10px 0 0 0;" href="https://go.2sxc.org/docs-versions" target="_blank">
+              v16 <span class="glyphicon glyphicon-menu-down"></span>
+            </a>
+            <div id="breadcrumb">
+              <ul class="breadcrumb">
+                <li></li>
+              </ul>
+            </div>
           </div>
         </div>
       </header>

diff --git a/docs/abyss/architecture/index.html b/docs/abyss/architecture/index.html
@@ -87,10 +87,15 @@
         </nav>
 
         <div class="subnav navbar navbar-default">
-          <div class="container hide-when-search" id="breadcrumb">
-            <ul class="breadcrumb">
-              <li></li>
-            </ul>
+          <div class="container hide-when-search" id="xxx-breadcrumb">
+            <a class="navbar-right version-button" style="padding: 10px 0 0 0;" href="https://go.2sxc.org/docs-versions" target="_blank">
+              v16 <span class="glyphicon glyphicon-menu-down"></span>
+            </a>
+            <div id="breadcrumb">
+              <ul class="breadcrumb">
+                <li></li>
+              </ul>
+            </div>
           </div>
         </div>
       </header>

diff --git a/docs/abyss/cdn/index.html b/docs/abyss/cdn/index.html
@@ -87,10 +87,15 @@
         </nav>
 
         <div class="subnav navbar navbar-default">
-          <div class="container hide-when-search" id="breadcrumb">
-            <ul class="breadcrumb">
-              <li></li>
-            </ul>
+          <div class="container hide-when-search" id="xxx-breadcrumb">
+            <a class="navbar-right version-button" style="padding: 10px 0 0 0;" href="https://go.2sxc.org/docs-versions" target="_blank">
+              v16 <span class="glyphicon glyphicon-menu-down"></span>
+            </a>
+            <div id="breadcrumb">
+              <ul class="breadcrumb">
+                <li></li>
+              </ul>
+            </div>
           </div>
         </div>
       </header>

diff --git a/docs/abyss/contribute/build.html b/docs/abyss/contribute/build.html
@@ -87,10 +87,15 @@
         </nav>
 
         <div class="subnav navbar navbar-default">
-          <div class="container hide-when-search" id="breadcrumb">
-            <ul class="breadcrumb">
-              <li></li>
-            </ul>
+          <div class="container hide-when-search" id="xxx-breadcrumb">
+            <a class="navbar-right version-button" style="padding: 10px 0 0 0;" href="https://go.2sxc.org/docs-versions" target="_blank">
+              v16 <span class="glyphicon glyphicon-menu-down"></span>
+            </a>
+            <div id="breadcrumb">
+              <ul class="breadcrumb">
+                <li></li>
+              </ul>
+            </div>
           </div>
         </div>
       </header>

diff --git a/docs/abyss/contribute/code.html b/docs/abyss/contribute/code.html
@@ -87,10 +87,15 @@
         </nav>
 
         <div class="subnav navbar navbar-default">
-          <div class="container hide-when-search" id="breadcrumb">
-            <ul class="breadcrumb">
-              <li></li>
-            </ul>
+          <div class="container hide-when-search" id="xxx-breadcrumb">
+            <a class="navbar-right version-button" style="padding: 10px 0 0 0;" href="https://go.2sxc.org/docs-versions" target="_blank">
+              v16 <span class="glyphicon glyphicon-menu-down"></span>
+            </a>
+            <div id="breadcrumb">
+              <ul class="breadcrumb">
+                <li></li>
+              </ul>
+            </div>
           </div>
         </div>
       </header>

diff --git a/docs/abyss/contribute/doc-tags.html b/docs/abyss/contribute/doc-tags.html
@@ -87,10 +87,15 @@
         </nav>
 
         <div class="subnav navbar navbar-default">
-          <div class="container hide-when-search" id="breadcrumb">
-            <ul class="breadcrumb">
-              <li></li>
-            </ul>
+          <div class="container hide-when-search" id="xxx-breadcrumb">
+            <a class="navbar-right version-button" style="padding: 10px 0 0 0;" href="https://go.2sxc.org/docs-versions" target="_blank">
+              v16 <span class="glyphicon glyphicon-menu-down"></span>
+            </a>
+            <div id="breadcrumb">
+              <ul class="breadcrumb">
+                <li></li>
+              </ul>
+            </div>
           </div>
         </div>
       </header>

diff --git a/docs/abyss/contribute/docs.html b/docs/abyss/contribute/docs.html
@@ -87,10 +87,15 @@
         </nav>
 
         <div class="subnav navbar navbar-default">
-          <div class="container hide-when-search" id="breadcrumb">
-            <ul class="breadcrumb">
-              <li></li>
-            </ul>
+          <div class="container hide-when-search" id="xxx-breadcrumb">
+            <a class="navbar-right version-button" style="padding: 10px 0 0 0;" href="https://go.2sxc.org/docs-versions" target="_blank">
+              v16 <span class="glyphicon glyphicon-menu-down"></span>
+            </a>
+            <div id="breadcrumb">
+              <ul class="breadcrumb">
+                <li></li>
+              </ul>
+            </div>
           </div>
         </div>
       </header>