Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Create set of metadata for <info> #98

Open
tomschr opened this issue Oct 21, 2021 · 0 comments
Open

Create set of metadata for <info> #98

tomschr opened this issue Oct 21, 2021 · 0 comments
Assignees
Labels
geekodoc 2️⃣ For GeekoDoc version2 only

Comments

@tomschr
Copy link
Contributor

tomschr commented Oct 21, 2021

Problem Description

We've discussed several ways how we could deal with metadata. Some ideas are in the article DocBook and metadata. cf also jsc#DOCTEAM-238.

However, none of them was really appropriate, so we need to define our own set.

Design Ideas

  • Define our own set in a different namespace.
  • Should be easy to write and memorize.
    • Ease of manual use can help avoid the need for a custom tagging tool that may soon end up unmaintained (like docmanager nowadays)
  • Should be as validatable as possible: it should be possible to validate concrete metadata types and in some cases also content (e.g. for stuff like dates), rather than just being able to validate a generic tag name.
  • Extensibility should be provided by quick additions to the schema rather than by being able to define new tags ad-hoc
    • Think about whether it makes most sense to ship within GeekoDoc or ship separately, so it's not bound to GeekoDoc releases
  • Should be XML-based, for use with stylesheets
    • Possible goal: make it usable from native AsciiDoc to avoid the necessity of docinfo file
  • Possible goal: Custom tags should allow for straightforward conversion into a standard tag set such as DocBook's <meta/> tags or RDFa Lite.
  • Possible goal: Include functionality from dm: namespace/supersede dm: namespace.

Related issues/PRs

[initial description by toms, large parts of bottom section of issue by sknorr]

@tomschr tomschr added geekodoc Version independent general GeekoDoc issues geekodoc 2️⃣ For GeekoDoc version2 only labels Oct 21, 2021
@tomschr tomschr self-assigned this Oct 21, 2021
@tomschr tomschr added this to To do in GeekoDoc v2.1.0 via automation Oct 21, 2021
@tomschr tomschr removed the geekodoc Version independent general GeekoDoc issues label Oct 27, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
geekodoc 2️⃣ For GeekoDoc version2 only
Projects
Development

No branches or pull requests

1 participant