Merge pull request #53 from rhuygen/main

Updated backlinks at the top of the manuals
IvS-KULeuven · Mar 29, 2024 · 8490bb9 · 8490bb9
2 parents ae415bc + a57b629
commit 8490bb9
Show file tree

Hide file tree

Showing 16 changed files with 175 additions and 41 deletions.
diff --git a/docs/asciidocs/commanding-manual.html b/docs/asciidocs/commanding-manual.html
@@ -727,11 +727,31 @@ <h1>Ground Tests Commanding Manual</h1>
 <div id="content">
 <div id="preamble">
 <div class="sectionbody">
-<div class="sidebarblock">
-<div class="content">
-Backlink &#8594; <a href="https://ivs-kuleuven.github.io/plato-cgse-doc/">CGSE Documentation web site</a>
-</div>
-</div>
+<table class="tableblock frame-all grid-all stretch">
+<colgroup>
+<col style="width: 50%;">
+<col style="width: 50%;">
+</colgroup>
+<thead>
+<tr>
+<th class="tableblock halign-left valign-top" colspan="2"><a href="https://ivs-kuleuven.github.io/plato-cgse-doc/">Backlink to the CGSE Documentation Website</a></th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="https://ivs-kuleuven.github.io/plato-cgse-doc/asciidocs/user-manual.html">User Manual</a></p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="https://ivs-kuleuven.github.io/plato-cgse-doc/asciidocs/developer-manual.html">Developer Manual</a></p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Commanding Manual (this document)</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="https://ivs-kuleuven.github.io/plato-cgse-doc/api/egse/index.html">CGSE API Documentation</a></p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="https://ivs-kuleuven.github.io/plato-cgse-doc/asciidocs/installation-manual.html">Installation Manual</a></p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="https://ivs-kuleuven.github.io/plato-cgse-doc/asciidocs/icd.html">Interface Control Document (ICD)</a></p></td>
+</tr>
+</tbody>
+</table>
 </div>
 </div>
 <div class="sect1">
@@ -8723,7 +8743,7 @@ <h4 id="_pvs">18.E.3. PVS</h4>
 <div id="footer">
 <div id="footer-text">
 Version 0.13<br>
-Last updated 2024-03-29 11:20:52 +0100
+Last updated 2024-03-29 11:36:57 +0100
 </div>
 </div>
 <script>

diff --git a/docs/asciidocs/developer-manual.html b/docs/asciidocs/developer-manual.html
@@ -817,17 +817,23 @@ <h1>Common–EGSE : Developer Manual</h1>
 <col style="width: 50%;">
 <col style="width: 50%;">
 </colgroup>
+<thead>
+<tr>
+<th class="tableblock halign-left valign-top" colspan="2"><a href="https://ivs-kuleuven.github.io/plato-cgse-doc/">Backlink to the CGSE Documentation Website</a></th>
+</tr>
+</thead>
 <tbody>
 <tr>
-<td class="tableblock halign-left valign-top" colspan="2"><p class="tableblock"><a href="https://ivs-kuleuven.github.io/plato-cgse-doc/">Backlink to the CGSE Documentation Website</a></p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="https://ivs-kuleuven.github.io/plato-cgse-doc/asciidocs/user-manual.html">User Manual</a></p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Developer Manual (this document)</p></td>
 </tr>
 <tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="https://ivs-kuleuven.github.io/plato-cgse-doc/asciidocs/commanding-manual.html">Commanding Manual</a></p></td>
 <td class="tableblock halign-left valign-top"><p class="tableblock"><a href="https://ivs-kuleuven.github.io/plato-cgse-doc/api/egse/index.html">CGSE API Documentation</a></p></td>
-<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="https://ivs-kuleuven.github.io/plato-cgse-doc/asciidocs/installation-manual.html">Installation Manual</a></p></td>
 </tr>
 <tr>
