From d890d0a3e1dfbde16890c0ff113a5ee31a9389c4 Mon Sep 17 00:00:00 2001 From: Kyle Meyer Date: Sun, 9 Feb 2014 22:44:23 -0500 Subject: DOC: Suggest keybindings --- README | 24 ++++++++++++++++++++++++ bog-readme.org | 21 +++++++++++++++++++++ bog-todo.org | 3 ++- 3 files changed, 47 insertions(+), 1 deletion(-) diff --git a/README b/README index df5ba95..dc3f133 100644 --- a/README +++ b/README @@ -17,6 +17,7 @@ _________________ .. 2.6 Renaming a new PDF .. 2.7 Renaming a new BibTeX file .. 2.8 Generating a combined BibTeX file +3 Recommended keybindings Bog is a system for taking research notes in [Org mode]. As any Org user @@ -187,3 +188,26 @@ and taking notes with Org, not on writing research articles with Org. collect the references that are needed. `bog-create-combined-bib' can be used to create a BibTeX file that has entries for all the citekeys in the current buffer. + + +3 Recommended keybindings +========================= + + Bog doesn't claim any keybindings, but using "C-c b" as a prefix while + in Org mode is a good option. + + Key Command + ------------------------------------ + C-c b p bog-find-citekey-pdf + C-c b b bog-find-citekey-bib + C-c b w bog-search-citekey-on-web + + This can be achieved by placing the code below in your .emacs file. + + ,---- + | (define-prefix-command 'bog-map) + | (define-key org-mode-map (kbd "C-c b") 'bog-map) + | (define-key bog-map "p" 'bog-find-citekey-pdf) + | (define-key bog-map "b" 'bog-find-citekey-bib) + | (define-key bog-map "w" 'bog-search-citekey-on-web) + `---- diff --git a/bog-readme.org b/bog-readme.org index 2a69397..277fa36 100644 --- a/bog-readme.org +++ b/bog-readme.org @@ -140,3 +140,24 @@ If single-entry BibTeX files are used, there should be a way to collect the references that are needed. =bog-create-combined-bib= can be used to create a BibTeX file that has entries for all the citekeys in the current buffer. + +* Recommended keybindings + +Bog doesn't claim any keybindings, but using "C-c b" as a prefix while +in Org mode is a good option. + +| Key | Command | +|---------+---------------------------| +| C-c b p | bog-find-citekey-pdf | +| C-c b b | bog-find-citekey-bib | +| C-c b w | bog-search-citekey-on-web | + +This can be achieved by placing the code below in your .emacs file. + +#+begin_src emacs-lisp + (define-prefix-command 'bog-map) + (define-key org-mode-map (kbd "C-c b") 'bog-map) + (define-key bog-map "p" 'bog-find-citekey-pdf) + (define-key bog-map "b" 'bog-find-citekey-bib) + (define-key bog-map "w" 'bog-search-citekey-on-web) +#+end_src diff --git a/bog-todo.org b/bog-todo.org index 09bb0b2..6e20aed 100644 --- a/bog-todo.org +++ b/bog-todo.org @@ -29,7 +29,8 @@ Perhaps use a cache file. This could be used in ** DOC Installation instructions -** DOC Suggest keybindings +** DONE Suggest keybindings + CLOSED: [2014-02-08 Sat 02:37] * Notes -- cgit v1.2.3