emacs-orgmode@gnu.org archives
 help / color / mirror / code / Atom feed
From: Stephen Eglen <S.J.Eglen@damtp.cam.ac.uk>
To: emacs-orgmode@gnu.org
Cc: Stephen Eglen <S.J.Eglen@damtp.cam.ac.uk>
Subject: org-iswitchb documentation
Date: Mon, 28 Jun 2010 11:19:50 +0100	[thread overview]
Message-ID: <20386.1277720390@maps> (raw)

Dear all,

As the author of iswitchb, I was very happy to see M-x org-iswitchb
included.  Further, it is recommended as a default keybinding in the
manual:

----------------------------------------------------------------------
1.3 Activation
==============

...
     (add-to-list 'auto-mode-alist '("\\.org\\'" . org-mode))
     (global-set-key "\C-cl" 'org-store-link)
     (global-set-key "\C-ca" 'org-agenda)
     (global-set-key "\C-cb" 'org-iswitchb)
----------------------------------------------------------------------

So I was surprised when trying org-iswitchb that I didn't see the
iswitchb feedback when typing buffer names.  I eventually found that I
needed to set either of the following variables to t so that this would
work:

  org-completion-use-iswitchb, org-completion-use-ido

These variables are not mentioned in the docstrings of either
org-iswitchb or org-icompleting-read.   Here is a suggested patch to the
docstring for org-iswitchb.

Thanks for all the good work, as ever!

Stephen

$ git diff org.el

diff --git a/lisp/org.el b/lisp/org.el
index 7bb4f45..67e0278 100644
--- a/lisp/org.el
+++ b/lisp/org.el
@@ -15201,7 +15201,13 @@ changes from another.  I believe the procedure must be l
 (defun org-iswitchb (&optional arg)
   "Use `org-icompleting-read' to prompt for an Org buffer to switch to.
 With a prefix argument, restrict available to files.
-With two prefix arguments, restrict available buffers to agenda files."
+With two prefix arguments, restrict available buffers to agenda files.
+
+To see feedback whilst typing the buffer name, you can use the
+facilities of either the ido or iswitchb package.  Set either
+`org-completion-use-iswitchb' or `org-completion-use-ido' to
+non-nil and see documentation of those variables for further
+details."
   (interactive "P")
   (let ((blist (cond ((equal arg '(4))  (org-buffer-list 'files))
                      ((equal arg '(16)) (org-buffer-list 'agenda))

             reply	other threads:[~2010-06-28 10:19 UTC|newest]

Thread overview: 13+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2010-06-28 10:19 Stephen Eglen [this message]
2010-06-28 12:09 ` org-iswitchb documentation Livin Stephen Sharma
2010-06-28 12:22 ` Carsten Dominik
2010-06-28 12:26   ` Stephen Eglen
2010-06-29  7:26     ` Carsten Dominik
2010-06-29  8:14       ` Stephen Eglen
2010-06-29  8:43         ` Carsten Dominik
2010-06-29  9:44           ` Richard Riley
2010-06-29  9:51             ` Carsten Dominik
2010-07-02  7:14             ` Carsten Dominik
2010-06-29 22:46       ` Eric S Fraga
2010-06-28 13:00   ` Stephen Eglen
2010-06-28 15:14     ` Kim F. Storm

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

  List information: https://www.orgmode.org/

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20386.1277720390@maps \
    --to=s.j.eglen@damtp.cam.ac.uk \
    --cc=emacs-orgmode@gnu.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
Code repositories for project(s) associated with this public inbox

	https://git.savannah.gnu.org/cgit/emacs/org-mode.git

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).