org-publish

org-publish

[David O'Toole]

I have some ideas for changes to org-publish. I am helping someone set
up a content-heavy site using Emacs and Org-Mode, and we ran into
several problems that I would like to fix. We have workarounds in place
but these immediately suggested interesting fixes. For example it
doesn't seem possible to publish to .PHP files but maybe I missed
something. I need to reread the code because there seem to have been
many changes since I last looked at it. Furthermore it did not seem
possible to control :auto-preamble and :auto-postamble on a per-file
basis (without setting up a special project just for that one file and
using include/exclude.) Anyone mind if I make some changes and send a
patch? Is there a more recent version than the one in CVS that i should
begin with? 

Re: org-publish

[Sebastian Rose]

Hi David,

here are some solutions I could come up with. Maybe one of them is
helpful.


* Customize org

  M-x customize-variable org-export-html-extension

  and set it to 'php'?



* Apache: use mod_mime or add-handler

  You could also use the add-handler directive in your apache config
  file or (maybe) .htaccess files to execute your *.html files as PHP.

  See:
  http://httpd.apache.org/docs/2.2/mod/mod_mime.html#addhandler

  or:
  http://httpd.apache.org/docs/2.2/mod/mod_mime.html



* Apache and mod_rewrite

  You might also set up a .htaccess file like this:



    <IfModule mod_rewrite.c>
      RewriteEngine on
      RewriteBase   /
      RewriteRule   ^(.*)$ passthrough.php$1 [L]
    </IfModule>

  if you put all your *.html files exported by org into a subdirectory
  called org, passthrough.php will be called with the path to that file
  relative to /org/.

  $PATH_INFO = "org".getenv('PATH_INFO'); // not tested

  get's you that relative path (you'll have to strip '#target' and
  '?querystring' though).

  Now you can open the file, read it line by line and replace what ever
  you like (add custom headers and footers...).


  Keep in mind, that the exported files are valid XHTML so might want to
  use some XML related technique to parse and change the files on the
  fly.





Regards,

  Sebastian



David O'Toole <dto@gnu.org> writes:
> I have some ideas for changes to org-publish. I am helping someone set
> up a content-heavy site using Emacs and Org-Mode, and we ran into
> several problems that I would like to fix. We have workarounds in place
> but these immediately suggested interesting fixes. For example it
> doesn't seem possible to publish to .PHP files but maybe I missed
> something. I need to reread the code because there seem to have been
> many changes since I last looked at it. Furthermore it did not seem
> possible to control :auto-preamble and :auto-postamble on a per-file
> basis (without setting up a special project just for that one file and
> using include/exclude.) Anyone mind if I make some changes and send a
> patch? Is there a more recent version than the one in CVS that i should
> begin with?

--
Sebastian Rose, Hannover, Germany
Phone: +49 173 83 93 417
Mail.: sebatian_rose@gmx.de, s.rose@emma-stil.de

org-publish

[Richard G Riley]

I would like to suggest that 

C-c C-e P  "Publish the project containing the current file." also
publishes any projects which contain that project. e.g I have a
"container project"

	("cv"
	 :components ("cv-html" "cv-raw")
	 )

This would mean one doesn't have to manually select org-publish and then
enter "cv" to publish the entire project. One can do it using hot keys
from any file within cv-html or cv-raw.

Re: org-publish

[Carsten Dominik]

On Jul 4, 2008, at 8:28 AM, Richard G Riley wrote:

>
> I would like to suggest that
>
> C-c C-e P  "Publish the project containing the current file." also
> publishes any projects which contain that project. e.g I have a
> "container project"
>
> 	("cv"
> 	 :components ("cv-html" "cv-raw")
> 	 )
>
> This would mean one doesn't have to manually select org-publish and  
> then
> enter "cv" to publish the entire project. One can do it using hot keys
> from any file within cv-html or cv-raw.

But if you have changed only a file in a sub project, what is the need
for publishing the container?

- Carsten

Re: org-publish

[Richard G Riley]

Carsten Dominik <dominik@uva.nl> writes:

