re-organized code layout, integrate Deno to bundle modules, update build options and docs

Author: R. S. Doiel

CITATION.cff

@@ -3,7 +3,7 @@ cff-version: 1.2.0
 message: "If you use this software, please cite it as below."
 type: software
 title: CL-web-components
-abstract: "CL-web-components provides a collection of Web Components used by Caltech Library in various web sites and projects.
+abstract: "CL-web-components provides a collection of Web Components used by Caltech Library across sites and projects.
 
 The following are the components currently provided.
 
@@ -24,6 +24,10 @@ authors:
     given-names: R. S.
     orcid: https://orcid.org/0000-0003-0900-6903
     email: [email protected]
+  - family-names: Smith
+    given-names: Twila
+    orcid: https://orcid.org/0009-0003-7975-1922
+    email: [email protected]
 
 contacts:
   - family-names: Doiel
@@ -32,8 +36,8 @@ contacts:
     email: [email protected]
 
 repository-code: "https://github.com/caltechlibrary/CL-web-components"
-version: 0.0.11
-date-released: 2025-07-07
+version: 0.0.12
+date-released: 2025-07-17
 
 license-url: "https://caltechlibrary.github.io/CL-web-components/LICENSE"
 keywords:

DEVELOPERS.html

@@ -20,9 +20,12 @@
 <section>
 <h1 id="developer-notes">Developer Notes</h1>
 <p>This is a new endeavor for Caltech Library. Our practices are
-evolving as we develop this project and we periodically make course
-corrections. In I hope to highlight approaches or technique that proved
-useful.</p>
+evolving as we develop this project. You should expected periodically
+make course corrections. The following documentation will highlight our
+approaches and techniques to solving the challenges of developing a web
+component library for libraries, archives and museums.</p>
+<p>See the <a href="user_manual.html">user manual</a> for developer
+documentation.</p>
 </section>
 </body>
 </html>

DEVELOPERS.md

@@ -1,7 +1,7 @@
 
 # Developer Notes
 
-This is a new endeavor for Caltech Library. Our practices are evolving as we develop this project. You should expected periodically make course corrections. The following documentation will highlight our approaches and techiniquess to solving the challenges of developing a web component library for libraries, archives and museums.
+This is a new endeavor for Caltech Library. Our practices are evolving as we develop this project. You should expected periodically make course corrections. The following documentation will highlight our approaches and techniques to solving the challenges of developing a web component library for libraries, archives and museums.
+
+See the [user manual](user_manual.md) for developer documentation.
 
-- [Web Component Naming](web_component_naming.md)
-- [Integrating CSS in Web Compnoents](integrating_css_in_web_components.md)

INSTALL.html

@@ -36,7 +36,7 @@ <h1 id="cl-web-components">CL-web-components</h1>
 number in the filename. The combined bundle includes the version,
 releaseDate, releaseHash and licenseText in the bundle.</p>
 <p>Here’s an example of getting the v0.0.11
-<code>cl-web-compponents.js</code> combined bundled from the release on
+<code>cl-web-components.js</code> combined bundled from the release on
 macOS or Linux.</p>
 <pre><code>curl -L -O https://github.com/caltechlibrary/CL-web-components/releases/download/v0.0.10/cl-web-components-0.0.11.zip
 unzip cl-web-components-0.0.11.zip cl-web-components.js</code></pre>

INSTALL.md

@@ -7,7 +7,7 @@ It recommended that you download the Zip file containing the individual componen
 
 The zip files are provided for each release. They include the release number in the filename. The combined bundle includes the version, releaseDate, releaseHash and licenseText in the bundle.
 
-Here's an example of getting the v0.0.11 `cl-web-compponents.js` combined bundled from the release on macOS or Linux.
+Here's an example of getting the v0.0.11 `cl-web-components.js` combined bundled from the release on macOS or Linux.
 
 ~~~
 curl -L -O https://github.com/caltechlibrary/CL-web-components/releases/download/v0.0.10/cl-web-components-0.0.11.zip

Makefile

