Version-adaptive documentation

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.

---

Version 3.9 selected.

---

Sample version selection menu

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

Phase 2

Plan

• Use a 'test' MediaWiki.
• Put a version pull-down menu below the "Tools" group in the left-hand Nav section; store the selection in the user's browser localStorage.
• Create a test page with HTML `<sections>` which can be hidden, based on a 'data-vad' attribute.
• Embed a JavaScript link at the end of the page HTML to perform the requested selection.