Add user Help files (v1.A6+)
In addition you can set a different foreground and background colour for the text file and even display a background wallpaper under the text.
If you want multi-coloured text and\or a help menu system - go here.
If the start of the first line of the .help text file contains "0x", then that hex number will be used as the colour value for all the text and the entire first line will not be displayed to the user, e.g.
here is the first line
here is the second line
Press a key to return to the menu...
The 0x colour can be in grub4dos single-byte format (e.g. 0x1F = blue text on white background) or 0xRRGGBB00rrggbb (background RGB+text rgb) format.
If you wish, you can also add a comment after the colour value if you add ' ;; # ' after the hex value: e.g.
0xFFFFFF000000FF ;; # Version 1.0 2018-10-17 Added menu heading
A long file will not scroll but will be displayed one screenfull at a time. When the end is reached the user must press a key return to the menu.
It is advisable to make the last line of your .help file prompt the user to press a key.
The file name determines it's order of appearance in the E2B menu. For example, use a filename beginning with $$ if you want the menu entry to appear near the beginning of the menu.
If don't want the file name itself to be used as the menu entry, add a .txt file (e.g. HowToUse.help and HowToUse.txt). Using a .txt file will also allow you to set a hotkey for the help file and add help text under the menu.
Screen display using above .help file.
Tip: If you don't want to see the brief E2B messages that are displayed when QRUN.g4b is called, use set redir=1 in your \_ISO\MyE2B.cfg file or use a .mnu file (see below).
You can have a generic hotkey (e.g. CTRL+F1) to display your \_ISO\HowToUse.help help file from any menu, by adding this line to the \_ISO\MyE2B.cfg file:
()/%grub%/hotkey [Ctrl+F1] "/%grub%/QRUN.g4b /_ISO/HowToUse.help" > nul
Help file + background wallpaper (E2B v1.A7+)
You can add extra commands after the colour value in the .help file, such as:
0xFFFFFF000000FF ;; # Version 1.0 2018-10-17 ;; splashimage /_ISO/Help800x600.jpg ;; call Fn.70 2 ;; splashimage --offset=0x00=400=50 /_ISO/HelpStamp.jpg
This will display a background wallpaper (Help800x600.jpg) and over-stamp it with a smaller image (HelpStamp.jpg) in the top-right corner (change 0x00 to 0x80 and use a .bmp file if you want a transparent-background stamp). The stamp could be your company logo or some text in a large fancy font.
Each command is separated by a ;; and a # symbol is used to denote a comment. The command call Fn.70 2 enables the wallpaper to be kept on the display.
The help text must not cause scrolling of the display if Fn.70 2 is used (use one screen full of text only).
A .mnu file can be used to display multiple small help files one at a time, each with different backgrounds - see below.
Display multiple help files (E2B v1.A7+)
\_ISO\docs\Sample mnu Files\E2B Menus\HelpWithBackground.mnu
Note: Using the command graphicsmode -1 1024, you could switch the screen to 1024x768 mode which would allow you to show more text per screen. You would also need 1024x768 wallpaper. At the end of the .mnu file before the configfile line, you should restore the original graphics mode - e.g. graphicsmode -1 800. Not all systems (e.g. some netbooks such as early eeePCs) will support 1024x768 however.
You can use force.help to display a text file even if it does not have a .help file extension, e.g:
#Display any text file on a large screen (no background)
title ^Ctrl+F1 HELP (1024x768) (Ctrl+F1]\nDisplay help file
# suppress E2B messages
set redir=> nul
# switch to 1024x768
graphicsmode -1 1024 768
# change text colour to red on white
#display text on large screen
/%grub%/QRUN.g4b force.help /_ISO/Sample_MyE2B.cfg
#restore redir settings
graphicsmode -1 800
#change text colour to what it was before (usually cyan)
Recommended for Easy2Boot (fastest!) - SanDisk Extreme SDCZ880-128G-G46