Add include, substitution and admonition support reST markup #223

jgm · 2011-06-10T00:37:05Z

Hi!

It would be nice if Pandoc would have support for full reST markup which is
more powerful than e.g. markdown, and with the present suite of 'writers'
it would allow converting input to many output formats.



Sincerely,
Gour




Google Code Info:
Issue #: 130
Author: ggd...@gmail.com
Created On: 2009-02-21T09:48:14.000Z
Closed On:

jgm · 2011-06-10T00:37:06Z

The features that I've particularly missed: "include" and "admonition".

I still have to use rst2html.py for my documents that use these features.

#t

Google Code Info:
Author: LibreSof...@gmail.com
Created On: 2009-04-17T15:38:42.000Z

jgm · 2011-06-10T00:37:07Z

I'm particularly missing the "class" directive, especially in conjunction with code
blocks. According to the ReST docs, you use it like this:

.. class:: special

This is a special paragraph.

For code blocks, you need to do this:

.. class:: python
..

::

def some_python_function():
# etc

Google Code Info:
Author: lukeplan...@gmail.com
Created On: 2009-11-09T11:38:14.000Z

jgm · 2011-06-10T00:37:07Z

An alternative for nicer handling of code blocks would be the custom 'code-block'
directive that is commonly used. It is implemented by Sphinx, a popular tool for
documenting libraries, especially Python. See http://sphinx.pocoo.org/markup/
code.html. Syntax is much simpler than the above:

.. code-block:: python

def some_python_function():
# etc

Google Code Info:
Author: lukeplan...@gmail.com
Created On: 2009-11-09T11:59:52.000Z

valholl · 2012-07-16T13:15:12Z

I would love full support for reStructuredText too.

One thing I'm missing is support for substitution definitions: http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html#substitution-definitions with image and replace directives.

EronHennessey · 2013-10-04T19:27:08Z

Agreed with the above comments, and would like to refresh this issue.

I'd dearly love to see reStructuredText's .. include:: filename.rst directives honored (or at least some output that they've been ignored). This, to me, is one of the largest benefits of using reST instead of markdown.

I'm currently getting around this by using rst2html.py to convert the files to HTML, then using pandoc to convert it from HTML to markdown (for GitHub, etc.)... it's weird to have to use HTML as the intermediary format, but it works. ;)

Substitution support would be great, too.

ramnathv · 2014-02-28T14:44:14Z

Let me add another vote for this 👍

mpickering · 2014-12-07T11:31:49Z

To summarise, missing features are

include
substitution
admonition

The latter two should be easy to implement. The first requires some more machinery I am currently thinking about.

chiffa · 2016-02-23T23:22:23Z

I would suggest that ..include:: is a critical part of the ReStructuredText and the reason I am working with it.

timofurrer · 2016-11-16T08:30:58Z

What's the state on the `.. include::`` directive?

jgm · 2016-11-16T11:09:43Z

.. include:: is not yet implemented.

Currently this would require adding a handleIncludes function like in the LaTeX reader, and modifying pandoc.hs to run this on the input before passing it to the (pure) LaTeX reader. This is pretty ugly, though. A cleaner solution would require #2930, which would allow pure readers to be run with IO (processing includes) or without it.

TODO: handle the options (see comment in code). See #223.

jgm · 2016-12-04T22:46:34Z

include is now implemented in the typeclass branch, which will eventually become pandoc 2.0.

It shouldn't be too hard to implement admonition and substitution as well.

TODO: handle the options (see comment in code). See #223.

jgm · 2017-02-07T22:19:20Z

We've got admonitions now.

* We no longer add an "admonition" class, we just use the class for the type of admonition, "note" for example. * We put the word corresponding to the label in a paragraph inside a div at the beginning of the admonition with class "admonition-title". * This is about as close as we can get to RST's own output. See #223.

jgm · 2017-02-07T22:20:13Z

And we've had substitutions for a long time. I think this issue can now finally be closed!

DZSlides: Force word wrapping in code tags

mcepl · 2017-07-19T18:57:42Z

include is now implemented in the typeclass branch, which will eventually become pandoc 2.0.

There is no typeclass branch in the current repo. Where can I find .. include:: honoring code for testing?

mb21 · 2017-07-19T19:31:32Z

I think the typeclass branch has been merged into current master already...

mcepl · 2017-07-19T20:04:12Z

And does the release 1.19.2.1 contain it as well or do I have to build from the git checkout?

iandol · 2017-07-20T00:58:49Z

You can try the nightly build: https://github.com/pandoc-extras/pandoc-nightly/releases

Gim6626 · 2018-05-30T08:56:06Z

Got pandoc v1.19.2.4, no "include" support. Since which version it was added?

mb21 · 2018-05-30T10:02:15Z

Just get the newest pandoc from https://github.com/jgm/pandoc/releases

saurabhnanda · 2020-08-17T12:14:51Z

Two question regarding the include directive:

