Version-adaptive documentation: Difference between revisions
Jump to navigation
Jump to search
(add conclusions) |
(add Phase 2 Plan) |
||
| (One intermediate revision by the same user not shown) | |||
| 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> | ||
| Line 32: | Line 35: | ||
## [[Packet_Communications]] | ## [[Packet_Communications]] | ||
## [[LinuxInstall]] | ## [[LinuxInstall]] | ||
<h3>Phase 2</h3> | |||
<h4>Plan</h4> | |||
* 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. | |||
Revision as of 03:37, 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.
Version 3.9 selected.
Sample version selection menu
Conclusions
- I have found that this methodology for hiding sections of a document is relatively easy.
- There are several groups of pages which might benefit from this method:
- Block docs
- Tutorials
- Installation instructions
- Specific examples are:
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.