-<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="https://ivs-kuleuven.github.io/plato-cgse-doc/asciidocs/user-manual.html">User Manual</a></p></td>
-<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="https://ivs-kuleuven.github.io/plato-cgse-doc/asciidocs/commanding-manual.html">Commanding Manual</a></p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="https://ivs-kuleuven.github.io/plato-cgse-doc/asciidocs/installation-manual.html">Installation Manual</a></p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="https://ivs-kuleuven.github.io/plato-cgse-doc/asciidocs/icd.html">Interface Control Document (ICD)</a></p></td>
 </tr>
 </tbody>
 </table>
@@ -7475,7 +7481,7 @@ <h3 id="_setting_up_the_development_environment">32.2. Setting up the developmen
 <div id="footer">
 <div id="footer-text">
 Version 1.10<br>
-Last updated 2024-03-18 08:24:32 +0100
+Last updated 2024-03-29 11:36:34 +0100
 </div>
 </div>
 <script type="text/x-mathjax-config">

diff --git a/docs/asciidocs/icd.html b/docs/asciidocs/icd.html
@@ -585,11 +585,31 @@ <h1>Common-EGSE : Interface Control Document</h1>
 <div id="content">
 <div id="preamble">
 <div class="sectionbody">
-<div class="sidebarblock">
-<div class="content">
-Backlink &#8594; <a href="https://ivs-kuleuven.github.io/plato-cgse-doc/">CGSE Documentation web site</a>
-</div>
-</div>
+<table class="tableblock frame-all grid-all stretch">
+<colgroup>
+<col style="width: 50%;">
+<col style="width: 50%;">
+</colgroup>
+<thead>
+<tr>
+<th class="tableblock halign-left valign-top" colspan="2"><a href="https://ivs-kuleuven.github.io/plato-cgse-doc/">Backlink to the CGSE Documentation Website</a></th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="https://ivs-kuleuven.github.io/plato-cgse-doc/asciidocs/user-manual.html">User Manual</a></p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="https://ivs-kuleuven.github.io/plato-cgse-doc/asciidocs/developer-manual.html">Developer Manual</a></p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="https://ivs-kuleuven.github.io/plato-cgse-doc/asciidocs/commanding-manual.html">Commanding Manual</a></p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="https://ivs-kuleuven.github.io/plato-cgse-doc/api/egse/index.html">CGSE API Documentation</a></p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="https://ivs-kuleuven.github.io/plato-cgse-doc/asciidocs/installation-manual.html">Installation Manual</a></p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Interface Control Document (ICD, this document)</p></td>
+</tr>
+</tbody>
+</table>
 </div>
 </div>
 <div class="sect1">
@@ -1341,7 +1361,7 @@ <h3 id="hdf5-format">4.2. The format of the HDF5 files</h3>
 <i class="fa icon-note" title="Note"></i>
 </td>
 <td class="content">
-So, why do need this additional <code>hk_data</code>? This was a request by ESA, the housekeeping after all data is sent contains valuable information about the FEE during the transmission of the data, e.g. the error flags reflect possible errors that occurred during the transmission.
+So, why do we need this additional <code>hk_data</code>? This was a request by ESA, the housekeeping after all data is sent contains valuable information about the FEE during the transmission of the data, e.g. the error flags reflect possible errors that occurred during the transmission.
 </td>
 </tr>
 </table>
@@ -2501,7 +2521,7 @@ <h2 id="list-of-files">6. List of Files</h2>
 <div id="footer">
 <div id="footer-text">
 Version 0.4<br>
-Last updated 2024-03-29 11:21:21 +0100
+Last updated 2024-03-29 11:38:10 +0100
 </div>
 </div>
 <script>

diff --git a/docs/asciidocs/installation-manual.html b/docs/asciidocs/installation-manual.html
@@ -664,11 +664,31 @@ <h1>Common-EGSE : Installation Manual</h1>
 <div id="content">
 <div id="preamble">
 <div class="sectionbody">
