New package: UnicodeMath v0.0.1

[JuliaRegistrator]

• Registering package: UnicodeMath
• Repository: https://github.com/manuelbb-upb/UnicodeMath.jl
• Created by: @manuelbb-upb
• Version: v0.0.1
• Commit: 6be3630dedb88b588a1b86a2abdd40bba2d31a9c
• Reviewed by: @manuelbb-upb
• Reference: manuelbb-upb/UnicodeMath.jl@6be3630#commitcomment-166501226
• Description: Unicode glyph mapping inspired by LaTeX package unicode-math
• Release notes:

## Initial Release

- First registered version (`0.0.1`) of `UnicodeMath` package.
- No exports, provides `apply_style`, `_sym` and other `sym` functions.

[github-actions]

Hello, I am an automated registration bot. I help manage the registration process by checking your registration against a set of AutoMerge guidelines. If all these guidelines are met, this pull request will be merged automatically, completing your registration. It is strongly recommended to follow the guidelines, since otherwise the pull request needs to be manually reviewed and merged by a human.

1. New package registration

Please make sure that you have read the package naming guidelines.

2. AutoMerge Guidelines are all met! ✅

Your new package registration met all of the guidelines for auto-merging and is scheduled to be merged when the mandatory waiting period (3 days) has elapsed.

3. To pause or stop registration

If you want to prevent this pull request from being auto-merged, simply leave a comment. If you want to post a comment without blocking auto-merging, you must include the text [noblock] in your comment.

Tip: You can edit blocking comments to add [noblock] in order to unblock auto-merging.

[goerz]

I'm not sure I understand the scope of this package, or how it relates to the unicode-math LaTeX package. My understanding of that LaTeX package is that it allows to use e.g. α in an equation inside a .tex file instead of the normal \alpha. That is not something that has an obvious Julia-equivalent. Does this package simply convert between the different unicode font styles as the examples in the README seems to suggest? What are the available options for math_style_spec?

The name UnicodeMath may be too general for this. Maybe UnicodeMathStyles?

[manuelbb-upb]

yes, the package pretty much substitutes input glyphs with styled glyphs adhering to some styling convention.
in that, it is similar to UnicodeFun, but with more compound styles and the configuration options.
the package is mainly meant as a companion for MathTexEngine to provide some of the commands that unicode-math has for LaTeX, e.g., \symbf.
in Kolaru/MathTeXEngine.jl#141 some issues are linked that could be resolved.
we have also brainstormed ideas on how to integrate this functionality into MathTexEngine; a new package allows for more flexibility in testing things out, and also with licensing, should it turn out that UnicodeMath cannot be released under MIT (I am pretty sure MIT is ok though).

the available style specifications (:iso, :tex, :french, :upright, :literal) are not documented yet, at some point a little explanation will be added; the styles are very similar to the corresponding unicode-math styles.

[goerz]

Right, that makes sense. I definitely tink the package needs a more descriptive name, though. What I would expect from a package named UnicodeMath would probably be somewhat similar to what is already provided by the to_latex function in UnicodeFun. On that note: Doesn't UnicodeFun already include the functionality you are implementing here (to_caligraphic etc.)? If some specific style is missing there, maybe it would make more sense to contribute to UnicodeFun? @SimonDanisch

If it does make sense to continue with this package, based on your opening statement in Kolaru/MathTeXEngine.jl#141 (comment)

This is a WIP with the goal of enabling a bit more control over character shapes

I would suggest UnicodeCharacterShapes as a more descriptive package name.

the available style specifications (:iso, :tex, :french, :upright, :literal) are not documented yet, at some point a little explanation will be added;

I would urge you to do that now. Registered packages must be sufficiently documented to be useable, and "I'll add documentation later" too often turns into "never"

[manuelbb-upb]

Thanks for your suggestions!

If some specific style is missing there, maybe it would make more sense to contribute to UnicodeFun?

That is actually how it started: SimonDanisch/UnicodeFun.jl#24 😄
But unicode-math is a bit more complicated than the “simple” substitutions that are in UnicodeFun.
For example, Latin or Greek characters are normalized to adhere to a common ("normal") style and either all be upright or italic.
In UnicodeMath the same alphabets/scripts/glyph ranges as in unicode-math (:latin, :Latin, :num, :greek, :Greek, :partial, :Nabla) have style mapping dicts similar to _default_font_modifiers in MathTexEngine that should respect the expected styling configuration.

I am not particular about having a separate UnicodeMath package however, and you are right about the naming.
It felt a bit off as part of MathTeXEngine, but maybe the code could/should become part of UnicodeFun.
I'll wait for @SimonDanisch to give his opinion :)

I would urge you to do that now.

Right, wherever the code ends up, I'll add a bit more explanation 👍

Let's keep the merge blocked for now.

[github-actions]

This pull request has been inactive for 30 days and will be automatically closed 7 days from now. If this pull request should not be closed, please either (1) fix the AutoMerge issues and re-trigger Registrator, which will automatically update the pull request, or (2) post a comment explaining why you would like this pull request to be manually merged. [noblock]

[github-actions]

This pull request has been inactive for more than 30 days and has automatically been closed. Feel free to register your package or version again once you fix the AutoMerge issues. [noblock]