esciencecenter-digital-skills / software-support-essentials

https://esciencecenter-digital-skills.github.io/software-support-essentials/
Other
0 stars 1 forks source link

Non-intuitive behavior of the widemd and various media type chapter properties #23

Open JaroCamphuijsen opened 1 year ago

JaroCamphuijsen commented 1 year ago

As per #17 it is possible to embed videos and websites besides the already existing image option in the big panel of each chapter and have full page width markdown chapter. A chapter type is now selected in the chapter header by adding a property (image, video, website, widemd) with the value of the property being the content of that type of medium. For widemd there is no extra content, so any value renders a widemd chapter (even widemd=False). This behavior is non-intuitive. In the current implementation it is also possible to combine various media types, but this renders only one single type with undocumented preferential order.

Proposed solution: Use two property keywords chapter-type with values [image, video, website, markdown] and media-content with the respective links or paths (should be documented well which type of chapter requires which kind of media-content value. The media-content does not do anything in the case of a markdown chapter.