Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Outdated math example in user manual 0.15.6 #2169

Closed
Omikhleia opened this issue Nov 14, 2024 · 3 comments · Fixed by #2167
Closed

Outdated math example in user manual 0.15.6 #2169

Omikhleia opened this issue Nov 14, 2024 · 3 comments · Fixed by #2167
Assignees
Labels
documentation Documentation bug or improvement issue

Comments

@Omikhleia
Copy link
Member

The new pairing of opening/closing operators in TeX-like math makes this part of the package documentation outdated:

image

But the effect of braces for grouping would still have to be explained and is still valid for solving certain cases ("un-paired" stretchy operators). We should revise this part of the documentation, possibly depending on how other topic in #2148 are eventually addressed.

@Omikhleia Omikhleia added the documentation Documentation bug or improvement issue label Nov 14, 2024
@Omikhleia Omikhleia added this to Math Nov 14, 2024
@github-project-automation github-project-automation bot moved this to To do in Math Nov 14, 2024
@alerque
Copy link
Member

alerque commented Nov 14, 2024

I wouldn't mind seeing a more exhausting example page of math for the website too. You've had some nice samples in issues, we should cobble together a page worth showcasing some more of the bits that are coming together.

@Omikhleia
Copy link
Member Author

I wouldn't mind seeing a more exhausting example page of math for the website too. You've had some nice samples in issues, we should cobble together a page worth showcasing some more of the bits that are coming together.

Why not linking a 80+ pages booklet on the topic? 🤣
(work in progress, opinionated, quite critical at times, but with a good disclaimer -- and lots of curated examples eventually).

@alerque
Copy link
Member

alerque commented Nov 14, 2024

Linking an 80+ page booklet would absolutely be appropriate, from the manual, from the website, whatever. I'm more than up for that, feel free to PR things to the manual or website any time.

For the sake of the examples section of the website where folks with only a casual interest or evaluating whether SILE is even remotely the right tool for them, a single page example document to put in the gallery would still serve a different purpose. If it happened to be an equivalent of some sample page from another typesetter that I could also add to polytype that would be cool too.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Documentation bug or improvement issue
Projects
Status: Done
2 participants