Liquid tags #21

jakevdp · 2013-05-03T14:47:52Z

This adds a set of extensions to use Liquid-style tags within markdown (similar to those provided by octopress). There are four tags included at this time, though the module is written to be easily extensible:

Insert images of a given size:

{% img /url/to/image.png [width] [height] [title] [alt]%}

Insert HTML5/flash compatible videos:

{% video /url/to/video.mp4 [width] [height] [title] %}

Insert code from a file, with a title and link to download:
```
{% include_code filename [title] %}
```

Insert an HTML-rendered ipython notebook:

{% notebook filename.ipynb [cells[start:end]] %}

Examples and details of how to use each are in the Readme file, and in the doc strings of each plugin.

almet · 2013-05-17T05:16:19Z

that looks great.

However, I would love to have this not only bound to markdown, but also available for people using restructured text, do you think that would be useful?

jakevdp · 2013-05-18T16:37:04Z

I agree that would be nice, but would basically require writing and testing an entirely new implementation. The current one is built on markdown preprocessors, and you'd have to do the equivalent with ReST preprocessors as well. I've never dug into ReST - do you know if it would be straightforward to do?

mlgill · 2013-05-24T17:47:05Z

When I attempted to used the Liquid tags notebook plugin from this pull request (21) with a very simple markdown post and IPython notebook, I get the following error upon running pelican:

WARNING: Could not process /Users/mlgill/Dropbox/themodernscientist/content/2013-05-24-testing_ipython_notebook.md
parsing error: didn't find the end of the div

If I comment out lines 144-145 of notebook.py and rerun pelican, everything is fine and the html post looks as expected. Thus, I believe the error is not valid. I have only briefly looked into debugging the issue and haven't yet figured out the problem.

Here is some information about my setup:

* IPython version 0.13.2
* Liquid tags from pull request 21 of pelican-plugins
* nbconvert github commit 0fababc961cbe0b58df4cf0286e6b2c41fb695c53
* nbconvert requires `style.min.css` to be placed in `IPython/frontend/html/notebook/static/css` and IPython version 0.13.2 doesn't have this file, so I've tried this using `style.min.css` from github commit c751c59af3ed736332cf6e2f61d27e39ccc5a788. However, the issue persists when using `notebook.css` from IPython version 0.13.2 instead.
* Pelican version 3.2.1
* Python version 2.7.5
* Mac OS X version 10.8.3

Please let me know if I can provide further information or test something.

jakevdp · 2013-05-24T18:31:06Z

That piece is a bit of an ugly hack -- once the nbconvert architecture is stabilized, we should be able to select cells within nbconvert, rather than slicing up the generated html.

It would be better to try and fix this once the nbconvert refactor is finished.

mlgill · 2013-05-25T16:02:48Z

No problem. I knew what this code was doing and this is why I didn't spend tons of time debugging it since I could myself hack it and make things work. Given the situation with nbconvert, I figured you'd want to wait. At least it's documented now as having been an issue for the future.

ibayer · 2013-06-13T19:46:23Z

Hey, I'm quit interested in this plug in. Do I need to expect significant changes before this PR gets merged?
@jakevdp Thanks for your work!

justinmayer · 2013-06-13T21:26:24Z

Thanks for the contribution, Jake. To recap, here's where we are so far:

@ametaireau said:

I would love to have this not only bound to Markdown, but also available for people using reStructuredText, do you think that would be useful?

@jakevdp replied:

I agree that would be nice, but would basically require writing and testing an entirely new implementation. The current one is built on Markdown preprocessors, and you'd have to do the equivalent with reST preprocessors as well. I've never dug into reST - do you know if it would be straightforward to do?

I agree reST support would be nice, but I suspect we should merge this in its current form for the following reasons:

It's a plugin (not core) and thus perhaps can be afforded more "leeway"
Implementing support for reST may be a non-trivial task
Nobody has stepped forward to implement equivalent support for reST

Last but not least, even if we merge this plugin in its current form, anybody is of course free to pick this up again in the future to implement support for reST, Asciidoc, and other formats.

