tomschr
commented
11 months ago The fine-tuning part is done next week. However, for testing purposes, it's probably fine enough.
Closed tomschr closed 11 months ago
tomschr
commented
11 months ago The fine-tuning part is done next week. However, for testing purposes, it's probably fine enough.
After Jana did some research, it seems that JSON-LD (JSON Linked Data) is the way to go for our metadata.
This PR fixes DOCTEAM-1061 and contains the following changes:
<script type="application/ld+json">...</scriptin the<head>tag.Add the JSON-LD content inside the previous
<script>:"@context": "http://schema.org",: constant"@type": "TechArticle",: constant"headline": using theinfo/titleortitletag whatever is available"abstract": using the firstinfo/abstractorinfo/highlightstag whatever is available"author": usinginfo/authorgroup. Creates a list of authors like:If no authorgroup is available, the "author" entry is skipped.
"dateModified": adding the current date using the extension functiondate:date-time()"datePublished": usinginfo/meta[@name='published'](just a placeholder),info/pubdate,info/date, orinfo/revhistory/revision[1]/datein this order. If none of these elements are available, no entry is created. (Needs to be discussed)"publisher": a constant, created as:
Other, useful properties
datePublished,dateModified,dateCreated: dates about our document. Not entirely sure which could be helpfularticleSection: could be a sub structure that belongs to a higher parent structure (like a chapter in a book). This would probably only be useful for chunked HTML (if at all)audience: our intended audience (beginners, developers, experts, ...)archivedAt,expires: when one of our guides goes end of life.copyrightHolder,copyrightNotice,copyrightYear: maybe useful for legal reasonslicense: could point to the URL of GNU FDL (or any other licenses)creativeWorkStatus: its stage in a lifecycle, for example Incomplete, Draft, Published, Obsolete. Could be helpful when something is in "beta state" (like ALP).genre: could that hold our categories (like "systems management")?inLanguage: the language that the text is written inkeywords: could be used to describe the article. Multiple entries in a keywords list are possibleversion: could hold the release (15 SP5, for example). For doc-modular or doc-unversioned, this key can be skipped.proficiencyLevel: Proficiency needed for this content, expected values: 'Beginner', 'Expert'.References