filters: Move to generic naming

Author: harens

tex2lambda/__init__.py

@@ -1,9 +1,9 @@
 """Python library and CLT for converting LaTeX documents into Lambda Feedback compatible JSON/ZIP files."""
 
+import beartype
 import click
 import panflute
 import rich_click
-import beartype
 from beartype.claw import beartype_this_package
 from rich.traceback import install
 

tex2lambda/filters/PartPartSolSol/__init__.py

@@ -0,0 +1,37 @@
+\documentclass{article}
+
+\begin{document}
+
+\newenvironment{SomeSolutionDividerName}{}{}
+
+\section*{Minimal Example}
+
+\hrulefill
+
+\medskip
+
+\begin{enumerate}
+
+    \item Here is some interesting information. Calculate the following:
+
+          \begin{enumerate}
+              \item $1+1$
+              \item $2+2$
+          \end{enumerate}
+
+          \begin{SomeSolutionDividerName}
+              \begin{enumerate}
+                  \item $1+1=2$
+                  \item $2+2=4$
+              \end{enumerate}
+          \end{SomeSolutionDividerName}
+
+    \item This questions has no parts. What is the solution?
+
+          \begin{SomeSolutionDividerName}
+              This is the solution.
+          \end{SomeSolutionDividerName}
+
+\end{enumerate}
+
+\end{document}

tex2lambda/filters/PartPartSolSol/example.tex

@@ -1,9 +1,6 @@
 #!/usr/bin/env python3
 
-"""Pandoc filter for Physics Linear Algebra.
-
-See https://pandoc.org/filters.html for more information.
-"""
+"""A filter that parses files where solutions come after the whole questions and are broken down by part."""
 
 from typing import Optional
 

tex2lambda/filters/linear.py …2lambda/filters/PartPartSolSol/filter.pytex2lambda/filters/linear.py renamed to tex2lambda/filters/PartPartSolSol/filter.py tex2lambda/filters/linear.py renamed to tex2lambda/filters/PartPartSolSol/filter.py

@@ -0,0 +1,39 @@
+\documentclass{article}
+
+\begin{document}
+
+\newenvironment{SomeSolutionDividerName}{}{}
+
+\section*{Minimal Example}
+
+\hrulefill
+
+\medskip
+
+\begin{enumerate}
+
+  \item Here is some interesting information. Calculate the following:
+
+        \begin{enumerate}
+          \item $1+1$
+
+                \begin{SomeSolutionDividerName}
+                  $1+1=2$
+                \end{SomeSolutionDividerName}
+
+          \item $2+2$
+
+                \begin{SomeSolutionDividerName}
+                  $2+2=4$
+                \end{SomeSolutionDividerName}
+        \end{enumerate}
+
+  \item This questions has no parts. What is the solution?
+
+        \begin{SomeSolutionDividerName}
+          This is the solution.
+        \end{SomeSolutionDividerName}
+
+\end{enumerate}
+
+\end{document}

tex2lambda/filters/PartSolPart/__init__.py

@@ -1,9 +1,6 @@
 #!/usr/bin/env python3
 
-"""Pandoc filter for Physics Linear Algebra.
-
-See https://pandoc.org/filters.html for more information.
-"""
+"""A filter that parses files where a soltution follows each individual part."""
 
 from collections import deque
 from typing import Optional

tex2lambda/filters/PartSolPart/example.tex

@@ -0,0 +1,39 @@
+\documentclass[12pt]{article}
+
+\newenvironment{AnyName}{}{}
+
+\begin{document}
+
+\section{Minimal Example}
+
+\subsection{}
+
+Here is some preliminary question information that might be useful.
+
+\begin{enumerate}
+    \item This is part (a)
+    \item The filter still works even if there aren't any parts
+\end{enumerate}
+
+\begin{AnyName}
+    \paragraph{Solution}
+
+    This is the final answer. It contains the solutions for all parts without breaking them up.
+
+    $$
+        1+1 = 2
+    $$
+
+    The solution is copied across all parts.
+
+\end{AnyName}
+
+\subsection{}
+
+This is question 2.
+
+\begin{AnyName}
+    \paragraph{Solution} And here's the solution
+\end{AnyName}
+
+\end{document}

tex2lambda/filters/linear2.py tex2lambda/filters/PartSolPart/filter.pytex2lambda/filters/linear2.py renamed to tex2lambda/filters/PartSolPart/filter.py

@@ -1,9 +1,6 @@
 #!/usr/bin/env python3
 
-"""Pandoc filter for Materials files (specifically by Jonathan Rackham).
-
-See https://pandoc.org/filters.html for more information.
-"""
+"""A filter that parses files where solutions are denoted by beginning with the paragraph text 'Solution'. The solutions don't break down by part."""
 
 from typing import Optional
 
@@ -36,6 +33,7 @@ def pandoc_filter(
     """
     match type(elem):
         # Question text is stored in paragraph blocks where the preceding block is a section header.
+        # TODO: This doesn't work if the question has more than one paragraph
         case pf.Para:
             if (
                 isinstance(elem.prev, pf.Header)