Just my two cents. Any other thoughts?

jakevdp · 2013-06-13T22:42:02Z

Actually, I'd like to first make sure the notebook piece works with the finished nbconvert refactor -- I haven't had a chance to do that piece yet. While we're at it, we may as well wait until nbconvert is merged into IPython for the 1.0 release, slated for July.

almet · 2013-06-28T09:38:38Z

Any update?

jakevdp · 2013-06-28T14:12:37Z

Not yet - I'm still planning to wait for the IPython 1.0 release, otherwise we'll have to rewrite this code again in a month.

jakevdp · 2013-07-03T15:57:56Z

Just so folks can keep up-to-date -- I've been working on getting the features into IPython 1.0 that will allow this PR to be finished, and finished well. IPython work here:

mlgill · 2013-07-03T16:07:49Z

@jakevdp Thanks for the info. Have been waiting patiently for all the necessary updates. Happy to give it a try when ready.

ibayer · 2013-07-03T16:51:39Z

@jakevdp thanks for the update. I'm eager to give it a try too.

almet · 2013-07-11T08:52:33Z

Awesome, we're almost there!

Carreau · 2013-07-23T22:22:14Z

liquid_tags/notebook.py

+                     help="last cell of notebook to be converted")
+
+    def call(self, nb, resources):
+        nbc = deepcopy(nb)


Will now take care of that for you :-)

nband resources are now guaranted to be deepcopied before beeing passed to the first transformer, so you shoudl be safe of not deepcopying it yourself if you are concern with performance.

jakevdp · 2013-08-06T23:16:40Z

For anyone curious, this currently does not work with the IPython release candidate (some things have been renamed). I'm working on remedying that.

jakevdp · 2013-08-07T02:20:54Z

Turns out is was a simple name remapping. This should work with the IPython 1.0 release candidate available at this tag: https://github.com/ipython/ipython/tree/1.0.0a1

There are a few nbconvert bug fixes in the process of being backported from master for release. Again, we should wait until IPython 1.0 is final to merge, but I think this is pretty close!

justinmayer · 2013-08-07T02:26:48Z

Fantastic, Jake. Excited for the release!

Carreau · 2013-08-07T07:26:30Z

Oups, sorry for the name conflict, I try to warn you when there are changes that might affect the plugin, but this one slipped through my fingers.

pelson · 2013-08-10T19:37:20Z

liquid_tags/Readme.md

+- First, the plugin requires that the nbconvert package [1]_ to be in the
+  python path. For example, in bash, this can be set via
+
+      >$ export PYTHONPATH=/path/to/nbconvert/


Think this needs updating since nbconvert is now in IPython.

jakevdp · 2013-08-15T21:31:15Z

We'll need to watch out for this change, though it's IPython 2.0: ipython/ipython#4044

Carreau · 2013-08-16T07:40:47Z

We will probably also rename Exporter -> TemplateExporter as we will have one more base classe.

pelson · 2013-08-17T12:31:04Z

liquid_tags/notebook.py

+# Below is the pelican plugin code.
+#
+SYNTAX = "{% notebook /path/to/notebook.ipynb [ cells[start:end] ] %}"
+FORMAT = re.compile(r"""^(\s+)?(?P<src>\S+)(\s+)?((cells\[)(?P<start>-?[0-9]*):(?P<end>-?[0-9]*)(\]))?(\s+)?$""")


It'd be nice if this could handle spaces in the filename. Perhaps allowing people to specify the filename in quotes would disambiguate the situation?

I agree that would be nice, but I think adding this sort of thing would overly-complicate an already extremely dense regular expression. Something like this would work:

FORMAT = re.compile(r"""^(\s+)?(?P<src>\"[^\"]*\"|\'[^\']*\'|\S+)(\s+)?((cells\[)(?P<start>-?[0-9]*):(?P<end>-?[0-9]*)(\]))?(\s+)?$""")

But then you end up with a string containing quotation marks if they're used, which adds further complicated post-processing. Additionally, a regular expression like this is extremely difficult to read, maintain, and understand, even if you're the person who wrote it!

