Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
143 commits
Select commit Hold shift + click to select a range
71d2c0b
Created markdown file
AndersEkl May 8, 2024
07e48c8
Updated disposition of guidelines document
AndersEkl May 14, 2024
3770435
Translated comments to English
AndersEkl May 14, 2024
9cd7d8a
Introduction added
AndersEkl Aug 26, 2024
65d47da
add invisible operators
samimaattaCelia Sep 2, 2024
99f69a8
start drafting about alt-attributes
samimaattaCelia Sep 2, 2024
a4190d9
When to use MathML
AndersEkl Sep 3, 2024
6ba2240
Merge branch '2024-1' of https://github.com/nlbdev/mathml-guidelines …
AndersEkl Sep 3, 2024
e4ca3c8
Add instruction for `alttext` use
samimaattaCelia Sep 4, 2024
6380cec
Add content about `altimg`
samimaattaCelia Sep 4, 2024
36c6b05
Fix grammar
samimaattaCelia Sep 4, 2024
bc9fdd5
Write draft for section `<mn>`
samimaattaCelia Sep 4, 2024
8e496ee
Draft the `mo` section
samimaattaCelia Sep 4, 2024
3ef9f9f
Add note on how the context affects different chatacters
samimaattaCelia Sep 4, 2024
8b43bbd
Fix grammar
samimaattaCelia Sep 4, 2024
6e01101
Fix grammar
samimaattaCelia Sep 4, 2024
6d9c3f5
Draft for "Tabular math"
samimaattaCelia Sep 4, 2024
ba7a31f
Draft for tables in MathML
samimaattaCelia Sep 4, 2024
3fd8ac2
Draft about matrices
samimaattaCelia Sep 4, 2024
3a217a4
Draft content for `<mi>` section
samimaattaCelia Sep 4, 2024
761bb7c
Add context for heading
samimaattaCelia Sep 4, 2024
cbb6584
Fix incorrect markup
samimaattaCelia Sep 4, 2024
aec9c35
Add that ellipsis is also an identifier
samimaattaCelia Sep 4, 2024
a708ea4
Parts that Sami writes
samimaattaCelia Sep 9, 2024
5011385
Added to Introduction
AndersEkl Sep 9, 2024
7c58999
Merge branch '2024-1' of https://github.com/nlbdev/mathml-guidelines …
AndersEkl Sep 9, 2024
b649dd9
Add examples for HTML tables
samimaattaCelia Sep 9, 2024
857396f
Merge branch '2024-1' of https://github.com/nlbdev/mathml-guidelines …
samimaattaCelia Sep 9, 2024
6198b6b
Note about chemistry
AndersEkl Sep 10, 2024
f12f366
Add content to `<mrow>`
samimaattaCelia Sep 23, 2024
c6e4f82
add example to the `<mrow>`
samimaattaCelia Sep 23, 2024
aab348d
add images of determinants
samimaattaCelia Sep 23, 2024
3482983
Rename sections on tabular math and add content
samimaattaCelia Sep 23, 2024
c12658d
Add piecewise function as an example
samimaattaCelia Sep 23, 2024
041fbb4
Add text about the piecewise function
samimaattaCelia Sep 23, 2024
46b0f70
fix typo
samimaattaCelia Sep 23, 2024
b5d091e
add example mark up of pair of equations
samimaattaCelia Sep 23, 2024
f4062a3
Add text about systems of equations and equation solving
samimaattaCelia Sep 23, 2024
14650eb
fix a typo
samimaattaCelia Sep 23, 2024
21ce46d
fix typo
samimaattaCelia Sep 24, 2024
4075c56
add rowspan and columnspan
samimaattaCelia Sep 24, 2024
c036eaf
reduce heading level
samimaattaCelia Sep 24, 2024
fd007a8
add html attribute to codeblock
samimaattaCelia Oct 14, 2024
cebf39e
change heading
samimaattaCelia Oct 14, 2024
ba72ff2
remove (Sami)
samimaattaCelia Oct 14, 2024
c28f1a4
fix typo
samimaattaCelia Oct 14, 2024
457994f
write about accents
samimaattaCelia Oct 14, 2024
f20e9c3
Update Nordic MathML Guidelines 2024-1.md
TimArborealis Oct 31, 2024
82cf336
Update Nordic MathML Guidelines 2024-1.md
TimArborealis Nov 1, 2024
9f9f158
Update Nordic MathML Guidelines 2024-1.md
TimArborealis Nov 19, 2024
ab64635
Update Nordic MathML Guidelines 2024-1.md
TimArborealis Nov 22, 2024
49a7d56
Prescripts & postscripts
TimArborealis Nov 25, 2024
fb47cec
Continued on MathML fundamentals
TimArborealis Nov 26, 2024
d2de133
namespace declaration
TimArborealis Nov 27, 2024
d18cfc6
MathML fundamentals and Chemistry
TimArborealis Nov 28, 2024
4909e8a
Update Nordic MathML Guidelines 2024-1.md
AndersEkl Dec 3, 2024
8fa4c79
typo
samimaattaCelia Dec 13, 2024
1636d89
write about large operators
samimaattaCelia Dec 13, 2024
cf3c913
remove blockquotes
samimaattaCelia Dec 13, 2024
f3c8e7b
Move text into better position
samimaattaCelia Dec 16, 2024
22ccf9c
Update Nordic MathML Guidelines 2024-1.md
AndersEkl Dec 18, 2024
515ae67
write section on `<mtext>`
samimaattaCelia Dec 19, 2024
45f9c37
Update Nordic MathML Guidelines 2024-1.md
AndersEkl Dec 19, 2024
8938bb2
Write section on labeling and referencing equations
samimaattaCelia Dec 20, 2024
bcf72c4
add `<mspace>` to section heading
samimaattaCelia Dec 20, 2024
3be4dee
fix heading level
samimaattaCelia Dec 20, 2024
422532d
New section on when to use images of mathematical content
samimaattaCelia Dec 20, 2024
eca525b
open question about spacing
samimaattaCelia Dec 20, 2024
288c6b8
open questions for images
samimaattaCelia Dec 20, 2024
0327785
use wrapper for the block math content
samimaattaCelia Dec 20, 2024
f1e3f13
Refine the markup on labeling
samimaattaCelia Dec 20, 2024
2f819db
fix self-closing tag
samimaattaCelia Dec 20, 2024
767b3d3
Update Nordic MathML Guidelines 2024-1.md
AndersEkl Dec 20, 2024
eef9758
Merge branch '2024-1' of https://github.com/nlbdev/mathml-guidelines …
AndersEkl Dec 20, 2024
490d615
Update Nordic MathML Guidelines 2024-1.md
AndersEkl Dec 20, 2024
9857690
Update Nordic MathML Guidelines 2024-1.md
AndersEkl Dec 20, 2024
ca6fe46
Write section on `<mfrac>`
samimaattaCelia Dec 31, 2024
8922287
update `<mrow>` heading
samimaattaCelia Dec 31, 2024
291b866
Clarify that `alttext` and `altimg` are not to be used
samimaattaCelia Dec 31, 2024
02e39d8
Reference to EPUB guidelines
samimaattaCelia Jan 13, 2025
72358c3
Update Nordic MathML Guidelines 2024-1.md
AndersEkl Jan 13, 2025
707d1db
Update Nordic MathML Guidelines 2024-1.md
TimArborealis Jan 14, 2025
21d2323
Update Nordic MathML Guidelines 2024-1.md
AndersEkl Jan 15, 2025
1e67dd8
Adding section about annotations
AndersEkl Jan 15, 2025
c1098e4
Whitespace in <mtext>
TimArborealis Jan 17, 2025
69f2ba7
add to the section on <mi> about units
samimaattaCelia Jan 21, 2025
76104d6
mark up for punctuation
samimaattaCelia Jan 23, 2025
e204fdf
use doc-backlink for references
samimaattaCelia Jan 23, 2025
a137e80
remove indentation
samimaattaCelia Feb 19, 2025
e98a046
remove github lingo
samimaattaCelia Feb 19, 2025
637800f
Special markup for Finnish notation
samimaattaCelia Feb 19, 2025
871287f
Write section on footnotes inside math expressions
samimaattaCelia Feb 19, 2025
32f0934
Fix typos
samimaattaCelia Feb 20, 2025
7d29ac9
simplify equation referencing
samimaattaCelia Feb 20, 2025
5f43938
don't use anchor links inside math elements
samimaattaCelia Feb 20, 2025
28e9312
removed mentions of <mrow> for correct rendering
samimaattaCelia Feb 24, 2025
8d780ee
use mathML to display
samimaattaCelia Feb 24, 2025
8fb8a6e
add `<math>` elements
samimaattaCelia Feb 24, 2025
f7fab53
remove `<mrow>`s
samimaattaCelia Feb 24, 2025
d500cf4
remove `<mrow>s`
samimaattaCelia Feb 24, 2025
1328009
add special characters based on Marthe's suggestions
samimaattaCelia Feb 24, 2025
8af97ae
Update Nordic MathML Guidelines 2024-1.md
eliseaas Feb 26, 2025
cb5737b
Alignment section
TimArborealis Mar 3, 2025
1ac1d45
add section about <msqrt> and <mroot>
samimaattaCelia Mar 4, 2025
36537c6
Write section on <mpadded> and <mspace>
samimaattaCelia Mar 4, 2025
ba516d8
Fill in blanks
TimArborealis Mar 6, 2025
54ca6e2
Handwritten stuff
TimArborealis Mar 6, 2025
96b9b9f
Update Nordic MathML Guidelines 2024-1.md
Mar 6, 2025
74f31d6
change how the code example is written
samimaattaCelia Mar 17, 2025
0bb3923
clarify "block" attribute usage
samimaattaCelia Mar 17, 2025
7ad777d
Delete image.png
samimaattaCelia Mar 17, 2025
fb534a0
write about nested munder
samimaattaCelia Mar 17, 2025
849a31d
Update Nordic MathML Guidelines 2024-1.md
AndersEkl Mar 18, 2025
9e72dbd
Add example about footnotes
samimaattaCelia Mar 18, 2025
945b472
Merge branch '2024-1' of https://github.com/nlbdev/mathml-guidelines …
samimaattaCelia Mar 18, 2025
f3a3517
add a new line
samimaattaCelia Mar 18, 2025
4629d16
fix typos in HTML comments
samimaattaCelia Mar 19, 2025
d31a303
Added attribute for units.
MartheGjelstad Mar 25, 2025
c431888
rewrite section on labeled equations
samimaattaCelia Mar 31, 2025
41bde70
add section on crossed out math
samimaattaCelia Apr 2, 2025
74cbb3b
remove ID thing
samimaattaCelia Apr 2, 2025
3c222ed
Added description for percent.
MartheGjelstad Apr 2, 2025
7dedeab
Minor corrections
TimArborealis Apr 2, 2025
ef128c8
Rewrote the section "When to use MathML"
MartheGjelstad Apr 3, 2025
8cc1142
Remove aria-labelledby from labeled equations
samimaattaCelia Apr 3, 2025
56d4d09
fix grammar
samimaattaCelia Apr 3, 2025
4cae448
Merge branch '2024-1' of https://github.com/nlbdev/mathml-guidelines …
samimaattaCelia Apr 3, 2025
41942b6
Update Nordic MathML Guidelines 2024-1.md
Apr 4, 2025
d836958
Edited the section about footnotes.
AndersEkl Apr 4, 2025
cc40568
Wrote section about units
AndersEkl Apr 4, 2025
bd96897
Update Nordic MathML Guidelines 2024-1.md
TimArborealis May 19, 2025
ce362f9
Updated link to Kvalidator
TimArborealis May 19, 2025
8d399c0
Update readme
MartheGjelstad Jun 24, 2025
14ade70
fix mmultiscripts markup
samimaattaCelia Jul 3, 2025
29f2279
Update GitHub Actions workflows for LaTeX build and add Markdown linting
GauteR Jul 29, 2025
e42e038
Add new issue templates for bug reports, feature requests, guideline …
GauteR Jul 29, 2025
8413d68
Fix file structure and some links in document
GauteR Jul 29, 2025
85d4444
Refine README.md for MathML guidelines by improving clarity and forma…
GauteR Jul 29, 2025
2df71d0
Assign MartheGjelstad as the assignee for the Guideline Problem Repor…
GauteR Jul 29, 2025
d7a5ebc
Rename guideline file to not include version information
GauteR Jul 29, 2025
8a19aa4
Add build workflow for deploying the guidelines to GitHub Pages
GauteR Jul 29, 2025
551f8b8
Merge pull request #59 from nlbdev/pr-1
GauteR Jul 30, 2025
669d05c
Add .gitignore for Jekyll build artifacts and OS-generated files; upd…
GauteR Jul 30, 2025
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 35 additions & 0 deletions .github/ISSUE_TEMPLATE/bug-report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
---
name: Bug Report
about: Report a bug or technical issue
title: '[BUG] '
labels: ['bug', 'needs-review']
assignees: []
---

