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

Lua filters deserve BETTER MARKETING. #121

Closed
stroobandt opened this issue Oct 17, 2020 · 10 comments
Closed

Lua filters deserve BETTER MARKETING. #121

stroobandt opened this issue Oct 17, 2020 · 10 comments

Comments

@stroobandt
Copy link
Contributor

Lua filters deserve BETTER MARKETING.
Currently. Lua filters look more like an afterthought at the bottom of the Extras page.
When one eventually lands on this README.md, it becomes a GitHub dumpster dive to find out which Lua filter does what. I would suggest adding one paragraph descriptions to the general README.md and do something similar on the Extras page.

Feel free to discuss this here.

@averms
Copy link
Contributor

averms commented Oct 18, 2020

When one eventually lands on this README.md, it becomes a GitHub dumpster dive to find out which Lua filter does what. I would suggest adding one paragraph descriptions to the general README.md and do something similar on the Extras page.

Agree with the first part. We could write a script that merges all the READMEs
and appends them to the root README. Maybe we could use include-files.lua?

@tarleb
Copy link
Member

tarleb commented Oct 18, 2020

See branch html-pages for my plans to improve on the current situation. I'd like to have a separate website, with a separate page for each filter, and an overview page featuring the paragraph between the main heading and first second-level heading. Example filter page:
pagebreak.zip

@tarleb
Copy link
Member

tarleb commented Apr 29, 2023

We've created a new org pandoc-ext to make filters more visible. New filters are announced on Mastodon. Quarto-related pages like awesome-quarto mention the filters, too.

While we could still do more, it's enough for me to consider this done.

@tarleb tarleb closed this as completed Apr 29, 2023
@stroobandt
Copy link
Contributor Author

@tarleb Great! But what needs to be done for my math2svg Lua filter to make it onto the list?

@alerque
Copy link
Collaborator

alerque commented Apr 29, 2023

@tarleb I know my attention has been devoured in other directions lately, but I do come round to Pandoc & especially Lua stuff now and then. If you want triage/maintenance/ci help on the new org feel free to invite and I'll pitch is as time permits.

@tarleb
Copy link
Member

tarleb commented Apr 29, 2023

@tarleb Great! But what needs to be done for my math2svg Lua filter to make it onto the list?

The filter migration is work in progress, I didn't get to math2svg yet. I generally encourage contributors to maintain filters under their own namespace and to mention them in pandoc-ext/info (e.g., https://github.com/b3/include-code-files), but I'm also happy to move the code to a repo in pandoc-ext and give the maintainer access (as happened with list-table). Just let me know your preference.

@tarleb
Copy link
Member

tarleb commented Apr 29, 2023

If you want triage/maintenance/ci help on the new org feel free to invite and I'll pitch is as time permits.

Thanks, I'll gladly take you up on that.

@stroobandt
Copy link
Contributor Author

move the code to a repo in pandoc-ext and give the maintainer access

I prefer the above option for math2svg. Thanks!

@tarleb
Copy link
Member

tarleb commented Apr 30, 2023

I've created the repo and given you access. It's set to "private" for now, because I aim for all repos in the pandoc-ext org to follow a few common patterns, which we'll have to add to math2svg first. I've yet to write those patterns down in detail, but the gist is:

  • Good docs
  • MIT license
  • Usable as a Quarto extension (if the filter makes sense in that context)
  • Options should be taken from an object with the same name as the filter, e.g.,
    my-filter:
      setting1: true
      setting2: [this, that]
      # etc.

I plan to publish another filter that will create this structure from myfilter_foo and myfilter.bar values, so old math2svg configs will still be usable.

@bpj
Copy link

bpj commented Apr 30, 2023 via email

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

5 participants