UX improvements

docs/changelog.md

@@ -1,5 +1,16 @@
 # Changelog for `jupyterlab_latex`
 
+- **4.1.0**:
+
+- Added UI improvements to LaTeX Editor
+    - Preview Button
+    - Symbol and Constant Menu
+    - Filtered Error Messages
+    - Table Creation GUI
+    - Equation Buttons
+    - Typeface Modifier GUI
+    - Bullet point and Numbered List Buttons
+
 - **3.2.0**:
 
   - Minimum supported JupyterLab is 3.6.0

jupyterlab_latex/build.py

@@ -136,6 +136,91 @@ def bib_condition(self):
         """
         return any([re.match(r'.*\.bib', x) for x in set(glob.glob("*"))])
 
+    def filter_output(self, latex_output):
+        """Filters latex output for "interesting" messages
+
+        Parameters
+        ----------
+        latex_output: string
+            This is the output of the executed latex command from,
+            run_command in run_latex.
+
+        returns:
+            A string representing the filtered output.
+
+        Notes
+        -----
+        - Based on the public domain perl script texfot v 1.43 written by
+          Karl Berry in 2014. It has no home page beyond the package on
+          CTAN: <https://ctan.org/pkg/texfot>.
+
+        """
+        ignore = re.compile(r'''^(
+            LaTeX\ Warning:\ You\ have\ requested\ package
+            |LaTeX\ Font\ Warning:\ Some\ font\ shapes
+            |LaTeX\ Font\ Warning:\ Size\ substitutions
+            |Package\ auxhook\ Warning:\ Cannot\ patch
+            |Package\ caption\ Warning:\ Un(supported|known)\ document\ class
+            |Package\ fixltx2e\ Warning:\ fixltx2e\ is\ not\ required
+            |Package\ frenchb?\.ldf\ Warning:\ (Figures|The\ definition)
+            |Package\ layouts\ Warning:\ Layout\ scale
+            |\*\*\*\ Reloading\ Xunicode\ for\ encoding      # spurious ***
+            |pdfTeX\ warning:.*inclusion:\ fou               #nd PDF version ...
+            |pdfTeX\ warning:.*inclusion:\ mul               #tiple pdfs with page group
+            |libpng\ warning:\ iCCP:\ Not\ recognizing
+            |!\ $
+            |This\ is
+            |No\ pages\ of\ output.                          # possibly not worth ignoring?
+            )''', re.VERBOSE)
+
+        next_line = re.compile(r'''^(
+            .*?:[0-9]+:                        # usual file:lineno: form
+            |!                                 # usual ! form
+            |>\ [^<]                           # from \show..., but not "> <img.whatever"
+            |.*pdfTeX\ warning                 # pdftex complaints often cross lines
+            |LaTeX\ Font\ Warning:\ Font\ shape
+            |Package\ hyperref\ Warning:\ Token\ not\ allowed
+            |removed\ on\ input\ line          # hyperref
+            |Runaway\ argument
+            )''', re.VERBOSE)
+
+        show = re.compile(r'''^(
+            Output\ written
+            |No\ pages\ of\ output
+            |\(.*end\ occurred\ inside\ a\ group
+            |(Und|Ov)erfull
+            |(LaTeX|Package|Class).*(Error|Warning)
+            |.*Citation.*undefined
+            |.*\ Error                                # as in \Url Error ->...
+            |Missing\ character:                      # good to show (need \tracinglostchars=1)
+            |\\endL.*problem                          # XeTeX?
+            |\*\*\*\s                                 # *** from some packages or subprograms
+            |l\.[0-9]+                                # line number marking
+            |all\ text\ was\ ignored\ after\ line
+            |.*Fatal\ error
+            |.*for\ symbol.*on\ input\ line
+            )''', re.VERBOSE)
+
+        print_next = False
+        filtered_output = []
+
+        for line in latex_output.split('\n'):
+            if print_next:
+                filtered_output.append(line)
+                print_next = False
+
+            elif ignore.match(line):
+                continue
+
+            elif next_line.match(line):
+                filtered_output.append(line)
+                print_next = True
+
+            elif show.match(line):
+                filtered_output.append(line)
+
+        return '\n'.join(filtered_output)
+
 
     @gen.coroutine
     def run_latex(self, command_sequence):
@@ -167,7 +252,7 @@ def run_latex(self, command_sequence):
                 self.set_status(500)
                 self.log.error((f'LaTeX command `{" ".join(cmd)}` '
                                  f'errored with code: {code}'))
-                return output
+                return json.dumps({'fullMessage':output, 'errorOnlyMessage':self.filter_output(output)})
 
         return "LaTeX compiled"
 

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jupyterlab/latex",
-  "version": "4.0.0",
+  "version": "4.1.0",
   "description": "JupyterLab extension for running LaTeX",
   "keywords": [
     "jupyter",
@@ -44,7 +44,6 @@
     "clean:lib": "rimraf lib tsconfig.tsbuildinfo",
     "clean:labextension": "rimraf jupyterlab-latex/labextension",
     "clean:all": "jlpm clean:lib && jlpm clean:labextension",
-    "precommit": "lint-staged",
     "prettier": "prettier --write '**/*{.ts,.tsx,.js,.jsx,.css,.json,.md}'",
     "install:extension": "jlpm build",
     "watch": "tsc -w"
@@ -66,6 +65,7 @@
     "@jupyterlab/fileeditor": "^4.0.0",
     "@jupyterlab/launcher": "^4.0.0",
     "@jupyterlab/mainmenu": "^4.0.0",
+    "@jupyterlab/notebook": "^4.0.0",
     "@jupyterlab/services": "^7.0.0",
     "@jupyterlab/settingregistry": "^4.0.0",
     "@jupyterlab/statedb": "^4.0.0",
@@ -122,5 +122,10 @@
     },
     "outputDir": "jupyterlab_latex/labextension"
   },
-  "styleModule": "style/index.js"
+  "styleModule": "style/index.js",
+  "husky": {
+    "hooks": {
+      "pre-commit": "lint-staged"
+    }
+  }
 }

sample.tex

@@ -1,57 +1,63 @@
-\documentclass{article}
-\usepackage{graphicx}
-
-\begin{document}
-
-\title{JupyterLab \LaTeX}
-\date{}
-\maketitle
-
-\section{Introduction}
-This is a sample document demonstrating the ability to live-edit
-\LaTeX documents in JupyterLab.
-\\
-\\
-Right-click on this document, and select "Show LaTeX Preview".
-A new panel should open up on the right with the PDF that is generated
-by this document. If there are any errors in the document, an
-error panel should open below.
-\\
-\\
-We can write equations:
-\begin{equation}
-    \rho \left( \frac{\partial \mathbf{u}}{\partial t} + \mathbf{u} \cdot \nabla \mathbf{u} \right) =
-    -\nabla P + \eta \nabla^2 \mathbf{u} + \rho \mathbf{g}.
-\label{eq:Navier–Stokes}
-\end{equation}
-\\
-\\
-And we can write tables:
-\begin{center}
-  \begin{tabular}{ | l | c | r| }
-    \hline
-    1 & 2 & 3 \\ 
-    4 & 5 & 6 \\ 
-    7 & 8 & 9 \\
-    \hline
-  \end{tabular}
-\end{center}
-
-We can reference equations by their numbers, i.e. Equation (\ref{eq:Navier–Stokes}).
-
-\subsection{We can add new subsections}
-And we can include images, such as the Jupyter logo:
-\begin{center}
-  \includegraphics[width=0.65\textwidth]{images/jupyter_logo.png}
-\end{center}
-
-
-
-\pagebreak
-
-
-
-
-You can also use SyncTeX by typing ⌘(CMD)/CTRL+⇧(SHIFT)+X.
-
-\end{document}
+\documentclass{article}
+\usepackage{graphicx}
+
+\begin{document}
+
+\title{JupyterLab \LaTeX}
+\date{}
+\maketitle
+test
+$5_{3_{4} + 4_{3} + 5^{4}}$
+\section{Introduction}
+This is a sample document demonstrating the ability to live-edit
+\LaTeX documents in JupyterLab.
+\\
+Right-click on this document, and select "Show LaTeX Preview".
+A new panel should open up on the right with the PDF that is generated
+by this document. If there are any errors in the document, an
+error panel should open below.
+\\
+Test
+\\
+We can write equations:
+\begin{equation}
+    \rho \left( \frac{\partial \mathbf{u}}{\partial t} + \mathbf{u} \cdot \nabla \mathbf{u} \right) =
+    -\nabla P + \eta \nabla^2 \mathbf{u} + \rho \mathbf{g}.
+\label{eq:Navier–Stokes}
+\end{equation}
+\\
+And we can write tables:
+\begin{center}
+  \begin{tabular}{ | l | c | r| }
+    \hline
+    1 & 2 & 3 \\ 
+    4 & 5 & 6 \\ 
+    7 & 8 & 9 \\
+    \hline
+  \end{tabular}
+\end{center}
+
+
+\centering{Right-click on this document, and select "Show LaTeX Preview". A new panel should open up on the right with the PDF that is generated by this document. If there are any errors in the document, an error panel should open below.}
+
+
+We can reference equations by their numbers, i.e. Equation (\ref{eq:Navier–Stokes}).
+
+Hello
+We can reference equations by their numbers, i.e. Equation (\ref{eq:Navier–Stokes}).
+
+
+\subsection{We can add new subsections}
+And we can include images, such as the Jupyter logo:
+\begin{center}
+  \includegraphics[width=0.65\textwidth]{images/jupyter_logo.png}
+\end{center}
+
+
+
+\pagebreak
+
+
+You can also use SyncTeX by typing ⌘(CMD)/CTRL+⇧(SHIFT)+X.
+
+\end{document}