Is is possible to include a function that resolves relative paths, else the directlve becomes brittle when (a) you're processing multiple RST documents from a deeply nested directory tree, or (b) moving files around.
is it possible to use the include directive to include external code snippets such that pandoc recognizes them as code snippets and parses / renders them accordingly?

jgm · 2020-08-21T19:37:54Z

is it possible to use the include directive to include external code snippets such that pandoc recognizes them as code snippets and parses / renders them accordingly?

Can you do this in RST? If so, try the same syntax with pandoc and see if it works. IF not, we should support it, but open a new issue.

Is is possible to include a function that resolves relative paths,

I'm not sure what you mean here; relative paths should work, but pandoc interprets them relative to the working directory (or any --resource-paths).

saurabhnanda · 2020-08-22T06:06:05Z

@jgm continuing the conversation in two separate threads.

ghost assigned jgm Jun 10, 2011

mpickering changed the title ~~full support for reST markup~~ Add include, substitution and admonition support reST markup Dec 7, 2014

mpickering added complexity:high complexity:low labels Dec 7, 2014

nwf mentioned this issue Mar 29, 2015

More Sphinx ReST extensions #2043

Closed

dcode mentioned this issue Dec 31, 2015

Add Markdown Admonition Support #2610

Open

jgm added a commit that referenced this issue Dec 4, 2016

RST reader: Simple .. include:: support.

f7b3f92

TODO: handle the options (see comment in code). See #223.

jgm added a commit that referenced this issue Dec 8, 2016

RST reader: Simple .. include:: support.

292c3f6

TODO: handle the options (see comment in code). See #223.

jgm added a commit that referenced this issue Dec 24, 2016

RST reader: Simple .. include:: support.

fc60c9c

TODO: handle the options (see comment in code). See #223.

jgm added a commit that referenced this issue Jan 16, 2017

RST reader: Simple .. include:: support.

7026d53

TODO: handle the options (see comment in code). See #223.

jgm added a commit that referenced this issue Jan 24, 2017

RST reader: Simple .. include:: support.

5faf96a

TODO: handle the options (see comment in code). See #223.

jgm modified the milestone: pandoc 2.0 Jan 25, 2017

jgm added a commit that referenced this issue Jan 25, 2017

RST reader: Simple .. include:: support.

ad3ff34

TODO: handle the options (see comment in code). See #223.

jgm closed this as completed Feb 7, 2017

jgm added a commit that referenced this issue Feb 27, 2017

Merge pull request #223 from Nicop06/patch-1

c5b8f6c

DZSlides: Force word wrapping in code tags

This was referenced Aug 22, 2020

Better ReST: Directive to include external code snippets? #6631

Closed

Better ReST: Function to resolve external includes? #6632

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add include, substitution and admonition support reST markup #223

Add include, substitution and admonition support reST markup #223

jgm commented Jun 10, 2011

jgm commented Jun 10, 2011

jgm commented Jun 10, 2011

jgm commented Jun 10, 2011

valholl commented Jul 16, 2012

EronHennessey commented Oct 4, 2013

ramnathv commented Feb 28, 2014

mpickering commented Dec 7, 2014

chiffa commented Feb 23, 2016

timofurrer commented Nov 16, 2016

jgm commented Nov 16, 2016

jgm commented Dec 4, 2016

jgm commented Feb 7, 2017

jgm commented Feb 7, 2017

mcepl commented Jul 19, 2017

mb21 commented Jul 19, 2017 •

edited

Loading

mcepl commented Jul 19, 2017

iandol commented Jul 20, 2017 •

edited

Loading

Gim6626 commented May 30, 2018

mb21 commented May 30, 2018

saurabhnanda commented Aug 17, 2020

jgm commented Aug 21, 2020

saurabhnanda commented Aug 22, 2020

Add include, substitution and admonition support reST markup #223

Add include, substitution and admonition support reST markup #223

Comments

jgm commented Jun 10, 2011

jgm commented Jun 10, 2011

jgm commented Jun 10, 2011

jgm commented Jun 10, 2011

valholl commented Jul 16, 2012

EronHennessey commented Oct 4, 2013

ramnathv commented Feb 28, 2014

mpickering commented Dec 7, 2014

chiffa commented Feb 23, 2016

timofurrer commented Nov 16, 2016

jgm commented Nov 16, 2016

jgm commented Dec 4, 2016

jgm commented Feb 7, 2017

jgm commented Feb 7, 2017

mcepl commented Jul 19, 2017

mb21 commented Jul 19, 2017 • edited Loading

mcepl commented Jul 19, 2017

iandol commented Jul 20, 2017 • edited Loading

Gim6626 commented May 30, 2018

mb21 commented May 30, 2018

saurabhnanda commented Aug 17, 2020

jgm commented Aug 21, 2020

saurabhnanda commented Aug 22, 2020

mb21 commented Jul 19, 2017 •

edited

Loading

iandol commented Jul 20, 2017 •

edited

Loading