update on wing design documentation

wing_design/doc/Doxyfile

@@ -1290,7 +1290,7 @@ GENERATE_HTML          = YES
 # The default directory is: html.
 # This tag requires that the tag GENERATE_HTML is set to YES.
 
-HTML_OUTPUT            = propulsionDesign
+HTML_OUTPUT            = wing_design
 
 # The HTML_FILE_EXTENSION tag can be used to specify the file extension for each
 # generated HTML page (for example: .htm, .php, .asp).
@@ -1369,7 +1369,8 @@ HTML_EXTRA_STYLESHEET  = ../../libs/extern/doxygen-awesome-css/doxygen-awesome.c
 
 HTML_EXTRA_FILES       = ../../libs/extern/doxygen-awesome-css/doxygen-awesome-darkmode-toggle.js\
     ../../libs/extern/doxygen-awesome-css/doxygen-awesome-tabs.js\
-    ../../libs/extern/doxygen-awesome-css/doxygen-awesome-fragment-copy-button.js
+    ../../libs/extern/doxygen-awesome-css/doxygen-awesome-fragment-copy-button.js\
+    
 
 # The HTML_COLORSTYLE tag can be used to specify if the generated HTML output
 # should be rendered with a dark or light theme.

wing_design/doc/content/basic-concepts.md

@@ -10,46 +10,49 @@ Here you can find available wing build methods from the _wing\_design_ tool insi
 - _UNICADO is shipped natively with the cantilever wing method for a tube and wing configuration._
 - _A basic Blended Wing body method is planned!_
 
-```mermaid
+<pre class='mermaid'>
   graph LR;
-    A[Wing Design] -->B[Tube and Wing];
+    A[Wing Design]-->B[Tube and Wing];
     B-->C[Cantilever];
     A-->D[Blended Wing body]
-```
-> [!IMPORTANT]
-> Since the documentation might be delayed to the development progress - this graph might not have all information yet
+</pre>
+
+<dl class="section bug">
+  <dt>Important</dt>
+  <dd>Since the documentation might be delayed to the development progress - this graph might not have all information yet</dd>
+</dl>
 ___
 
 ### Wing Loading
 Wing loading is the mass / weight of the aircraft distributed over its reference wing area.
 - _Initial parameter to start design_
-- _Wing Loading $= M/S$_ in ($kg/m^2$)
-- _Wing Loading $= M*g/S$_ in ($N/m^2$)
-- _$M :$ Aircraft mass_
-- _$g :$ Gravitational acceleration_
+- _Wing Loading = M / S_ in (kg/m^2)
+- _Wing Loading = M &times; g / S_ in (N/m^2)
+- _M : Aircraft mass_
+- _g : Gravitational acceleration_
 - _Wing Loading &uarr; Higher speeds at takeoff necessary_
 - _Wing Loading &darr; Lower speeds at takeoff_
 
 ### Wing Geometry
 Understanding the wing geometry is crucial for designing an efficient wing. Below are key terms and their meanings:
-- Aspect Ratio ($AR$): The ratio of the wingspan to the average chord length
-  - _$AR= {b^2}/{S}$_
-  - _$b :$ Wingspan_
-  - _$S :$ Wing reference area (projected area on ground from top view)_
-  - _High $AR$ (e.g. gliders) &rarr; increased aerodynamic efficiency (higher drag) but slender and more flexible wing._
-  - _Low $AR$ (e.g., fighter jets) &rarr; decreased aerodynmic efficiency and stiffer._
-
-- Taper Ratio ($\lambda$): The ratio of the tip chord to the root chord.
-  - _$\lambda = c_{tip}/c_{root}$_
+- Aspect Ratio (_AR_): The ratio of the wingspan to the average chord length
+  - _AR= b&sup2; / S_
+  - _b : Wingspan_
+  - _S : Wing reference area (projected area on ground from top view)_
+  - _High AR (e.g. gliders) &rarr; increased aerodynamic efficiency (higher drag) but slender and more flexible wing._
+  - _Low AR (e.g., fighter jets) &rarr; decreased aerodynmic efficiency and stiffer._
+
+- Taper Ratio (&lambda;): The ratio of the tip chord to the root chord.
+  - _\lambda = c<sub>tip</sub>/c<sub>root</sub>_
   - _A taper ratio of one indicates a rectangular wing._
   - _Reduced taper ratio can improve aerodynamic efficiency and reduce structural weight._
 