-<div class="sidebarblock">
-<div class="content">
-Backlink &#8594; <a href="https://ivs-kuleuven.github.io/plato-cgse-doc/">CGSE Documentation web site</a>
-</div>
-</div>
+<table class="tableblock frame-all grid-all stretch">
+<colgroup>
+<col style="width: 50%;">
+<col style="width: 50%;">
+</colgroup>
+<thead>
+<tr>
+<th class="tableblock halign-left valign-top" colspan="2"><a href="https://ivs-kuleuven.github.io/plato-cgse-doc/">Backlink to the CGSE Documentation Website</a></th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="https://ivs-kuleuven.github.io/plato-cgse-doc/asciidocs/user-manual.html">User Manual</a></p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="https://ivs-kuleuven.github.io/plato-cgse-doc/asciidocs/developer-manual.html">Developer Manual</a></p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="https://ivs-kuleuven.github.io/plato-cgse-doc/asciidocs/commanding-manual.html">Commanding Manual</a></p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="https://ivs-kuleuven.github.io/plato-cgse-doc/api/egse/index.html">CGSE API Documentation</a></p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Installation Manual (this document)</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="https://ivs-kuleuven.github.io/plato-cgse-doc/asciidocs/icd.html">Interface Control Document (ICD)</a></p></td>
+</tr>
+</tbody>
+</table>
 </div>
 </div>
 <div class="sect1">
@@ -3448,7 +3468,7 @@ <h3 id="_textualog_tui">21.2. Textualog TUI</h3>
 <div id="footer">
 <div id="footer-text">
 Version 1.5<br>
-Last updated 2023-09-15 22:05:05 +0200
+Last updated 2024-03-29 11:39:04 +0100
 </div>
 </div>
 <script>

diff --git a/docs/asciidocs/user-manual.html b/docs/asciidocs/user-manual.html
@@ -614,11 +614,31 @@ <h1>Common–EGSE &amp; Test Scripts: User Manual</h1>
 <div id="content">
 <div id="preamble">
 <div class="sectionbody">
-<div class="sidebarblock">
-<div class="content">
-Backlink &#8594; <a href="https://ivs-kuleuven.github.io/plato-cgse-doc/">CGSE Documentation web site</a>
-</div>
-</div>
+<table class="tableblock frame-all grid-all stretch">
+<colgroup>
+<col style="width: 50%;">
+<col style="width: 50%;">
+</colgroup>
+<thead>
+<tr>
+<th class="tableblock halign-left valign-top" colspan="2"><a href="https://ivs-kuleuven.github.io/plato-cgse-doc/">Backlink to the CGSE Documentation Website</a></th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">User Manual (this document)</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="https://ivs-kuleuven.github.io/plato-cgse-doc/asciidocs/developer-manual.html">Developer Manual</a></p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="https://ivs-kuleuven.github.io/plato-cgse-doc/asciidocs/commanding-manual.html">Commanding Manual</a></p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="https://ivs-kuleuven.github.io/plato-cgse-doc/api/egse/index.html">CGSE API Documentation</a></p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="https://ivs-kuleuven.github.io/plato-cgse-doc/asciidocs/installation-manual.html">Installation Manual</a></p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="https://ivs-kuleuven.github.io/plato-cgse-doc/asciidocs/icd.html">Interface Control Document (ICD)</a></p></td>
+</tr>
+</tbody>
+</table>
 </div>
 </div>
 <div class="sect1">
@@ -2479,7 +2499,7 @@ <h3 id="_where_can_i_find_my_test_data">5.8. Where can I find my test data?</h3>
 <div id="footer">
 <div id="footer-text">
 Version 0.3<br>
-Last updated 2024-03-18 08:25:16 +0100
+Last updated 2024-03-29 11:39:52 +0100
 </div>
 </div>
 <script>

