Re: [O] [ANN] org-sidebar-tree: Sidebar tree-view buffer for outline navigation

[Adam Porter]

"Fraga, Eric" <address@hidden> writes:

> Hi Adam,
>
> I've had a chance to play with it a little bit.  Works very well
> generally.  Some notes:

Hi Eric,

> - a way to exit the sidebar-tree mode to get back to the full buffer
>   (e.g. to run commands that require the whole file).  The documentation
>   seems to indicate that 'q' should do this but it didn't work for
>   me.  I do use evil mode but q didn't work whether in evil or emacs
>   states.

Please note that it's not a mode, it's just a side window displaying an
indirect buffer in Org mode (like how org-tree-to-indirect-buffer
works).  You can do anything in the tree-view buffer that you can do in
any other Org buffer, including inputting characters, calling Org
commands, switching windows, killing the buffer, deleting the window,
etc.

The only difference is that certain keys are bound by default to
commands which are more appropriate for the tree-view buffer, e.g. the
cycle commands don't show body text, and RET/mouse-1 jump to headings in
the source window.

"q" is no longer bound differently, and the readme has been updated.

> - hitting RET on a headline which has subtrees doesn't show the
>   subtrees.  Can this be customized?  It might be nice to have two
>   different bindings to allow for recursion and not.

Like other Org buffers, <tab> is used to cycle headings by default.  As
documented, the keymap org-sidebar-tree-map is used, which you're free
to customize.

I recently improved the tree-view cycling command to work more like
org-cycle.  Please let me know if you think it needs more work.

> - invoking org-sidebar-tree when point is at the top of the file,
>   e.g. on the #+title: line of a document, gives an error:
>   outline-back-to-heading: Before first heading.

That bug is fixed.

Note as well that the tree-view can be activated for narrowed Org
buffers, in which case it is also narrowed to the visible portion of the
buffer.  So you can, e.g.:

1.  "M-x customize-option RET org-sidebar-tree-jump-fn RET", and set it to
    use indirect buffers when jumping to headings.
2.  "M-x org-sidebar-tree RET" in an Org buffer.
3.  Move point to a heading and press RET to display that heading in the
    other window.
4.  "M-x org-sidebar-tree RET" to display only that subtree in the
    tree-view buffer.

This makes it easy to treat subtrees as separate projects or entities.

Thanks for your feedback!