Version-adaptive documentation: Difference between revisions
Jump to navigation
Jump to search
m (correct bullets) |
(add conclusions) |
||
| (One intermediate revision by the same user not shown) | |||
| Line 5: | Line 5: | ||
<h3>Phase 1</h3> | <h3>Phase 1</h3> | ||
<h4>Plan</h4> | |||
* Emulate MediaWiki with a local nodeJS program to allow non-destructive testing. | * Emulate MediaWiki with a local nodeJS program to allow non-destructive testing. | ||
* Create a test page with sections which can be hidden, based on 'data- | * Create a test page with sections which can be hidden, based on a 'data-vad' attribute. | ||
* Create a form to enter Version | * Create a form to enter a Version selection. | ||
* Store Version | * Store the Version selection in a user cookie. | ||
* Before displaying the page, execute a script to show or hide sections relevant to the Version | * Before displaying the page, execute a script to show or hide sections relevant to the Version selection. | ||
<h4>Test results</h4> | |||
---- | |||
<p>All versions selected.</p> | |||
[[File:Phase1_all.png|326px]] | |||
---- | |||
<p>Version 3.9 selected.</p> | |||
[[File:Phase1_3-9.png|329px]] | |||
<h4>Conclusions</h4> | |||
# 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: | |||
## [[QT_GUI_Chooser]] | |||
## [[Packet_Communications]] | |||
## [[LinuxInstall]] | |||
# Since there are so few pages which would benefit, I am not sure the project is worth the effort to implement it. | |||
Revision as of 14:59, 27 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.
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:
- Since there are so few pages which would benefit, I am not sure the project is worth the effort to implement it.