## Bug Description
<!-- A clear and concise description of what the bug is -->

## Steps to Reproduce

1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error

## Expected Behavior
<!-- A clear and concise description of what you expected to happen -->

## Actual Behavior
<!-- A clear and concise description of what actually happened -->

## Screenshots
<!-- If applicable, add screenshots to help explain your problem -->

## Environment

- **Document Type**: [e.g., LaTeX, Markdown, PDF]
- **Section**: [e.g., Guidelines, Examples, Build Process]
- **Browser/Reader**: [if applicable]

## Additional Context
<!-- Add any other context about the problem here -->
28 changes: 28 additions & 0 deletions .github/ISSUE_TEMPLATE/example-request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
---
name: Example Request
about: Request a new example or clarification for the MathML guidelines
title: '[EXAMPLE] '
labels: ['documentation', 'needs-review']
assignees: []
---

## Mathematical Expression
<!-- Describe the mathematical expression that needs an example -->

## Context
<!-- Provide context about where this expression appears (e.g., algebra, calculus, physics) -->

## Current Difficulty
<!-- What is unclear or missing about how to mark this up? -->

## Desired Example
<!-- What kind of example would be most helpful? -->

## Related Guidelines
<!-- Which existing guidelines are related to this request? -->

## Use Case Frequency
<!-- How common is this type of expression in educational materials? -->

