UX improvements

.gitignore

@@ -10,3 +10,6 @@ lib/
 node_modules/
 npm-debug.log
 test/build/*
+.DS_Store
+workspace.code-workspace
+.DS_Store

README.md

@@ -114,4 +114,94 @@ c.LatexConfig.shell_escape = "allow"
 
 ## Changes
 
+---
+
+# JupyterLab LabTeX
+
+JupyterLab LabTeX is a document generator extension for JupyterLab which allows users to edit and compile LaTeX documents in a more efficient and user-friendly way.
+
+# Release Notes
+
+--- 
+
+## Version 0.4.0 
+
+### New Features 
+
+* Image Formatting GUI: This feature allows the user to format an image (size, placement, captions, etc.) 
+
+* Insert Images GUI: This feature (partially complete) allows the user to upload an image from their PC and insert it directly into the document 
+
+* Insert Plots GUI: This feature allows the user to insert graphs and plots in an intuitive manner 
+
+* Text Layout Customization GUI: This feature allows the user to format a paragraphs layout (alignment for example) 
+
+### Bug Fixes 
+
+N/A 
+
+### Known Issues 
+
+* While the insert images GUI works, it's having trouble getting the real path to an image, and is thus unable to insert an image.
+
+* During autocomplete implementation, a bug was found with either Jupyterlab-LSP or TexLab. We are working with their respective maintainers to resolve the issue. 
+
+--- 
+
+## Version 0.3.0
+
+### New Features
+
+- Bullet Point and Numbered List
+
+- Autocomplete
+
+- Typeface Modifier GUI
+
+### Bug Fixes
+
+N/A
+
+### Known Issues
+
+N/A
+
+## Version 0.2.0
+
+### New Features
+
+- Equation Buttons
+
+- Table Creation GUI
+
+- Preview Button
+
+- Filtered Error Messages
+
+### Bug Fixes
+
+N/A
+
+### Known Issues
+
+- Unicode characters for Symbol/Constant Menu do not display correctly
+
+## Version 0.1.0
+
+### New Features
+
+- Symbol Menu
+
+- Constant Menu
+
+### Bug Fixes
+
+- LaTeX Editor toolbar buttons are now only visible for .TEX files
+
+### Known Issues
+
+N/A
+
+---
+
 For information on the changes with different versions of the `jupyterlab-latex` library, see our [changelog](./docs/changelog.md)

jupyterlab_latex/build.py

@@ -67,7 +67,6 @@ class LatexBuildHandler(APIHandler):
     def initialize(self, notebook_dir):
         self.notebook_dir = notebook_dir
 
-
     def build_tex_cmd_sequence(self, tex_base_name, run_bibtex=False):
         """Builds tuples that will be used to call LaTeX shell commands.
 
@@ -136,6 +135,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 +251,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"