Post by Stefan on Jul 3, 2020 12:36:27 GMT -5
Hi Guys,
Don't get me wrong, I think the SPFLite documentation is VERY comprehensive. That said, here are some minor things that caught my eye over time...
(Please bear in mind that these comments are based on documentation shipped with v20151)
Main SPFLite HELP document
(1) Is the Index Tab needed, given it refers to just 4, rather random, entries:
New keyword (File Manager)
New keyword 1 (Excluded lines)
SPFLite (Instances & Configs)
Unexclude (Excluded lines)
(2) There's no support for the 'HELP LINE' primary command.
i.e. While 'HELP FIND' primary command jumps into the documentation at the FIND syntax page, HELP LINE is less accommodating.
(3) The various 'KEYMAP' sections mention the 'implied (Enter)' after {line command} and non-[]-bracketed Primary commands, often accompanied by ways of how to suppress them.
While the "suppression technique" is a clue, it isn't until you reach the paragraph about (RestoreCursor) that you learn that 'implied (Enter)' applies ONLY IF the line/primary command is the last element in the key definition.
(4a) The main document's Contents Tab - Primary Command access is excellent!
It provides direct access to any given command description AND it lists the available commands to help users find which command they may need.
Macro HELP document
(4b) In contrast, the Macros doc doesn't provide direct access to any available functions. Neither the Contents Tab nor the Search Tab provide easy access to specific functions.
I found the most effective way is to start with either 'Function Overview' or 'Function Details' and then page down, or use CTRL+F to search that section.
I found the most effective way is to start with either 'Function Overview' or 'Function Details' and then page down, or use CTRL+F to search that section.
I think a Contents Tab - Functions facility, like the primary command facility referred to in (4a), leading directly to an individual function, would be really useful.
I think it would also be helpful if that entry also repeated the FM=YES/NO, EDIT=YES/NO information.