Version-adaptive documentation

From GNU Radio
Revision as of 02:11, 27 November 2022 by Duggabe (talk | contribs) (add test results)
Jump to navigation Jump to search

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