@@ -35,7 +35,8 @@ ifeq ($(OS), Windows)
 	EXT = .exe
 endif
 
-build: $(PROGRAMS) CITATION.cff README.md about.md version.js
+build: CITATION.cff README.md about.md version.js
+	deno task build
 
 hash: .FORCE
 	git log --pretty=format:'%h' -n 1
@@ -66,19 +67,17 @@ refresh:
 	git fetch origin
 	git pull origin $(BRANCH)
 
-publish: build website .FORCE
+publish: website .FORCE
 	./publish.bash
 
 clean:
 	-rm *.bak >/dev/null
 	@if [ -d dist ]; then rm -fR dist; fi
 	@if [ -d testout ]; then rm -fR testout; fi
 
-dist: .FORCE
-	@mkdir -p dist
+dist: build .FORCE
 	@rm -fR dist/* >/dev/null 
-	deno bundle --platform=browser --outdir=dist $(WEB_COMPONENTS)
-	deno bundle --platform=browser --output=dist/cl-web-components.js mod.js
+	deno task release
 	cp INSTALL.md dist/
 	cp LICENSE dist/
 	cp about.md dist/

README.md

@@ -1,14 +1,14 @@
 
 
-# CL-web-components 0.0.11
+# CL-web-components
 
-CL-web-components provides a collection of Web Components used by Caltech Library in various web sites and projects.
+CL-web-components provides a collection of Web Components used by Caltech Library across sites and projects.
 
 The following are the components currently provided.
 
 
 `ul-a-to-z`
-: This component takes an innerHTML containing a UL list. The UL list is then turned into an A to Z navigatable UL List. If JavaScript is unavailable then the innerHTML UL remains as a fallback.
+: This component takes an innerHTML containing a UL list. The UL list is then turned into an A to Z navigable UL List. If JavaScript is unavailable then the innerHTML UL remains as a fallback.
 
 `textarea-csv`
 : This is a textarea like component who's innerHTML content is CSV data. The component will display this as an editable table. 
@@ -21,31 +21,42 @@ The following are the components currently provided.
 
 ## Release Notes
 
-- version: 0.0.11
+- version: 0.0.12
 - status: wip
-- released: 2025-07-07
+- released: 2025-07-17
 
-Renamed components to use a prefix of the standard element name they are extending.
+This release includes a re-organization of the project source code. Editable code is now maintained in `src/`.  The bundled versions
+are retained in the root of the repository. Distribution versions are generating in the `dist/` directory.
+
+Deno 2.4.1 or better is now a requirement to build the bundled versions.
+
+Additional documentation has been updated and improved in preparation for eventual integration into the Caltech Library design system.
+The web component, `textarea-csv` now uses the `jsr:@std/csv` library which provides robust CSV support.
 
 
 ### Authors
 
 - Doiel, R. S.
+- Smith, Twila
 
 
 
 ### Maintainers
 
 - Doiel, R. S.
 
+## Software Requirements
 
-## Software Suggestions
+- Deno >= 2.4.1 (for bundling dependencies)
 
-- Deno >= 2.4
-- CMTools >= 0.0.33
+### Software Suggestions
+
+- CMTools >= 0.0.35
 - Pandoc >= 3.1
 
-**Uses: HTML5-compatible web browser**
+#### Runtime platform
+
+HTML5-compatible web browser**
 
 ## Related resources
 

about.html

@@ -19,21 +19,32 @@
 </nav>
 <section>
 <h1 id="about-this-software">About this software</h1>
-<h2 id="cl-web-components-0.0.11">CL-web-components 0.0.11</h2>
-<p>Renamed components to use a prefix of the standard element name they
-are extending.</p>
+<h2 id="cl-web-components-0.0.12">CL-web-components 0.0.12</h2>
+<p>This release includes a re-organization of the project source code.
+Editable code is now maintained in `src/`. The bundled versions are
+retained in the root of the repository. Distribution versions are
+generating in the `dist/` directory.</p>
+<p>Deno 2.4.1 or better is now a requirement to build the bundled
+versions.</p>
+<p>Additional documentation has been updated and improved in preparation
+for eventual integration into the Caltech Library design system. The web
+component, `textarea-csv` now uses the `jsr:<span class="citation"
+data-cites="std/csv">@std/csv</span>` library which provides robusts CSV
+support.</p>
 <h3 id="authors">Authors</h3>
 <ul>
 <li>R. S. Doiel, <a href="https://orcid.org/0000-0003-0900-6903"
 class="uri">https://orcid.org/0000-0003-0900-6903</a></li>
+<li>Twila Smith, <a href="https://orcid.org/0009-0003-7975-1922"
+class="uri">https://orcid.org/0009-0003-7975-1922</a></li>
 </ul>
 <h3 id="maintainers">Maintainers</h3>
 <ul>
 <li>R. S. Doiel, <a href="https://orcid.org/0000-0003-0900-6903"
 class="uri">https://orcid.org/0000-0003-0900-6903</a></li>
 </ul>
 <p>CL-web-components provides a collection of Web Components used by
-Caltech Library in various web sites and projects.</p>
+Caltech Library across sites and projects.</p>
 <p>The following are the components currently provided.</p>
 <dl>
 <dt>`ul-a-to-z`</dt>
@@ -76,10 +87,13 @@ <h3 id="programming-languages">Programming languages</h3>
 <li>HTML</li>
 <li>CSS</li>
 </ul>
+<h3 id="software-requirements">Software Requirements</h3>
+<ul>
+<li>Deno &gt;= 2.4.1 (for bundling dependencies)</li>
+</ul>
 <h3 id="software-suggestions">Software Suggestions</h3>
 <ul>
-<li>Deno &gt;= 2.4</li>
-<li>CMTools &gt;= 0.0.33</li>
+<li>CMTools &gt;= 0.0.35</li>
 <li>Pandoc &gt;= 3.1</li>
 </ul>
 </section>

about.md

@@ -1,6 +1,6 @@
 ---
 title: CL-web-components
-abstract: "CL-web-components provides a collection of Web Components used by Caltech Library in various web sites and projects.
+abstract: "CL-web-components provides a collection of Web Components used by Caltech Library across sites and projects.
 
 The following are the components currently provided.
 
@@ -20,6 +20,9 @@ authors:
   - family_name: Doiel
     given_name: R. S.
     id: https://orcid.org/0000-0003-0900-6903
+  - family_name: Smith
+    given_name: Twila
+    id: https://orcid.org/0009-0003-7975-1922
 
 
 maintainer:
@@ -28,7 +31,7 @@ maintainer:
     id: https://orcid.org/0000-0003-0900-6903
 
 repository_code: https://github.com/caltechlibrary/CL-web-components
-version: 0.0.11
+version: 0.0.12
 license_url: https://caltechlibrary.github.io/CL-web-components/LICENSE
 
 programming_language:
@@ -43,19 +46,26 @@ keywords:
   - ES6
   - Web Components
 
-date_released: 2025-07-07
+date_released: 2025-07-17
 ---
 
 About this software
 ===================
 
-## CL-web-components 0.0.11
+## CL-web-components 0.0.12
 
-Renamed components to use a prefix of the standard element name they are extending.
+This release includes a re-organization of the project source code. Editable code is now maintained in `src/`.  The bundled versions
+are retained in the root of the repository. Distribution versions are generating in the `dist/` directory.
+
+Deno 2.4.1 or better is now a requirement to build the bundled versions.
+
+Additional documentation has been updated and improved in preparation for eventual integration into the Caltech Library design system.
+The web component, `textarea-csv` now uses the `jsr:@std/csv` library which provides robusts CSV support.
 
 ### Authors
 
 - R. S. Doiel, <https://orcid.org/0000-0003-0900-6903>
+- Twila Smith, <https://orcid.org/0009-0003-7975-1922>
 
 
 
@@ -65,7 +75,7 @@ Renamed components to use a prefix of the standard element name they are extendi
 - R. S. Doiel, <https://orcid.org/0000-0003-0900-6903>
 
 
-CL-web-components provides a collection of Web Components used by Caltech Library in various web sites and projects.
+CL-web-components provides a collection of Web Components used by Caltech Library across sites and projects.
 
 The following are the components currently provided.
 
@@ -95,12 +105,14 @@ The following are the components currently provided.
 
 
 
+### Software Requirements
+
+- Deno &gt;&#x3D; 2.4.1 (for bundling dependencies)
 
 
 ### Software Suggestions
 
-- Deno &gt;&#x3D; 2.4
-- CMTools &gt;&#x3D; 0.0.33
+- CMTools &gt;&#x3D; 0.0.35
 - Pandoc &gt;&#x3D; 3.1
 
 

building_web_components_with_deno.html

@@ -0,0 +1,75 @@
+<!DOCTYPE html>
+<html lang="en-US">
+<head>
+    <title>CL-web-components</title>
+    <link rel="stylesheet" href="/css/site.css">
+</head>
+<body>
+<nav>
+<ul>
+    <li><a href="/">Home</a></li>
+    <li><a href="index.html">README</a></li>
+    <li><a href="LICENSE">LICENSE</a></li>
+    <li><a href="user_manual.html">User Manual</a></li>
+    <li><a href="INSTALL.html">INSTALL</a></li>
+    <li><a href="about.html">About</a></li>
+    <li><a href="search.html">Search</a></li>
+    <li><a href="https://github.com/caltechlibrary/CL-web-components">GitHub</a></li>
+</ul>
+</nav>
+<section>
+<h1 id="building-web-components-with-deno">Building Web Components with
+Deno</h1>
+<p>Web components run in the browser as JavaScript. Generally speaking
+their built as independent modules. There is a growing library of
+standard modules at <a href="https://jsr.io"
+class="uri">https://jsr.io</a>. The standard modules work in Deno as
+well as the browser. This includes useful libraries like
+<code>@std/csv</code>, <code>@std/path</code> and
+<code>@std/yaml</code>. The referencing an import of these by full URLs
+is not ideal. It makes much more sense to take advantage Deno which
+provides additional functionality like check, lint, fmt and bundle. The
+last item is important for web components. With bundle we can generate a
+a web component including it’s dependent modules. This gives us much
+more reliability in deployments and flexibility of moving code between
+browser and server.</p>
+<h2 id="un-bundled-sources">Un-bundled sources</h2>
+<p>If you are working on a web component the un-bundled source should be
+placed in the <code>src/</code> directory. This allows you to include
+remote and local modules easily. The build process maintains the
+<code>version.js</code> module which includes the versioning of this
+repository as well as license text.</p>
+<p>Current the following component(s) <strong>require</strong> bundling
+due to external dependencies.</p>
+<ul>
+<li><a href="src/textarea-csv.js">src/textarea-csv.js</a>, uses
+<code>@std/csv</code></li>
+</ul>
+<p>You can build local bundles and test versions using the following
+Deno task command.</p>
+<pre class="shell"><code>deno task build</code></pre>
+<h2 id="building-cl-web-components">Building CL-web-components</h2>
+<p>The process to build a release is a little more complex than is
+convenient for a Deno task. If your are on macOS or Linux you can use
+GNU Make to run the Makefile.</p>
+<pre class="shell"><code>make build
+make website
+web release</code></pre>
+<p>On Windows you can use the related PowerShell scripts that replace
+make. Example,</p>
+<pre class="pwsh"><code>make.ps1 build
+make.ps1 website
+make.ps1 release</code></pre>
+<p>The “release” option makes the zip files needed for a GitHub release.
+If you are on macOS or Linux you can run the <code>./replace.bash</code>
+script to perform those chores if you have <code>gh</code>
+installed.</p>
+<p>NOTE: The bundled JavaScript files are in the root directory. The
+source are in the <code>src</code> directory. If you need to fix
+something, add something, etc. It should go in the <code>src/</code>
+directory. You may need to either add or edit the tasks in
+<code>deno.json</code>, <code>Makefile</code> or
+<code>make.ps1</code>.</p>
+</section>
+</body>
+</html>