include file contents in org files?

include file contents in org files?

[Rainer Stengele]

Dear list,

I'd like to have the initial lines (configuration) of any org file be
the same. Yes, I could configure everything in my .emacs file - but I
want to see my configuration - TAGS etc. - at the beginning of my org
files.
If I change anything in for example the TAGS section I have to do the
change in each and every org files I use - which is stupid.
Is there a possibility to include a file and show it maybe between a
ruler set?

Maybe something like:

#INLCUDEFROM <file path>
#INCLUDEDCONTENTS START
#+STARTUP: overview
#+TAGS: @HOME(h) @IGN @KUNDE(k) @UNTERWEGS(u)
#+TAGS: BESORGEN(b) COMPUTER(c) EMAIL(e) IGNORE(r) INFO(i)
#+STARTUP: hidestars
#+SEQ_TODO: TODO INARBEIT | DONE CANCELED DELEGATED
#INCLUDEDCONTENTS END

comments? bad/good idea?

Rainer

Re: include file contents in org files?

[Bastien]

Rainer Stengele <rainer.stengele@yahoo.de> writes:

> I'd like to have the initial lines (configuration) of any org file be
> the same.

Perhaps we can use Tempo [1] or Templates [2] for this?

Here is an example using Tempo:

--8<---------------cut here---------------start------------->8---
(require 'tempo)

(tempo-define-template "org-initial-options"
		       '("#+STARTUP: overview
#+TAGS: @HOME(h) @IGN @KUNDE(k) @UNTERWEGS(u)
#+TAGS: BESORGEN(b) COMPUTER(c) EMAIL(e) IGNORE(r) INFO(i)
#+STARTUP: hidestars
#+SEQ_TODO: TODO INARBEIT | DONE CANCELED DELEGATED")
		       nil
		       "Insert initial options in Org files.")

(define-abbrev org-mode-abbrev-table "options" ""
  'tempo-template-org-initial-options)
--8<---------------cut here---------------end--------------->8---

Then just type "options" at the very beginning of a new Org file, then
press C-x a e, it will expand into the desired options.

Regards,

Notes: 
[1]  http://www.emacswiki.org/cgi-bin/wiki/TempoMode
[2]  http://www.emacswiki.org/cgi-bin/wiki/TemplatesMode

-- 
Bastien

Re: include file contents in org files?

[Eddward DeVilla]

On 8/21/07, Rainer Stengele <rainer.stengele@yahoo.de> wrote:
> Dear list,
>
> I'd like to have the initial lines (configuration) of any org file be
> the same. Yes, I could configure everything in my .emacs file - but I
> want to see my configuration - TAGS etc. - at the beginning of my org
> files.
> If I change anything in for example the TAGS section I have to do the
> change in each and every org files I use - which is stupid.
> Is there a possibility to include a file and show it maybe between a
> ruler set?

I've wanted something like that myself so that my org files /could/
stand on their own, but so I would need to edit them all if my
preferred defaults were to change.  Ultimately, I've settled on having
an emacs config that I can move with my files.  At some point I want
to use a package (I can't remember the name) that can split custom
configuration into multiple files.

What might be nice is to be able to put a token at the top of the file
to export the config from custom (or as much as reasonable) into the
file using a config name.  So in custom you set a configuration name
(say eddwards-org-config) and at the top of your file you put

#+INLINE_CONFIG: eddwards-org-config

and org-mode would insert the configuration after it, replace any
config line that might already be there.  If the keyword in the file
doesn't match what is in custom or if there isn't a name given in the
file or custom, then do not insert anything in the file.  Org could
maybe update all of the agenda files as appropriate.

The reason for the name is so I can receive a file from someone else
(say my brother) and not have the config info in his file overlaid
with mine, distorting how he intended the file to be seen.  That would
cover my needs for org, but I'll still probably get a custom splitter
since I'm starting to use emace for more things and I have at least
three separate machine I use it on and I'd like to share some of the
customizations.

Edd

Re: include file contents in org files?

[Adam Spiers]

Bastien (bzg@altern.org) wrote:
> Rainer Stengele <rainer.stengele@yahoo.de> writes:
> 
> > I'd like to have the initial lines (configuration) of any org file be
> > the same.
> 
> Perhaps we can use Tempo [1] or Templates [2] for this?

If I understand Rainer's original requirements, that wouldn't work,
because once expansion had been performed across multiple files, you
would still need to edit them all if you needed to make a change to
the common component.  An include mechanism sounds like a nice idea to
me.

Re: include file contents in org files?

[Rainer Stengele]

Adam Spiers schrieb:
> Bastien (bzg@altern.org) wrote:
>> Rainer Stengele <rainer.stengele@yahoo.de> writes:
>>
>>> I'd like to have the initial lines (configuration) of any org file be
>>> the same.
>> Perhaps we can use Tempo [1] or Templates [2] for this?
> 
> If I understand Rainer's original requirements, that wouldn't work,
> because once expansion had been performed across multiple files, you
> would still need to edit them all if you needed to make a change to
> the common component.  An include mechanism sounds like a nice idea to
> me.

Adam, you've got it right.
I would like to have something like a #include under C but also see the 
contents of the included file.
The include "update" could take place whenever the org file is opened or 
maybe by request "org-update-includes" or whatever.


Rainer

Re: Re: include file contents in org files?

[Carsten Dominik]

On Aug 22, 2007, at 11:32, Rainer Stengele wrote:

> Adam Spiers schrieb:
>> Bastien (bzg@altern.org) wrote:
>>> Rainer Stengele <rainer.stengele@yahoo.de> writes:
>>>
>>>> I'd like to have the initial lines (configuration) of any org file 
>>>> be
>>>> the same.
>>> Perhaps we can use Tempo [1] or Templates [2] for this?
>> If I understand Rainer's original requirements, that wouldn't work,
>> because once expansion had been performed across multiple files, you
>> would still need to edit them all if you needed to make a change to
>> the common component.  An include mechanism sounds like a nice idea to
>> me.
>
> Adam, you've got it right.
> I would like to have something like a #include under C but also see 
> the contents of the included file.
> The include "update" could take place whenever the org file is opened 
> or maybe by request "org-update-includes" or whatever.

While I maybe can see the use of having an #include mechanism,
I don't see why you'd want to *see* the included stuff.
It is just as easy to look at the include file itself, and if it is
the same for every file you use, you'd have it memorized soon enough.

- Carsten

Re: include file contents in org files?

[Rainer Stengele]

Carsten Dominik schrieb:
> 
...
> 
> While I maybe can see the use of having an #include mechanism,
> I don't see why you'd want to *see* the included stuff.
> It is just as easy to look at the include file itself, and if it is
> the same for every file you use, you'd have it memorized soon enough.
> 
> - Carsten

Well - thinking hard about it I have to agree it's not really necessary 
to see the contents of the file.

Seeing it at the beginning of any org file was just quite convenient 
when I started using org-mode and was still modifying my used TAG set etc.

Agreed, a simple "standard" include mechanism would do it very well!

Rainer

Re: include file contents in org files?

[Rainer Stengele]

Rainer Stengele schrieb:
> Carsten Dominik schrieb:
>>
> ...
>>
>> While I maybe can see the use of having an #include mechanism,
>> I don't see why you'd want to *see* the included stuff.
>> It is just as easy to look at the include file itself, and if it is
>> the same for every file you use, you'd have it memorized soon enough.
>>
>> - Carsten
> 
> Well - thinking hard about it I have to agree it's not really necessary 
> to see the contents of the file.
> 
> Seeing it at the beginning of any org file was just quite convenient 
> when I started using org-mode and was still modifying my used TAG set etc.
> 
> Agreed, a simple "standard" include mechanism would do it very well!
> 
> Rainer

Taking the idea a little "around the corner" I wonder if it would be 
possible to hide everything that begins with a "#" before the first heading.
Application: I have my org files under subversion control and carry 
around this line at the beginning of my files:


# SVN $Revision: 385 $  $Date: 2007-08-21 23:50:43 +0200 (Di, 21 Aug 2007) $

I would like to hide that and similar lines unless showing all with "C-c 
C-a". Also a possible "#include" line could be hidden. If somebody wants 
to see the lines - of course - a config option would do it.

Rainer

Re: Re: include file contents in org files?

[Carsten Dominik]

On Aug 22, 2007, at 12:54, Rainer Stengele wrote:
>
> Taking the idea a little "around the corner" I wonder if it would be 
> possible to hide everything that begins with a "#" before the first 
> heading.
> Application: I have my org files under subversion control and carry 
> around this line at the beginning of my files:
>
>
> # SVN $Revision: 385 $  $Date: 2007-08-21 23:50:43 +0200 (Di, 21 Aug 
> 2007) $
>
> I would like to hide that and similar lines unless showing all with 
> "C-c C-a". Also a possible "#include" line could be hidden. If 
> somebody wants to see the lines - of course - a config option would do 
> it.
>
> Rainer

The easiest way is this:

    * COMMENT setup section
    #+STARTUP: overview
    more stuff that should be hidden

    * The first "real" headline in the file.

Another possibility woud be to use a drawer for this,
for example a SETUP drawer.

    (setq org-drawers '("PROPERTIES" "SETUP"))

Then you could write

    :SETUP:
    #+STARTUP: overview
    more stuff that should be hidden
    :END:

    * The first "real" headline in the file.

All you then need to do is to make sure that the drawer will
be closed when first visiting the file, for example

    (add-hook 'org-mode-hook
       (lambda () (org-cycle-hide-drawers 'all)))

- Carsten

Re: include file contents in org files?

[Rainer Stengele]

Carsten Dominik schrieb:
> On Aug 22, 2007, at 12:54, Rainer Stengele wrote:
>>
>> Taking the idea a little "around the corner" I wonder if it would be 
>> possible to hide everything that begins with a "#" before the first 
>> heading.
>> Application: I have my org files under subversion control and carry 
>> around this line at the beginning of my files:
>>
>>
>> # SVN $Revision: 385 $  $Date: 2007-08-21 23:50:43 +0200 (Di, 21 Aug 
>> 2007) $
>>
>> I would like to hide that and similar lines unless showing all with 
>> "C-c C-a". Also a possible "#include" line could be hidden. If 
>> somebody wants to see the lines - of course - a config option would do 
>> it.
>>
>> Rainer
> 
> The easiest way is this:
> 
>    * COMMENT setup section
>    #+STARTUP: overview
>    more stuff that should be hidden
> 
>    * The first "real" headline in the file.
> 
> Another possibility woud be to use a drawer for this,
> for example a SETUP drawer.
> 
>    (setq org-drawers '("PROPERTIES" "SETUP"))
> 
> Then you could write
> 
>    :SETUP:
>    #+STARTUP: overview
>    more stuff that should be hidden
>    :END:
> 
>    * The first "real" headline in the file.
> 
> All you then need to do is to make sure that the drawer will
> be closed when first visiting the file, for example
> 
>    (add-hook 'org-mode-hook
>       (lambda () (org-cycle-hide-drawers 'all)))
> 
> - Carsten

I use the drawers. Works perfect. Thanks a lot!

Re: Re: include file contents in org files?

[Carsten Dominik]

On Aug 22, 2007, at 22:25, Rainer Stengele wrote:
>> All you then need to do is to make sure that the drawer will
>> be closed when first visiting the file, for example
>>    (add-hook 'org-mode-hook
>>       (lambda () (org-cycle-hide-drawers 'all)))
>> - Carsten
>
> I use the drawers. Works perfect. Thanks a lot!

Hiding drawers will be automatic upon visiting a file in
version 5.06 - this means that you can and should remove this
from your hook again once you get 5.06.

- Carsten

Re: Re: include file contents in org files?

[Daniel J. Sinder]

> Then you could write
> 
>    :SETUP:
>    #+STARTUP: overview
>    more stuff that should be hidden
>    :END:
> 
>    * The first "real" headline in the file.

I like this, but here's a word of caution.... I had previously
started my setup on the first line of the file.  But, if you put the
:SETUP: drawer the first line, using TAB when point is on the first
character of the file only does global visibility cycling (as it
should).  To open the :SETUP: drawer, you need to move point off the
first character.

Re: Re: include file contents in org files?

[Carsten Dominik]

On Aug 24, 2007, at 1:32, Daniel J. Sinder wrote:

>> Then you could write
>>
>>    :SETUP:
>>    #+STARTUP: overview
>>    more stuff that should be hidden
>>    :END:
>>
>>    * The first "real" headline in the file.
>
> I like this, but here's a word of caution.... I had previously
> started my setup on the first line of the file.  But, if you put the
> :SETUP: drawer the first line, using TAB when point is on the first
> character of the file only does global visibility cycling (as it
> should).  To open the :SETUP: drawer, you need to move point off the
> first character.

or configure the variable `org-cycle-global-at-bob'.  Maybe we should
acatually change the default of this variable.  Is there anyone
relying on the behavior that TAB behaves specially at the beginning
of the buffer?

- Carsten

Re: include file contents in org files?

[Rainer Stengele]

Carsten Dominik schrieb:
> 
> On Aug 24, 2007, at 1:32, Daniel J. Sinder wrote:
> 
>>> Then you could write
>>>
>>>    :SETUP:
>>>    #+STARTUP: overview
>>>    more stuff that should be hidden
>>>    :END:
>>>
>>>    * The first "real" headline in the file.
>>
>> I like this, but here's a word of caution.... I had previously
>> started my setup on the first line of the file.  But, if you put the
>> :SETUP: drawer the first line, using TAB when point is on the first
>> character of the file only does global visibility cycling (as it
>> should).  To open the :SETUP: drawer, you need to move point off the
>> first character.
> 
> or configure the variable `org-cycle-global-at-bob'.  Maybe we should
> acatually change the default of this variable.  Is there anyone
> relying on the behavior that TAB behaves specially at the beginning
> of the buffer?
> 
> - Carsten

Actually I stumbled over this thing. I now switched 
org-cycle-global-at-bob off.
I opt to change the default.

Rainer