-- Sweep Angle ($\Lambda$): The angle between the chord at a given position and a line perpendicular to the chord
+- Sweep Angle (&Phi;): The angle between the chord at a given position and a line perpendicular to the chord
   - _Increased sweep leads to higher overall speeds due to reduction of the mach number normal to the leading edge_
-    - _backward sweep: increased aerodynamic load at the outer wing part &rarr; bad behaviour at high angle of attack ($AoA$)_
+    - _backward sweep: increased aerodynamic load at the outer wing part &rarr; bad behaviour at high angle of attack (AoA)_
     - _forward sweep: decreased aerodynamic load at the outer wing part but increased structural load due to wing torsion effects_
 
-- Dihedral / Anhedral Angle ($\nu$): Effects wing clearance and roll stability due to sideslip
+- Dihedral / Anhedral Angle (&nu;): Effects wing clearance and roll stability due to sideslip
   - Common dihedral angle (positive) for low wing configuration
   - Common anhedral angle (negative) for shoulder or high wing configurations
 
@@ -62,7 +65,7 @@ An airfoil defines the cross-sectional shape of a wing. The key characteristics
   - _High camber  - generates more lift but comes with increased drag_
   - _No camber (symmetrical) often used for aerobatic A/C_
   - _Chord: Defines the length of the line from leading to trailing edge_
-  - _Thickness to Chord Ratio ($t/c$): maximum airfoil thickness in relation to its chord length_
+  - _Thickness to Chord Ratio (t/c): maximum airfoil thickness in relation to its chord length_
   - _affects lift, drag and wing cross section_
 
 

wing_design/doc/content/dfw.md

@@ -253,9 +253,11 @@ The tool adapted the wing aspect ratio to the maximum possible aspect ratio sinc
 
 Soo .... Now it is your turn!
 
-> [!TIP]
-> Start by changing only one parameter at once. There might be interactions with other parameters, so don't rush!
-
+<dl class="section invariant">
+<dt>Tip</dt>
+<dd>
+Start by changing only one parameter at once. There might be interactions with other parameters, so don't rush!
+</dd>
 ## Troubleshooting
 - Tool does not run properly:
   - Make sure you have all the paths set up correctly and the specified elements exist!

wing_design/doc/content/getting-started.md

@@ -23,31 +23,29 @@ Parameters to chose:
 - `wing_configuration`:
   - `mode_0: cantilever`: sets wing type to cantilever wing.
 
-> [!NOTE]
-> Example selection
->
-> `configuration_type` is set to `tube_and_wing`
->
-> `wing_configuration` is set to `mode_0` which selects `cantilever`
-> ```mermaid
->  graph LR;
->    A[Wing Design] ==> B[Tube and Wing];
->    B==>C[Cantilever];
->    A-->D[Blended Wing body]
->
->    style B stroke-width:4px
->    style C stroke:#0f0, stroke-width:4px
->```
+To select a tube and wing with a cantilever chose the following inside the aircraft exchange file
+- `configuration_type` is set to `tube_and_wing`
+- `wing_configuration` is set to `mode_0` which selects `cantilever`
+  <pre class="mermaid">
+ graph LR;
+   A[Wing Design] ==> B[Tube and Wing];
+   B==>C[Cantilever];
+   A-->D[Blended Wing body]
+   style B stroke-width:4px
+   style C stroke:#0f0, stroke-width:4px
+   </pre>
 
 Each `wing_configuration`will have it's own block to chose parameters from.
->[!NOTE]
->For default values or ranges, you should check the description of the parameters or the allowed ranges inside the configuration file
-
-> [!TIP]
-> If you are missing some of the terms in here - take a look at [basic concepts](basic-concepts.md).
->
->
-
+<dl class="section todo">
+<dt>Note</dt>
+<dd>
+For default values or ranges, you should check the description of the parameters or the allowed ranges inside the configuration file
+</dd>
+</dl>
+<dl class ="section invariant">
+<dt>Tip</dt>
+<dd>If you are missing some of the terms in here - take a look at [basic concepts](basic-concepts.md).</dd>
+</dl>
 ## Configuration parameters &rarr; Tube and Wing
 In this section you find parameters for tube and wing methods.
 ### Cantilever calculation methods and parameters
