Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Support for org-mode #1484

Open
hummuscience opened this issue Sep 25, 2019 · 7 comments · Fixed by stencila/encoda#827
Open

Support for org-mode #1484

hummuscience opened this issue Sep 25, 2019 · 7 comments · Fixed by stencila/encoda#827
Labels
state: inactive Had little or no recent activity type: feature Proposes a new feature

Comments

@hummuscience
Copy link

hummuscience commented Sep 25, 2019

When thinking about executable documents, aside from jupyter notebooks, org-mode pops to mind.

org-mode is an emacs mode that allows writing simple text documents with code blocks (from any language), execute them, and embed the results in the same file. John Kitchin (https://github.com/jkitchin) and his group have used org-mode with this functionality to write and publish more than 20 papers (http://kitchingroup.cheme.cmu.edu/scimax).

There are already well established (built in) converters to latex and html. Additionally, using pandoc (which supports org-mode), the documents can be converted to a myriad of other outputs.

Maybe it would be a good addition to the list.

@nokome
Copy link
Member

nokome commented Sep 25, 2019

Thanks for the suggestion @Cumol, it's a good one.

As you say, given that Pandoc supports Org mode, it shouldn't be too time consuming, and I'm tempted to start a PR to add a orgmode codec. However, at this stage I think we need to focus on improving the existing codecs and documentation, for a 1.0 release, before adding new ones.

Having said that, if you or anyone else wanted to start a PR that adds it, I'd be more than happy to help out 🙂

@tlestang
Copy link

tlestang commented Oct 4, 2020

As @Cumol mentioned org-mode (particularly the subset of org-mode functionalities known as org-babel) can be powerful way to write and export executable documents, making it a great tool for e.g. reproducible research and the writing of reports/articles.
In my opinion the main advantages of org-mode are:

  • It's plain text.
  • It supports a large variety of languages (through a mix of both built-in and contributed supports), in the same document.

It would be great to see org-mode among the supported formats!

@nokome
Copy link
Member

nokome commented Oct 4, 2020

Hi @Cumol and @tlestang. I'd be happy to add a org codec, and don't think it would take too long. But I'm not familiar with org mode, so if I do spend the time adding that, would you be able to help test it out and refine it?

@hummuscience
Copy link
Author

@nokome yes, just let us know what needs to be done :)

@tlestang
Copy link

tlestang commented Oct 5, 2020

Sure, very happy to help!

@alex-ketch alex-ketch reopened this Feb 19, 2021
stencila-ci referenced this issue in stencila/encoda Feb 19, 2021
## [0.106.1](v0.106.0...v0.106.1) (2021-02-19)

### Bug Fixes

* **ELife:** Don't scale graphic assets to support low-res images ([c7efc36](c7efc36)), closes [#286](https://github.com/stencila/encoda/issues/286)
@stencila-ci

This comment was marked as off-topic.

@nokome nokome transferred this issue from stencila/encoda Jul 28, 2022
@nokome
Copy link
Member

nokome commented Jul 28, 2022

I've transferred this issue from encoda to here, which is now the repo that it could be implemented in. Timing of this transfer is related to a new request for org mode support in #1483.

@nokome nokome added state: inactive Had little or no recent activity type: feature Proposes a new feature labels Oct 18, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
state: inactive Had little or no recent activity type: feature Proposes a new feature
Projects
None yet
Development

Successfully merging a pull request may close this issue.

5 participants