* filter for src-block export question
@ 2014-09-20 23:33 John Kitchin
2014-09-21 21:11 ` John Kitchin
0 siblings, 1 reply; 2+ messages in thread
From: John Kitchin @ 2014-09-20 23:33 UTC (permalink / raw)
To: emacs-orgmode
I have noticed that when code blocks have input variables, e.g.
#+tblname: tbl-data
| x | y |
|---+---|
| 1 | 1 |
| 2 | 4 |
| 3 | 9 |
#+BEGIN_SRC python :var data=tbl-data
print data
#+END_SRC
#+RESULTS:
: [[1, 1], [2, 4], [3, 9]]
When I export this, the codeblock shows no indication of what "data" is,
or where it came from. I had hoped to develop a filter that would allow
me to put something like:
<pre>language=python
parameters: :var data=tbl-data</pre>
in front of the block for an html export. I tried following the example
here: http://orgmode.org/manual/Advanced-configuration.html at the end,
by defining a derived mode. However, it does not appear that the
information is kept in the parse tree.
(src-block (:language python :switches nil :parameters nil :begin 536 :end 578 :number-lines nil :preserve-indent t :retain-labels t :use-labels t :label-fmt nil :hiddenp nil :value print data
:post-blank 2 :post-affiliated 536 :parent #4))
although if I look at the element at point, it seems to be there:
(src-block (:language python :switches nil :parameters :var
data=tbl-data :begin 536 :end 629 :number-lines nil :preserve-indent t
:retain-labels t :use-labels t :label-fmt nil :hiddenp nil :value print
data (princ (org-element-at-point))
I am not sure why the :end values are not the same though.
Here is what I was trying to use:
#+BEGIN_SRC emacs-lisp
(defun my-src-block (src-block contents info)
(message "start-block\n\n%s\n\nend-block" info)
(concat "<pre>"
(format "[language: %s]" (org-element-property :language src-block))
(format "\nparameters: %s" (org-element-property :parameters src-block))
"</pre><br>"
(org-export-format-code-default src-block info)))
(org-export-define-derived-backend 'my-html 'html
:translate-alist '((src-block . my-src-block)))
(org-export-to-file 'my-html "custom-src-table-export.html")
(browse-url "custom-src-table-export.html")
#+END_SRC
There are two issues with this block:
1. All parameters are listed as nil
2. the code is not syntax highlighted in html at all.
Any suggestions on how to achieve this? I also want to insert
tablenames, and if the src-block is named to put the name above the
block (for extra gravy, a hyperlink from :var to the source ;).
thanks,
--
-----------------------------------
John Kitchin
http://kitchingroup.cheme.cmu.edu
^ permalink raw reply [flat|nested] 2+ messages in thread* Re: filter for src-block export question
2014-09-20 23:33 filter for src-block export question John Kitchin
@ 2014-09-21 21:11 ` John Kitchin
0 siblings, 0 replies; 2+ messages in thread
From: John Kitchin @ 2014-09-21 21:11 UTC (permalink / raw)
To: emacs-orgmode
To followup on this, I believe there is either a bug or an inconsistency
in the export engine with regards to getting the parameters of a
src-block. Below, I show why it appears there is a bug.
* Bug report for org-mode
Here is a named table
#+tblname: tbl-data
| x | y |
|---+---|
| 1 | 1 |
| 2 | 4 |
| 3 | 9 |
Here is a named src-block with a defined var
#+name: print-table
#+BEGIN_SRC python :var data=tbl-data :results value
return data
#+END_SRC
#+RESULTS: print-table
| 1 | 1 |
| 2 | 4 |
| 3 | 9 |
Now, we illustrate that the src-block does have :parameters.
#+name: get-properties
#+BEGIN_SRC emacs-lisp
(save-excursion
(re-search-backward "#\\+name: print-table")
(org-element-property :parameters (org-element-at-point)))
#+END_SRC
#+RESULTS: get-properties
: :var data=tbl-data :results value
In the export machinery, though it appears the src-block does not.
#+BEGIN_SRC emacs-lisp :results output
(defun my-src-block (src-block contents info)
(princ (concat
(format "[language: %s]\n" (org-element-property :language src-block))
(format "name: %s\n" (org-element-property :name src-block))
(format "parameters: %s\n\n" (org-element-property :parameters src-block))))
(org-export-format-code-default src-block info))
(org-export-define-derived-backend 'my-html 'html
:translate-alist '((src-block . my-src-block)))
(org-export-to-file 'my-html "custom-src-table-export.html")
#+END_SRC
#+RESULTS:
#+begin_example
[language: python]
name: print-table
parameters: nil
[language: emacs-lisp]
name: get-properties
parameters: nil
[language: emacs-lisp]
name: nil
parameters: nil
#+end_example
You can see the parameters are nil in each case, even though we know the
print-table block does have parameters.
I do not know where the parameters get lost, so I am reporting the issue here.
John Kitchin <jkitchin@andrew.cmu.edu> writes:
> I have noticed that when code blocks have input variables, e.g.
>
> #+tblname: tbl-data
> | x | y |
>
> |---+---|
> | 1 | 1 |
> | 2 | 4 |
> | 3 | 9 |
>
> #+BEGIN_SRC python :var data=tbl-data
> print data
> #+END_SRC
>
>
> #+RESULTS:
> : [[1, 1], [2, 4], [3, 9]]
>
> When I export this, the codeblock shows no indication of what "data" is,
> or where it came from. I had hoped to develop a filter that would allow
> me to put something like:
>
> <pre>language=python
> parameters: :var data=tbl-data</pre>
>
> in front of the block for an html export. I tried following the example
> here: http://orgmode.org/manual/Advanced-configuration.html at the end,
> by defining a derived mode. However, it does not appear that the
> information is kept in the parse tree.
>
> (src-block (:language python :switches nil :parameters nil :begin 536
> :end 578 :number-lines nil :preserve-indent t :retain-labels t
> :use-labels t :label-fmt nil :hiddenp nil :value print data
> :post-blank 2 :post-affiliated 536 :parent #4))
>
> although if I look at the element at point, it seems to be there:
>
> (src-block (:language python :switches nil :parameters :var
> data=tbl-data :begin 536 :end 629 :number-lines nil :preserve-indent t
> :retain-labels t :use-labels t :label-fmt nil :hiddenp nil :value print
> data (princ (org-element-at-point))
>
> I am not sure why the :end values are not the same though.
>
> Here is what I was trying to use:
>
> #+BEGIN_SRC emacs-lisp
> (defun my-src-block (src-block contents info)
> (message "start-block\n\n%s\n\nend-block" info)
> (concat "<pre>"
> (format "[language: %s]" (org-element-property :language src-block))
> (format "\nparameters: %s" (org-element-property :parameters src-block))
> "</pre><br>"
> (org-export-format-code-default src-block info)))
>
> (org-export-define-derived-backend 'my-html 'html
> :translate-alist '((src-block . my-src-block)))
>
> (org-export-to-file 'my-html "custom-src-table-export.html")
> (browse-url "custom-src-table-export.html")
> #+END_SRC
>
> There are two issues with this block:
>
> 1. All parameters are listed as nil
> 2. the code is not syntax highlighted in html at all.
>
> Any suggestions on how to achieve this? I also want to insert
> tablenames, and if the src-block is named to put the name above the
> block (for extra gravy, a hyperlink from :var to the source ;).
>
> thanks,
--
-----------------------------------
John Kitchin
Professor
Doherty Hall A207F
Department of Chemical Engineering
Carnegie Mellon University
Pittsburgh, PA 15213
412-268-7803
http://kitchingroup.cheme.cmu.edu
^ permalink raw reply [flat|nested] 2+ messages in thread
end of thread, other threads:[~2014-09-21 21:11 UTC | newest]
Thread overview: 2+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2014-09-20 23:33 filter for src-block export question John Kitchin
2014-09-21 21:11 ` John Kitchin
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).