1 Compilation issues

While we seek to support as much of LaTeX as possible, there are features that are either not implemented, difficult to implement, or impossible to implement.

If the SERVE fails and you are working in a codespace, then you can use xake directly to debug your code. You can use pdflatex to compile and use

pdflatex FILE-NAME.tex
xake -v compile FILE-NAME.tex
more FILE-NAME.tex.log

If you find a file that does not compile, you can try to compile the file directly while slowly moving \end{document} down through the document. By starting at the top, the file should compile, and then you should be able to locate the exact location of the bug.

If a LaTeX package is unsupported and you need to use it, you can modify xmScripts/config.txt, note this is subject to change

 # version of Ximera xake container to use (with xmlatex)
 #
 # : "${XAKE_VERSION:=v2.4.2-full}"   # with texlive_full

by removing the # in front of the container ending in “full.” Note, this is a large container, and hence is not shipped by default. If you want to also deploy from a codespace, you will also need to, again, subject to change

image: ghcr.io/ximeraproject/xake2024:v2.4.2
# image: ghcr.io/ximeraproject/xake2024:v2.4.2-full

By commenting, adding a # to, the beginning of the first line and removing # from the second.

If codespace is not acting correctly, you can always “Delete” it, and make a new one.

Files in xmScripts/ must be executable. If there is an issue with permissions, open the codespace and run

chmod +x ~/xmScripts/xmlatex*

In a codespace (or inside a Docker container), pdflatex and xake (Ximera’s make program) are available and the xmlatex script is in your PATH. This means that the following commands are available to the user:

xmlatex compilePdf <path-to-your-texfile>
xmlatex compile <path-to-your-texfile>
xmlatex bake
xmlatex serve
xmlatex updateDevEnv

The final command will update your authoring environment to our most recent release.

2 Online issues

Sometimes there is strange behavior online. If this happens, start by visiting the offending URL in a private browser. If the content looks good in a private browser, than the issue is due to cookies or browser settings.

An svg-viewer missing error message means that there was a compilation error that confused Xake. The offending file needs to be recompiled. Make a trivial change in the file, and delete all SVG files in the directory.

Sometimes Ximera materials look good to instructors and others, but not to some individual students.

Ximera refreshes the page when submitting can be caused by several issues, each with a different solution:

Problem:

Poor internet connection

Solution:

Refresh the page immediately before entering each answer.

Problem:

Browser settings

Solution:

Try using a different browser. Different students have reported luck with different browsers, including Edge, Firefox, and Chrome.

Problem:

Antivirus Software

Solution:

Some antivirus software (such as McAfee) are now blocking websockets, a technology Ximera relies on. Try turning off the websockets setting on the antivirus software.

Problem:

VPN

Solution:

If you are using a VPN, try turning it off before using Ximera.

unknown node type: parser error message. This sometimes appears rather than the actual rendered mathematics. This is due to a corruption in the cookies/cache for the browser, and the person seeing this error need to clear their cache and then reload the page to resolve the problem.

Difficulty accessing Ximera is often caused by browser settings. The easiest solution is usually to try using a different browser. Students seem to have the best luck with Chrome, Firefox, or Safari.

Math processing error This is caused by an error in the browser setting. Two things to try:

First possible solution: Clear browser cookies. Close the browser. Open the browser and log in to the LMS (if applicable). Go to the assignment.

Second possible solution: Find one of the pages this is happening, Put your mouse over the ‘math processing error’ Now, ‘right-click’ and select ‘accessibility’ If collapsible math is checked, uncheck it. Reload the page.