{"id":1945,"date":"2012-11-08T10:41:38","date_gmt":"2012-11-08T18:41:38","guid":{"rendered":"https:\/\/www.phoenixtechpubs.com\/blog\/?p=1945"},"modified":"2012-11-12T09:37:56","modified_gmt":"2012-11-12T17:37:56","slug":"editing-equations-in-oxygen-xml-editor","status":"publish","type":"post","link":"https:\/\/www.phoenixtechpubs.com\/blog\/index.php\/2012\/11\/editing-equations-in-oxygen-xml-editor\/","title":{"rendered":"Editing Equations in Oxygen XML Editor"},"content":{"rendered":"

Editing equations in Oxygen XML Editor version 14.0 was more difficult than we expected. After trying several of the leading MathML editors, we found a versatile, easy-to-use, inexpensive solution.<\/p>\n

Oxygen XML Fragment Editor<\/span><\/p>\n

The Help Pages of Oxygen XML Editor<\/a> version 14.0 have this to say about its support for equations:<\/span><\/p>\n

\u201c\u2026 includes a built-in editor for MathML<\/dfn> notations. To start the MathML<\/dfn> editor either double click a MathML<\/dfn> notation or select the Edit Equation action from its contextual menu. In the MathML<\/dfn> editor you are able to edit the mathematical symbols of a MathML<\/dfn> notation.\u201d<\/span><\/p>\n

Either action opens the XML Fragment Editor window. A few problems with using this tool will surprise the user:<\/span><\/p>\n

    \n
  1. WYSIWYG tools for entering new equations are not available.<\/span><\/li>\n<\/ol>\n

    MathML is not intended to be written or edited directly; an important reason all XML editors include a wysiwyg editing mode for MathML. This mode in Oxygen is called Authoring<\/em> and is selected using the Author<\/strong> tab. While in Authoring<\/em> mode, an equation is inserted by selecting Dita<\/strong>->Insert<\/strong>-> Insert<\/strong> Equation<\/strong> from the contextual menu. This action opens the XML Fragment Editor<\/strong> window with the Pythagorean equation as its default. The MathML code that implements this equation is displayed directly below the equation (see the example below). Note that there are no controls or menus in the window for rewriting the equation.<\/span><\/p>\n

    \"\"<\/span><\/a><\/span><\/p>\n

    2. It is difficult, if not impractical, to edit equations using its wysiwyg feature.<\/span><\/p>\n

    The red box enclosing the equation is the only hint of possible wysiwyg editing capability. You can point-and-click on a component of this equation so the red box surrounds it and then make a simple change in code below it. For example, you can select each \u201csquared\u201d term and change it to \u201ccubed\u201d. Or you can change the \u201c+\u201d to \u201c-“. But you cannot insert complex operators.<\/span><\/p>\n

    3. Although the bottom half of the window allows editing an equation via its MathML code, the code quickly becomes intractable as expressions become more complex.<\/span><\/p>\n

    The MathML displayed in the XML Fragment Editor<\/strong> window is the same non-wysiwyg view as would be seen if you had selected the Text<\/strong> tab. The user could, in theory, enter a new equation by making changes to the default equation in Text<\/em> mode. But, as has been said, MathML is not intended to be written or edited directly. The complexity of the code just for the default equation makes this apparent. Also, you can also see the difficulty of locating components to make even simple edits in an existing complex equation that someone else has entered into the document, as shown\u00a0 in the screen capture below.<\/span><\/p>\n

    \"\"<\/span><\/a><\/span><\/p>\n

    Because we found the Oxygen XML Fragment Editor impractical for editing MathML, we researched other MathML editing options.<\/span><\/p>\n

    MathFlow<\/span><\/p>\n

    The makers of Oxygen XML Editor recommend the MathFlow<\/em><\/a> plugin from Design Science for a fully functional MathML authoring tool.\u00a0 The interface is easy to use and familiar to anyone who has entered equations in MSWord. However, the MathFlow plugin was incompatible with our client’s specialized build routine to output pdf and html failed, making the tool unusable for us.<\/span><\/p>\n

    Web Equation
    \n<\/span><\/p>\n

    At the Web Equation<\/em> web-site (http:\/\/webdemo.visionobjects.com\/equation.html?locale=default<\/a>), an equation can be moused onto a grid, like drawing onto legal pad (see below). A print-quality image of the equation is rendered below the grid, to confirm the moused input. The MathML code is displayed by clicking on the MathML<\/strong> tab. This code can then be copied from the web-site and pasted directly into the XML document while in Text<\/em> mode. Or it can be pasted into the document while in Authoring<\/em> mode via the XML Fragment Editor<\/strong> window. However, with either method, our XML schema requires \u201cm:\u201d prefixes that are missing from the code supplied by Web Equation<\/em>. For example, <mrow> and <\/mrow> tags should be <m:mrow> and <\/m:mrow>. To solve this problem as efficiently as possible, we copied the code into Notepad, used Notepad\u2019s Find\/Replace function to replace all instances of <m and <\/m with <m:m and <\/m:m, then copied-pasted this result into the XML document.<\/span><\/p>\n

    \"\"<\/span><\/a><\/span><\/p>\n

    We found Web<\/em> Equation<\/em> to be of limited use, not just because of the extra step needed to add element prefixes, but also because many attempts were needed before the rendered equation was correct.<\/span><\/p>\n

    Mathematics StackExchange<\/span><\/p>\n

    Mathematics StackExchange<\/em><\/a> is a mathematics question and answer website (http:\/\/math.stackexchange.com\/search?q=serial+summation). We searched and found summation equations similar to what we wanted. The MathML code for any equation at that website can be displayed by right-clicking the equation. Then the code is entered into the XML document using the same steps as described for Web Equation<\/em>. Of course, because it is unlikely that any of the equations available at Mathematics StackExchange<\/em> will be an exact match to what is needed, editing is generally required, which is a non-trivial effort using either Notepad or the Oxygen editor.<\/span><\/p>\n

    \"\"<\/span><\/a><\/span><\/p>\n

    MathType<\/span><\/p>\n

    MathType<\/em><\/a>, also from Design Science, has the same user-friendly interface as MathFlow<\/em> and its MathML coding includes compatible namespace prefixes. The user enters the equation using a complete set of mathematic operators and templates displayed at the top of the MathType<\/strong> window, then only has to copy the equation rendered in the window and paste directly into the XML document. Our build routine worked perfectly. We chose MathType<\/em>\u00a0 as our primary MathML editor because it provides all the functionality we need and, because it is not a plugin, doesn’t break the Oxygen editor.
    \n<\/span><\/p>\n

    \"\"<\/span><\/a><\/span><\/p>\n

    \u00a0<\/address>\n
    \u00a0<\/address>\n
    Grandy is a senior technical writer at Phoenix Technical Publications. Phoenix Tech Pubs has provided complete technical writing and documentation services in Oakland and the San Francisco Bay Area for over 25 years.<\/span><\/address>\n

    \u00a0<\/span><\/p>\n

    \u00a0<\/span><\/p>\n","protected":false},"excerpt":{"rendered":"

    Editing equations in Oxygen XML Editor version 14.0 was more difficult than we expected. After trying several of the leading MathML editors, we found a versatile, easy-to-use, inexpensive solution. Oxygen XML Fragment Editor The Help Pages of Oxygen XML Editor version 14.0 have this to say about its support for equations: \u201c\u2026 includes a built-in … Continue reading Editing Equations in Oxygen XML Editor<\/span> →<\/span><\/a><\/p>\n","protected":false},"author":8,"featured_media":0,"comment_status":"closed","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[67,159],"tags":[156,189,190,191,155,192],"class_list":["post-1945","post","type-post","status-publish","format-standard","hentry","category-grandys-blogs","category-technical-writing-and-documentation","tag-dita","tag-mathml","tag-oxygen","tag-oxygen-xml-editor","tag-xml","tag-xml-editor"],"_links":{"self":[{"href":"https:\/\/www.phoenixtechpubs.com\/blog\/index.php\/wp-json\/wp\/v2\/posts\/1945","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/www.phoenixtechpubs.com\/blog\/index.php\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/www.phoenixtechpubs.com\/blog\/index.php\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/www.phoenixtechpubs.com\/blog\/index.php\/wp-json\/wp\/v2\/users\/8"}],"replies":[{"embeddable":true,"href":"https:\/\/www.phoenixtechpubs.com\/blog\/index.php\/wp-json\/wp\/v2\/comments?post=1945"}],"version-history":[{"count":38,"href":"https:\/\/www.phoenixtechpubs.com\/blog\/index.php\/wp-json\/wp\/v2\/posts\/1945\/revisions"}],"predecessor-version":[{"id":2028,"href":"https:\/\/www.phoenixtechpubs.com\/blog\/index.php\/wp-json\/wp\/v2\/posts\/1945\/revisions\/2028"}],"wp:attachment":[{"href":"https:\/\/www.phoenixtechpubs.com\/blog\/index.php\/wp-json\/wp\/v2\/media?parent=1945"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/www.phoenixtechpubs.com\/blog\/index.php\/wp-json\/wp\/v2\/categories?post=1945"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/www.phoenixtechpubs.com\/blog\/index.php\/wp-json\/wp\/v2\/tags?post=1945"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}