Merge pull request #546 from nasa/issue-545-diagrams

Fix diagram links in User's Guide
nasa · Dec 5, 2024 · 995653e · 995653e
2 parents 3286d87 + f86f72e
commit 995653e
Show file tree

Hide file tree

Showing 4 changed files with 21 additions and 21 deletions.
diff --git a/docs/fpp-spec.html b/docs/fpp-spec.html
@@ -10579,7 +10579,7 @@ <h3 id="Analysis-and-Translation_Translation-Tools">22.4. Translation Tools</h3>
 </div>
 <div id="footer">
 <div id="footer-text">
-Last updated 2024-12-04 10:25:34 -0800
+Last updated 2024-12-04 15:30:17 -0800
 </div>
 </div>
 <script src="code-prettify/run_prettify.js"></script>

diff --git a/docs/fpp-users-guide.html b/docs/fpp-users-guide.html
@@ -3721,7 +3721,7 @@ <h3 id="Defining-State-Machines_States-Signals-and-Transitions">9.2. States, Sig
 </div>
 <div class="imageblock text-center">
 <div class="content">
-<img src="diagrams/state-machine/Basic.png" alt="Device state machine" width="200">
+<img src="users-guide/diagrams/state-machine/Basic.png" alt="Device state machine" width="200">
 </div>
 </div>
 <div class="paragraph">
@@ -3922,7 +3922,7 @@ <h4 id="Defining-State-Machines_Actions_Actions-in-Transitions">9.3.1. Actions i
 </div>
 <div class="imageblock text-center">
 <div class="content">
-<img src="diagrams/state-machine/ActionsInTransitions.png" alt="Device state machine with actions on transitions" width="500">
+<img src="users-guide/diagrams/state-machine/ActionsInTransitions.png" alt="Device state machine with actions on transitions" width="500">
 </div>
 </div>
 <div class="paragraph">
@@ -4047,7 +4047,7 @@ <h4 id="Defining-State-Machines_Actions_Entry-and-Exit-Actions">9.3.2. Entry and
 </div>
 <div class="imageblock text-center">
 <div class="content">
-<img src="diagrams/state-machine/EntryAndExitActions.png" alt="Device state machine with entry and exit actions" width="500">
+<img src="users-guide/diagrams/state-machine/EntryAndExitActions.png" alt="Device state machine with entry and exit actions" width="500">
 </div>
 </div>
 <div class="paragraph">
@@ -4249,7 +4249,7 @@ <h4 id="Defining-State-Machines_More-on-State-Transitions_Guarded-Transitions">9
 </div>
 <div class="imageblock text-center">
 <div class="content">
-<img src="diagrams/state-machine/GuardedTransitions.png" alt="Device state machine with a guarded transition" width="400">
+<img src="users-guide/diagrams/state-machine/GuardedTransitions.png" alt="Device state machine with a guarded transition" width="400">
 </div>
 </div>
 <div class="paragraph">
@@ -4416,7 +4416,7 @@ <h4 id="Defining-State-Machines_More-on-State-Transitions_Self-Transitions">9.4.
 </div>
 <div class="imageblock text-center">
 <div class="content">
-<img src="diagrams/state-machine/SelfTransitions.png" alt="Device state machine with a self transition" width="400">
+<img src="users-guide/diagrams/state-machine/SelfTransitions.png" alt="Device state machine with a self transition" width="400">
 </div>
 </div>
 <div class="paragraph">
@@ -4509,7 +4509,7 @@ <h4 id="Defining-State-Machines_More-on-State-Transitions_Internal-Transitions">
 </div>
 <div class="imageblock text-center">
 <div class="content">
-<img src="diagrams/state-machine/InternalTransitions.png" alt="Device state machine with an internal transition" width="200">
+<img src="users-guide/diagrams/state-machine/InternalTransitions.png" alt="Device state machine with an internal transition" width="200">
 </div>
 </div>
 <div class="paragraph">
@@ -4633,7 +4633,7 @@ <h3 id="Defining-State-Machines_Choices">9.5. Choices</h3>
 </div>
 <div class="imageblock text-center">
 <div class="content">
-<img src="diagrams/state-machine/Choices.png" alt="Device state machine with a choice" width="450">
+<img src="users-guide/diagrams/state-machine/Choices.png" alt="Device state machine with a choice" width="450">
 </div>
 </div>
 <div class="paragraph">
@@ -4956,7 +4956,7 @@ <h4 id="Defining-State-Machines_Hierarchy_Substates">9.6.1. Substates</h4>
 </div>
 <div class="imageblock text-center">
 <div class="content">
-<img src="diagrams/state-machine/Substates.png" alt="Device state machine with substates" width="500">
+<img src="users-guide/diagrams/state-machine/Substates.png" alt="Device state machine with substates" width="500">
 </div>
 </div>
 <div class="paragraph">
@@ -5183,7 +5183,7 @@ <h4 id="Defining-State-Machines_Hierarchy_Inherited-Transitions">9.6.2. Inherite
 </div>
 <div class="imageblock text-center">
 <div class="content">
