Version-adaptive documentation: Difference between revisions
Jump to navigation
Jump to search
(add phase 2 test results) |
No edit summary |
||
| Line 52: | Line 52: | ||
[[File:Phase2_3-9.png|800px]] | [[File:Phase2_3-9.png|800px]] | ||
---- | ---- | ||
<h4>Conclusions</h4> | |||
# Testing with the [[Message_Debug_Test_Page]] proves the basic concept. | |||
# You can select multiple versions such as 3.9 and 3.10, but there are no smarts to know that the 3.9 content applies to 3.10, so selecting 3.10 only yields no content. | |||
# Version 4.0 can be added whenever we want. | |||
== References == | == References == | ||
* [https://github.com/duggabe/js-vad Using JavaScript to modify MediaWiki pages] | * [https://github.com/duggabe/js-vad Using JavaScript to modify MediaWiki pages] | ||
Revision as of 23:16, 9 December 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.
- Before displaying the page, execute a script to show or hide sections based on the Version selection.
Test results
Page before any selections are made (i.e. all information is shown).
Version selection before clicking 'Submit'.
Version 3.9 selected. Note that the items for 3.8 are not shown (hidden).
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 selection menu below the "Tools" group in the left-hand Navigation section.
- Create a test page with HTML "div" tags 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.
Test results
Page before any selections are made (i.e. all information is shown).
Version 3.9 selected. Note that the items for 3.8 are not shown (hidden).
Conclusions
- Testing with the Message_Debug_Test_Page proves the basic concept.
- You can select multiple versions such as 3.9 and 3.10, but there are no smarts to know that the 3.9 content applies to 3.10, so selecting 3.10 only yields no content.
- Version 4.0 can be added whenever we want.