tomduck / pandoc-theoremnos

A pandoc filter for numbering theorems and theorem references.
GNU General Public License v3.0
9 stars 5 forks source link

New project #2

Open tomduck opened 5 years ago

tomduck commented 5 years ago

This project was contributed to the the pandoc-xnos filter suite by @ValiValpas. Many thanks!

I'm going to use this Issue to report and discuss changes as we work toward a release.

I have made some changes to the initial commit. The version number is now 2.0.0a1 which identifies it as an alpha release. Install instructions are given at the top of the README.md. Any existing installation may need to be removed before installing this one.

I have created a 'nextrelease' branch for development.

Pandoc-xnos has been updated and will be automatically upgraded when this project is installed. Some more changes to pandoc-xnos will likely be needed as described in PR #1.

The demos have been built and are pushed to the 'demos' branch.

More soon. ☺︎

tomduck commented 5 years ago

Version 2.0.0a2 is now posted. Meta processing code marked "TODO" was moved to pandoc-xnos, and changes suggested by pylint were made.

tomduck commented 5 years ago

Version 2.0.0a3 is posted. Mixed numbered/unnumbered definitions lists are now supported.

To do: 1) Create default behaviour for other output formats; 2) Optimize output; 3) Create demos as per other pandoc-xnos projects; 4) Make compatible with pandoc-1.15 to 1.17 and python 2.7 (tests fail); 5) Define some default theorem types (e.g., thm, defn); 6) Review documentation; and 7) Integrate into the pandoc-xnos filter suite.

I am also considering renaming the project pandoc-defnos in keeping with the fact that the filter is for numbering definitions in pandoc-markdown definitions lists. The idea here is to ensure pandoc users can readily identify what the filter is for. Any thoughts on that, @ValiValpas?

jschlatow commented 5 years ago

@tomduck First of all, thanks for picking up my code and pushing it forward.

I noticed that you latest change broke the demo. The first item ('Day') of the unnumbered definition list is discarded and neither appears in html nor pdf output.

Re. renaming: You already mentioned earlier that you're not married to the name. My line of thought (as a LaTeX person) was that 'theorem' matches the naming scheme of the corresponding LaTeX packages. However, I also see the logic in your argumentation as 'definition list' is the correct term in markdown and html. I'd be okay with 'defnos' as I find 'theoremnos' a quite bulky name.

tomduck commented 5 years ago

Thanks, @ValiValpas. Yes, I see too that the demo broke. I will fix it. --Tom

Freed-Wu commented 4 years ago

yes, if pandoc --filter xnos will get

{(???)}
My Theorem
This is my theorem.

but use theoremnos will not get this error.