The best option would be to write a simple modular parsing framework to express these things within the submodule, but I don't really have the bandwidth to take that on right now. Plus, who puts spaces in their filenames anymore? 😄

gvwilson · 2013-08-17T21:49:40Z

This looks cool - will you be adding {% for %} and {% if %}, and if so, can they wrap cells, i.e., can I put:

+------------------------------+
| {% if instructor %} |
+------------------------------+
| ...a regular Python cell... |
+------------------------------+
| ...a Markdown cell... |
+------------------------------+
| {% endif %} |
+------------------------------+

and have it work as expected? Because I'd use that right away :-)

jakevdp · 2013-08-18T03:42:16Z

@gvwilson - that's a bit beyond the scope of this. The liquid tags are within the pelican markdown file, not within the notebook itself, so I'm not sure how that would work in this context.

Carreau · 2013-08-18T11:28:49Z

@gvwilson this would go into nbconvert template/transformers, then in pelican you could do :

{% notebook /path/to/notebook.ipynb [ instructor | learner ] %}

jakevdp · 2013-08-20T17:28:30Z

Aside from several feature requests which I likely won't get to, I think this is ready to merge.
I've been using it with IPython 1.0 on my blog for about a week now, and all the bugs seem to be worked out.

There's certainly going to be work in the future to make it compatible with IPython 2.0, and perhaps add a better parsing framework than the raw regular expressions I'm currently using. Also, adding RST support would be nice, if someone wants to take that on.

None of those are blockers, though, and I'd like to finalize what we have.

jakevdp · 2013-08-26T03:17:26Z

A user noted that if sphinx is not installed, then the IPython version check was giving a misleading message. I fixed that.

AlexMikhalev · 2013-08-27T15:03:48Z

What is the current status of this pull request?

jakevdp · 2013-08-27T19:11:09Z

Ready for merge

justinmayer · 2013-08-28T02:16:06Z

Thanks to Jake for all the hard work on this plugin, with due appreciation to others who assisted.

Add Liquid Tags plugin

almet · 2018-06-08T10:01:37Z

Please, Avoid publishing passive aggressive comments like that. It's not helpful, to anyone. It's sometimes hard for maintainers to find the time to work on all the issues, especially when it comes to managing plugins and themes. Pelican-plugins was at first thought as a way to catalog all the plugins. If the project is maintained somewhere else it's a good news, not a bad one :-) Big up to anyone who helped on this. And please, avoid being aggressive to people who commit their free time to open source projects. Cheers, Alex

…

On 07/06/2018 19:40, Natalino Busa wrote: ... fast forward 5 years, still not merged, although it works perfectly. Fortunately, this very useful and inspiring plugin is maintained on a separate repository ... — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#21 (comment)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AAEGAY11_F5MpDHyR2Bdg3VkziYLj7vZks5t6WV8gaJpZM4AoLxr>.

Most users of the theme do not set any favicon. It results in useless HTTP requests Fix getpelican#21

jakevdp added 11 commits May 2, 2013 08:36

initial commit: img, video, include_code tags

57d62ce

add notebook tag

1ae1833

add ~ files to gitignore

87f81ab

fix notebook formatting

a934cde

make code & notebook directories configurable

790fe92

update readme

a6ad0e6

change to work with new nbconvert

c0e7562

add ablility to specify notebook cells

d5e4d17

add ability to specify static directory

d091f27

save notebook header only once

e0e303a

fix cell indexing issue

76d27c2

jakevdp mentioned this pull request May 6, 2013

add header extra args duilio/pelican-octopress-theme#13

Merged

jakevdp added 3 commits May 5, 2013 21:00

fix notebook cell parsing

5977160

add literal tag for displaying {% ... %}

ce11ec8

properly set language in include_code

92e4483

make compatible with newer IPython

5af2ff3

Carreau reviewed Jul 23, 2013
View reviewed changes

Change names for compatibility with IPython 1.0alpha

499ee98

modify mathjax to not interfere with normal posts

c545c9e

adjust anim_icon CSS

4643ab7