diff --git a/docs/pdfs/commanding-manual.pdf b/docs/pdfs/commanding-manual.pdf
diff --git a/docs/pdfs/developer-manual.pdf b/docs/pdfs/developer-manual.pdf
diff --git a/docs/pdfs/icd.pdf b/docs/pdfs/icd.pdf
diff --git a/docs/pdfs/installation-manual.pdf b/docs/pdfs/installation-manual.pdf
diff --git a/docs/pdfs/user-manual.pdf b/docs/pdfs/user-manual.pdf
diff --git a/src/command/commanding-manual.adoc b/src/command/commanding-manual.adoc
@@ -23,8 +23,19 @@ endif::[]
 
 ifndef::backend-pdf[]
 
-[sidebar]
-Backlink -> https://ivs-kuleuven.github.io/plato-cgse-doc/[CGSE Documentation web site]
+[cols="1,1"]
+|===
+2+| https://ivs-kuleuven.github.io/plato-cgse-doc/[Backlink to the CGSE Documentation Website]
+
+| https://ivs-kuleuven.github.io/plato-cgse-doc/asciidocs/user-manual.html[User Manual]
+| https://ivs-kuleuven.github.io/plato-cgse-doc/asciidocs/developer-manual.html[Developer Manual]
+
+| Commanding Manual (this document)
+| https://ivs-kuleuven.github.io/plato-cgse-doc/api/egse/index.html[CGSE API Documentation]
+
+| https://ivs-kuleuven.github.io/plato-cgse-doc/asciidocs/installation-manual.html[Installation Manual]
+| https://ivs-kuleuven.github.io/plato-cgse-doc/asciidocs/icd.html[Interface Control Document (ICD)]
+|===
 
 endif::[]
 

diff --git a/src/develop/developer-manual.adoc b/src/develop/developer-manual.adoc
@@ -26,10 +26,14 @@ ifndef::backend-pdf[]
 [cols="1,1"]
 |===
 2+| https://ivs-kuleuven.github.io/plato-cgse-doc/[Backlink to the CGSE Documentation Website]
-| https://ivs-kuleuven.github.io/plato-cgse-doc/api/egse/index.html[CGSE API Documentation]
-| https://ivs-kuleuven.github.io/plato-cgse-doc/asciidocs/installation-manual.html[Installation Manual]
+
 | https://ivs-kuleuven.github.io/plato-cgse-doc/asciidocs/user-manual.html[User Manual]
+| Developer Manual (this document)
+
 | https://ivs-kuleuven.github.io/plato-cgse-doc/asciidocs/commanding-manual.html[Commanding Manual]
+| https://ivs-kuleuven.github.io/plato-cgse-doc/api/egse/index.html[CGSE API Documentation]
+
+| https://ivs-kuleuven.github.io/plato-cgse-doc/asciidocs/installation-manual.html[Installation Manual]
 | https://ivs-kuleuven.github.io/plato-cgse-doc/asciidocs/icd.html[Interface Control Document (ICD)]
 |===
 

