Request: calfw and calfw-org

[japhir]

This magnificent package shows a nice block calendar view for many different input sources. It already has a lot of evil-native keybindings, but IMO it's still not fully there. I thought I'd create an issue here to see if we can come up with a nice scheme, and possibly just send a PR for key changes at the other repository, since they are mostly implemented already.

I've copy-pasted the below from their README, and added a new left column for new suggested keybindings, mostly based on evil-org. What do you reckon?

Key bindings

In the calendar buffer and region, you can use following key bindings:

evil	Navigation
h	[left], b, h	Previous day
l	[right], f, l	Next day
k	[up], p, k	Previous week
j	[down], n, j	Next week
^	^	Week begin
$	$	Week end
gg	[home]	First date in this month
G	[end]	Last date in this month
[, gk, C-k	M-v, [PgUp], <	Previous month
], gj, C-j	C-v, [PgDown], >	Next month
.	t	Today
gd	g	Absolute date (YYYY/MM/DD)
TAB	TAB	Next item in a day

evil	Changing View
zm	M	Month view
zw	W	1 Week view
zt	T	2 Week view
zd	D	Day view

evil	Operation
gr	r	Refresh data and re-draw contents
SPC	SPC	Pop-up detail buffer (like Quicklook in Mac)
RET, [click]	RET, [click]	Jump (howm, orgmode)
q	q	Bury buffer

You can use another key binding like org agenda buffer, setting cfw:org-overwrite-default-keybinding to non-nil, like following code:

(setq cfw:org-overwrite-default-keybinding t)

Then, following key bindings are overwritten:

evil	key	function
gr	g	Refresh data and re-draw contents (cfw:refresh-calendar-buffer)
gd	j	Goto the specified date (cfw:org-goto-date)
C	k	org-capture
q	x	Close calfw and other buffers opened by calfw-org (cfw:org-clean-exit)
zd	d	Day view (cfw:change-view-day)
zd	v d	Day view (cfw:change-view-day)
zw	v w	1 Week view (cfw:change-view-week)
zm	v m	Month View (cfw:change-view-month)

[jojojames]

This looks cool. I'm traveling now but will definitely check this out when I get back!

[jojojames]

gr | r | Refresh data and re-draw contents
-- | -- | --

This would be the only tweak I'd make. Otherwise, everything else looks fine to me. @Ambrevar ?

[Ambrevar]

Agreed with @jojojames' suggestion.

Beside [ and ], I would also add C-j and C-k + gj and gk.
Thanks for your contribution @japhir !

[japhir]

I've just edited the above to add your suggestions to the table. So now it's a nice proposal, for which I don't know how to create a PR ;-). I'll try to look into it this weekend.

[japhir]

So, looks like I didn't take a look at it that weekend. I've now got too many calendar events for effective use of calfw, so I don't use it anymore.