Generate a table of contents without exporting

Generate a table of contents without exporting

[RG Williams]

Hi,
I know you can generate a table of contents when exporting, but can you do
it just within org? For context, I'm uploading an .org file to github and I
don't need to export it to another format because github recognizes and
displays it just fine. It's long so a ToC would be nice. Do I just have to
write it myself?

Re: Generate a table of contents without exporting

[Thorsten Jolitz]

RG Williams <rgwills@gmail.com> writes:

> Hi,
> I know you can generate a table of contents when exporting, but can you do
> it just within org? For context, I'm uploading an .org file to github and I
> don't need to export it to another format because github recognizes and
> displays it just fine. It's long so a ToC would be nice. Do I just have to
> write it myself?

Calling 

,--------------------------
| M-x org-org-export-as-org
`--------------------------

on this org buffer

#+begin_src org
#+OPTIONS: toc:2

* A
** A1
** A2
* B
** B1
** B2
#+end_src

yields this 

,---------------------------------
| # Created 2014-04-01 Di 00:28
| #+TITLE: tmp<7>
| #+AUTHOR: Thorsten Jolitz
| #+OPTIONS: toc:2
| 
| * A
| ** A1
| ** A2
| 
| * B
| ** B1
| ** B2
| 
| # Emacs 24.3.1 (Org mode 8.2.5h)
`---------------------------------

so unfortunately exporting with toc does not seem to be implemented in
ox-org.el, but maybe you'll get better advice. 

-- 
cheers,
Thorsten

Re: Generate a table of contents without exporting

[RG Williams]

Thorsten Jolitz <tjolitz <at> gmail.com> writes:

> Calling 
> 
> ,--------------------------
> | M-x org-org-export-as-org
> `--------------------------
> 
>...
> 
> so unfortunately exporting with toc does not seem to be implemented in
> ox-org.el, but maybe you'll get better advice. 

Thanks for trying! :)

RD

Re: Generate a table of contents without exporting

[Charles Berry]

RG Williams <rgwills <at> gmail.com> writes:

> 
> Hi,
> I know you can generate a table of contents when exporting, but can you do
> it just within org? For context, I'm uploading an .org file to github and I
> don't need to export it to another format because github recognizes and
> displays it just fine. It's long so a ToC would be nice. Do I just have to
> write it myself?
> 
> 

AFAIK, you do have to write it yourself, but org-mode provides decent tools
for doing it. Here is an example. Run the src-block and a table of contents
will appear near the top. Change the content and rerun the src-block and
the t-o-c will change accordingly.

It doesn't deal with rules for omitting headlines like
COMMENT, :noexport:, etc, but if you are simply copying the .org file,
maybe it is good enough.


--8<---------------cut here---------------start------------->8---
#+RESULTS: Table_of_Contents

* h
lower H
* i
lower I
* j
lower J
** 1
one
** 2
two

#+NAME: Table_of_Contents
#+BEGIN_SRC emacs-lisp :wrap example
  (mapconcat 'identity
   (org-element-map 
       (org-element-parse-buffer 'headline) 'headline 
     (lambda (hl) (let
                      ((lev
                        (org-element-property :level hl)) 
                       (htitle (org-element-property :title hl)))
                    (concat (make-string  lev ? ) "- " htitle )))) "\n")
#+END_SRC
--8<---------------cut here---------------end--------------->8---


HTH,

Chuck

Re: Generate a table of contents without exporting

[Nick Dokos]

Charles Berry <ccberry@ucsd.edu> writes:

> RG Williams <rgwills <at> gmail.com> writes:
>
>> 
>> Hi,
>> I know you can generate a table of contents when exporting, but can you do
>> it just within org? For context, I'm uploading an .org file to github and I
>> don't need to export it to another format because github recognizes and
>> displays it just fine. It's long so a ToC would be nice. Do I just have to
>> write it myself?
>> 
>> 
>
> AFAIK, you do have to write it yourself, but org-mode provides decent tools
> for doing it. Here is an example. Run the src-block and a table of contents
> will appear near the top. Change the content and rerun the src-block and
> the t-o-c will change accordingly.
>
> It doesn't deal with rules for omitting headlines like
> COMMENT, :noexport:, etc, but if you are simply copying the .org file,
> maybe it is good enough.
>
>
> #+RESULTS: Table_of_Contents
>
> * h
> lower H
> * i
> lower I
> * j
> lower J
> ** 1
> one
> ** 2
> two
>
> #+NAME: Table_of_Contents
> #+BEGIN_SRC emacs-lisp :wrap example
>   (mapconcat 'identity
>    (org-element-map 
>        (org-element-parse-buffer 'headline) 'headline 
>      (lambda (hl) (let
>                       ((lev
>                         (org-element-property :level hl)) 
>                        (htitle (org-element-property :title hl)))
>                     (concat (make-string  lev ? ) "- " htitle )))) "\n")
> #+END_SRC
>
>

Another more manual way: export to text and cut-and-paste the TOC into
a noexport top-level section.

Nick

Re: Generate a table of contents without exporting

[RG Williams]

Nick Dokos <ndokos <at> gmail.com> writes:

> Another more manual way: export to text and cut-and-paste the TOC into
> a noexport top-level section.
> 
> Nick

Thank Nick! That's a great idea, haha. Not sure why that never occurred to me.

RG

Re: Generate a table of contents without exporting

[RG Williams]

Charles Berry <ccberry <at> ucsd.edu> writes:

> #+NAME: Table_of_Contents
> #+BEGIN_SRC emacs-lisp :wrap example
>...
> #+END_SRC
>
> HTH,
> Chuck

Thank you, Charles! That works really well :)

RG