Skip to content

Commit

Permalink
Deployed 7770f24 with MkDocs version: 1.5.3
Browse files Browse the repository at this point in the history
  • Loading branch information
titusz committed Dec 28, 2023
1 parent 7836e85 commit b25a47b
Show file tree
Hide file tree
Showing 3 changed files with 118 additions and 55 deletions.
171 changes: 117 additions & 54 deletions iep-0002/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -173,72 +173,104 @@
</label>
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix="">
<li class="md-nav__item">
<a class="md-nav__link" href="#1-meta-code">
<a class="md-nav__link" href="#1-general">
<span class="md-ellipsis">
1. Meta-Code
1. General
</span>
</a>
<nav aria-label="1. Meta-Code" class="md-nav">
<ul class="md-nav__list">
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#11-general">
<a class="md-nav__link" href="#2-purpose">
<span class="md-ellipsis">
1.1 General
2. Purpose
</span>
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#12-purpose">
<a class="md-nav__link" href="#3-format">
<span class="md-ellipsis">
1.2 Purpose
3. Format
</span>
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#13-format">
<a class="md-nav__link" href="#4-inputs">
<span class="md-ellipsis">
4. Inputs
</span>
</a>
<nav aria-label="4. Inputs" class="md-nav">
<ul class="md-nav__list">
<li class="md-nav__item">
<a class="md-nav__link" href="#41-name-element">
<span class="md-ellipsis">
1.3 Format
4.1 name element
</span>
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#14-inputs">
<a class="md-nav__link" href="#42-description-element">
<span class="md-ellipsis">
1.4 Inputs
4.2 description element
</span>
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#15-outputs">
<a class="md-nav__link" href="#43-meta-element">
<span class="md-ellipsis">
1.5 Outputs
4.3 meta element
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#16-seed-metadata">
<a class="md-nav__link" href="#5-outputs">
<span class="md-ellipsis">
1.6 Seed metadata
5. Outputs
</span>
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#17-metadata-embedding">
<a class="md-nav__link" href="#6-seed-metadata">
<span class="md-ellipsis">
1.7 Metadata embedding
6. Seed metadata
</span>
</a>
<nav aria-label="6. Seed metadata" class="md-nav">
<ul class="md-nav__list">
<li class="md-nav__item">
<a class="md-nav__link" href="#61-meta-code-processing">
<span class="md-ellipsis">
6.1 Meta-Code processing
</span>
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#18-metadata-extraction">
<a class="md-nav__link" href="#62-meta-hash-processing">
<span class="md-ellipsis">
1.8 Metadata extraction
6.2 Meta-Hash processing
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#7-metadata-embedding">
<span class="md-ellipsis">
7. Metadata embedding
</span>
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#8-metadata-extraction">
<span class="md-ellipsis">
8. Metadata extraction
</span>
</a>
</li>
</ul>
</nav>
</li>
Expand Down Expand Up @@ -348,72 +380,104 @@
</label>
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix="">
<li class="md-nav__item">
<a class="md-nav__link" href="#1-meta-code">
<a class="md-nav__link" href="#1-general">
<span class="md-ellipsis">
1. Meta-Code
1. General
</span>
</a>
<nav aria-label="1. Meta-Code" class="md-nav">
<ul class="md-nav__list">
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#11-general">
<a class="md-nav__link" href="#2-purpose">
<span class="md-ellipsis">
1.1 General
2. Purpose
</span>
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#12-purpose">
<a class="md-nav__link" href="#3-format">
<span class="md-ellipsis">
1.2 Purpose
3. Format
</span>
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#13-format">
<a class="md-nav__link" href="#4-inputs">
<span class="md-ellipsis">
4. Inputs
</span>
</a>
<nav aria-label="4. Inputs" class="md-nav">
<ul class="md-nav__list">
<li class="md-nav__item">
<a class="md-nav__link" href="#41-name-element">
<span class="md-ellipsis">
1.3 Format
4.1 name element
</span>
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#14-inputs">
<a class="md-nav__link" href="#42-description-element">
<span class="md-ellipsis">
1.4 Inputs
4.2 description element
</span>
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#15-outputs">
<a class="md-nav__link" href="#43-meta-element">
<span class="md-ellipsis">
1.5 Outputs
4.3 meta element
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#16-seed-metadata">
<a class="md-nav__link" href="#5-outputs">
<span class="md-ellipsis">
1.6 Seed metadata
5. Outputs
</span>
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#17-metadata-embedding">
<a class="md-nav__link" href="#6-seed-metadata">
<span class="md-ellipsis">
1.7 Metadata embedding
6. Seed metadata
</span>
</a>
<nav aria-label="6. Seed metadata" class="md-nav">
<ul class="md-nav__list">
<li class="md-nav__item">
<a class="md-nav__link" href="#61-meta-code-processing">
<span class="md-ellipsis">
6.1 Meta-Code processing
</span>
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#18-metadata-extraction">
<a class="md-nav__link" href="#62-meta-hash-processing">
<span class="md-ellipsis">
1.8 Metadata extraction
6.2 Meta-Hash processing
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#7-metadata-embedding">
<span class="md-ellipsis">
7. Metadata embedding
</span>
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#8-metadata-extraction">
<span class="md-ellipsis">
8. Metadata extraction
</span>
</a>
</li>
</ul>
</nav>
</div>
Expand Down Expand Up @@ -471,18 +535,17 @@ <h1 id="iscc-unit-meta-code"><abbr title="International Standard Content Code">I
developed at the International Organization for Standardization as
<a href="https://www.iso.org/standard/77899.html"><abbr title="International Organization for Standardization">ISO</abbr>/DIS 24138</a></p>
</div>
<h2 id="1-meta-code">1. Meta-Code<a class="headerlink" href="#1-meta-code" title="Permanent link">#</a></h2>
<h3 id="11-general">1.1 General<a class="headerlink" href="#11-general" title="Permanent link">#</a></h3>
<h2 id="1-general">1. General<a class="headerlink" href="#1-general" title="Permanent link">#</a></h2>
<p>The Meta-Code is a <abbr title="hash that preserves correlations between inputs to the hash algorithm">similarity hash</abbr> generated from <abbr title="that which is identified">referent</abbr> <abbr title="initial metadata used as input to a hash function">seed metadata</abbr> as defined in
<a href="../iep-0012/">IEP-0012</a></p>
<h3 id="12-purpose">1.2 Purpose<a class="headerlink" href="#12-purpose" title="Permanent link">#</a></h3>
<h2 id="2-purpose">2. Purpose<a class="headerlink" href="#2-purpose" title="Permanent link">#</a></h2>
<p>The Meta-Code shall support the following use cases:</p>
<ol>
<li>clustering of digital assets based on their <abbr title="data that defines and describes other data">metadata</abbr>;</li>
<li>discovery of digital assets with similar <abbr title="data that defines and describes other data">metadata</abbr>;</li>
<li>verification or manual disambiguation of matching codes.</li>
</ol>
<h3 id="13-format">1.3 Format<a class="headerlink" href="#13-format" title="Permanent link">#</a></h3>
<h2 id="3-format">3. Format<a class="headerlink" href="#3-format" title="Permanent link">#</a></h2>
<p>The Meta-Code shall have the <abbr title="ordered sequence of bits">data</abbr> format as illustrated in Figure 2:</p>
<figure>
<p><a class="glightbox" href="../images/iscc-iep-0002-f02-meta-code.png"><img alt="Figure 2 - Data format of the Meta-Code" src="../images/iscc-iep-0002-f02-meta-code.png"/></a>
Expand All @@ -497,7 +560,7 @@ <h3 id="13-format">1.3 Format<a class="headerlink" href="#13-format" title="Perm
<p class="admonition-title">EXAMPLE: 256-<abbr title="atomic unit of information in a computer system">bit</abbr> Meta-Code in its canonical form:</p>
<p><abbr title="International Standard Content Code">ISCC</abbr>:AADUL6P7RMVNT4UJJ4SMTDXBL5JFZ5XPCDKO42XYPJEVQ4L7PTYDORQ</p>
</div>
<h3 id="14-inputs">1.4 Inputs<a class="headerlink" href="#14-inputs" title="Permanent link">#</a></h3>
<h2 id="4-inputs">4. Inputs<a class="headerlink" href="#4-inputs" title="Permanent link">#</a></h2>
<p>Seed <abbr title="data that defines and describes other data">metadata</abbr> is the <abbr title="data that defines and describes other data">metadata</abbr> that is used as the input to calculate the Meta-Code and has three
possible elements:</p>
<ol>
Expand All @@ -517,15 +580,15 @@ <h3 id="14-inputs">1.4 Inputs<a class="headerlink" href="#14-inputs" title="Perm
<p>The <abbr title="sequence of characters that uniquely denotes a referent">identifier</abbr> standards and their schemas defined by <abbr title="International Organization for Standardization">ISO</abbr>/TC 46/SC 9 provide helpful guidance
in selecting <abbr title="initial metadata used as input to a hash function">seed metadata</abbr>.</p>
</div>
<h4 id="141-name-element">1.4.1 name element<a class="headerlink" href="#141-name-element" title="Permanent link">#</a></h4>
<h3 id="41-name-element">4.1 name element<a class="headerlink" href="#41-name-element" title="Permanent link">#</a></h3>
<p>The text input for the name element shall be pre-processed before similarity hashing as follows:</p>
<ol>
<li>Apply <abbr title="International Organization for Standardization">ISO</abbr>/IEC 10646 NFKC Unicode Normalization (see Unicode Normalization Forms <a href="https://unicode.org/reports/tr15/#Norm_Forms">https://unicode.org/reports/tr15/#Norm_Forms</a>). </li>
<li>Remove control characters (see Unicode Character Database <a href="https://www.unicode.org/ucd/">https://www.unicode.org/ucd/</a>). </li>
<li>Strip leading and trailing whitespace. </li>
<li>Trim the end of the text such that the UTF-8 encoded size does not exceed 128 bytes.</li>
</ol>
<h4 id="142-description-element">1.4.2 description element<a class="headerlink" href="#142-description-element" title="Permanent link">#</a></h4>
<h3 id="42-description-element">4.2 description element<a class="headerlink" href="#42-description-element" title="Permanent link">#</a></h3>
<p>Text input for the description element shall be pre-processed before similarity hashing as follows:</p>
<ol>
<li>Apply NFKC Unicode Normalization.</li>
Expand All @@ -542,7 +605,7 @@ <h4 id="142-description-element">1.4.2 description element<a class="headerlink"
<li>Collapse more than two consecutive newlines characters to a maximum of two consecutive newlines.</li>
<li>Strip leading and trailing whitespace characters.</li>
</ol>
<h4 id="143-meta-element">1.4.3 meta element<a class="headerlink" href="#143-meta-element" title="Permanent link">#</a></h4>
<h3 id="43-meta-element">4.3 meta element<a class="headerlink" href="#43-meta-element" title="Permanent link">#</a></h3>
<ol>
<li>The value of the meta element shall be wrapped in a RFC 2397 Data-URL.</li>
<li>The value of the meta element may include any conceivable and supportive <abbr title="data that defines and describes other data">metadata</abbr> such as for example:<ul>
Expand All @@ -563,7 +626,7 @@ <h4 id="143-meta-element">1.4.3 meta element<a class="headerlink" href="#143-met
</ol>
</li>
</ol>
<h3 id="15-outputs">1.5 Outputs<a class="headerlink" href="#15-outputs" title="Permanent link">#</a></h3>
<h2 id="5-outputs">5. Outputs<a class="headerlink" href="#5-outputs" title="Permanent link">#</a></h2>
<p>Meta-Code processing shall generate the following output elements for inclusion into the produced
<abbr title="International Standard Content Code">ISCC</abbr> <abbr title="data that defines and describes other data">metadata</abbr>:</p>
<ol>
Expand All @@ -581,8 +644,8 @@ <h3 id="15-outputs">1.5 Outputs<a class="headerlink" href="#15-outputs" title="P
<p class="admonition-title">NOTE 2</p>
<p>An <abbr title="application that generates ISCCs for digital content">ISCC processor</abbr> may produce other custom output elements, which are helpful to identify the <abbr title="file or stream encoded in conformance with a specific content format">digital asset</abbr>.</p>
</div>
<h3 id="16-seed-metadata">1.6 Seed <abbr title="data that defines and describes other data">metadata</abbr><a class="headerlink" href="#16-seed-metadata" title="Permanent link">#</a></h3>
<h4 id="161-meta-code-processing">1.6.1 Meta-Code processing<a class="headerlink" href="#161-meta-code-processing" title="Permanent link">#</a></h4>
<h2 id="6-seed-metadata">6. Seed <abbr title="data that defines and describes other data">metadata</abbr><a class="headerlink" href="#6-seed-metadata" title="Permanent link">#</a></h2>
<h3 id="61-meta-code-processing">6.1 Meta-Code processing<a class="headerlink" href="#61-meta-code-processing" title="Permanent link">#</a></h3>
<p>The Meta-Code shall be constructed from 2 similarity hashes interleaved in 32-<abbr title="atomic unit of information in a computer system">bit</abbr> chunks by
selecting the elements according to the <abbr title="set of instructions">algorithm</abbr> illustrated in Figure 3.</p>
<figure>
Expand All @@ -597,7 +660,7 @@ <h4 id="161-meta-code-processing">1.6.1 Meta-Code processing<a class="headerlink
<li>If the meta element is unavailable, the second part of the <abbr title="hash that preserves correlations between inputs to the hash algorithm">similarity hash</abbr> shall be generated from the description element.</li>
<li>If the description element is unavailable, the second part of the <abbr title="hash that preserves correlations between inputs to the hash algorithm">similarity hash</abbr> shall also be generated from the name element.</li>
</ol>
<h4 id="162-meta-hash-processing">1.6.2 Meta-Hash processing<a class="headerlink" href="#162-meta-hash-processing" title="Permanent link">#</a></h4>
<h3 id="62-meta-hash-processing">6.2 Meta-Hash processing<a class="headerlink" href="#62-meta-hash-processing" title="Permanent link">#</a></h3>
<p>The Meta-Hash shall be constructed from the <abbr title="initial metadata used as input to a hash function">seed metadata</abbr> by selecting input elements according to
the <abbr title="set of instructions">algorithm</abbr> illustrated in Figure 4.</p>
<figure>
Expand All @@ -611,7 +674,7 @@ <h4 id="162-meta-hash-processing">1.6.2 Meta-Hash processing<a class="headerlink
<li>If the meta element is unavailable, but the description element is available, the space-concatenated value of the pre-processed name and description shall be the input to the <abbr title="computationally efficient function mapping binary strings of arbitrary length to binary strings of fixed length, such that it is computationally infeasible to find two distinct values that hash into a common value">cryptographic hash function</abbr>.</li>
<li>If only the name element is available, its pre-processed value shall be the input to the <abbr title="computationally efficient function mapping binary strings of arbitrary length to binary strings of fixed length, such that it is computationally infeasible to find two distinct values that hash into a common value">cryptographic hash function</abbr>.</li>
</ol>
<h3 id="17-metadata-embedding">1.7 Metadata embedding<a class="headerlink" href="#17-metadata-embedding" title="Permanent link">#</a></h3>
<h2 id="7-metadata-embedding">7. Metadata embedding<a class="headerlink" href="#7-metadata-embedding" title="Permanent link">#</a></h2>
<ol>
<li>Seed <abbr title="data that defines and describes other data">metadata</abbr> shall be embedded into the processed <abbr title="file or stream encoded in conformance with a specific content format">digital asset</abbr> if:<ol>
<li><abbr title="initial metadata used as input to a hash function">seed metadata</abbr> values have been provided explicitly to an <abbr title="application that generates ISCCs for digital content">ISCC processor</abbr>;</li>
Expand All @@ -628,7 +691,7 @@ <h3 id="17-metadata-embedding">1.7 Metadata embedding<a class="headerlink" href=
<li>If <abbr title="initial metadata used as input to a hash function">seed metadata</abbr> is to be embedded, it shall be embedded before processing other <abbr title="International Standard Content Code">ISCC</abbr>-UNITs.</li>
<li>An <abbr title="application that generates ISCCs for digital content">ISCC processor</abbr> should document for which media types it supports <abbr title="data that defines and describes other data">metadata</abbr>-embedding and how it maps <abbr title="initial metadata used as input to a hash function">seed metadata</abbr> to format specific elements.</li>
</ol>
<h3 id="18-metadata-extraction">1.8 Metadata extraction<a class="headerlink" href="#18-metadata-extraction" title="Permanent link">#</a></h3>
<h2 id="8-metadata-extraction">8. Metadata extraction<a class="headerlink" href="#8-metadata-extraction" title="Permanent link">#</a></h2>
<ol>
<li>An <abbr title="application that generates ISCCs for digital content">ISCC processor</abbr> shall try to extract <abbr title="initial metadata used as input to a hash function">seed metadata</abbr> from the <abbr title="file or stream encoded in conformance with a specific content format">digital asset</abbr> if:<ol>
<li><abbr title="initial metadata used as input to a hash function">seed metadata</abbr> has not been provided explicitly to the <abbr title="application that generates ISCCs for digital content">ISCC processor</abbr>;</li>
Expand Down
2 changes: 1 addition & 1 deletion search/search_index.json

Large diffs are not rendered by default.

Binary file modified sitemap.xml.gz
Binary file not shown.

0 comments on commit b25a47b

Please sign in to comment.