> On Jul 4, 2008, at 8:28 AM, Richard G Riley wrote:
>
>>
>> I would like to suggest that
>>
>> C-c C-e P  "Publish the project containing the current file." also
>> publishes any projects which contain that project. e.g I have a
>> "container project"
>>
>> 	("cv"
>> 	 :components ("cv-html" "cv-raw")
>> 	 )
>>
>> This would mean one doesn't have to manually select org-publish and
>> then
>> enter "cv" to publish the entire project. One can do it using hot keys
>> from any file within cv-html or cv-raw.
>
> But if you have changed only a file in a sub project, what is the need
> for publishing the container?
>
> - Carsten

But what if I have changed more than one file? Which (in my case is
typical). Since the timestamps are now working better there is no real
transfer overhead.

Re: org-publish

[Carsten Dominik]

On Jul 5, 2008, at 8:42 AM, Richard G Riley wrote:

> Carsten Dominik <dominik@uva.nl> writes:
>
>> On Jul 4, 2008, at 8:28 AM, Richard G Riley wrote:
>>
>>>
>>> I would like to suggest that
>>>
>>> C-c C-e P  "Publish the project containing the current file." also
>>> publishes any projects which contain that project. e.g I have a
>>> "container project"
>>>
>>> 	("cv"
>>> 	 :components ("cv-html" "cv-raw")
>>> 	 )
>>>
>>> This would mean one doesn't have to manually select org-publish and
>>> then
>>> enter "cv" to publish the entire project. One can do it using hot  
>>> keys
>>> from any file within cv-html or cv-raw.
>>
>> But if you have changed only a file in a sub project, what is the  
>> need
>> for publishing the container?
>>
>> - Carsten
>
> But what if I have changed more than one file? Which (in my case is
> typical). Since the timestamps are now working better there is no real
> transfer overhead.

A subproject may be part of several containers.