pelson reviewed Aug 10, 2013
View reviewed changes

pelson reviewed Aug 17, 2013
View reviewed changes

jakevdp added 2 commits August 20, 2013 09:53

fix mathjax script

9e416a7

provide warning if IPython 2.0-dev is being used

e36dae6

explicitly check for IPython version

6cd4482

justinmayer added a commit that referenced this pull request Aug 28, 2013

Merge pull request #21 from jakevdp/liquid_tags

a20ca76

Add Liquid Tags plugin

justinmayer merged commit a20ca76 into getpelican:master Aug 28, 2013

jakevdp mentioned this pull request Aug 28, 2013

BUG: liquid tags notebook version check #65

Merged

jakevdp deleted the liquid_tags branch June 7, 2018 17:43

calfzhou pushed a commit to calfzhou/pelican-plugins that referenced this pull request Sep 28, 2019

Make favicons optional

fee5aa2

Most users of the theme do not set any favicon. It results in useless HTTP requests Fix getpelican#21

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Liquid tags #21

Liquid tags #21

jakevdp commented May 3, 2013

almet commented May 17, 2013

jakevdp commented May 18, 2013

mlgill commented May 24, 2013

jakevdp commented May 24, 2013

mlgill commented May 25, 2013

ibayer commented Jun 13, 2013

justinmayer commented Jun 13, 2013

jakevdp commented Jun 13, 2013

almet commented Jun 28, 2013

jakevdp commented Jun 28, 2013

jakevdp commented Jul 3, 2013

mlgill commented Jul 3, 2013

ibayer commented Jul 3, 2013

almet commented Jul 11, 2013

Carreau Jul 23, 2013

Carreau Aug 7, 2013

jakevdp commented Aug 6, 2013

jakevdp commented Aug 7, 2013

justinmayer commented Aug 7, 2013

Carreau commented Aug 7, 2013

pelson Aug 10, 2013

jakevdp commented Aug 15, 2013

Carreau commented Aug 16, 2013

pelson Aug 17, 2013

jakevdp Aug 20, 2013

gvwilson commented Aug 17, 2013

jakevdp commented Aug 18, 2013

Carreau commented Aug 18, 2013

jakevdp commented Aug 20, 2013

jakevdp commented Aug 26, 2013

AlexMikhalev commented Aug 27, 2013

jakevdp commented Aug 27, 2013

justinmayer commented Aug 28, 2013

almet commented Jun 8, 2018 via email

Liquid tags #21

Liquid tags #21

Conversation

jakevdp commented May 3, 2013

almet commented May 17, 2013

jakevdp commented May 18, 2013

mlgill commented May 24, 2013

jakevdp commented May 24, 2013

mlgill commented May 25, 2013

ibayer commented Jun 13, 2013

justinmayer commented Jun 13, 2013

jakevdp commented Jun 13, 2013

almet commented Jun 28, 2013

jakevdp commented Jun 28, 2013

jakevdp commented Jul 3, 2013

mlgill commented Jul 3, 2013

ibayer commented Jul 3, 2013

almet commented Jul 11, 2013

Carreau Jul 23, 2013

Choose a reason for hiding this comment

Carreau Aug 7, 2013

Choose a reason for hiding this comment

jakevdp commented Aug 6, 2013

jakevdp commented Aug 7, 2013

justinmayer commented Aug 7, 2013

Carreau commented Aug 7, 2013

pelson Aug 10, 2013

Choose a reason for hiding this comment

jakevdp commented Aug 15, 2013

Carreau commented Aug 16, 2013

pelson Aug 17, 2013

Choose a reason for hiding this comment

jakevdp Aug 20, 2013

Choose a reason for hiding this comment

gvwilson commented Aug 17, 2013

jakevdp commented Aug 18, 2013

Carreau commented Aug 18, 2013

jakevdp commented Aug 20, 2013

jakevdp commented Aug 26, 2013

AlexMikhalev commented Aug 27, 2013

jakevdp commented Aug 27, 2013

justinmayer commented Aug 28, 2013

almet commented Jun 8, 2018 via email