lfos / calcurse

A text-based calendar and scheduling application
https://calcurse.org
BSD 2-Clause "Simplified" License
990 stars 94 forks source link

Impossible to use the built-in help #461

Open navid-zamani opened 1 year ago

navid-zamani commented 1 year ago

(Version: 4.6.0)

Calcurse does have the built-in “help” (<?>) function. But all it tells the user, is to run “help \<function>” or “help \<key>”.

How would I know what functions there are? Or how they are written? Let alone the workflow the developer intended?
That’s the whole point of calling the (generic) help function! ^^
It’s a bit like an old text adventure game, or Family Feud. ^^

So the program would be massively improved by two things:

  1. Add a reference index to the general help function (<?>), that lists all available functions in a hierarchical structure. (Could also be markup-enhanced.)
  2. Add a guide above that, that lists typical workflows, like create/retrieve/update/delete calendar entries, configuration, setting up common back-ends (like CalDAV connections to some server), hooks, and CLI usage.

None of it needs to be long. In fact, the shorter (higher information density), the better. The function index can probably be created automatically. (It would also be cool if the current key bindings were shown behind the function names in the index.)

Ideally, those things (with default key bindings) could also be available on the Calcurse web site so one can look into it before even installing it. But that’s secondary, given that this is a program whose whole point is to not have a graphical UI. :)