Skip to content

Refines MathML guidelines for improved accuracy and readability#91

Open
MartheGjelstad wants to merge 17 commits intomainfrom
Test-word-release
Open

Refines MathML guidelines for improved accuracy and readability#91
MartheGjelstad wants to merge 17 commits intomainfrom
Test-word-release

Conversation

@MartheGjelstad
Copy link
Contributor

Enhances the clarity and correctness of the Nordic MathML Guidelines document:

  • Updates mathematical examples to consistently use $ delimiters for inline rendering, improving visual presentation.
  • Corrects numerous typos, grammatical errors, and clarifies wording throughout the document.
  • Ensures proper Unicode character usage for mathematical symbols and operators in examples.
  • Fixes various MathML code examples, including missing elements, incorrect spacing, and updated rendering.
  • Standardizes Markdown formatting, such as list markers, blank lines around code blocks, and paragraph spacing.
  • Addresses minor rendering problems, updates image alt texts, and corrects image paths.

GauteR and others added 17 commits March 10, 2026 14:28
Fixed some minor markdown errors
Fixed minor rendering error
Various cleanup of the code to generate a Word document.
- If the guidelines say to markup something with MathML, the example is marked up as math.
- Changed some italic letters to non-italic.
- Changed some unicodes characters
Fixed some typos and alttext
@MartheGjelstad MartheGjelstad self-assigned this Mar 20, 2026
@MartheGjelstad MartheGjelstad requested a review from GauteR March 20, 2026 08:55
Copy link
Member

@GauteR GauteR left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Approved, but could look at the following inconsistency:

The chemistry section says simple formulas can be kept in standard HTML, but the examples were changed to inline math notation. This makes the guideline internally inconsistent and may lead to inconsistent implementation.

Recommendation:
Either revert the examples to HTML notation (CO2, H2O) to match the rule, or update the rule text to explicitly allow/prefer inline math notation in this case.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants