mirror of
https://github.com/ISEAL-Community/iseal-core.git
synced 2024-11-26 08:38:19 +01:00
Alan Orth
286896486e
After running the util/generate_docs.py script to parse and extract the metadata term specifications and their controlled vocabularies, we use Hugo to generate the HTML site. The HTML site uses Bootstrap with several ISEAL brand colors gleaned from the corporate website.
65 lines
3.5 KiB
HTML
65 lines
3.5 KiB
HTML
{{ define "title" }}{{ .Site.Title }}{{ end }}
|
|
|
|
{{ define "main" }}
|
|
|
|
<body data-bs-spy="scroll" data-bs-target="#navbar-navigation">
|
|
<div class="container-fluid">
|
|
<div class="row">
|
|
<!-- only show menu on large devices -->
|
|
<div class="col-lg-2 d-none d-lg-block">
|
|
<div class="sticky-top">
|
|
<nav id="navbar-navigation" class="navbar navbar-light bg-light flex-column align-items-start p-3">
|
|
<a class="navbar-brand" href="#">Navigation</a>
|
|
<nav class="nav nav-pills flex-column">
|
|
<a class="nav-link" href="#metadata">Metadata</a>
|
|
<nav class="nav nav-pills flex-column">
|
|
<a class="nav-link ms-3 my-1" href="#required-metadata">Required Metadata</a>
|
|
<a class="nav-link ms-3 my-1" href="#optional-metadata">Optional Metadata</a>
|
|
</nav>
|
|
<a class="nav-link" href="#feedback">Feedback</a>
|
|
</nav>
|
|
</nav>
|
|
</div>
|
|
</div>
|
|
<!-- main content is 10 columns on large devices, 12 on all others -->
|
|
<main class="col-lg-10">
|
|
<h1>ISEAL Core Schema Specification</h1>
|
|
<p class="lead">This page provides a reference specification for the ISEAL Core Schema.</p>
|
|
<p>In this documentation we list metadata requirements, provide controlled vocabularies, and share technical information about the schema.</p>
|
|
<h2 id="metadata">Metadata</h2>
|
|
<p>ISEAL Core currently uses fields from the following standard metadata schemas:</p>
|
|
<ul>
|
|
<li><a href="https://www.dublincore.org/specifications/dublin-core/dcmi-terms/#section-3">Dublin Core Elements</a> with the <code>dc</code> namespace prefix. These were <a href="http://www.dlib.org/dlib/July95/07weibel.html">originally designated in 1995</a> and are considered deprecated and superseded by Dublin Core Terms. Due to legacy code in the DSpace software we must still use some of these.</li>
|
|
<li><a href="https://www.dublincore.org/specifications/dublin-core/dcmi-terms/#section-2">Dublin Core Terms</a> with the <code>dcterms</code> namespace prefix. These contain the original Dublin Core Terms and add others. As of 2008 these supercede the original Dublin Core Elements.</li>
|
|
</ul>
|
|
<p>General guidelines for metadata using the ISEAL Core Schema:</p>
|
|
<ul>
|
|
<li><strong>Encoding</strong>: metadata should be encoded in UTF-8 to ensure correct representation of international characters.</li>
|
|
<li><strong>Applicability</strong>: metadata should describe what the item is, <em>not what it isn't</em>. If a metadata field is not applicable you should not use it. Do not enter "N/A"!</li>
|
|
</ul>
|
|
<h3 id="required-metadata">Required Metadata</h3>
|
|
|
|
{{ range where (where site.RegularPages "Type" "terms") "Params.required" "==" true }}
|
|
<div class="col">
|
|
{{ .Render "term" }}
|
|
</div>
|
|
{{ end }}
|
|
|
|
<h3 id="optional-metadata">Optional Metadata</h3>
|
|
<p>These fields are optional, but we strongly suggest that you include as many as you can.</p>
|
|
|
|
{{ range where (where site.RegularPages "Type" "terms") "Params.required" "==" false }}
|
|
<div class="col">
|
|
{{ .Render "term" }}
|
|
</div>
|
|
{{ end }}
|
|
<h2 id="feedback">Feedback</h2>
|
|
<p>If you have questions/comments please contact ____.</p>
|
|
</main>
|
|
</div><!-- end .row -->
|
|
</div><!-- end .container-fluid -->
|
|
|
|
{{ end }}
|
|
|
|
{{- /* vim: set ts=2 sw=2 et: */}}
|