Embedded help system #92
Closed
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
To enable a global help system, bind alt-h by default to all instances of fzf and sk. The bind executes zfsbootmenu-help -L $_SECTION. Before invoking each instance of fzf/sk, set _SECTION to the appropriate value (MAIN, SNAPSHOT, ...). zfsbootmenu-help then uses this argument to pre-sort the list of topics, pushing that topic to the head of the list / pre-selecting it. The documentation is internal to zfsbootmenu-help, and is created using a very simple templating system with basic colors and text centering. fold is used to word wrap based on the size of the preview window. The preview window size is calculated based on the number of columns minus 26 characters (the longest topic title + fzf marker ). When adding new help sections, care should be taken with colorizing text. Because ANSI escape sequences are used, fold is not able to correctly calculate the length of given word, so it word wraps incorrectly.
ericonr
reviewed
Oct 29, 2020
Contributor
ericonr
left a comment
ericonr
left a comment
There was a problem hiding this comment.
Perhaps use "This operation" instead of "The operation"? I'm not sure on this one.
And switch all of them to "fail gracefully".
| $( colorize lightblue "[ALT+C] cmdline" ) | ||
| Temporarily edit the kernel command line that will be used to boot the next kernel and boot environment. This change is not persisted between boots. | ||
|
|
||
| $( colorize lightblue "[ALT+P] Pool status" ) |
Contributor
There was a problem hiding this comment.
What is the capitalization? Here it's Pool status, but above it's set bootfs.
Member
Author
There was a problem hiding this comment.
I was mirroring the descriptions used in the footer. Those should probably get a normalization pass next.
ahesford
reviewed
Oct 30, 2020
Member
ahesford
left a comment
ahesford
left a comment
There was a problem hiding this comment.
I pushed a commit to use $HELP_SECTION instead of $_SECTION to make the meaning more obvious, and believe I've made the global variable unnecessary. Please look over the commit. If you think these are positive changes, please squash; otherwise, just drop the commit.
Beyond this, the grammatical changes should be made but are not reflected in my commit.
zdykstra
added a commit
that referenced
this pull request
Oct 30, 2020
Enable a global help system, bind alt-h by default to all instances of fzf and sk. The bind executes zfsbootmenu-help -L $HELP_SECTION. Before invoking each instance of fzf/sk, set HELP_SECTION to the appropriate value (MAIN, SNAPSHOT, ...). zfsbootmenu-help then uses this argument to pre-sort the list of topics, pushing that topic to the head of the list / pre-selecting it. The documentation is internal to zfsbootmenu-help, and is created using a very simple templating system with basic colors and text centering. fold is used to word wrap based on the size of the preview window. The preview window size is calculated based on the number of columns minus 26 characters (the longest topic title + fzf marker ). When adding new help sections, care should be taken with colorizing text. Because ANSI escape sequences are used, fold is not able to correctly calculate the length of given word, so it word wraps incorrectly. Closes #92 Co-authored-by: Zach Dykstra <[email protected]> Co-authored-by: Andrew J. Hesford <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
To enable a global help system, bind alt-h by default to all instances
of fzf and sk. The bind executes zfsbootmenu-help -L $_SECTION.
Before invoking each instance of fzf/sk, set _SECTION to the appropriate
value (MAIN, SNAPSHOT, ...). zfsbootmenu-help then uses this argument to
pre-sort the list of topics, pushing that topic to the head of the list
/ pre-selecting it.
The documentation is internal to zfsbootmenu-help, and is created using
a very simple templating system with basic colors and text centering.
fold is used to word wrap based on the size of the preview window. The
preview window size is calculated based on the number of columns minus
26 characters (the longest topic title + fzf marker ).
When adding new help sections, care should be taken with colorizing
text. Because ANSI escape sequences are used, fold is not able to
correctly calculate the length of given word, so it word wraps
incorrectly.
The text / pager can be reviewed by manually executing
90zfsbootmenu/zfsbootmenu-help.sh.