From mboxrd@z Thu Jan 1 00:00:00 1970 From: tsd@tsdye.com (Thomas S. Dye) Subject: Re: Updating the Babel section of Worg Date: Thu, 09 Feb 2012 07:20:11 -1000 Message-ID: References: <87mx8xyt7q.fsf_-_@gmx.com> <87pqdrlkuw.fsf_-_@gmx.com> <8762fhe76u.fsf@gmx.com> Mime-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: quoted-printable Return-path: Received: from eggs.gnu.org ([140.186.70.92]:57182) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1RvXfa-0005Zd-SM for emacs-orgmode@gnu.org; Thu, 09 Feb 2012 12:20:35 -0500 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1RvXfQ-0006Oy-4Y for emacs-orgmode@gnu.org; Thu, 09 Feb 2012 12:20:30 -0500 Received: from oproxy9.bluehost.com ([69.89.24.6]:35356) by eggs.gnu.org with smtp (Exim 4.71) (envelope-from ) id 1RvXfP-0006OS-NQ for emacs-orgmode@gnu.org; Thu, 09 Feb 2012 12:20:20 -0500 In-Reply-To: <8762fhe76u.fsf@gmx.com> (Eric Schulte's message of "Wed, 08 Feb 2012 07:14:15 -0700") List-Id: "General discussions about Org-mode." List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: emacs-orgmode-bounces+geo-emacs-orgmode=m.gmane.org@gnu.org Sender: emacs-orgmode-bounces+geo-emacs-orgmode=m.gmane.org@gnu.org To: Eric Schulte Cc: emacs-orgmode@gnu.org Hi Eric, I pushed a draft of the revised LaTeX language section to Worg (http://orgmode.org/worg/org-contrib/babel/languages/ob-doc-LaTeX.html). Please take a look and edit as necessary. Too often I understand these things partially! If Andreas Leha is reading this it would be good to take a look at my description of the ImageMagick facility. I tried to stick closely to the sources, but might have strayed. All the best, Tom Eric Schulte writes: > tsd@tsdye.com (Thomas S. Dye) writes: > >> Hi Eric, >> >> I've attached a first draft of a template for review and revision. It >> is heavily influenced by John Hendy's terrific gnuplot page. I >> believe it incorporates the points in your outline. Feel free to >> edit as appropriate. >> > > Looks great to me. I made a small change, and I've just pushed it up to > worg and linked to it from the languages page. We can continue to > improve this template as needed on worg although I think it is already > in very good shape and ready for use. > > Thanks, > >> >> All the best, >> Tom >> >> >> >> >> Eric Schulte writes: >> >>> Hi Tom, >>> >>> tsd@tsdye.com (Thomas S. Dye) writes: >>> >>>> Hi Eric, >>>> >>>> Yes, this is overdue. I think your plan is a good one. >>>> >>>> Perhaps a few of the individual use cases could be moved to FIXME, >>>> instead? I'm thinking here of Feiming Chen's R setup and some of my >>>> contributions when I was experimenting writing LaTeX inside source >>>> code blocks. The authors could resurrect these as they see fit. >>>> >>> >>> I don't know what FIXME is, but if there is a way to keep the page in >>> the worg git repository but remove it from the exported HTML then that >>> sounds ideal. >>> >>>> >>>> Hopefully, others will contribute use examples. My sense from reading >>>> the list is there are many interesting ones. >>>> >>>> I'd like it if Org mode users designed a template for the language >>>> specific pages. Currently, these seem to me a mixed bag and it would = be >>>> good to regularize them. >>> >>> The below is a modified version of a template which can be found in a >>> couple of the existing language tutorials, I think it serves as a good >>> starting point. >>> >>> - Install and Setup >>> - Instillation and configuration of software (e.g., the language itse= lf) >>> - Configuration of Emacs (e.g., activate language, set command path) >>> - Examples >>> - Common ways to use the language in an Org-mode document >>> - Special cases >>> - are there any language-specific header arguments >>> - does the language support session evaluation >>> - does the language support all result types >>> - is the language different from most babel languages >>> (e.g., C is compiled before execution, ditaa returns files, etc...) >>> >>>> It would also be nice to have one for each of the supported languages. >>>> There are 11 language specific pages now, which leaves quite a few >>>> languages under-documented. >>> >>> (length org-babel-load-languages) ;; =3D> 27 >>> >>> ls org-contrib/babel/languages/ob-doc-*|wc -l # =3D> 11 >>> >>> It looks like we have at least 16 more to go before we hit full language >>> coverage. Perhaps we should use the empty cells in the "documentation" >>> column in the languages table at [1] as a sign up space for volunteers >>> who would be willing to write a brief tutorial demonstrating usage of >>> Org-mode with their favorite language. >>> >>> Moving forward this is likely something we could request of the >>> contributors of new languages. >>> >>> Also, once the template above is finalized it should be posted on worg >>> and linked to through the languages page. >>> >>>> >>>> I'll be happy to work on this as I can. >>>> >>> >>> Great, I don't anticipate having time to put towards this, although I'll >>> be happy to help troubleshoot where I can. >>> >>> Cheers, >>> >>>> >>>> All the best, >>>> Tom >>>> >>>> >>>> Eric Schulte writes: >>>> >>>>> Thanks for raising this point. The bulk of the content in the Babel >>>>> portion of worg is fairly old, predating the syntax standardization >>>>> efforts this fall. I've just pushed some minor updates to the main >>>>> babel pages, but updating the language-specific tutorials and the >>>>> individual use cases will be a much larger effort. >>>>> >>>>> I'm not sure how to proceed. One option would be to go through and a= dd >>>>> a [uses deprecated syntax] tag to the top of each such page, which co= uld >>>>> be removed after the page has been checked and possibly updated to >>>>> ensure consistency with the latest syntax. >>>>> >>>>> Given that the Babel syntax will not be changing significantly moving >>>>> forward now would be a good time to do such a review. Ideally this >>>>> could be completed before the release of Emacs 24 in a couple of mont= hs. >>>>> >>>>> Any other ideas for update/reorganization or volunteers? >>>>> >>>>> Cheers, >>>>> >>>>> tsd@tsdye.com (Thomas S. Dye) writes: >>>>> >>>>>> Hi Riccardo, >>>>>> >>>>>> Thanks for the URL. Org mode has evolved since this article was >>>>>> written. It should probably be revised or taken off Worg. I've cop= ied >>>>>> Eric Schulte, who is better able than me to determine the correct co= urse >>>>>> of action here. >>>>>> >>>>>> In the meantime, an up-to-date description of how Org mode can be us= ed >>>>>> to write literate programs has appeared in the Journal of Statistical >>>>>> Software. You can find it here: http://www.jstatsoft.org/v46/i03 >>>>>> >>>>>> Perhaps you could use the examples in the JSS article to get started? >>>>>> If these don't work for you, or if they raise questions that are dif= ficult >>>>>> to answer, please do come back to the list with your queries. >>>>>> >>>>>> All the best, >>>>>> Tom >>>>>> >>>>>> Riccardo Romoli writes: >>>>>> >>>>>>> Hi, this is the URL: >>>>>>> >>>>>>> http://orgmode.org/worg/org-contrib/babel/how-to-use-Org-Babel-for-= R.html >>>>>>> >>>>>>> Best >>>>>>> R >>>>>>> >>>>>>> 2012/2/5 Thomas S. Dye >>>>>>> >>>>>>>> Hi Riccardo, >>>>>>>> >>>>>>>> This code appears to be outdated. I don't recall this code on the= org >>>>>>>> site. Could you send a URL? >>>>>>>> >>>>>>>> All the best, >>>>>>>> Tom >>>>>>>> >>>>>>>> Riccardo Romoli writes: >>>>>>>> >>>>>>>> > Hi, I'm trying to generate some figure with R, into an org sessi= on. >>>>>>>> Firstly >>>>>>>> > I use the code in the org site. The problem is that the code do = not >>>>>>>> > generate any figure. >>>>>>>> > >>>>>>>> > This is the code: >>>>>>>> > >>>>>>>> > #+TITLE:Test >>>>>>>> > #+AUTHOR: Your Name >>>>>>>> > #+EMAIL: your-email@server.com >>>>>>>> > #+BABEL: :session *R* :cache yes :results output graphics :expor= ts >>>>>>>> > both :tangle yes >>>>>>>> > >>>>>>>> > * Example of Org-Babel for R Literate Programming >>>>>>>> > ** R text output >>>>>>>> > A simple summary. >>>>>>>> > #+begin_src R >>>>>>>> > x <- rnorm(10) >>>>>>>> > summary(x) >>>>>>>> > #+end_src >>>>>>>> > >>>>>>>> > ** R graphics output >>>>>>>> > Note we use the object =3Dx=3D generated in previous code block,= thanks to >>>>>>>> > the header option =3D:session *R*=3D. The output graphics file = is >>>>>>>> > =3Da.png=3D. >>>>>>>> > >>>>>>>> > #+begin_src R :file a.png >>>>>>>> > y <- rnorm(10) >>>>>>>> > plot(x, y) >>>>>>>> > #+end_src >>>>>>>> > >>>>>>>> > Same plot with larger dimension: >>>>>>>> > >>>>>>>> > #+begin_src R :file b.png :width 800 :height 800 >>>>>>>> > plot(x, y) >>>>>>>> > #+end_src >>>>>>>> > >>>>>>>> > >>>>>>>> > Where do I wrong? >>>>>>>> > >>>>>>>> > Best >>>>>>>> > Riccardo >>>>>>>> > Hi, I'm trying to generate some figure with R, into an org s= ession. >>>>>>>> Firstly I use the code in the org site. The problem is that the co= de do not >>>>>>>> generate any figure. This is the code: >>>>>>>> > #+TITLE:Test >>>>>>>> > #+AUTHOR: Your Name >>>>>>>> > #+EMAIL: mailto:your-email@server.com >>>>>>>> > #+BABEL: :session *R* :cache yes :results output graphics :expor= ts both >>>>>>>> :tangle yes >>>>>>>> > >>>>>>>> > * Example of Org-Babel for R Literate Programming >>>>>>>> > ** R text output >>>>>>>> > A simple summary. >>>>>>>> > #+begin_src R >>>>>>>> > x <- rnorm(10) >>>>>>>> > summary(x) >>>>>>>> > #+end_src >>>>>>>> > >>>>>>>> > ** R graphics output >>>>>>>> > Note we use the object =3Dx=3D generated in previous code block,= thanks to >>>>>>>> > the header option =3D:session *R*=3D. The output graphics file = is >>>>>>>> > =3Da.png=3D. >>>>>>>> > >>>>>>>> > #+begin_src R :file a.png >>>>>>>> > y <- rnorm(10) >>>>>>>> > plot(x, y) >>>>>>>> > #+end_src >>>>>>>> > >>>>>>>> > Same plot with larger dimension: >>>>>>>> > >>>>>>>> > #+begin_src R :file b.png :width 800 :height 800 >>>>>>>> > plot(x, y) >>>>>>>> > #+end_src >>>>>>>> > Where do I wrong?BestRiccardo >>>>>>>> >>>>>>>> -- >>>>>>>> Thomas S. Dye >>>>>>>> http://www.tsdye.com >>>>>>>> >>>>>>> Hi, this is the URL:http://orgmode.org/worg/org-contrib/babel/how-t= o-use-Org-Babel-for-R.htmlBestR >>>>>>> 2012/2/5 Thomas S. Dye Hi Riccardo, >>>>>>> >>>>>>> >>>>>>> This code appears to be outdated. =C2=A0I don't recall this cod= e on the org >>>>>>> site. =C2=A0Could you send a URL? >>>>>>> >>>>>>> All the best, >>>>>>> Tom >>>>>>> >>>>>>> Riccardo Romoli writes: >>>>>>> >>>>>>>> Hi, I'm trying to generate some figure with R, into an org ses= sion. Firstly >>>>>>>> I use the code in the org site. The problem is that the code do not >>>>>>>> generate any figure. >>>>>>>> >>>>>>>> This is the code: >>>>>>>> >>>>>>>> #+TITLE:Test >>>>>>>> #+AUTHOR: Your Name >>>>>>>> #+EMAIL: mailto:your-email@server.com >>>>>>>> #+BABEL: :session *R* :cache yes :results output graphics :exports >>>>>>>> both :tangle yes >>>>>>>> >>>>>>>> * Example of Org-Babel for R Literate Programming >>>>>>>> ** R text output >>>>>>>> A simple summary. >>>>>>>> #+begin_src R >>>>>>>> =C2=A0 x <- rnorm(10) >>>>>>>> =C2=A0 summary(x) >>>>>>>> #+end_src >>>>>>>> >>>>>>>> ** R graphics output >>>>>>>> Note we use the object =3Dx=3D generated in previous code block, t= hanks to >>>>>>>> the header option =3D:session *R*=3D. =C2=A0The output graphics fi= le is >>>>>>>> =3Da.png=3D. >>>>>>>> >>>>>>>> #+begin_src R =C2=A0:file a.png >>>>>>>> =C2=A0 y <- rnorm(10) >>>>>>>> =C2=A0 plot(x, y) >>>>>>>> #+end_src >>>>>>>> >>>>>>>> Same plot with larger dimension: >>>>>>>> >>>>>>>> #+begin_src R =C2=A0:file b.png :width 800 :height 800 >>>>>>>> =C2=A0 plot(x, y) >>>>>>>> #+end_src >>>>>>>> >>>>>>>> >>>>>>>> Where do I wrong? >>>>>>>> >>>>>>>> Best >>>>>>>> Riccardo >>>>>>>> Hi, I'm trying to generate some figure with R, into an org >>>>>>>> session. Firstly I use the code in the org site. The problem is >>>>>>>> that the code do not generate any figure. This is the code: >>>>>>>> #+TITLE:Test >>>>>>>> #+AUTHOR: Your Name >>>>>>>> #+EMAIL: mailto:mailto:your-email@server.com >>>>>>>> #+BABEL: :session *R* :cache yes :results output graphics :exports= both :tangle yes >>>>>>>> >>>>>>>> * Example of Org-Babel for R Literate Programming >>>>>>>> ** R text output >>>>>>>> A simple summary. >>>>>>>> #+begin_src R >>>>>>>> =C2=A0 x <- rnorm(10) >>>>>>>> =C2=A0 summary(x) >>>>>>>> #+end_src >>>>>>>> >>>>>>>> ** R graphics output >>>>>>>> Note we use the object =3Dx=3D generated in previous code block, t= hanks to >>>>>>>> the header option =3D:session *R*=3D. =C2=A0The output graphics fi= le is >>>>>>>> =3Da.png=3D. >>>>>>>> >>>>>>>> #+begin_src R =C2=A0:file a.png >>>>>>>> =C2=A0 y <- rnorm(10) >>>>>>>> =C2=A0 plot(x, y) >>>>>>>> #+end_src >>>>>>>> >>>>>>>> Same plot with larger dimension: >>>>>>>> >>>>>>>> #+begin_src R =C2=A0:file b.png :width 800 :height 800 >>>>>>>> =C2=A0 plot(x, y) >>>>>>>> #+end_src >>>>>>>> Where do I wrong?BestRiccardo >>>>>>> >>>>>>> -- >>>>>>> Thomas S. Dye >>>>>>> http://www.tsdye.com >>>>>>> >>> >>> >>> Footnotes:=20 >>> [1] http://orgmode.org/worg/org-contrib/babel/languages.html --=20 Thomas S. Dye http://www.tsdye.com