Licensing section has weird section headers

[LourensVeen]

It looks like the headers (tabs?) at the top of the page are made from the file names, and I didn't anticipate that when I created the files for the licensing section, so they look a bit funny ("ExHaveLicensingPolicy"). Or maybe that's a fallback and I need to change the way the header of the page is written for it to be picked up. Anyway, needs fixing.

[JaroCamphuijsen]

Thank you @LourensVeen for the issue. This is indeed still something on the framework side. We are not sure yet how to best extract the title. What would your preferred way be? I can think of several options:

• like now extract the filename, that should than be clarified in the docs, drawback is loss of flexibility
• take the first main header in the file,
• best is maybe to have a configuration header, like in the main level markdown file in each chapter markdown as well

My favorite would be the last option, but we have to see how the reveal.js pmd files react to that.

[LourensVeen]

I was surprised to find the file name in there, because as a programmer I'm not used to file names being used as input for anything. But I'm perhaps not a typical contributor, so that shouldn't be the deciding factor I think.

The first main header could work, but it would constrain the first header on the page to be short enough to work as a tab title. Maybe that's not a bad thing though.

I'm not really sure what you mean with the third option, like there would be a metadata block at the top of the file?

[JaroCamphuijsen]

Yeah filenames are not the best thing to take for menu items, I agree. But then again, Nuxt works in mysterious.. oh no, intuitive ways. It is really the default in Nuxt... Right @raar1 ?

My idea would be to have a block of configuration settings at the top of each of the content markdown files. The block would be similar to what's in the license.md file in the module directory.

We probably want to collect more information in this header eventually, for example the order, instead of taking that from the filename as well.

So for example:

<!--- modules/03.university_policy.md --->
---
title: University policies
order: 3
---

## University software policies

Universities employ researchers, who often create and use software in the course of ...

[LourensVeen]

Putting the ordering in there occurred to me as well. We could chain them using a reference to the previous chapter instead of having a number, then you can more easily insert something halfway. (There's your computational complexity from the internal training :smile:.) On the other hand, how would you refer to another file, by filename? Chapter title? And you could end up with a cycle as well and then you have other problems. So maybe a number is easier. We could use floating point numbers, then you can insert 3.5 in between 3 and 4...

[JaroCamphuijsen]

Hi @LourensVeen, I just want to let you know that it is currently possible to add a header with metadata to your markdown files like this:

<!--- modules/03.university_policy.md --->
---
title: University policies
---

It will render the title of the chapter accordingly. However, currently this will not work for the slides (.pmd) file. Well, actually it will work, but then it will also create a slide in the reveal.js slideshow. So there, preferably the first slide will actually hold the title that will also show up as a chapter tab. We will work on making this more similar to the other markdowns.

[JaroCamphuijsen]

@LourensVeen this was somewhat addressed by @Cmurilochem in #57 , but you might not agree with the outcome. (Actually I also have an opinion: the titles are slightly too long). Feel free to change them.

[Cmurilochem]

@LourensVeen. Also, I am not sure if the ordering of the reading material is correct. If you want, you can change it in the header via the order option

---
title: Copyright and software
type: reading
order: 2
---

Alternatively, you can send me the correct order, and titles and I can update.

[JaroCamphuijsen]

@LourensVeen Do you agree that we close this issue, as it was solved in https://github.com/esciencecenter-digital-skills/research-software-support/pull/57? In your next module update you can always change the chapter titles if you want. I'm closing the issue for now, feel free to reopen it if you think it is still relevant.