react-client icon indicating copy to clipboard operation
react-client copied to clipboard

YAML Metadata should support the licence of the content

Open elearningdienst opened this issue 3 years ago • 1 comments

Which part of the project should be enhanced?

The YAML "Engine"

Is your enhancement request related to a problem? Please describe.

within /yaml-metadata in a hedgedoc instance you can see the supported YAML metadata. There is no possibility to expose a licence metadata to any search engines.

Describe the solution you'd like

There should be a licence option in the YAML metadata. That option should set a proper meta property in the head section of the note. Just like title or description. See Screenshot.

---
title: Example to YAML metadata in hedgedoc
description: Some Text and so on
tags: OER, YAML, Bildung, Use Case, Whatever
lang: de-de
**license: https://creativecommons.org/licenses/by-sa/4.0/deed.de**

---

grafik

Describe alternatives you've considered

I always set the licence human readable, but that is mostly ignored by search engines.

e.g

## Lizenz & Kontakt

Alle Inhalte dieses Pads sind freigegeben unter Public Domain ([CC0](https://creativecommons.org/publicdomain/zero/1.0/deed.de)) und können von allen Interessierten offen weiter genutzt werden.

Kontakt bei Fragen via Mail: [email protected]

or

## Lizenzhinweis:
Das Grobkonzept BlaBla von BlaBla steht unter der Lizenz [**CC BY-SA 4.0**](https://creativecommons.org/licenses/by-sa/4.0/legalcode.de).

Additional context

I use hedgedoc in an educational context, so a proper licence of the content is necessary to reuse and remix the content if it is open access or - even better - an open educational resource. If a search engine can index it properly, the content is better to find for any user.

elearningdienst avatar Oct 17 '21 16:10 elearningdienst

Interesting idea. Seems like you can achieve this by placing an <a>-tag with rel="license" in your document or by placing a <link> tag in the html head.

See https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/rel

While the first solution should already work in HedgeDoc 1, because you can add a plain html <a> tag in the document, the second one is of course preferred. Because we focus on developing HedgeDoc 2 right now, we won't add this feature to HedgeDoc 1. I'll transfer this issue to the repository of the new client for HedgeDoc 2.

mrdrogdrog avatar Oct 17 '21 16:10 mrdrogdrog