Implement JSON-LD #552
Merged
Implement JSON-LD #552
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
tomschr
force-pushed
the
docteam-1061-json-ld
branch
4 times, most recently
from
244718d
to
c593165
Compare
Fixes DOCTEAM-1061 Introduces a new parameter: * generate.json-ld: Switch to generate (=1) or not (=0). By default, it's currently disabled Currently the following Schema.org properties are created: * "headline": using the first info/title or title tag * "abstract": using the first info/abstract or info/highlights tag * "author": using info/authorgroup or info/author (multiple) * "dateModified": create current date using the extension function "date:date-time()" * "datePublished": using info/meta[@name='published'] (placeholder), info/pubdate, info/date or info/revhistory/revision[1]/date in this order * "version": using info/productnumber * "keywords": using info/keywords * "publisher": a reference to SUSE and its logo
tomschr
force-pushed
the
docteam-1061-json-ld
branch
from
c593165
to
04a9b3f
Compare
|
The fine-tuning part is done next week. However, for testing purposes, it's probably fine enough. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.<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