emacs-orgmode@gnu.org archives
 help / color / mirror / code / Atom feed
From: Bastien <bzg@altern.org>
To: emacs-orgmode@gnu.org
Subject: Re: Re: org-toc.el - browsable table of contents for Org
Date: Sat, 29 Sep 2007 15:21:27 +0200	[thread overview]
Message-ID: <87zlz5y5d4.fsf@bzg.ath.cx> (raw)
In-Reply-To: <loom.20070929T073503-342@post.gmane.org> (Renzo Been's message of "Sat, 29 Sep 2007 07:37:23 +0000 (UTC)")

Renzo Been <swangdoodles@gmail.com> writes:

>> But I like the idea of having some kind of margin, just as linum.el does
>> for line numbers:
>> http://stud4.tuwien.ac.at/~e0225855/linum/linum.html
>
> Yes, I had a look at linum, and it looks like a good mechanism that can be of 
> use in the TOC. If you could make such a margin, that would be great for the 
> TOC... 
>
>> What kind of information you would like to be displayed in this margin?
>> (Remember there is org-toc-info already, so the margin and the echo-area
>> should work in a complementary way.)
>
> Maybe the margin could display how many sub-headings are below the heading that 
> shows in the TOC? Or how many lines of text there are folded inside it? Or the 
> number of TODO's that are below it? 

Please check latest org-toc.el (0.9a):

  http://www.cognition.ens.fr/~guerry/u/org-toc.el

,----[ org-toc-margin-default-format ]
| The default margin format. This is overriden by any occurrence
| of #+TOC_MARGIN: in the base Org buffer.
| 
| %l stands for the heading's line number.
| %h stands for the number of headings below this heading.
| %t stands for the number of TODO items below this heading.
| 
| For example, a format like "%5l hl:%2h td:%2t | " would show:
| 
|  1456 hl: 2 td: 1 | * A headline here
| 
| - this headline is on line 1456
| - there are 2 headlines below it
| - there are 1 TODO item among these 2 headlines
| 
| Attention: using a complex margin format for big Org files could
| slow down things considerabily.
`----

> Or maybe it's better to keep things simple. And put no extra
> information in the margin?

The default for the margin is "", since I also think it's better to not
display too much information by default.

> Just put two or three symbols (ones that do not conflict with org-mode) 
> there, to make the TOC display distinguishable from the base-buffer. You could 
> use a symbol from the utf-8 coding table. I've put some examples here: 
>
> http://swangdoodles.googlepages.com/Unicodes-for-org-toc.html 

I added a new background for the TOC. Please tell me what do you think.

> What happens is that the TOC-buffer does open. But it is opened as a full view 
> buffer,
> not as a split screen together with the org-file

I will investigate, thanks.

> What might also be handy is to limit the size of the TOC-buffer. Right
> now, what happens when I'm in a large org-file, and use the TOC, is
> that it takes over half the screen...

For now I just rely on shrink-window-if-larger-than-buffer, which seems
fine to me. But If people think we should force a max size for the TOC,
let me know.

-- 
Bastien

      reply	other threads:[~2007-09-29 13:21 UTC|newest]

Thread overview: 8+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2007-09-23 14:38 org-toc.el - browsable table of contents for Org Bastien
2007-09-24  9:31 ` Levin
2007-09-24 23:06   ` Bastien
2007-09-26 14:11     ` Renzo Been
2007-09-26 16:06       ` Bastien
2007-09-26 16:22         ` Carsten Dominik
2007-09-29  7:37         ` Renzo Been
2007-09-29 13:21           ` Bastien [this message]

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=87zlz5y5d4.fsf@bzg.ath.cx \
    --to=bzg@altern.org \
    --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).