colonial-heritage / research-guides-dev

Development repo for integrating the research guides from NIOD into the Datahub
Creative Commons Attribution Share Alike 4.0 International
0 stars 0 forks source link

make main texts of guides just one field in YAML #14

Closed valevo closed 2 months ago

valevo commented 2 months ago

background

decision

TODO

Something like

Description:
   content: |
       some description **text**.
   content-type: "text/markdown"

Provenance research:
   content: |
       info about doing _provenance_ research.
   content-type: "text/markdown"

becomes

main-text:
  content: | 
    ## Description

    some description **text**.

    ## Provenance research

    info about doing _provenance_ research.

  content-type: "text/markdown"

Since section headers are now no longer variable names in the YAML but inside of text, they should be translated into Dutch/English (besides formatting, contents of texts are not altered in the front-end).

wreints commented 2 months ago

Would this be the way?

Description [Content]
Provenance research [Content]

Doing it this way would also mean that I need to change the language of Description and Provenance research into Dutch (for the Dutch RAs), right?

valevo commented 2 months ago

see above; what you posted is nice but is technically HTML and not Markdown (and although most Markdown processors accept HTML code, we want to keep it pure Markdown, so as to not mix text annotation and text formatting). A good Markdown processor will turn the Markdown I wrote above automatically into HTML similar to what you wrote.

wreints commented 2 months ago

@valevo Looks good, I'll add it to the RAs. How should I approach this for the Level 1s?