With the time stamps now properly working, you can also make it a habit
to simply publish everything with `C-c C-e A'.

- Carsten

org-publish

[Richard G Riley]

I am trying to use org-publish

I have defined

(setq org-publish-project-alist
      '(("RgrBlog"
	 :base-directory "/home/rgr/.emacs.d/org-files/"
	 :publishing-directory "~/webs/rgr/public_html/org-publish/"
	 :section-numbers nil
	 :author "rgr"
	 :table-of-contents t
	 :style "<link rel=stylesheet
                     href=\"stylesheet.css\"
                     type=\"text/css\">")))

But when I call org-publish I get nothing. Obviously I have missed
something obvious (the directories are correct) since no files appear at
all.

Any help much appreciated.

Re: org-publish

[Manish]

  On Sat, Jun 21, 2008 at 6:57 AM, Richard G Riley wrote:
  >
  > I am trying to use org-publish
  >
  > I have defined
  >
  > (setq org-publish-project-alist
  >      '(("RgrBlog"
  >         :base-directory "/home/rgr/.emacs.d/org-files/"
  >         :publishing-directory "~/webs/rgr/public_html/org-publish/"
  >         :section-numbers nil
  >         :author "rgr"
  >         :table-of-contents t
  >         :style "<link rel=stylesheet
  >                     href=\"stylesheet.css\"
  >                     type=\"text/css\">")))
  >
  > But when I call org-publish I get nothing. Obviously I have missed
  > something obvious (the directories are correct) since no files appear at
  > all.

I have also been trying to make this work and have a similar setup.
Not sure if this will help in your case but try adding:

   :publishing-function org-publish-org-to-html

-- Manish

Re: org-publish

[Richard G Riley]

Manish <mailtomanish.sharma@gmail.com> writes:

> On Sat, Jun 21, 2008 at 5:40 PM, Richard G Riley wrote:
>> Manish  writes:
>>
>>>   On Sat, Jun 21, 2008 at 6:57 AM, Richard G Riley wrote:
>>>   >
>>>   > I am trying to use org-publish
>>>   >
>>>   > I have defined
>>>   >
>>>   > (setq org-publish-project-alist
>>>   >      '(("RgrBlog"
>>>   >         :base-directory "/home/rgr/.emacs.d/org-files/"
>>>   >         :publishing-directory "~/webs/rgr/public_html/org-publish/"
>>>   >         :section-numbers nil
>>>   >         :author "rgr"
>>>   >         :table-of-contents t
>>>   >         :style "<link rel=stylesheet
>>>   >                     href=\"stylesheet.css\"
>>>   >                     type=\"text/css\">")))
>>>   >
>>>   > But when I call org-publish I get nothing. Obviously I have missed
>>>   > something obvious (the directories are correct) since no files appear at
>>>   > all.
>>>
>>> I have also been trying to make this work and have a similar setup.
>>> Not sure if this will help in your case but try adding:
>>>
>>>    :publishing-function org-publish-org-to-html
>>>
>> Did this work for you? It made no difference in my case.
>
> Actually, no.  The reason I mentioned it was because it seemed to
> be a required setting.  I suspect it's not working for me because
> of some conflicting settings somewhere (been frobbing with my
> setup lately.)  I am sorry it didn't work.  Sorry for the noise.
>
> -- Manish

Could someone who uses org-publish possibly post their setting for this
variable and possibly a subset (including header) of a published file?

Re: org-publish

[Nick Dokos]

Richard G Riley <rileyrgdev@googlemail.com> wrote:

> >>> Not sure if this will help in your case but try adding:
> >>>
> >>>    :publishing-function org-publish-org-to-html
> >>>

> Could someone who uses org-publish possibly post their setting for this
> variable and possibly a subset (including header) of a published file?
> 

Richard,

I have a minimal setup that works fine for me. Here is the relevant
section from my org initialization file, which gets loaded from .emacs:

;;; org-publish
(setq org-publish-project-alist
      '(("status"
         :base-directory "~/lib/status/weekly"
         :publishing-directory "/ssh:nick@foo.bar.com:~/public_html/logs"
         :publishing-function org-publish-org-to-html
         :headline-levels 3
         :section-numbers nil
         :table-of-contents nil
;         :style nil
         :auto-preamble t
         :auto-postamble nil
         )))

(require 'org-publish)


Basically, I jot down status at the end of each day and then publish the
jottings at the end of the week. The org and published files look like
this (this is an edited version of the ones from the week that ended on
June 13):


---------------------------------------------------------------------------

* Status

** [2008-06-09 Mon] 
   - foo
   - bar
   - baz

** [2008-06-10 Tue]

   - foo
   - bar
   - baz

** [2008-06-11 Wed]

   - foo
   - bar

** [2008-06-12 Thu]

   - foo
   - bar

** [2008-06-13 Fri]

   - foo
   - bar
   - baz


#+TITLE: Status
#+OPTIONS: num:nil toc:nil author:nil timestamp:nil

---------------------------------------------------------------------------
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
               "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml"
lang="en" xml:lang="en">
<head>
<title>Status</title>
<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"/>
<meta name="generator" content="Org-mode"/>
<meta name="generated" content="2008/06/16 10:10:33 AM"/>
<meta name="author" content="Nick Dokos"/>
<style type="text/css">
  html {
	font-family: Times, serif;
	font-size: 12pt;
  }
  .title { text-align: center; }
  .todo  { color: red; }
  .done { color: green; }
  .timestamp { color: grey }
  .timestamp-kwd { color: CadetBlue }
  .tag { background-color:lightblue; font-weight:normal }
  .target { }
  pre {
	border: 1pt solid #AEBDCC;
	background-color: #F3F5F7;
	padding: 5pt;
	font-family: courier, monospace;
        font-size: 90%;
  }
  table { border-collapse: collapse; }
  td, th {
	vertical-align: top;
	<!--border: 1pt solid #ADB9CC;-->
  }
  dt { font-weight: bold; }
</style>
</head><body>
<h1 class="title">Status</h1>

<div id="outline-container-1" class="outline-2">
<h2 id="sec-1">Status</h2>
<div id="text-1">



</div>

<div id="outline-container-1.1" class="outline-3">
<h3 id="sec-1.1"><span class="timestamp">2008-06-09 Mon</span> </h3>
<div id="text-1.1">

<ul>
<li>
foo
</li>
<li>
bar
</li>
<li>
baz
</li>
</ul>
</div>

</div>

<div id="outline-container-1.2" class="outline-3">
<h3 id="sec-1.2"><span class="timestamp">2008-06-10 Tue</span></h3>
<div id="text-1.2">


<ul>
<li>
foo
</li>
<li>
bar
</li>
<li>
baz
</li>
</ul>
</div>

</div>

<div id="outline-container-1.3" class="outline-3">
<h3 id="sec-1.3"><span class="timestamp">2008-06-11 Wed</span></h3>
<div id="text-1.3">


<ul>
<li>
foo
</li>
<li>
bar

</li>
</ul>
</div>

</div>

<div id="outline-container-1.4" class="outline-3">
<h3 id="sec-1.4"><span class="timestamp">2008-06-12 Thu</span></h3>
<div id="text-1.4">


<ul>
<li>
foo
</li>
<li>
bar

</li>
</ul>
</div>

</div>

<div id="outline-container-1.5" class="outline-3">
<h3 id="sec-1.5"><span class="timestamp">2008-06-13 Fri</span></h3>
<div id="text-1.5">


<ul>
<li>
foo
</li>
<li>
bar

</li>
<li>
baz

</li>
</ul>
</div>
</div>
</div>
</body>
</html>

---------------------------------------------------------------------------

HTH,
Nick

Re: org-publish

[Manish]

  On Sun, Jun 22, 2008 at 9:57 AM, Nick Dokos wrote:

  [snip]

  > I have a minimal setup that works fine for me. Here is the relevant
  > section from my org initialization file, which gets loaded from .emacs:
  >
  > ;;; org-publish
  > (setq org-publish-project-alist
  >      '(("status"
  >         :base-directory "~/lib/status/weekly"
  >         :publishing-directory "/ssh:nick@foo.bar.com:~/public_html/logs"
  >         :publishing-function org-publish-org-to-html
  >         :headline-levels 3
  >         :section-numbers nil
  >         :table-of-contents nil
  > ;         :style nil
  >         :auto-preamble t
  >         :auto-postamble nil
  >         )))
  >
  > (require 'org-publish)

  [example snipped]

I have similar settings but I still do not get any output.  Any
ideas what I can check or what other debug information can I
provide?

Any thoughts appreciated.

-- Manish

Re: org-publish

[Carsten Dominik]

Have you tried

(setq org-publish-use-timestamps-flag nil)


?  Maybe you have not changed the input files for a while, and Org  
thinks they have already been published......

- Carsten

On Jun 22, 2008, at 4:25 PM, Manish wrote:

>  On Sun, Jun 22, 2008 at 9:57 AM, Nick Dokos wrote:
>
>  [snip]
>
>> I have a minimal setup that works fine for me. Here is the relevant
>> section from my org initialization file, which gets loaded  
>> from .emacs:
>>
>> ;;; org-publish
>> (setq org-publish-project-alist
>>     '(("status"
>>        :base-directory "~/lib/status/weekly"
>>        :publishing-directory "/ssh:nick@foo.bar.com:~/public_html/ 
>> logs"
>>        :publishing-function org-publish-org-to-html
>>        :headline-levels 3
>>        :section-numbers nil
>>        :table-of-contents nil
>> ;         :style nil
>>        :auto-preamble t
>>        :auto-postamble nil
>>        )))
>>
>> (require 'org-publish)
>
>  [example snipped]
>
> I have similar settings but I still do not get any output.  Any
> ideas what I can check or what other debug information can I
> provide?
>
> Any thoughts appreciated.
>
> -- Manish
>
>
> _______________________________________________
> Emacs-orgmode mailing list
> Remember: use `Reply All' to send replies to the list.
> Emacs-orgmode@gnu.org
> http://lists.gnu.org/mailman/listinfo/emacs-orgmode

