Add final version of the user manual

.github/workflows/build.yml

@@ -45,14 +45,9 @@ jobs:
           path: build/packages
 
   build-linux:
-    runs-on: ubuntu-18.04
+    runs-on: ubuntu-20.04
     timeout-minutes: 30
     steps:
-      - uses: egor-tensin/setup-gcc@v1
-        with:
-          version: 11
-          platform: x64
-
       - uses: actions/checkout@v2
         with:
           path: virtualbow

documents/user-manual/source/appendix-tips-and-tricks.md

@@ -29,7 +29,7 @@ After selecting *Background image...* in the plot's context menu, you can load a
 
 <figure>
   <img src="images/screenshots/editor/plot-overlay.png" style="width:600px">
-  <figcaption><b>Figure:</b> Table context menu</figcaption>
+  <figcaption><b>Figure:</b> Background image dialog</figcaption>
 </figure>
 
 This feature can be used to model existing bows more easily or to compare the simulation results with actual photographs.

documents/user-manual/source/introduction.md

@@ -20,5 +20,5 @@ For support, feedback or to get the latest version of the software please visit
 
 > [https://www.virtualbow.org/](https://www.virtualbow.org/)
 
-Please keep in mind that VirtualBow is still under development!
+> **Note:** Please keep in mind that VirtualBow is still under development.
 The simulation results are still largely unverified and should not be taken at face value yet, although many users already reported good agreement.

documents/user-manual/source/model-editor-layers.md

@@ -25,4 +25,5 @@ Layer heights may be zero over portions of the length.
 This is useful for modelling layers that don't cover the whole limb.
 Common examples for this are fadeouts and tip wedges.
 
-The actual height distribution is constructed as a smooth curve (monotone cubic spline) passing through the supplied values and is shown in the _Graph_ panel.
+The actual height distribution is constructed as a smooth curve (monotone cubic spline) passing through the supplied values and is shown in the _Graph_ panel.
+You can use the context menu for additional options on the plot, like showing/hiding control points or adding an overlay image.

documents/user-manual/source/model-editor-profile.md

@@ -10,6 +10,7 @@ The profile defines the shape of the (back of the) bow in unbraced state.
 If the _Profile_ category in the model tree is selected, the buttons (<img src="images/icons/list-add.svg" style="width:20; vertical-align:middle">, <img src="images/icons/list-remove.svg" style="width:20; vertical-align:middle">, <img src="images/icons/list-move-up.svg" style="width:20; vertical-align:middle">, <img src="images/icons/list-move-down.svg" style="width:20; vertical-align:middle">) can be used to add, remove and reorder segments of different types that make up the profile curve (e.g. lines, arcs and more).
 The properties of each segment depend on its type and are explained below.
 The resulting shape of the profile curve is shown in the _Graph_ panel.
+You can use the context menu for additional options on the plot, like showing/hiding control points, curvature or adding an overlay image.
 
 <figure>
   <img src="images/screenshots/editor/profile-plot.png" style="width:800px">

documents/user-manual/source/model-editor-width.md

@@ -10,4 +10,5 @@ The width is the same for all layers of the bow.
 
 The width distribution is defined by a table of relative length and width values.
 Each table row must contain a relative length along the limb (from 0% to 100%) and the corresponding width.
-The actual width distribution is constructed as a smooth curve (monotone cubic spline) passing through the supplied values and is shown in the _Graph_ panel.
+The actual width distribution is constructed as a smooth curve (monotone cubic spline) passing through the supplied values and is shown in the _Graph_ panel.
+You can use the context menu for additional options on the plot, like showing/hiding control points or adding an overlay image.

documents/user-manual/source/result-viewer.md

@@ -15,3 +15,5 @@ Below the tabs there is a slider where you can change the current state of the b
 This value applies to all of the tabs.
 Drag the slider to a specific position or use the play buttons to show the simulation results as a continuous animation.
 The input field and the dropdown menu next to it allow you to jump directly to special points in the results, for example where certain forces or stresses reach their maximum.
+
+> **Note:** The physical units that are used throughout the result viewer can be changed under _Options_ - _Units_.

platforms/linux/CMakeLists.txt

@@ -5,7 +5,7 @@ add_custom_command(
     COMMAND ${CMAKE_COMMAND} -E copy ${CMAKE_CURRENT_SOURCE_DIR}/virtualbow-gui.desktop ${CMAKE_BINARY_DIR}/linux/usr/share/applications/virtualbow-gui.desktop
     COMMAND ${CMAKE_COMMAND} -E copy ${CMAKE_CURRENT_SOURCE_DIR}/virtualbow-post.desktop ${CMAKE_BINARY_DIR}/linux/usr/share/applications/virtualbow-post.desktop
     COMMAND ${CMAKE_COMMAND} -E copy ${CMAKE_SOURCE_DIR}/resources/icons/logo.svg ${CMAKE_BINARY_DIR}/linux/usr/share/icons/hicolor/scalable/apps/virtualbow.svg
-    COMMAND ${CMAKE_COMMAND} -E copy ${CMAKE_SOURCE_DIR}/resources/docs/user-manual/* ${CMAKE_BINARY_DIR}/linux/usr/share/virtualbow/user-manual
+    COMMAND ${CMAKE_COMMAND} -E copy_directory ${CMAKE_SOURCE_DIR}/resources/docs/user-manual ${CMAKE_BINARY_DIR}/linux/usr/share/virtualbow/user-manual
     COMMAND ${CMAKE_COMMAND} -E copy ${CMAKE_BINARY_DIR}/application/virtualbow-gui ${CMAKE_BINARY_DIR}/linux/usr/bin/virtualbow-gui
     COMMAND ${CMAKE_COMMAND} -E copy ${CMAKE_BINARY_DIR}/application/virtualbow-slv ${CMAKE_BINARY_DIR}/linux/usr/bin/virtualbow-slv
     COMMAND ${CMAKE_COMMAND} -E copy ${CMAKE_BINARY_DIR}/application/virtualbow-post ${CMAKE_BINARY_DIR}/linux/usr/bin/virtualbow-post

resources/docs/user-manual/.nojekyll

@@ -0,0 +1 @@
+This file makes sure that Github Pages doesn't process mdBook's output.

resources/docs/user-manual/404.html

@@ -0,0 +1,169 @@
+<!DOCTYPE HTML>
+<html lang="en" class="sidebar-visible no-js light">
+    <head>
+        <!-- Book generated using mdBook -->
+        <meta charset="UTF-8">
+        <title>Page not found - VirtualBow User Manual</title>
+        <base href="/">
+        <!-- Custom HTML head -->
+        <meta content="text/html; charset=utf-8" http-equiv="Content-Type">
+        <meta name="description" content="">
+        <meta name="viewport" content="width=device-width, initial-scale=1">
+        <meta name="theme-color" content="#ffffff" />
+
+        <link rel="icon" href="favicon.svg">
+        <link rel="shortcut icon" href="favicon.png">
+        <link rel="stylesheet" href="css/variables.css">
+        <link rel="stylesheet" href="css/general.css">
+        <link rel="stylesheet" href="css/chrome.css">
+        <link rel="stylesheet" href="css/print.css" media="print">
+        <!-- Fonts -->
+        <link rel="stylesheet" href="FontAwesome/css/font-awesome.css">
+        <link rel="stylesheet" href="fonts/fonts.css">
+        <!-- Highlight.js Stylesheets -->
+        <link rel="stylesheet" href="highlight.css">
+        <link rel="stylesheet" href="tomorrow-night.css">
+        <link rel="stylesheet" href="ayu-highlight.css">
+
+        <!-- Custom theme stylesheets -->
+        <!-- MathJax -->
+        <script async type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.1/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
+    </head>
+    <body>
+        <!-- Provide site root to javascript -->
+        <script type="text/javascript">
+            var path_to_root = "";
+            var default_theme = window.matchMedia("(prefers-color-scheme: dark)").matches ? "navy" : "light";
+        </script>
+
+        <!-- Work around some values being stored in localStorage wrapped in quotes -->
+        <script type="text/javascript">
+            try {
+                var theme = localStorage.getItem('mdbook-theme');
+                var sidebar = localStorage.getItem('mdbook-sidebar');
+
+                if (theme.startsWith('"') && theme.endsWith('"')) {
+                    localStorage.setItem('mdbook-theme', theme.slice(1, theme.length - 1));
+                }
+
+                if (sidebar.startsWith('"') && sidebar.endsWith('"')) {
+                    localStorage.setItem('mdbook-sidebar', sidebar.slice(1, sidebar.length - 1));
+                }
+            } catch (e) { }
+        </script>
+
+        <!-- Set the theme before any content is loaded, prevents flash -->
+        <script type="text/javascript">
+            var theme;
+            try { theme = localStorage.getItem('mdbook-theme'); } catch(e) { }
+            if (theme === null || theme === undefined) { theme = default_theme; }
+            var html = document.querySelector('html');
+            html.classList.remove('no-js')
+            html.classList.remove('light')
+            html.classList.add(theme);
+            html.classList.add('js');
+        </script>
+
+        <!-- Hide / unhide sidebar before it is displayed -->
+        <script type="text/javascript">
+            var html = document.querySelector('html');
+            var sidebar = 'hidden';
+            if (document.body.clientWidth >= 1080) {
+                try { sidebar = localStorage.getItem('mdbook-sidebar'); } catch(e) { }
+                sidebar = sidebar || 'visible';
+            }
+            html.classList.remove('sidebar-visible');
+            html.classList.add("sidebar-" + sidebar);
+        </script>
+
+        <nav id="sidebar" class="sidebar" aria-label="Table of contents">
+            <div class="sidebar-scrollbox">
+                <ol class="chapter"><li class="chapter-item expanded affix "><a href="introduction.html">Introduction</a></li><li class="chapter-item expanded "><a href="model-editor.html"><strong aria-hidden="true">1.</strong> Model Editor</a></li><li><ol class="section"><li class="chapter-item expanded "><a href="model-editor-comments.html"><strong aria-hidden="true">1.1.</strong> Comments</a></li><li class="chapter-item expanded "><a href="model-editor-settings.html"><strong aria-hidden="true">1.2.</strong> Settings</a></li><li class="chapter-item expanded "><a href="model-editor-dimensions.html"><strong aria-hidden="true">1.3.</strong> Dimensions</a></li><li class="chapter-item expanded "><a href="model-editor-materials.html"><strong aria-hidden="true">1.4.</strong> Materials</a></li><li class="chapter-item expanded "><a href="model-editor-layers.html"><strong aria-hidden="true">1.5.</strong> Layers</a></li><li class="chapter-item expanded "><a href="model-editor-profile.html"><strong aria-hidden="true">1.6.</strong> Profile</a></li><li class="chapter-item expanded "><a href="model-editor-width.html"><strong aria-hidden="true">1.7.</strong> Width</a></li><li class="chapter-item expanded "><a href="model-editor-string.html"><strong aria-hidden="true">1.8.</strong> String</a></li><li class="chapter-item expanded "><a href="model-editor-masses.html"><strong aria-hidden="true">1.9.</strong> Masses</a></li><li class="chapter-item expanded "><a href="model-editor-damping.html"><strong aria-hidden="true">1.10.</strong> Damping</a></li></ol></li><li class="chapter-item expanded "><a href="result-viewer.html"><strong aria-hidden="true">2.</strong> Result Viewer</a></li><li><ol class="section"><li class="chapter-item expanded "><a href="result-viewer-characteristics.html"><strong aria-hidden="true">2.1.</strong> Characteristics</a></li><li class="chapter-item expanded "><a href="result-viewer-shape.html"><strong aria-hidden="true">2.2.</strong> Shape</a></li><li class="chapter-item expanded "><a href="result-viewer-stress.html"><strong aria-hidden="true">2.3.</strong> Stress</a></li><li class="chapter-item expanded "><a href="result-viewer-curvature.html"><strong aria-hidden="true">2.4.</strong> Curvature</a></li><li class="chapter-item expanded "><a href="result-viewer-energy.html"><strong aria-hidden="true">2.5.</strong> Energy</a></li><li class="chapter-item expanded "><a href="result-viewer-others.html"><strong aria-hidden="true">2.6.</strong> Other Plots</a></li></ol></li><li class="chapter-item expanded "><a href="solver.html"><strong aria-hidden="true">3.</strong> Solver</a></li><li><ol class="section"><li class="chapter-item expanded "><a href="solver-command-line.html"><strong aria-hidden="true">3.1.</strong> Command Line</a></li><li class="chapter-item expanded "><a href="solver-file-formats.html"><strong aria-hidden="true">3.2.</strong> File Formats</a></li><li class="chapter-item expanded "><a href="solver-scripting.html"><strong aria-hidden="true">3.3.</strong> Scripting</a></li></ol></li><li class="chapter-item expanded "><a href="appendix.html"><strong aria-hidden="true">4.</strong> Appendix</a></li><li><ol class="section"><li class="chapter-item expanded "><a href="appendix-model-files.html"><strong aria-hidden="true">4.1.</strong> A - Model Files</a></li><li class="chapter-item expanded "><a href="appendix-result-files.html"><strong aria-hidden="true">4.2.</strong> B - Result Files</a></li><li class="chapter-item expanded "><a href="appendix-bending-test.html"><strong aria-hidden="true">4.3.</strong> C - Bending Test</a></li><li class="chapter-item expanded "><a href="appendix-tips-and-tricks.html"><strong aria-hidden="true">4.4.</strong> D - Tips & Tricks</a></li></ol></li></ol>
+            </div>
+            <div id="sidebar-resize-handle" class="sidebar-resize-handle"></div>
+        </nav>
+
+        <div id="page-wrapper" class="page-wrapper">
+
+            <div class="page">
+                <div id="menu-bar-hover-placeholder"></div>
+                <div id="menu-bar" class="menu-bar sticky bordered">
+                    <div class="left-buttons">
+                        <button id="sidebar-toggle" class="icon-button" type="button" title="Toggle Table of Contents" aria-label="Toggle Table of Contents" aria-controls="sidebar">
+                            <i class="fa fa-bars"></i>
+                        </button>
+                        <button id="theme-toggle" class="icon-button" type="button" title="Change theme" aria-label="Change theme" aria-haspopup="true" aria-expanded="false" aria-controls="theme-list">
+                            <i class="fa fa-paint-brush"></i>
+                        </button>
+                        <ul id="theme-list" class="theme-popup" aria-label="Themes" role="menu">
+                            <li role="none"><button role="menuitem" class="theme" id="light">Light (default)</button></li>
+                            <li role="none"><button role="menuitem" class="theme" id="rust">Rust</button></li>
+                            <li role="none"><button role="menuitem" class="theme" id="coal">Coal</button></li>
+                            <li role="none"><button role="menuitem" class="theme" id="navy">Navy</button></li>
+                            <li role="none"><button role="menuitem" class="theme" id="ayu">Ayu</button></li>
+                        </ul>
+                        <button id="search-toggle" class="icon-button" type="button" title="Search. (Shortkey: s)" aria-label="Toggle Searchbar" aria-expanded="false" aria-keyshortcuts="S" aria-controls="searchbar">
+                            <i class="fa fa-search"></i>
+                        </button>
+                    </div>
+
+                    <h1 class="menu-title">VirtualBow User Manual</h1>
+
+                    <div class="right-buttons">
+                        <a href="print.html" title="Print this book" aria-label="Print this book">
+                            <i id="print-button" class="fa fa-print"></i>
+                        </a>
+                    </div>
+                </div>
+
+                <div id="search-wrapper" class="hidden">
+                    <form id="searchbar-outer" class="searchbar-outer">
+                        <input type="search" id="searchbar" name="searchbar" placeholder="Search this book ..." aria-controls="searchresults-outer" aria-describedby="searchresults-header">
+                    </form>
+                    <div id="searchresults-outer" class="searchresults-outer hidden">
+                        <div id="searchresults-header" class="searchresults-header"></div>
+                        <ul id="searchresults">
+                        </ul>
+                    </div>
+                </div>
+                <!-- Apply ARIA attributes after the sidebar and the sidebar toggle button are added to the DOM -->
+                <script type="text/javascript">
+                    document.getElementById('sidebar-toggle').setAttribute('aria-expanded', sidebar === 'visible');
+                    document.getElementById('sidebar').setAttribute('aria-hidden', sidebar !== 'visible');
+                    Array.from(document.querySelectorAll('#sidebar a')).forEach(function(link) {
+                        link.setAttribute('tabIndex', sidebar === 'visible' ? 0 : -1);
+                    });
+                </script>
+
+                <div id="content" class="content">
+                    <main>
+                        <h1 id="document-not-found-404"><a class="header" href="#document-not-found-404">Document not found (404)</a></h1>
+<p>This URL is invalid, sorry. Please use the navigation bar or search to continue.</p>
+
+                    </main>
+
+                    <nav class="nav-wrapper" aria-label="Page navigation">
+                        <!-- Mobile navigation buttons -->
+                        <div style="clear: both"></div>
+                    </nav>
+                </div>
+            </div>
+
+            <nav class="nav-wide-wrapper" aria-label="Page navigation">
+            </nav>
+
+        </div>
+
+        <script type="text/javascript">
+            window.playground_copyable = true;
+        </script>
+        <script src="elasticlunr.min.js" type="text/javascript" charset="utf-8"></script>
+        <script src="mark.min.js" type="text/javascript" charset="utf-8"></script>
+        <script src="searcher.js" type="text/javascript" charset="utf-8"></script>
+        <script src="clipboard.min.js" type="text/javascript" charset="utf-8"></script>
+        <script src="highlight.js" type="text/javascript" charset="utf-8"></script>
+        <script src="book.js" type="text/javascript" charset="utf-8"></script>
+
+        <!-- Custom JS scripts -->
+    </body>
+</html>