@@ -116,8 +114,10 @@ _Spars Methods_
 ## Configuration parameters &rarr; Blended Wing Body
 In this section you find parameters for Blended Wing Body methods.
 
-> [!NOTE]
-> In the beta version of UNICADO, BWB methods are under development
+<dl class="section todo">
+<dt>Note</dt>
+<dd>In the beta version of UNICADO, BWB methods are under development</dd>
+</dl>
 
 ## Additional configurations
 Additionally, one has to define the common airfoil data paths inside the configuration file:
@@ -126,12 +126,14 @@ Additionally, one has to define the common airfoil data paths inside the configu
 ## Additional information and requirements
 The methods in the wing design tool also require additional information on the design mach number, and the ICAO aerodrome reference code (for determination of maximum allowed span) from the requirements and specification block of the _Aircraft Exchange File_.
 
-> [!IMPORTANT]
-> Keep in mind that the _wing\_design_ tool generates a wing as a part of an aircraft. This lets it rely on specific values, e.g. for definining the area inside the fuselage etc. This leads to mandatory items at this point:
->
-> - A specified fuselage - here length and width and height are necessary to determine wing geometry and wing position
-> - Initial Maximum Takeoff Mass (MTOM) - for determination of the wing area necessary based on the wing loading (only if method is selected)
+<dl class="section bug">
+<dt>Important</dt>
+<dd>
+ Keep in mind that the _wing\_design_ tool generates a wing as a part of an aircraft. This lets it rely on specific values, e.g. for definining the area inside the fuselage etc. This leads to mandatory items at this point:
 
+ - A specified fuselage - here length and width and height are necessary to determine wing geometry and wing position
+ - Initial Maximum Takeoff Mass (MTOM) - for determination of the wing area necessary based on the wing loading (only if method is selected)
+</dd>
 Please keep in mind, that the module is still in beta phase and you can gratefully contribute to the
 
 ## Next Steps

wing_design/doc/content/index.md

@@ -3,7 +3,6 @@ The wing is an essential part of the aircraft. The _wing\_design_ tool is one of
 
 ## A User's Guide to Wing Design
 The _wing\_design_ tool will help you design various wings for classical configurations to blended wing body confiugartions (in the future). This user documentation will guide you through all necessary steps to understand the tool as well as the necessary inputs and configurations to create a new wing from scratch.
-
 The following pages will guide you through the process of generating your first wing within UNICADO:
 
 - [Basic Concepts](basic-concepts.md)

wing_design/doc/header.html

@@ -10,6 +10,7 @@
 <!--BEGIN !PROJECT_NAME--><title>$title</title><!--END !PROJECT_NAME-->
 <link href="$relpath^tabs.css" rel="stylesheet" type="text/css"/>
 <!--BEGIN DISABLE_INDEX-->
+
   <!--BEGIN FULL_SIDEBAR-->
 <script type="text/javascript">var page_layout=1;</script>
   <!--END FULL_SIDEBAR-->
@@ -31,11 +32,34 @@
 $treeview
 $search
 $mathjax
-$darkmode
 <link href="$relpath^$stylesheet" rel="stylesheet" type="text/css" />
 $extrastylesheet
 </head>
 <body>
+<script type="text/javascript"src="https://cdn.jsdelivr.net/npm/mermaid@11.4.0/dist/mermaid.min.js"></script>
+<script type="text/javascript">
+  function toggleMermaidTheme(isDark) {
+    const theme = isDark ? "dark" : "default";
+    mermaid.initialize({
+      startOnLoad: true, // Prevent auto-processing
+      theme: theme,
+    });
+
+  }
+
+  function onDarkModeChange(isDark) {
+    toggleMermaidTheme(isDark);
+  }
+
+  function isDarkModeActive() {
+    return document.documentElement.classList.contains('dark-mode');
+  }
+  const observer = new MutationObserver(() => {
+    toggleMermaidTheme(isDarkModeActive())
+  })
+  observer.observe(document.documentElement, {attributes: true, attributeFilter: ['class']});
+  onDarkModeChange(isDarkModeActive());
+</script>
 <!--BEGIN DISABLE_INDEX-->
   <!--BEGIN FULL_SIDEBAR-->
 <div id="side-nav" class="ui-resizable side-nav-resizable"><!-- do not remove this div, it is closed by doxygen! -->