## Additional Context
<!-- Any other information that would help create a good example -->
31 changes: 31 additions & 0 deletions .github/ISSUE_TEMPLATE/feature-request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
---
name: Feature Request
about: Suggest a new feature or improvement for the MathML guidelines
title: '[FEATURE] '
labels: ['enhancement', 'needs-review']
assignees: []
---

## Problem Statement
<!-- A clear and concise description of what problem this feature would solve -->

## Proposed Solution
<!-- A clear and concise description of what you want to happen -->

## Alternative Solutions
<!-- A clear and concise description of any alternative solutions you've considered -->

## Use Cases
<!-- Describe specific scenarios where this feature would be useful -->

## Impact on Suppliers
<!-- How will this affect the Indian suppliers and other stakeholders? -->

## Implementation Considerations
<!-- Any technical or practical considerations for implementing this feature -->

## Examples
<!-- If applicable, provide examples of how this would work -->

## Additional Context
<!-- Add any other context or screenshots about the feature request here -->
25 changes: 25 additions & 0 deletions .github/ISSUE_TEMPLATE/guideline-problem.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
---
name: Guideline Problem Report
about: Report a problem or suggest changes to the MathML guidelines
title: '[GUIDELINE] '
labels: ['guideline', 'needs-review']
assignees: ['MartheGjelstad']
---

