Skip to content
This repository has been archived by the owner on Dec 23, 2019. It is now read-only.

Incorporating mathematical formatting in RFC XML output #27

Closed
opoudjis opened this issue Oct 3, 2017 · 8 comments
Closed

Incorporating mathematical formatting in RFC XML output #27

opoudjis opened this issue Oct 3, 2017 · 8 comments
Assignees

Comments

@opoudjis
Copy link
Contributor

opoudjis commented Oct 3, 2017

There's lots of mathematical formatting in MMark, delimited with $$, which I'm putting into Asciidoctor with the math[] macro. Maths is not natively supported by RFC XML. Should we presuppose an external XML schema for these, or leave them unrendered?

At a minimum, I could render it as italics, although I would have to selectively italicise only the letters and not the numbers or symbols in any such expression.

@ronaldtse
Copy link
Contributor

I don't think the MMark math blocks are rendered specially, they seem to be just passed through as centered code blocks. We just need a nice way of representing them.

@ronaldtse
Copy link
Contributor

For now I guess it would make most sense if we just <em> the math blocks. I don't think XMLRFC will support Math anytime soon. We should apply the same formatting for inline math as well as block math syntax.

@opoudjis
Copy link
Contributor Author

opoudjis commented Oct 4, 2017

OK; just be aware that <em> will end up italicising numbers as well as letters in the Math markup, which is not strictly speaking correct. (But partially italicising numbers and not letters is even worse.)

@opoudjis opoudjis self-assigned this Oct 4, 2017
@ronaldtse
Copy link
Contributor

Ah ha, got it. Let's do it your way @opoudjis

@opoudjis
Copy link
Contributor Author

opoudjis commented Oct 6, 2017

... What was my way? :-) I think it's leaving them alone. It does look ugly, admittedly.

The real way of doing these is to embed them in an appropriate external schema, which a downstream processor can pay attention to or ignore. But whether that makes any sense to do at all is a matter of what IETF have in place!

The native ASCIIdoc way of doing things looks like it's ASCIIMathML (http://www1.chapman.edu/~jipsen/mathml/asciimathsyntax.html), which a processor converts to MathML—and we could do the same, but only if that's going to be useful downstream.

@ronaldtse, at the moment I'm leaving these alone then, but let me know if there would be any appetite over at IETF for dealing with MathML.

@ronaldtse
Copy link
Contributor

Since the RFC XML schema doesn't specify specific support for Math, we probably shouldn't mess with that right now.

But it might be a good idea to have that option later to convert math to MathML output within XML (https://github.com/asciidoctor/asciidoctor-mathematical)

@opoudjis
Copy link
Contributor Author

This issue does not need to be acted on in a hurry, since IETF does not say anything about Mathematical formatting yet; but I am already converting AsciiML to MathML for the asciidoctor-iso gem.

@opoudjis
Copy link
Contributor Author

Closing this for now, since no indication that IETF can deal with math formatting; if they ask for this, we reactivate this (and it will be a straightforward task).

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants