w3c / w3c/vc-render-method

publish context file for renderMethod

Open
#16 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
HTML
Stars
9
Forks
8
Avg merge
14d 42m
Merged PRs (30d)
2

Description

At the moment we can use the renderMethod like so in a Verifiable Credential version 2:

"@context": [
        "https://www.w3.org/ns/credentials/v2",
        "https://purl.imsglobal.org/spec/ob/v3p0/context-3.0.3.json",
        "https://w3id.org/security/suites/ed25519-2020/v1"
        {
            "css3MediaQuery": "urn:uuid:c4c53282-e8e2-4914-83d8-566e25d2f899",
            "HTMLRenderingTemplate": "urn:uuid:925d00aa-ae94-4278-89d5-1cb59a8025e8"
        }
    ],
"renderMethod": [
        {
            "id": "https://raw.githubusercontent.com/digitalcredentials/test-files/main/html-templates/mock-MIT-bachelors-template.html",
            "type": "HTMLRenderingTemplate",
            "name": "PDF Display",
            "css3MediaQuery": "@media (orientation: portrait)"
        }
    ]

It would be nice to instead have a context something like:

"@context": [
        "https://www.w3.org/ns/credentials/v2",
        "https://purl.imsglobal.org/spec/ob/v3p0/context-3.0.3.json",
        "https://w3id.org/security/suites/ed25519-2020/v1",
        "https://w3id.org/ns/credentials/render/v1"         <======= NEW 
    ],
"renderMethod": [
        {
            "id": "https://raw.githubusercontent.com/digitalcredentials/test-files/main/html-templates/mock-MIT-bachelors-template.html",
            "type": "HTMLRenderingTemplate",
            "name": "PDF Display",
            "css3MediaQuery": "@media (orientation: portrait)"
        }
    ]

where the https://w3id.org/render/v1 defines the template types and anything else needed for the renderMethod.

@dmitrizagidulin

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the example @context and renderMethod shown in the issue, then review the proposed https://w3id.org/ns/credentials/render/v1 location and the terms it should define. Done means a published context exists at the agreed URL and the example can reference it without inline term definitions.

Written by the indexing model from the issue text.

Assessment

Tech stack
html
Domain
documentation
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.