diff --git a/src/icd/hdf5-format.adoc b/src/icd/hdf5-format.adoc
@@ -179,7 +179,7 @@ array([ 80, 240,   0, 144,   5, 130,  24,  29,   0,   0, 128,   0, 128,
 ======
 There is also a `hk_data` dataset which contains the housekeeping data that was requested from the FEE after all image data has been transmitted. The difference between the `hk` and the `hk_data` is that the former is a `HousekeepingPacket` object, while the latter is a `HousekeepingData` object. The reason for this difference is that the `hk` is a SpW packet that is always sent by the FEE after the timecode, the `hk_data` is the memory requested that contains the housekeeping information, no SpW packet was every constructed for it (as it was sent in an RMAP read request reply).
 
-NOTE: So, why do need this additional `hk_data`? This was a request by ESA, the housekeeping after all data is sent contains valuable information about the FEE during the transmission of the data, e.g. the error flags reflect possible errors that occurred during the transmission.
+NOTE: So, why do we need this additional `hk_data`? This was a request by ESA, the housekeeping after all data is sent contains valuable information about the FEE during the transmission of the data, e.g. the error flags reflect possible errors that occurred during the transmission.
 
 The CGSE provides a module to inspect and work with PLATO SpaceWire packets. The above housekeeping packet can be inspected using the `HousekeepingPacket` class from the `egse.spw` package:
 [tabs]

diff --git a/src/icd/icd.adoc b/src/icd/icd.adoc
@@ -22,8 +22,19 @@ endif::[]
 
 ifndef::backend-pdf[]
 
-[sidebar]
-Backlink -> https://ivs-kuleuven.github.io/plato-cgse-doc/[CGSE Documentation web site]
+[cols="1,1"]
+|===
+2+| https://ivs-kuleuven.github.io/plato-cgse-doc/[Backlink to the CGSE Documentation Website]
+
+| https://ivs-kuleuven.github.io/plato-cgse-doc/asciidocs/user-manual.html[User Manual]
+| https://ivs-kuleuven.github.io/plato-cgse-doc/asciidocs/developer-manual.html[Developer Manual]
+
+| https://ivs-kuleuven.github.io/plato-cgse-doc/asciidocs/commanding-manual.html[Commanding Manual]
+| https://ivs-kuleuven.github.io/plato-cgse-doc/api/egse/index.html[CGSE API Documentation]
+
+| https://ivs-kuleuven.github.io/plato-cgse-doc/asciidocs/installation-manual.html[Installation Manual]
+| Interface Control Document (ICD, this document)
+|===
 
 endif::[]
 

diff --git a/src/installation/installation-manual.adoc b/src/installation/installation-manual.adoc
@@ -23,8 +23,19 @@ endif::[]
 
 ifndef::backend-pdf[]
 
-[sidebar]
-Backlink -> https://ivs-kuleuven.github.io/plato-cgse-doc/[CGSE Documentation web site]
+[cols="1,1"]
+|===
+2+| https://ivs-kuleuven.github.io/plato-cgse-doc/[Backlink to the CGSE Documentation Website]
+
+| https://ivs-kuleuven.github.io/plato-cgse-doc/asciidocs/user-manual.html[User Manual]
+| https://ivs-kuleuven.github.io/plato-cgse-doc/asciidocs/developer-manual.html[Developer Manual]
+
+| https://ivs-kuleuven.github.io/plato-cgse-doc/asciidocs/commanding-manual.html[Commanding Manual]
+| https://ivs-kuleuven.github.io/plato-cgse-doc/api/egse/index.html[CGSE API Documentation]
+
+| Installation Manual (this document)
+| https://ivs-kuleuven.github.io/plato-cgse-doc/asciidocs/icd.html[Interface Control Document (ICD)]
+|===
 
 endif::[]
 

diff --git a/src/user/user-manual.adoc b/src/user/user-manual.adoc
@@ -22,8 +22,19 @@ endif::[]
 
 ifndef::backend-pdf[]
 
-[sidebar]
-Backlink -> https://ivs-kuleuven.github.io/plato-cgse-doc/[CGSE Documentation web site]
+[cols="1,1"]
+|===
+2+| https://ivs-kuleuven.github.io/plato-cgse-doc/[Backlink to the CGSE Documentation Website]
+
+| User Manual (this document)
+| https://ivs-kuleuven.github.io/plato-cgse-doc/asciidocs/developer-manual.html[Developer Manual]
+
+| https://ivs-kuleuven.github.io/plato-cgse-doc/asciidocs/commanding-manual.html[Commanding Manual]
+| https://ivs-kuleuven.github.io/plato-cgse-doc/api/egse/index.html[CGSE API Documentation]
+
+| https://ivs-kuleuven.github.io/plato-cgse-doc/asciidocs/installation-manual.html[Installation Manual]
+| https://ivs-kuleuven.github.io/plato-cgse-doc/asciidocs/icd.html[Interface Control Document (ICD)]
+|===
 
 endif::[]