## Problem Description
<!-- Describe the problem or suggested change to the guidelines -->

## Affected Section
<!-- Which section of the guidelines is affected? -->

## Current Guideline Text
<!-- Copy the current guideline text that needs to be changed -->

## Proposed Solution
<!-- Describe your proposed solution or change -->

## Impact Assessment
<!-- How will this change affect suppliers and users? -->

## Additional Context
<!-- Any additional information that might be helpful -->
16 changes: 0 additions & 16 deletions .github/ISSUE_TEMPLATE/suggestion.md

This file was deleted.

42 changes: 42 additions & 0 deletions .github/ISSUE_TEMPLATE/supplier-feedback.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
---
name: Supplier Feedback
about: Feedback from suppliers about the MathML guidelines implementation
title: '[SUPPLIER] '
labels: ['supplier-feedback', 'needs-review']
assignees: []
---

## Supplier Information

- **Supplier Name**:
- **Project/Book**:
- **Date**:

## Feedback Type

- [ ] Implementation difficulty
- [ ] Unclear guidelines
- [ ] Missing examples
- [ ] Technical issue
- [ ] Other

## Specific Issue
<!-- Describe the specific issue or feedback -->

## Guidelines Section
<!-- Which section of the guidelines is this related to? -->

## Current Implementation
<!-- How are you currently handling this? -->

