Feature request: Hints with markdown formatting

[rstudio]

Feature request: Hints with markdown formatting

[jjallaire]

Yes, we will definitely do this. @hadley Asked for this right away as well, it may actually end up being a more popular way to provide hints than code.

[jjallaire]

I've added the ability to compose hints in markdown, documentation is here: https://rstudio.github.io/tutor/45796A4F836C4B5B/exercises.html#hints_and_solutions

[dtkaplan]

This is good. It would be helpful to have the formatted hint appear in the same place as code hints, and with a similar box. As it is now, the formatted hint appears below the code pane and there's nothing to direct the user's attention to the hint. Of course, I can also do much of the highlighting with markdown, e.g. <div id="DC-01-intro-hint"> --------- The hint itself --------- </div>

…

On Wed, Dec 21, 2016 at 2:37 PM, JJ Allaire ***@***.***> wrote: I've added the ability to compose hints in markdown, documentation is here: https://rstudio.github.io/tutor/45796A4F836C4B5B/ exercises.html#hints_and_solutions — You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub <#3 (comment)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AAggrfNo0XH0xJNU9azmuLmcVg27B04Nks5rKY4fgaJpZM4LQPFv> .

-- ... DeWitt Wallace Professor of Mathematics, Statistics, and Computer Science Macalester College

[jjallaire]

I think we can either have the hints show up in the same frame as code or we can add some automatic highlighting of hint divs. I was thinking that by inserting the markdown hint into the area below the code it could be somewhat more expansive. I also thought that the framing that we use for code hints might be kind of a distraction / too busy for markdown hints.

So we could definitely add some framing for hints displayed below to make them more obvious. The question I'm interested in is which is more desirable -- markdown hints above in the same frame as code or markdown hints below.

@hadley had some thoughts about this (I believe he favored below but I don't recall exactly) so he might want to weigh in also.

[dtkaplan]

I'm neutral about above or below, just so long as there is a clear indication to the reader that a hint has appeared.

Regarding the

style of indicating a formatted hint, I wonder whether it would be better to use the regular chunk style (as with code hints) but with a chunk option that lets knitr format the markdown/rmarkdown contents of the chunk and wrap them in the

.

[jjallaire]

Okay, I just added a panel border treatment around the hint HTML. Let me know if that seems like enough (I'm wary of making it too busy as there are already quite a few boxes/headers within tutorials).

In terms of using regular code chunks for hints, I don't like this because you are now forcing the author to write markdown in an R code editor (thus giving up all of our markdown editing tools) as well as making it impossible to embed other R code chunks in the hint (since you can't next code chunks).

[dtkaplan]

Makes sense. Thanks.

…

On Thu, Dec 22, 2016 at 12:21 PM, JJ Allaire ***@***.***> wrote: Okay, I just added a panel border treatment around the hint HTML. Let me know if that seems like enough (I'm wary of making it too busy as there are already quite a few boxes/headers within tutorials). In terms of using regular code chunks for hints, I don't like this because you are now forcing the author to write markdown in an R code editor (thus giving up all of our markdown editing tools) as well as making it impossible to embed other R code chunks in the hint (since you can't next code chunks). — You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub <#3 (comment)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AAggrX7X_mMfxqlKBIG_-kyG0QhkLUTqks5rKr-XgaJpZM4LQPFv> .

-- ... DeWitt Wallace Professor of Mathematics, Statistics, and Computer Science Macalester College