Version-adaptive documentation: Difference between revisions

From GNU Radio
Jump to navigation Jump to search
(add conclusions)
(add version selection menu)
Line 21: Line 21:
<p>Version 3.9 selected.</p>
<p>Version 3.9 selected.</p>
[[File:Phase1_3-9.png|329px]]
[[File:Phase1_3-9.png|329px]]
----
<p>Sample version selection menu</p>
[[File:Gr_version_select.png]]


<h4>Conclusions</h4>
<h4>Conclusions</h4>

Revision as of 01:53, 30 November 2022

Concept

I am looking into the possibility of making certain pages of our Wiki be adaptive to the user's GNU Radio version (or desired version) so that sections which don't apply would be hidden. This would make cleaner page presentations and reduce the clutter of unrelated information.

Proof of Concept

Phase 1

Plan

  • Emulate MediaWiki with a local nodeJS program to allow non-destructive testing.
  • Create a test page with sections which can be hidden, based on a 'data-vad' attribute.
  • Create a form to enter a Version selection.
  • Store the Version selection in a user cookie.
  • Before displaying the page, execute a script to show or hide sections relevant to the Version selection.

Test results


All versions selected.

Phase1 all.png


Version 3.9 selected.

Phase1 3-9.png


Sample version selection menu

Gr version select.png

Conclusions

  1. I have found that this methodology for hiding sections of a document is relatively easy.
  2. There are several groups of pages which might benefit from this method:
    1. Block docs
    2. Tutorials
    3. Installation instructions
  3. Specific examples are:
    1. QT_GUI_Chooser
    2. Packet_Communications
    3. LinuxInstall
  4. Since there are so few pages which would benefit, I am not sure the project is worth the effort to implement it.