## Suggested Improvement
<!-- What would make this easier or clearer? -->

## Impact on Production
<!-- How does this affect your production timeline or quality? -->

## Examples
<!-- If applicable, provide examples of the problematic markup -->

## Additional Context
<!-- Any other relevant information -->
62 changes: 62 additions & 0 deletions .github/workflows/deploy-guidelines.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
name: Deploy Nordic MathML Guidelines to GitHub Pages

on:
push:
branches: [ main ]
pull_request:
branches: [ main ]
workflow_dispatch:

permissions:
contents: read
pages: write
id-token: write

concurrency:
group: "pages"
cancel-in-progress: false

jobs:
build:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4

- name: Setup Pages
uses: actions/configure-pages@v4

- name: Setup Ruby
uses: ruby/setup-ruby@v1
with:
ruby-version: '3.2'
bundler-cache: true

- name: Install Jekyll
run: |
gem install jekyll
gem install jekyll-seo-tag
gem install jekyll-sitemap

- name: Convert Guidelines Markdown to Jekyll Page
run: |
bash scripts/convert-guidelines.sh

- name: Build with Jekyll
run: |
jekyll build --baseurl ""
env:
JEKYLL_ENV: production

- name: Upload artifact
uses: actions/upload-pages-artifact@v3
with:
path: ./_site

deploy:
runs-on: ubuntu-latest
needs: build
if: github.ref == 'refs/heads/main'
steps:
- name: Deploy to GitHub Pages
uses: actions/deploy-pages@v4
20 changes: 0 additions & 20 deletions .github/workflows/main.yml

This file was deleted.

26 changes: 26 additions & 0 deletions .github/workflows/markdown-lint.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
name: Markdown Linting
on: [push, pull_request]

jobs:
lint:
runs-on: ubuntu-latest
steps:
- name: Checkout code
uses: actions/checkout@v4

- name: Setup Node.js
uses: actions/setup-node@v4
with:
node-version: '18'

- name: Install markdownlint
run: npm install -g markdownlint-cli

- name: Lint Markdown files
run: |
markdownlint "Guidelines/**/*.md" --config .markdownlint.json || true

- name: Check for broken links
run: |
npm install -g markdown-link-check
find Guidelines -name "*.md" -exec markdown-link-check {} \; || true
17 changes: 17 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# Generated Jekyll pages
_pages/guidelines.md

# Jekyll build output
_site/
.sass-cache/
.jekyll-cache/
.jekyll-metadata

# OS generated files
.DS_Store
.DS_Store?
._*
.Spotlight-V100
.Trashes
ehthumbs.db
Thumbs.db
Loading