Re: org-publish

[Manish]

  Nick>>> I have a minimal setup that works fine for me. Here is the relevant
  Nick>>> section from my org initialization file, which gets loaded
from .emacs:
  Nick>>>
  Nick>>> ;;; org-publish
  Nick>>> (setq org-publish-project-alist
  Nick>>>    '(("status"
  Nick>>>       :base-directory "~/lib/status/weekly"
  Nick>>>       :publishing-directory "/ssh:nick@foo.bar.com:~/public_html/logs"
  Nick>>>       :publishing-function org-publish-org-to-html
  Nick>>>       :headline-levels 3
  Nick>>>       :section-numbers nil
  Nick>>>       :table-of-contents nil
  Nick>>> ;         :style nil
  Nick>>>       :auto-preamble t
  Nick>>>       :auto-postamble nil
  Nick>>>       )))
  Nick>>>
  Nick>>> (require 'org-publish)

  Manish>> I have similar settings but I still do not get any output.  Any
  Manish>> ideas what I can check or what other debug information can I
  Manish>> provide?
  Manish>>
  Manish>> Any thoughts appreciated.

  Carsten> Have you tried
  Carsten>
  Carsten> (setq org-publish-use-timestamps-flag nil)
  Carsten>
  Carsten>
  Carsten> ?  Maybe you have not changed the input files for a while,
and Org thinks
  Carsten> they have already been published......

Works perfectly now!

What is curious is that it did not work earlier even when the
files were modified and saved.  But now it works not just after
setting this to nil (publish irrespective of modified time) but
publishes correctly with t after the files are modified as it
should (it did not work earlier, I swear.)  I will try various
settings to see if I can repeat that state and report if I
succeed.

Thanks again.

Best,
-- Manish

Re: org-publish

[Carsten Dominik]

On Jun 22, 2008, at 5:27 PM, Manish wrote:

>  Nick>>> I have a minimal setup that works fine for me. Here is the  
> relevant
>  Nick>>> section from my org initialization file, which gets loaded
> from .emacs:
>  Nick>>>
>  Nick>>> ;;; org-publish
>  Nick>>> (setq org-publish-project-alist
>  Nick>>>    '(("status"
>  Nick>>>       :base-directory "~/lib/status/weekly"
>  Nick>>>       :publishing-directory "/ssh:nick@foo.bar.com:~/ 
> public_html/logs"
>  Nick>>>       :publishing-function org-publish-org-to-html
>  Nick>>>       :headline-levels 3
>  Nick>>>       :section-numbers nil
>  Nick>>>       :table-of-contents nil
>  Nick>>> ;         :style nil
>  Nick>>>       :auto-preamble t
>  Nick>>>       :auto-postamble nil
>  Nick>>>       )))
>  Nick>>>
>  Nick>>> (require 'org-publish)
>
>  Manish>> I have similar settings but I still do not get any  
> output.  Any
>  Manish>> ideas what I can check or what other debug information can I
>  Manish>> provide?
>  Manish>>
>  Manish>> Any thoughts appreciated.
>
>  Carsten> Have you tried
>  Carsten>
>  Carsten> (setq org-publish-use-timestamps-flag nil)
>  Carsten>
>  Carsten>
>  Carsten> ?  Maybe you have not changed the input files for a while,
> and Org thinks
>  Carsten> they have already been published......
>
> Works perfectly now!
>
> What is curious is that it did not work earlier even when the
> files were modified and saved.  But now it works not just after
> setting this to nil (publish irrespective of modified time) but
> publishes correctly with t after the files are modified as it
> should (it did not work earlier, I swear.)

I guess this means that the tree with the timestamps directory ~/.org- 
timestamps
was somehow bad, did contain wrong times or was corrupt in another way.

- Carsten

Re: org-publish

[Richard G Riley]

Carsten Dominik <dominik@science.uva.nl> writes:

> On Jun 22, 2008, at 5:27 PM, Manish wrote:
>
>>  Nick>>> I have a minimal setup that works fine for me. Here is the
>> relevant
>>  Nick>>> section from my org initialization file, which gets loaded
>> from .emacs:
>>  Nick>>>
>>  Nick>>> ;;; org-publish
>>  Nick>>> (setq org-publish-project-alist
>>  Nick>>>    '(("status"
>>  Nick>>>       :base-directory "~/lib/status/weekly"
>>  Nick>>>       :publishing-directory "/ssh:nick@foo.bar.com:~/
>> public_html/logs"
>>  Nick>>>       :publishing-function org-publish-org-to-html
>>  Nick>>>       :headline-levels 3
>>  Nick>>>       :section-numbers nil
>>  Nick>>>       :table-of-contents nil
>>  Nick>>> ;         :style nil
>>  Nick>>>       :auto-preamble t
>>  Nick>>>       :auto-postamble nil
>>  Nick>>>       )))
>>  Nick>>>
>>  Nick>>> (require 'org-publish)
>>
>>  Manish>> I have similar settings but I still do not get any output.
>> Any
>>  Manish>> ideas what I can check or what other debug information can I
>>  Manish>> provide?
>>  Manish>>
>>  Manish>> Any thoughts appreciated.
>>
>>  Carsten> Have you tried
>>  Carsten>
>>  Carsten> (setq org-publish-use-timestamps-flag nil)
>>  Carsten>
>>  Carsten>
>>  Carsten> ?  Maybe you have not changed the input files for a while,
>> and Org thinks
>>  Carsten> they have already been published......
>>
>> Works perfectly now!
>>
>> What is curious is that it did not work earlier even when the
>> files were modified and saved.  But now it works not just after
>> setting this to nil (publish irrespective of modified time) but
>> publishes correctly with t after the files are modified as it
>> should (it did not work earlier, I swear.)
>
> I guess this means that the tree with the timestamps directory ~/.org-
> timestamps
> was somehow bad, did contain wrong times or was corrupt in another way.
>
> - Carsten

Could I request that this directory is moved to org-directory?

Re: org-publish

[Carsten Dominik]

On Jun 23, 2008, at 12:41 PM, Richard G Riley wrote:
> Could I request that this directory is moved to org-directory?

You can move it wherever you like by customizing
`org-publish-timestamp-directory'.  I don't want to change the default  
because people might be switching from one org-directory to another.

- Carsten

Re: org-publish

[Richard G Riley]

Carsten Dominik <dominik@science.uva.nl> writes:

> Have you tried
>
> (setq org-publish-use-timestamps-flag nil)
>
>
> ?  Maybe you have not changed the input files for a while, and Org
> thinks they have already been published......


That fixed it. I had never published before and my first query of this
variable says it did not exist ...

Re: org-publish

[Carsten Dominik]

On Jun 23, 2008, at 12:39 PM, Richard G Riley wrote:

> Carsten Dominik <dominik@science.uva.nl> writes:
>
>> Have you tried
>>
>> (setq org-publish-use-timestamps-flag nil)
>>
>>
>> ?  Maybe you have not changed the input files for a while, and Org
>> thinks they have already been published......
>
>
> That fixed it. I had never published before and my first query of this
> variable says it did not exist ...

This is because it is located in a module that is not loaded by  
default, only when it is needed.

If you want all these modules loaded, all variable always available, I  
think you
can load Org with

(require 'org-install)
(org-require-autoloaded-modules)


- Carsten

Re: org-publish

[Rick Moynihan]

>>
>> I have similar settings but I still do not get any output.  Any
>> ideas what I can check or what other debug information can I
>> provide?
>>
>> Any thoughts appreciated.
>>

Just the other day I ran into this problem with org-publish, and it took 
me quite a while to realise that I needed to create an org publish 
timestamp directory for it to work properly.

Is there a reason why this directory wasn't being created automatically? 
  Once I created the directory by hand it worked perfectly.

R.

Re: org-publish

[Carsten Dominik]

On Jul 7, 2008, at 7:24 AM, Rick Moynihan wrote:

>>>
>>> I have similar settings but I still do not get any output.  Any
>>> ideas what I can check or what other debug information can I
>>> provide?
>>>
>>> Any thoughts appreciated.
>>>
>
> Just the other day I ran into this problem with org-publish, and it  
> took me quite a while to realise that I needed to create an org  
> publish timestamp directory for it to work properly.
>
> Is there a reason why this directory wasn't being created  
> automatically?  Once I created the directory by hand it worked  
> perfectly.

This bug has been fixed by now.

- Carsten