[ANN] Export block syntax change

[ANN] Export block syntax change

[Nicolas Goaziou]

Hello,

I just finalized the syntax change for export blocks. As a reminder, the
new syntax is:

  #+BEGIN_EXPORT backend
  ...
  #+END_EXPORT

instead of

  #+BEGIN_backend
  ...
  #+END_backend

So, basically, "export" is a reserved block type, much like "src". As
a consequence, INCLUDE keywords syntax is modified, e.g.,

  #+INCLUDE: "file.org" HTML

becomes

  #+INCLUDE: "file.org" export html

The following function, included in ORG-NEWS, updates any Org document
to the new syntax. It is meant to be applied after applying the patch.

  (defun org-repair-export-blocks ()
    "Repair export blocks and INCLUDE keywords in current buffer."
    (when (eq major-mode 'org-mode)
      (let ((case-fold-search t)
            (back-end-re (regexp-opt
                          '("HTML" "ASCII" "LATEX" "ODT" "MARKDOWN" "MD" "ORG"
                            "MAN" "BEAMER" "TEXINFO" "GROFF" "KOMA-LETTER")
                          t)))
        (org-with-wide-buffer
         (goto-char (point-min))
         (let ((block-re (concat "^[ \t]*#\\+BEGIN_" back-end-re)))
           (save-excursion
             (while (re-search-forward block-re nil t)
               (let ((element (save-match-data (org-element-at-point))))
                 (when (eq (org-element-type element) 'special-block)
                   (save-excursion
                     (goto-char (org-element-property :end element))
                     (save-match-data (search-backward "_"))
                     (forward-char)
                     (insert "EXPORT")
                     (delete-region (point) (line-end-position)))
                   (replace-match "EXPORT \\1" nil nil nil 1))))))
         (let ((include-re
                (format "^[ \t]*#\\+INCLUDE: .*?%s[ \t]*$" back-end-re)))
           (while (re-search-forward include-re nil t)
             (let ((element (save-match-data (org-element-at-point))))
               (when (and (eq (org-element-type element) 'keyword)
                          (string= (org-element-property :key element) "INCLUDE"))
                 (replace-match "EXPORT \\1" nil nil nil 1)))))))))


Regards,

-- 
Nicolas Goaziou                                                0x80A93738

Re: [ANN] Export block syntax change

[Rasmus]

Hi,

Nicolas Goaziou <mail@nicolasgoaziou.fr> writes:

Thanks for the work.

> The following function, included in ORG-NEWS, updates any Org document
> to the new syntax. It is meant to be applied after applying the patch.

Will org-lint be able to detect and repair documents automatically?

Rasmus

-- 
Spil noget med Slayer!

Re: [ANN] Export block syntax change

[Nicolas Goaziou]

Hello,

Rasmus <rasmus@gmx.us> writes:

> Will org-lint be able to detect and repair documents automatically?

`org-lint' detects it already, but it doesn't repair anything, hence the
additional function in ORG-NEWS.


Regards,

-- 
Nicolas Goaziou

Re: [ANN] Export block syntax change

[Ken Mankoff]

Does this new syntax support that oft (or occasionally?) requested LaTeX header export?

I don't think so out of the box, because while LaTeX is a valid export word, LaTeX_preamble is not.

But, can the new syntax be used like this?

    \include{preamble}
    #+BEGIN_EXPORT LaTeX :file preamble.tex
    % preamble commands go here
    #+END_EXPORT

Thanks,

  -k.



On 2015-12-20 at 16:06, Nicolas Goaziou <mail@nicolasgoaziou.fr> wrote:
> Hello,
>
> I just finalized the syntax change for export blocks. As a reminder, the
> new syntax is:
>
>   #+BEGIN_EXPORT backend
>   ...
>   #+END_EXPORT
>
> instead of
>
>   #+BEGIN_backend
>   ...
>   #+END_backend
>
> So, basically, "export" is a reserved block type, much like "src". As
> a consequence, INCLUDE keywords syntax is modified, e.g.,
>
>   #+INCLUDE: "file.org" HTML
>
> becomes
>
>   #+INCLUDE: "file.org" export html
>
> The following function, included in ORG-NEWS, updates any Org document
> to the new syntax. It is meant to be applied after applying the patch.
>
>   (defun org-repair-export-blocks ()
>     "Repair export blocks and INCLUDE keywords in current buffer."
>     (when (eq major-mode 'org-mode)
>       (let ((case-fold-search t)
>             (back-end-re (regexp-opt
>                           '("HTML" "ASCII" "LATEX" "ODT" "MARKDOWN" "MD" "ORG"
>                             "MAN" "BEAMER" "TEXINFO" "GROFF" "KOMA-LETTER")
>                           t)))
>         (org-with-wide-buffer
>          (goto-char (point-min))
>          (let ((block-re (concat "^[ \t]*#\\+BEGIN_" back-end-re)))
>            (save-excursion
>              (while (re-search-forward block-re nil t)
>                (let ((element (save-match-data (org-element-at-point))))
>                  (when (eq (org-element-type element) 'special-block)
>                    (save-excursion
>                      (goto-char (org-element-property :end element))
>                      (save-match-data (search-backward "_"))
>                      (forward-char)
>                      (insert "EXPORT")
>                      (delete-region (point) (line-end-position)))
>                    (replace-match "EXPORT \\1" nil nil nil 1))))))
>          (let ((include-re
>                 (format "^[ \t]*#\\+INCLUDE: .*?%s[ \t]*$" back-end-re)))
>            (while (re-search-forward include-re nil t)
>              (let ((element (save-match-data (org-element-at-point))))
>                (when (and (eq (org-element-type element) 'keyword)
>                           (string= (org-element-property :key element) "INCLUDE"))
>                  (replace-match "EXPORT \\1" nil nil nil 1)))))))))
>
>
> Regards,

Re: [ANN] Export block syntax change

[Nicolas Goaziou]

Hello,

Ken Mankoff <mankoff@gmail.com> writes:

> Does this new syntax support that oft (or occasionally?) requested
> LaTeX header export?

This syntax doesn't introduce any new feature.

> I don't think so out of the box, because while LaTeX is a valid export word, LaTeX_preamble is not.
>
> But, can the new syntax be used like this?
>
>     \include{preamble}
>     #+BEGIN_EXPORT LaTeX :file preamble.tex
>     % preamble commands go here
>     #+END_EXPORT

No, it cannot.


Regards,

-- 
Nicolas Goaziou

Re: [ANN] Export block syntax change

[Suvayu Ali]

Hi,

On Sun, Dec 20, 2015 at 10:06:44PM +0100, Nicolas Goaziou wrote:
> 
> I just finalized the syntax change for export blocks. As a reminder, the
> new syntax is:
> 
>   #+BEGIN_EXPORT backend
>   ...
>   #+END_EXPORT
> 
> instead of
> 
>   #+BEGIN_backend
>   ...
>   #+END_backend

This seems to not work for me.  The following block is completely
missing from the exported tex source.

  #+begin_export latex
  \begin{equation}
    ct = (S.V. - P.V.) \times m/p.
  \end{equation}
  #+end_export

Am I missing something?

Cheers,

-- 
Suvayu

Open source is the future. It sets us free.

Re: [ANN] Export block syntax change

[John Hendy]

On Sat, Jan 2, 2016 at 1:54 AM, Suvayu Ali <fatkasuvayu+linux@gmail.com> wrote:
> Hi,
>
> On Sun, Dec 20, 2015 at 10:06:44PM +0100, Nicolas Goaziou wrote:
>>
>> I just finalized the syntax change for export blocks. As a reminder, the
>> new syntax is:
>>
>>   #+BEGIN_EXPORT backend
>>   ...
>>   #+END_EXPORT
>>
>> instead of
>>
>>   #+BEGIN_backend
>>   ...
>>   #+END_backend
>
> This seems to not work for me.  The following block is completely
> missing from the exported tex source.
>
>   #+begin_export latex
>   \begin{equation}
>     ct = (S.V. - P.V.) \times m/p.
>   \end{equation}
>   #+end_export
>

Confirming I also don't get anything exported in this example. Just
did a git pull:

M-x org-version
Org-mode version 8.3.2 (release_8.3.2-441-ga87dea @
/home/jwhendy/.elisp/org.git/lisp/)

Then again, ORG-NEWS with the change reads v. 9.0... but git says I'm
at 8.3. Perhaps it's not actually in effect yet? Then again, I looked
around at recent commits, and see an example of "#+begin_export latex"
used in ox-latex.el... so maybe it is supposed to be released. Sorry
I'm not more help. Mainly wanted to replicate for you.


John

> Am I missing something?
>
> Cheers,
>
> --
> Suvayu
>
> Open source is the future. It sets us free.
>

Re: [ANN] Export block syntax change

[Nicolas Goaziou]

Hello,

Suvayu Ali <fatkasuvayu+linux@gmail.com> writes:


> On Sun, Dec 20, 2015 at 10:06:44PM +0100, Nicolas Goaziou wrote:
>> 
>> I just finalized the syntax change for export blocks. As a reminder, the
>> new syntax is:
>> 
>>   #+BEGIN_EXPORT backend
>>   ...
>>   #+END_EXPORT
>> 
>> instead of
>> 
>>   #+BEGIN_backend
>>   ...
>>   #+END_backend
>
> This seems to not work for me.  The following block is completely
> missing from the exported tex source.
>
>   #+begin_export latex
>   \begin{equation}
>     ct = (S.V. - P.V.) \times m/p.
>   \end{equation}
>   #+end_export
>

Fixed. Thank you.

Regards,

-- 
Nicolas Goaziou

Re: [ANN] Export block syntax change

[Suvayu Ali]

On Sat, Jan 02, 2016 at 11:54:42AM +0100, Nicolas Goaziou wrote:
> Hello,
> 
> Suvayu Ali <fatkasuvayu+linux@gmail.com> writes:
> 
> 
> > On Sun, Dec 20, 2015 at 10:06:44PM +0100, Nicolas Goaziou wrote:
> >> 
> >> I just finalized the syntax change for export blocks. As a reminder, the
> >> new syntax is:
> >> 
> >>   #+BEGIN_EXPORT backend
> >>   ...
> >>   #+END_EXPORT
> >> 
> >> instead of
> >> 
> >>   #+BEGIN_backend
> >>   ...
> >>   #+END_backend
> >
> > This seems to not work for me.  The following block is completely
> > missing from the exported tex source.
> >
> >   #+begin_export latex
> >   \begin{equation}
> >     ct = (S.V. - P.V.) \times m/p.
> >   \end{equation}
> >   #+end_export
> >
> 
> Fixed. Thank you.

Thanks!  It works now.

Cheers,

-- 
Suvayu

Open source is the future. It sets us free.

Re: [ANN] Export block syntax change

[Kaushal Modi]

[-- Attachment #1: Type: text/plain, Size: 4994 bytes --]

Hi all,

I believe this change is breaking the ox-twbs package.

The error shown is:

Debugger entered--Lisp error: (error "Unknown keyword: :export-block")
  signal(error ("Unknown keyword: :export-block"))
  error("Unknown keyword: %s" :export-block)
  org-export-define-backend(twbs ((bold . org-twbs-bold) (center-block .
org-twbs-center-block) (clock . org-twbs-clock) (code . org-twbs-code)
(drawer . org-twbs-drawer) (dynamic-block . org-twbs-dynamic-block) (entity
. org-twbs-entity) (example-block . org-twbs-example-block) (export-block .
org-twbs-export-block) (export-snippet . org-twbs-export-snippet)
(fixed-width . org-twbs-fixed-width) (footnote-definition .
org-twbs-footnote-definition) (footnote-reference .
org-twbs-footnote-reference) (headline . org-twbs-headline)
(horizontal-rule . org-twbs-horizontal-rule) (inline-src-block .
org-twbs-inline-src-block) (inlinetask . org-twbs-inlinetask)
(inner-template . org-twbs-inner-template) (italic . org-twbs-italic) (item
. org-twbs-item) (keyword . org-twbs-keyword) (latex-environment .
org-twbs-latex-environment) (latex-fragment . org-twbs-latex-fragment)
(line-break . org-twbs-line-break) (link . org-twbs-link) (paragraph .
org-twbs-paragraph) (plain-list . org-twbs-plain-list) (plain-text .
org-twbs-plain-text) (planning . org-twbs-planning) (property-drawer .
org-twbs-property-drawer) (quote-block . org-twbs-quote-block)
(quote-section . org-twbs-quote-section) (radio-target .
org-twbs-radio-target) (section . org-twbs-section) (special-block .
org-twbs-special-block) (src-block . org-twbs-src-block) (statistics-cookie
. org-twbs-statistics-cookie) (strike-through . org-twbs-strike-through)
(subscript . org-twbs-subscript) (superscript . org-twbs-superscript)
(table . org-twbs-table) (table-cell . org-twbs-table-cell) (table-row .
org-twbs-table-row) (target . org-twbs-target) (template .
org-twbs-template) (timestamp . org-twbs-timestamp) (underline .
org-twbs-underline) (verbatim . org-twbs-verbatim) (verse-block .
org-twbs-verse-block)) :export-block "HTML" :filters-alist
((:filter-final-output . org-twbs-final-function)) :menu-entry (119 "Export
to TWBS HTML" ((72 "As HTML buffer" org-twbs-export-as-html) (104 "As HTML
file" org-twbs-export-to-html) (111 "As HTML file and open" (lambda (a s v
b) (if a (org-twbs-export-to-html t s v b) (org-open-file
(org-twbs-export-to-html nil s v b))))))) :options-alist ((:html-extension
nil nil org-twbs-extension) (:html-link-org-as-html nil nil
org-twbs-link-org-files-as-html) (:html-container "HTML_CONTAINER" nil
org-twbs-container-element) (:html-link-use-abs-url nil
"html-link-use-abs-url" org-twbs-link-use-abs-url) (:html-link-home
"HTML_LINK_HOME" nil org-twbs-link-home) (:html-link-up "HTML_LINK_UP" nil
org-twbs-link-up) (:html-mathjax "HTML_MATHJAX" nil "" space)
(:html-postamble nil "html-postamble" org-twbs-postamble) (:html-preamble
nil "html-preamble" org-twbs-preamble) (:html-head "HTML_HEAD" nil
org-twbs-head newline) (:html-head-extra "HTML_HEAD_EXTRA" nil
org-twbs-head-extra newline) (:html-head-include-default-style nil
"html-style" org-twbs-head-include-default-style)
(:html-head-include-scripts nil "html-scripts"
org-twbs-head-include-scripts) (:html-table-attributes nil nil
org-twbs-table-default-attributes) (:html-table-row-tags nil nil
org-twbs-table-row-tags) (:html-inline-images nil nil
org-twbs-inline-images) (:creator "CREATOR" nil org-twbs-creator-string)
(:with-latex nil "tex" org-twbs-with-latex) (:with-toc nil nil 2)
(:with-creator nil nil t) (:with-headline-numbers nil "whn" t)
(:section-numbers nil nil t) (:latex-header "LATEX_HEADER" nil nil
newline)))
  eval-buffer()  ; Reading at buffer position 5862


The error goes away after I comment out the line with :export-block keyword
in the org-export-define-backend function call.

Example:
https://github.com/marsmining/ox-twbs/blob/cfe67353d148e65a7676f1609d8cc22a4c8fbc78/ox-twbs.el#L108

What would be the proposed/correct fix for this?

Thanks.


--
Kaushal Modi

On Sat, Jan 2, 2016 at 9:40 AM, Suvayu Ali <fatkasuvayu+linux@gmail.com>
wrote:

> On Sat, Jan 02, 2016 at 11:54:42AM +0100, Nicolas Goaziou wrote:
> > Hello,
> >
> > Suvayu Ali <fatkasuvayu+linux@gmail.com> writes:
> >
> >
> > > On Sun, Dec 20, 2015 at 10:06:44PM +0100, Nicolas Goaziou wrote:
> > >>
> > >> I just finalized the syntax change for export blocks. As a reminder,
> the
> > >> new syntax is:
> > >>
> > >>   #+BEGIN_EXPORT backend
> > >>   ...
> > >>   #+END_EXPORT
> > >>
> > >> instead of
> > >>
> > >>   #+BEGIN_backend
> > >>   ...
> > >>   #+END_backend
> > >
> > > This seems to not work for me.  The following block is completely
> > > missing from the exported tex source.
> > >
> > >   #+begin_export latex
> > >   \begin{equation}
> > >     ct = (S.V. - P.V.) \times m/p.
> > >   \end{equation}
> > >   #+end_export
> > >
> >
> > Fixed. Thank you.
>
> Thanks!  It works now.
>
> Cheers,
>
> --
> Suvayu
>
> Open source is the future. It sets us free.
>
>

[-- Attachment #2: Type: text/html, Size: 6464 bytes --]

Re: [ANN] Export block syntax change

[Nicolas Goaziou]

Hello,

Kaushal Modi <kaushal.modi@gmail.com> writes:

> I believe this change is breaking the ox-twbs package.
>
> The error shown is:
>
> Debugger entered--Lisp error: (error "Unknown keyword: :export-block")

[...]

> The error goes away after I comment out the line with :export-block keyword
> in the org-export-define-backend function call.
>
> Example:
> https://github.com/marsmining/ox-twbs/blob/cfe67353d148e65a7676f1609d8cc22a4c8fbc78/ox-twbs.el#L108
>
> What would be the proposed/correct fix for this?

Remove the :export-block keyword, which is no longer necessary. I'm
going to update ORG-NEWS. Thank you.

Regards,

-- 
Nicolas Goaziou

Re: [ANN] Export block syntax change

[Kaushal Modi]

[-- Attachment #1: Type: text/plain, Size: 1587 bytes --]

Thanks Nicolas.

I agged the org-mode git repo for ":export-block" and found these
references:

contrib/lisp/ox-gfm.el
54:  :export-block '("GFM" "GITHUB FLAVORED MARKDOWN")

(Copied Lars for above)

contrib/lisp/ox-freemind.el
46:  :export-block "FREEMIND"

(Copied Jambunathan for above)

(And copying you for groff and org.texi)

contrib/lisp/ox-groff.el
95:  :export-block "GROFF"

doc/org.texi
17971:@code{:export-block} (to specify what blocks should not be exported
by this

doc/org
16222:dispatcher), ‘:export-block’ (to specify what blocks should not be

etc/ORG-NEWS
78:Moreover, ~:export-block~ keyword used in ~org-export-define-backend~

These references need to be removed, right?

Thanks.




--
Kaushal Modi

On Wed, Jan 6, 2016 at 1:06 PM, Nicolas Goaziou <mail@nicolasgoaziou.fr>
wrote:

> Hello,
>
> Kaushal Modi <kaushal.modi@gmail.com> writes:
>
> > I believe this change is breaking the ox-twbs package.
> >
> > The error shown is:
> >
> > Debugger entered--Lisp error: (error "Unknown keyword: :export-block")
>
> [...]
>
> > The error goes away after I comment out the line with :export-block
> keyword
> > in the org-export-define-backend function call.
> >
> > Example:
> >
> https://github.com/marsmining/ox-twbs/blob/cfe67353d148e65a7676f1609d8cc22a4c8fbc78/ox-twbs.el#L108
> >
> > What would be the proposed/correct fix for this?
>
> Remove the :export-block keyword, which is no longer necessary. I'm
> going to update ORG-NEWS. Thank you.
>
> Regards,
>
> --
> Nicolas Goaziou
>

[-- Attachment #2: Type: text/html, Size: 2776 bytes --]

Re: [ANN] Export block syntax change

[Nicolas Goaziou]

Kaushal Modi <kaushal.modi@gmail.com> writes:

> I agged the org-mode git repo for ":export-block" and found these
> references:
>
> contrib/lisp/ox-gfm.el
> 54:  :export-block '("GFM" "GITHUB FLAVORED MARKDOWN")
>
> (Copied Lars for above)
>
> contrib/lisp/ox-freemind.el
> 46:  :export-block "FREEMIND"
>
> (Copied Jambunathan for above)
>
> (And copying you for groff and org.texi)
>
> contrib/lisp/ox-groff.el
> 95:  :export-block "GROFF"
>
> doc/org.texi
> 17971:@code{:export-block} (to specify what blocks should not be exported
> by this
>
> doc/org
> 16222:dispatcher), ‘:export-block’ (to specify what blocks should not be
>
> etc/ORG-NEWS
> 78:Moreover, ~:export-block~ keyword used in ~org-export-define-backend~
>
> These references need to be removed, right?

I removed all of them but the last one.

Thank you.


Regards,

Re: [ANN] Export block syntax change

[Kaushal Modi]

[-- Attachment #1: Type: text/plain, Size: 65 bytes --]

> I removed all of them but the last one.

Of course :)

Thanks.

[-- Attachment #2: Type: text/html, Size: 440 bytes --]

Re: [ANN] Export block syntax change

[Kaushal Modi]

[-- Attachment #1: Type: text/plain, Size: 86 bytes --]

Out of curiosity, which org-mode version will see this change in
export-block syntax?

[-- Attachment #2: Type: text/html, Size: 138 bytes --]

Re: [ANN] Export block syntax change

[Nicolas Goaziou]

Hello,

Kaushal Modi <kaushal.modi@gmail.com> writes:

> Out of curiosity, which org-mode version will see this change in
> export-block syntax?

Org 9.0. See ORG-NEWS in development branch.

Regards,

-- 
Nicolas Goaziou