Skip to content

Deprecate pdf-mustache render suite. Mark svg-mustache render suite as needing implementer feedback. #49

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.

Sign up for GitHub

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

Open
msporny wants to merge 1 commit into
base: main
Choose a base branch
from
+2 −137
Open

Deprecate pdf-mustache render suite. Mark svg-mustache render suite as needing implementer feedback. #49

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
139 changes: 2 additions & 137 deletions index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -465,141 +465,6 @@ <h4>TemplateRenderMethod</h4>
information from the [=verifiable credential=] listed in `renderProperty`.
</p>

<section>
<h3>The `svg-mustache` Render Suite</h3>
<p>
The `svg-mustache` render suite uses the Mustache templating language to
modify an SVG file, which is then used to render a visual representation
of the [=verifiable credential=].
</p>

<p>
In the example below, a fully embedded SVG file is used as the rendering
template.
</p>

<pre class="example nohighlight"
title="Basic usage of the svg-mustache render suite">
{
<span class="comment">...</span>
"renderMethod": {
"type": "TemplateRenderMethod",
"renderSuite": "svg-mustache",
<span class="comment">// the SVG file is embedded in the VC</span>
"template": "data:image/svg+xml;base64,Qjei89...3jZpW"
}
}
</pre>

<p>
The next example links to the SVG file on the Web and secures it against
modification by using the `digestMultibase` property.
</p>

<pre class="example nohighlight"
title="A remotely hosted SVG file for an SVG render template">
{
<span class="comment">...</span>
"renderMethod": {
"type": "TemplateRenderMethod",
"renderSuite": "svg-mustache",
"template": {
<span class="comment">// this SVG file is fetched from the Web</span>
"id": "https://degree.example/credential-templates/bachelors",
"mediaType": "image/svg+xml",
"digestMultibase": "zQmerWC85Wg6wFl9znFCwYxApG270iEu5h6JqWAPdhyxz2dR"
}
}
</pre>

<p>
The next example links to the rendering template on the Web and secures it
using the `digestMultibase` property:
</p>

<pre class="example nohighlight"
title="A remotely hosted SVG render method">
{
<span class="comment">...</span>
"renderMethod": {
<span class="comment">// this render method is fetched from the Web</span>
"id": "https://degrees.example/bachelors-svg.jsonld",
"mediaType": "application/ld+json",
"type": "TemplateRenderMethod",
"renderSuite": "svg-mustache",
"digestMultibase": "zQmG270iEu5h6JqWAPdhyxz2dRerWC85Wg6wFl9znFCwYxAp"
}
</pre>

</section>

<section>
<h3>The `pdf-mustache` Render Suite</h3>
<p>
The `pdf-mustache` render suite uses the Mustache templating language to
modify a PDF file, which is then used to render a visual representation
of the [=verifiable credential=].
</p>

<p>
In the example below, a fully embedded PDF file is used as the rendering
template.
</p>

<pre class="example nohighlight"
title="Basic usage of the pdf-mustache render suite">
{
<span class="comment">...</span>
"renderMethod": {
"type": "TemplateRenderMethod",
"renderSuite": "pdf-mustache",
<span class="comment">// this PDF file is embedded in the VC</span>
"template": "data:application/pdf;base64,k309SK...pwK83b"
}
}
</pre>

<p>
The next example links to the PDF file on the Web and secures it against
modification by using the `digestMultibase` property.
</p>

<pre class="example nohighlight"
title="Remotely hosted PDF file for a PDF rendering template">
{
<span class="comment">...</span>
"renderMethod": {
"type": "TemplateRenderMethod",
"renderSuite": "pdf-mustache",
"template": {
<span class="comment">// this PDF file is fetched from the Web</span>
"id": "https://degree.example/bachelors.pdf",
"mediaType": "application/pdf",
"digestMultibase": "zQmznFCwYxApG270iEu5h6JqWAPdhyxz2dRerWC85Wg6wFl9"
}
}
</pre>

<p>
The next example links to the rendering template on the Web and secures it
using the `digestMultibase` property:
</p>

<pre class="example nohighlight"
title="Remotely hosted PDF rendering template">
{
<span class="comment">...</span>
"renderMethod": {
<span class="comment">// this render method is fetched from the Web</span>
"id": "https://degrees.example/bachelors-pdf.jsonld",
"type": "TemplateRenderMethod",
"renderSuite": "pdf-mustache",
"digestMultibase": "zQmEu5h6JqWAPdhyxmz2dRerWC85Wg6wFl9znFCwYxApG270"
}
</pre>

</section>

<section>
<h3>The `nfc` Render Suite</h3>
<p>
Expand Down Expand Up @@ -807,7 +672,7 @@ <h5>Wrapper Code</h5>

<p>
To complete the setup, the [=host page=] MUST inject the [=wrapper code=] (once populated
with the [=verifiable credential=] and the [=template code=]) into the iframe's `srcdoc`
with the [=verifiable credential=] and the [=template code=]) into the iframe's `srcdoc`
attribute which will run any JavaScript contained in the [=wrapper code=] and [=template code=].
</p>

Expand Down Expand Up @@ -854,7 +719,7 @@ <h5>Ready and Error Events</h5>
<h3>Algorithms</h3>
<p>
The following sections outline the algorithms that are used by the `html` render
suite to safely render the HTML template. Alternative algorithms MAY be used
suite to safely render the HTML template. Alternative algorithms MAY be used
as long as the security and privacy outcomes as well as the output is the same.
</p>

Expand Down