chore(rebuild): Merge pull request #70 from will-moore/spec_naming_style

Add camelCase naming style rule SHA: 3ec8d61 Reason: push, by @joshmoore Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
ome · Nov 8, 2021 · dbf30d4 · dbf30d4
1 parent 1feab40
commit dbf30d4
Show file tree

Hide file tree

Showing 4 changed files with 19 additions and 14 deletions.
diff --git a/0.1/index.html b/0.1/index.html
@@ -1489,7 +1489,7 @@
 </style>
   <meta content="Bikeshed version 83b904c2e, updated Wed Nov 3 17:20:53 2021 -0700" name="generator">
   <link href="https://ngff.openmicroscopy.org/0.1/" rel="canonical">
-  <meta content="b5a1f6cd83941e12ce9f12cb015ac8697bbbe764" name="document-revision">
+  <meta content="3ec8d61441a11983f7704537f84c1352509ba029" name="document-revision">
 <style>/* style-autolinks */
 
 .css.css, .property.property, .descriptor.descriptor {
@@ -1825,7 +1825,7 @@
   <div class="head">
     <img alt="OME logo (6 circles in a hexagon)" src="http://www.openmicroscopy.org/img/logos/ome-logomark.svg" style="float:right;width:42px;height:42px;"> 
    <h1 class="p-name no-ref" id="title">Next-generation file formats (NGFF)</h1>
-   <h2 class="no-num no-toc no-ref heading settled" id="subtitle"><span class="content">Final Community Group Report, <time class="dt-updated" datetime="2021-11-04">4 November 2021</time></span></h2>
+   <h2 class="no-num no-toc no-ref heading settled" id="subtitle"><span class="content">Final Community Group Report, <time class="dt-updated" datetime="2021-11-08">8 November 2021</time></span></h2>
    <div data-fill-with="spec-metadata">
     <dl>
      <dt>This version:

diff --git a/0.2/index.html b/0.2/index.html
@@ -1489,7 +1489,7 @@
 </style>
   <meta content="Bikeshed version 83b904c2e, updated Wed Nov 3 17:20:53 2021 -0700" name="generator">
   <link href="https://ngff.openmicroscopy.org/0.2/" rel="canonical">
-  <meta content="b5a1f6cd83941e12ce9f12cb015ac8697bbbe764" name="document-revision">
+  <meta content="3ec8d61441a11983f7704537f84c1352509ba029" name="document-revision">
 <style>/* style-autolinks */
 
 .css.css, .property.property, .descriptor.descriptor {
@@ -1825,7 +1825,7 @@
   <div class="head">
     <img alt="OME logo (6 circles in a hexagon)" src="http://www.openmicroscopy.org/img/logos/ome-logomark.svg" style="float:right;width:42px;height:42px;"> 
    <h1 class="p-name no-ref" id="title">Next-generation file formats (NGFF)</h1>
-   <h2 class="no-num no-toc no-ref heading settled" id="subtitle"><span class="content">Final Community Group Report, <time class="dt-updated" datetime="2021-11-04">4 November 2021</time></span></h2>
+   <h2 class="no-num no-toc no-ref heading settled" id="subtitle"><span class="content">Final Community Group Report, <time class="dt-updated" datetime="2021-11-08">8 November 2021</time></span></h2>
    <div data-fill-with="spec-metadata">
     <dl>
      <dt>This version:

diff --git a/0.3/index.html b/0.3/index.html
@@ -8,7 +8,7 @@
   <link href="https://www.w3.org/2008/site/images/favicon.ico" rel="icon">
   <meta content="Bikeshed version 83b904c2e, updated Wed Nov 3 17:20:53 2021 -0700" name="generator">
   <link href="https://ngff.openmicroscopy.org/0.3/" rel="canonical">
-  <meta content="b5a1f6cd83941e12ce9f12cb015ac8697bbbe764" name="document-revision">
+  <meta content="3ec8d61441a11983f7704537f84c1352509ba029" name="document-revision">
 <style>/* style-autolinks */
 
 .css.css, .property.property, .descriptor.descriptor {
@@ -344,7 +344,7 @@
   <div class="head">
    <p data-fill-with="logo"><a class="logo" href="https://www.w3.org/"> <img alt="W3C" height="48" src="https://www.w3.org/StyleSheets/TR/2016/logos/W3C" width="72"> </a> </p>
    <h1 class="p-name no-ref" id="title">Next-generation file formats (NGFF)</h1>
-   <h2 class="no-num no-toc no-ref heading settled" id="profile-and-date"><span class="content">Final Community Group Report, <time class="dt-updated" datetime="2021-11-04">4 November 2021</time></span></h2>
+   <h2 class="no-num no-toc no-ref heading settled" id="profile-and-date"><span class="content">Final Community Group Report, <time class="dt-updated" datetime="2021-11-08">8 November 2021</time></span></h2>
    <div data-fill-with="spec-metadata">
     <dl>
      <dt>This version:

diff --git a/latest/index.html b/latest/index.html
@@ -1489,7 +1489,7 @@
 </style>
   <meta content="Bikeshed version 83b904c2e, updated Wed Nov 3 17:20:53 2021 -0700" name="generator">
   <link href="https://ngff.openmicroscopy.org/latest/" rel="canonical">
-  <meta content="b5a1f6cd83941e12ce9f12cb015ac8697bbbe764" name="document-revision">
+  <meta content="3ec8d61441a11983f7704537f84c1352509ba029" name="document-revision">
 <style>/* style-autolinks */
 
 .css.css, .property.property, .descriptor.descriptor {
@@ -1825,7 +1825,7 @@
   <div class="head">
     <img alt="OME logo (6 circles in a hexagon)" src="http://www.openmicroscopy.org/img/logos/ome-logomark.svg" style="float:right;width:42px;height:42px;"> 
    <h1 class="p-name no-ref" id="title">Next-generation file formats (NGFF)</h1>
-   <h2 class="no-num no-toc no-ref heading settled" id="subtitle"><span class="content">Editor’s Draft, <time class="dt-updated" datetime="2021-11-04">4 November 2021</time></span></h2>
+   <h2 class="no-num no-toc no-ref heading settled" id="subtitle"><span class="content">Editor’s Draft, <time class="dt-updated" datetime="2021-11-08">8 November 2021</time></span></h2>
    <div data-fill-with="spec-metadata">
     <dl>
      <dt>This version:
@@ -1884,9 +1884,10 @@ <h2 class="no-num no-toc no-ref" id="contents">Table of Contents</h2>
       <li><a href="#plate-md"><span class="secno">3.5</span> <span class="content">"plate" metadata</span></a>
       <li><a href="#well-md"><span class="secno">3.6</span> <span class="content">"well" metadata</span></a>
      </ol>
-    <li><a href="#implementations"><span class="secno">4</span> <span class="content">Implementations</span></a>
-    <li><a href="#citing"><span class="secno">5</span> <span class="content">Citing</span></a>
-    <li><a href="#history"><span class="secno">6</span> <span class="content">Version History</span></a>
+    <li><a href="#naming-style"><span class="secno">4</span> <span class="content">Specification naming style</span></a>
+    <li><a href="#implementations"><span class="secno">5</span> <span class="content">Implementations</span></a>
+    <li><a href="#citing"><span class="secno">6</span> <span class="content">Citing</span></a>
+    <li><a href="#history"><span class="secno">7</span> <span class="content">Version History</span></a>
     <li>
      <a href="#w3c-conformance"><span class="secno"></span> <span class="content">Conformance</span></a>
      <ol class="toc">
@@ -2337,7 +2338,11 @@ <h3 class="heading settled" data-level="3.6" id="well-md"><span class="secno">3.
     <c- f>"version"</c-><c- p>:</c-> <c- u>"0.3"</c->
   <c- p>}</c->
 </pre>
-   <h2 class="heading settled" data-level="4" id="implementations"><span class="secno">4. </span><span class="content">Implementations</span><a class="self-link" href="#implementations"></a></h2>
+   <h2 class="heading settled" data-level="4" id="naming-style"><span class="secno">4. </span><span class="content">Specification naming style</span><a class="self-link" href="#naming-style"></a></h2>
+   <p>Multi-word keys in this specification should use the <code>camelCase</code> style.
+NB: some parts of the specification don’t obey this convention as they
+were added before this was adopted, but they should be updated in due course.</p>
+   <h2 class="heading settled" data-level="5" id="implementations"><span class="secno">5. </span><span class="content">Implementations</span><a class="self-link" href="#implementations"></a></h2>
    <p>Projects which support reading and/or writing OME-NGFF data include:</p>
    <dl>
     <dt><strong><a href="https://github.com/mobie/bigdataviewer-ome-zarr">bigdataviewer-ome-zarr</a></strong>
@@ -2360,11 +2365,11 @@ <h2 class="heading settled" data-level="4" id="implementations"><span class="sec
 version of this diagram is available from the <a href="https://downloads.openmicroscopy.org/presentations/2020/Dundee/Workshops/NGFF/zarr_diagram/">OME2020 Workshop</a>.
 Mouseover the blackboxes representing the implementations above to get a quick tip on how to use them.</p>
    <p class="note" role="note"><span>Note:</span> If you would like to see your project listed, please open an issue or PR on the <a href="https://github.com/ome/ngff">ome/ngff</a> repository.</p>
-   <h2 class="heading settled" data-level="5" id="citing"><span class="secno">5. </span><span class="content">Citing</span><a class="self-link" href="#citing"></a></h2>
+   <h2 class="heading settled" data-level="6" id="citing"><span class="secno">6. </span><span class="content">Citing</span><a class="self-link" href="#citing"></a></h2>
    <p><a href="https://ngff.openmicroscopy.org/0.3">Next-generation file format (NGFF) specifications for storing bioimaging data in the cloud.</a> J. Moore, <em>et al</em>. Editors. Open Microscopy Environment Consortium, 24 August 2021.
 This edition of the specification is <a href="https://ngff.openmicroscopy.org/0.3/]">https://ngff.openmicroscopy.org/0.3/</a>.
 The latest edition is available at <a href="https://ngff.openmicroscopy.org/latest/">https://ngff.openmicroscopy.org/latest/</a>. <a href="https://doi.org/10.5281/zenodo.4282107">(doi:10.5281/zenodo.4282107)</a></p>
-   <h2 class="heading settled" data-level="6" id="history"><span class="secno">6. </span><span class="content">Version History</span><a class="self-link" href="#history"></a></h2>
+   <h2 class="heading settled" data-level="7" id="history"><span class="secno">7. </span><span class="content">Version History</span><a class="self-link" href="#history"></a></h2>
    <table>
     <thead>
      <tr>