-<img src="diagrams/state-machine/InheritedTransitions.png" alt="Device state machine with inherited transitions" width="600">
+<img src="users-guide/diagrams/state-machine/InheritedTransitions.png" alt="Device state machine with inherited transitions" width="600">
 </div>
 </div>
 <div class="paragraph">
@@ -14754,7 +14754,7 @@ <h4 id="Writing-C-Plus-Plus-Implementations_Implementing-Deployments_Public-Symb
 </div>
 <div id="footer">
 <div id="footer-text">
-Last updated 2024-12-04 10:26:19 -0800
+Last updated 2024-12-04 15:31:01 -0800
 </div>
 </div>
 <script src="code-prettify/run_prettify.js"></script>

diff --git a/docs/users-guide/Defining-State-Machines.adoc b/docs/users-guide/Defining-State-Machines.adoc
@@ -157,7 +157,7 @@ state machine Device {
 Here is the example represented graphically, as a UML state
 machine:
 
-image::diagrams/state-machine/Basic.png[Device state machine,200,align="center"]
+image::users-guide/diagrams/state-machine/Basic.png[Device state machine,200,align="center"]
 
 This example defines a state machine `Device` that represents
 a device with on-off behavior.
@@ -330,7 +330,7 @@ state machine Device {
 
 Here is the graphical representation:
 
-image::diagrams/state-machine/ActionsInTransitions.png[Device state machine with actions on transitions,500,align="center"]
+image::users-guide/diagrams/state-machine/ActionsInTransitions.png[Device state machine with actions on transitions,500,align="center"]
 
 In this example there are four actions:
 `initialAction1`, `initialAction2`, `offOnAction`, and `onOffAction`.
@@ -441,7 +441,7 @@ state machine Device {
 
 Here is the graphical representation:
 
-image::diagrams/state-machine/EntryAndExitActions.png[Device state machine with entry and exit actions,500,align="center"]
+image::users-guide/diagrams/state-machine/EntryAndExitActions.png[Device state machine with entry and exit actions,500,align="center"]
 
 As with actions on transitions, each entry or exit specifier names
 a list of actions, and the actions are done in the order named.
@@ -615,7 +615,7 @@ state machine Device {
 
 Here is the graphical representation:
 
-image::diagrams/state-machine/GuardedTransitions.png[Device state machine with a guarded transition,400,align="center"]
+image::users-guide/diagrams/state-machine/GuardedTransitions.png[Device state machine with a guarded transition,400,align="center"]
 
 In this example, there is one guard, `powerOnIsSafe`.
 The implementation of this function will return true
@@ -764,7 +764,7 @@ state machine Device {
 
 Here is the graphical representation:
 
-image::diagrams/state-machine/SelfTransitions.png[Device state machine with a self transition,400,align="center"]
+image::users-guide/diagrams/state-machine/SelfTransitions.png[Device state machine with a self transition,400,align="center"]
 
 In this example, when the state machine is in the `ON` state and
 it receives a `cmdReset` signal, the following behavior occurs:
@@ -843,7 +843,7 @@ state machine Device {
 
 Here is the graphical representation:
 
-image::diagrams/state-machine/InternalTransitions.png[Device state machine with an internal transition,200,align="center"]
+image::users-guide/diagrams/state-machine/InternalTransitions.png[Device state machine with an internal transition,200,align="center"]
 
 In this example, when the state machine is in state `ON` and it
 receives a `cmdReset` signal, it does the `reset` action and
@@ -946,7 +946,7 @@ state machine Device {
 
 Here is the graphical representation:
 
-image::diagrams/state-machine/Choices.png[Device state machine with a choice,450,align="center"]
+image::users-guide/diagrams/state-machine/Choices.png[Device state machine with a choice,450,align="center"]
 
 This version of the `Device` state machine has three states:
 `ON`, `OFF`, and `ERROR`.
@@ -1207,7 +1207,7 @@ state machine Device {
 
 Here is the graphical representation:
 
-image::diagrams/state-machine/Substates.png[Device state machine with substates,500,align="center"]
+image::users-guide/diagrams/state-machine/Substates.png[Device state machine with substates,500,align="center"]
 
 This state machine has four states: `ON`, `OFF`, `OFF.SAFE`, and `OFF.UNSAFE`.
 The last two states are substates of `OFF`.
@@ -1386,7 +1386,7 @@ state machine Device {
 
 Here is the graphical representation:
 
-image::diagrams/state-machine/InheritedTransitions.png[Device state machine with inherited transitions,600,align="center"]
+image::users-guide/diagrams/state-machine/InheritedTransitions.png[Device state machine with inherited transitions,600,align="center"]
 
 Here we have rewritten the
 <<Defining-State-Machines_Hierarchy_Substates,

diff --git a/docs/users-guide/diagrams/state-machine/README.adoc b/docs/users-guide/diagrams/state-machine/README.adoc
@@ -1,4 +1,4 @@
-== diagrams/state-machine
+== users-guide/diagrams/state-machine
 
 This directory contains state machine diagrams for the FPP User's Guide.
 To generate the diagrams, the command `puml` must be in your path,