The new .md docu format has a big disadvantage compared to former pdf:

I often study OM function docu on my iPad when I am off from my OM-computer (not in creative rather learning mode). In the past with pdf it was very educational to see code examples with results of evaluation. Now with .md I can only study the function call (using a md-reader) but I am lacking computation on iPad I do not see the evaluation result. This is not optimal to learn OM.

Not sure how many users do something similar.

Is there a way to get evaluation included with docu?

Displaying the results in Markdown documents is not a technical problem. Adding the results for each expression would be very simple; however, it would require a significant amount of work because it would need to be applied to approximately 1,400 documents.

I was hoping for automation.

Personally, I'm happy they are gone. What I mean is, I would rather have Janusz spend time on other things.

Jesper

For me, the new Opusmodus Markdown is very useful for teaching, as it lets me write immediate, working examples for students alongside the explanations.

Maybe I must clarify that my post is not about pdf vs. markdown.

I also see some benefits of new .md format.

But the functional aspect of currently not being able to study the docu including results on offline devices is a really big disadvantage which was introduced coincidentally with switch from pdf to markdown.

If I understand @opmo correctly, it seems not to be a technical matter of format but rather a consequence that currently the results happen to be not included.

If theres a way to include results in markdown it would be very very appreciated.

I agree with both but I am just glad I have those pdfs archived because they were nice for studying functions on an iPad.

If you are using an iPad, iOS or Mac (can't speak for Android or Windows) - if you install a capable MD reader, you can simply open the .md documents directly inside the reader. This is effectively no different from opening a PDF on a tablet or phone. I have the 'Bear' app and it's great for browsing .md documents and because it's also an editor, the documents can be duplicated, edited/annotated and saved locally too. Just save the md documents from the Resources directory on laptop to a directory on iCloud, then set Bear to read that saved directory. The formatting is clean and very readable - and just as simple as it would be with PDF. Annotation is also straightforward. Here's an example of how clean the .md output is on Bear. Personally, I'm really pleased with the move to markdown. Apart from anything else, the file sizes are so much more efficient - and this makes storing documentation much tidier and I always found the PDF handling a bit clunky. This is now a modern documentation system. Here's what Bear's output looks like on a simple function helpfile:

@acrawnsley As I already wrote in my original post, I am also using a .md reader on iPad.

To repeat my point, whats missing (when reading docs off from OM) is the evaluation result as crutial part of learning experience (while it was included in former pdf docu).

@acrawnsley Can your .md reader show this evaluation result?

If so please let me know.

If not, this problem persists.

23 hours ago, Cliff said:

@acrawnsley As I already wrote in my original post, I am also using a .md reader on iPad.

To repeat my point, whats missing (when reading docs off from OM) is the evaluation result as crutial part of learning experience (while it was included in former pdf docu).

@acrawnsley Can your .md reader show this evaluation result?

If so please let me know.

If not, this problem persists.

No - because evaluation requires OM to be running which it doesn't on an iPad or iPhone. However, if you really want to see evaluation of expressions in md you can just add them. That's the benefit of an md document: it's completely editable whereas PDF is a lot less flexible. Copy evaluations from live runs in OM after trying them into the md docs on the iPad or transfer from PDF versions to md manually. The transfer manually is a good way of remembering code too the input/writing reinforces the learning of what it does. The benefit of using something like Bear is that the files then become completely manipulatable in ways that PDF just doesn't allow without an expensive Adobe subscription and they are synced across all devices - so taking evals out of OM listener and dropping into a md document is simple. Just some suggestions - works for me. Everyone is different in their preferences.

@acrawnsley Adding those results manually is no good option that scales for me and every single user. Needless to say it wont keep up with new versions.

I hope that this can be made part of central automated authoring pipeline by @opmo before a new version gets shipped.