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

Specify Markdown statements #239

Open
niemela opened this issue Aug 17, 2024 · 5 comments
Open

Specify Markdown statements #239

niemela opened this issue Aug 17, 2024 · 5 comments

Comments

@niemela
Copy link
Member

niemela commented Aug 17, 2024

There should be a section specifying Markdown statements (similar to the section specifying LaTeX).

I think the Markdown dialect we want to us is:

  • CommonMark
  • + $ and $$ for math
  • + tables
  • + footnotes

Also we should consider equivalents of all the commands defined for LaTeX:

  • \problemname
  • \illustration
  • \nextsample
  • \remainingsamples
    We might not need all of them, but definitely the sample ones.

I would suggest using {{ }} syntax for these. E.g. {{nextsample}} for including the next sample.

@mzuenni
Copy link
Contributor

mzuenni commented Aug 17, 2024

using {{ }} might conflict with Constants?

@RagnarGrootKoerkamp
Copy link
Collaborator

I think it's nice to actually have the same syntax; both are some kinda of problem-package owned templating, and {{unknown}} is left alone by variable substitution.

@mzuenni
Copy link
Contributor

mzuenni commented Aug 17, 2024

but then {{problemname}} will work in markdown but not in latex whereas "normal" constant work everywhere? that could be frustrating for users ^^'

@Matistjati
Copy link

The reference implementation (so far): Kattis/problemtools#274

@Matistjati
Copy link

Matistjati commented Aug 18, 2024

We have decided that:

  • We will not support {{problemname}}. You should use problem.yaml, and we will automatically add the problem name to the top of the statement. This needs to be specced (maybe it already is?)
  • We will not support {{includegraphics}}, as the commonmark syntax for images is simpler.
  • {{nextsample}} and {{remainingsamples}} will be supported

@niemela niemela assigned Matistjati and unassigned Matistjati Aug 18, 2024
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

No branches or pull requests

4 participants