Long equations going over margins

[bwbaker1]

@wrynearson @naomatheus

Description:

Long equations run over the page margins. We need to determine if there is a way to create a line break (only in latex equations) or update user guide to stress that equations need to be as short as possible.

Tasks:

• Determine if there is a way to add a "new line" character in the equation editors.
• Update the user guide to explain how to add new lines to equations. If there is no work around, update the user guide (perhaps add a message within the tool itself) stating that equations must be as short as possible to avoid overrunning equations.
• Update the equation LaTeX Cheatsheet icon to have text when hovered over (see image below). Currently, there is no text.

Acceptance Criteria:

• User guide and tool are updated to reflect how to handle long equations.

Icon within equation editor should have text when hovered over.

[wrynearson]

@bwbaker1 is this a problem only in the PDF generation or also in the frontend?

[bwbaker1]

@wrynearson This occurs in both the PDF and frontend.

[wrynearson]

Currently, in the equation editor, we have a warning that tells users that their equation may be too long to be rendered properly in the PDF (or the view mode).

However, the user isn't prevented from inserting such a long equation, which results in view mode overflow and PDF clipping.

According to Stack Exchange, there are several methods to insert line breaks, but this could be tricky to do automatically. This ticket should be in a later sprint – I moved it to S4.

We should assess whether a technical solution or a user guidance solution is better.

[wrynearson]

@bwbaker1 this is ready for your review

[bwbaker1]

@wrynearson This looks good. I think we can call this done.

cc @deborahUAH

[wrynearson]

This is solved for the Document PDF. This will be implemented on the Journal PDF. This is not implemented on the View mode.