lua-filters icon indicating copy to clipboard operation
lua-filters copied to clipboard

Lua filters deserve BETTER MARKETING.

Open stroobandt opened this issue 5 years ago • 2 comments

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.

stroobandt avatar Oct 17 '20 16:10 stroobandt

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?

averms avatar Oct 18 '20 03:10 averms

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 avatar Oct 18 '20 11:10 tarleb

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 avatar Apr 29 '23 12:04 tarleb

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

stroobandt avatar Apr 29 '23 16:04 stroobandt

@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.

alerque avatar Apr 29 '23 18:04 alerque

@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 avatar Apr 29 '23 19:04 tarleb

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.

tarleb avatar Apr 29 '23 19:04 tarleb

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

I prefer the above option for math2svg. Thanks!

stroobandt avatar Apr 29 '23 21:04 stroobandt

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:

  • [x] Good docs
  • [x] 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.

tarleb avatar Apr 30 '23 08:04 tarleb

Den lör 29 apr. 2023 21:12Albert Krewinkel @.***> skrev:

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.

I might be able to lend a hand as well as and when I have time.

Reply to this email directly, view it on GitHub https://github.com/pandoc/lua-filters/issues/121#issuecomment-1528853216, or unsubscribe https://github.com/notifications/unsubscribe-auth/AAI3OUZ3ID64SYEPSB73ZY3XDVRXXANCNFSM4SUPEIIA . You are receiving this because you are subscribed to this thread.Message ID: @.***>

bpj avatar Apr 30 '23 11:04 bpj