Page MenuHomePhabricator

List requirements for a visual VisualEditor plugin tool to add/edit maths blocks
Open, MediumPublic

Description

Before we start with the actual developments of such a tool we should list the requirements first.

Event Timeline

Physikerwelt claimed this task.
Physikerwelt raised the priority of this task from to Medium.
Physikerwelt updated the task description. (Show Details)

Hey, do you need any support with this?

Is this going to be a new product to the one already there? Are we thinking of a editor for the raw LaTeX or are we looking at some sort of gui like words equation editor? (Most of wiki-project maths are only interested in the former

A few points. It needs to have a big enough edit area to handle some of the bigger mathematical formula. The current widget does not allow resizing so its stuck with a small window which needs scrolling and wraps longer lines.

It needs to be small enough to work nicely with inline expressions which can just be a single variable name.

It needs to not obscure the equation being generated, a bug at one point with the current offering. (A movable window would be nice).

It needs to have a stable position. The current version can jump around a lot as your entering the equation because its trying to avoid obscuring the equation. This happens a lot when your typing in a new equation as every few keystrokes it will cause a latex error, flipping the display from rendered formula to error message.

It needs to distinguish between inline and display equations.

It needs to support the full syntax described in Help:Formula.

Is this going to be a new product to the one already there?

I think the plan is to extend/replace the existing editor with a 'rich editor' mode.

Are we thinking of a editor for the raw LaTeX or are we looking at some sort of gui like words equation editor?

The latter.

(Most of wiki-project maths are only interested in the former

True, but they aren't the only audiences for editing tools for formulæ.

A few points. It needs to have a big enough edit area to handle some of the bigger mathematical formula. The current widget does not allow resizing so its stuck with a small window which needs scrolling and wraps longer lines.

Agreed.

It needs to be small enough to work nicely with inline expressions which can just be a single variable name.

Yeah; maybe it should be resizable?

It needs to not obscure the equation being generated, a bug at one point with the current offering.

That sounds like a bug you should file; it works fine for me.

(A movable window would be nice).

Maybe, but epic and unlikely to be worth doing just for this.

It needs to have a stable position. The current version can jump around a lot as your entering the equation because its trying to avoid obscuring the equation.

I don't think it'd be tenable to have an inspector editor for this if we want a proper rich editor with drag-and-drop integral blocks and so on, but yes, something to be wary of irritating users.

This happens a lot when your typing in a new equation as every few keystrokes it will cause a latex error, flipping the display from rendered formula to error message.

Keep typing and it won't be an issue. ;-) However, more seriously, this won't be a LaTeX editor so that particular facet won't be an issue.

It needs to distinguish between inline and display equations.

Yes, and also the new "indented" mode, if that's happening.

It needs to support the full syntax described in Help:Formula.

https://www.mediawiki.org/wiki/Help:Formula is empty. I worry that you forget this is for all MediaWiki installations. ;-) https://en.wikipedia.org/wiki/Help:Displaying_a_formula is informative, though, thanks.

Are we thinking of a editor for the raw LaTeX or are we looking at some sort of gui like words equation editor?

The latter.

If so the ability to edit the LaTaX in VE is an essential requirement, either in this plugin or some other plugin is essential. This is necessary not just the existing maths editors who probably wont switch to VE anway.

LaTeX is the defacto standard in all mathematics journals you also see it a lot in Physics, and computer science, I'm not sure about chemistry, biology and other sciences. This means a lot of new editors in science articles will already be familiar with LaTeX and will want some means to input that.