pandoc / lua-filters

A collection of lua filters for pandoc
MIT License
611 stars 166 forks source link

Filter for linguistic examples #151

Closed cysouw closed 3 years ago

cysouw commented 3 years ago

New Lua-filter to make examples according to the field of linguistics. Proposes a logical structure for such examples, a way to edit them in Pandoc-markdown, parses such examples, and preparing output that works well with html, epub, docx. Exporting to various Latex packages dealing with the same problem are included.

tarleb commented 3 years ago

Thank you for the PR, this looks very impressive!

Linguistics is entirely outside my area of expertise, and I'm not sure I understand enough of what this does in details. We generally try to make sure that we can maintain all code in this repo ourselves in case the original author of a script goes missing. Given the massive size and unfamiliar topic of this filter, I'm uncertain whether we can achieve this. There are other Lua filters maintained as separate projects, like pandoc-zotxt. I feel like this might be a better option here. @jgm, what do you think?

I'll be happy to give feedback on the code either way. As a first comment, may I suggest to use editorconfig? It helps us to maintain a consistent coding style, and (mostly) prevents issues like mixing tabs and spaces.

cysouw commented 3 years ago

The code is also available in my own repo: https://github.com/cysouw/pandoc-ling, so I am fine either way.

However, I find the idea of a centralised point for Lua Filters very attractive, because it makes it easer for users to install and use them. However, I understand the problem of maintenance!

cysouw commented 3 years ago

BTW: @jgm is there any plan to include some of these filters in the regular Pandoc install?

tarleb commented 3 years ago

Suggestions to make the repo easier to find:

I still plan to setup a website for pandoc filters, and we could link it from there as well.

cysouw commented 3 years ago

OK, then just close this PR here and I'll keep working on it separately. thanks for the interest and the kind words!

(and BTW: maybe put the .DS_Store in the gitignore of this Repo, then they wouldn't come through with PR from macOS-users)

tarleb commented 3 years ago

(and BTW: maybe put the .DS_Store in the gitignore of this Repo, then they wouldn't come through with PR from macOS-users)

It's usually better to let users handle the idiosyncrasies of their systems and editors, e.g. by encouraging them to exclude auto-generated files via a global ~/.gitignore. But I don't feel strongly about it, so if you'd like to make a PR, I'd accept it.

If you are on Twitter and want to increase visibility there, then ping @pandoc_tips so we can retweet.

jgm commented 3 years ago

I agree: a big filter like this is probably better developed in a separate project.

BTW: @jgm is there any plan to include some of these filters in the regular Pandoc install?

No.