Skip to content

Commit ed447da

Browse files
author
R. S. Doiel
committed
updated documentation, prep for v0.0.13 release
1 parent 1abb9ce commit ed447da

18 files changed

+212
-17
lines changed

‎DEVELOPERS.html‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,19 @@ <h1 id="developer-notes">Developer Notes</h1>
2626
component library for libraries, archives and museums.</p>
2727
<p>See the <a href="user_manual.html">user manual</a> for developer
2828
documentation.</p>
29+
<h2 id="adding-new-components">Adding new components</h2>
30+
<p>New web components should be placed in the <code>src</code>
31+
directory. This is so they can be bundled into the complete
32+
<code>cl-web-components.js</code>. It also allows us to leverage other
33+
JavaScript or type script packages hosted at <a
34+
href="https://jsr.io">jsr.io</a>. Bundled versions of the components are
35+
presented in the root repository along side the <code>mod.js</code>
36+
file.</p>
37+
<h2 id="updating-existing-web-components">Updating existing web
38+
components</h2>
39+
<p>If you need to update an existing web components you should do so in
40+
the <code>src</code> directory. If you “fix” the one in the root
41+
directory it’ll get overwritten the next time the bundler is run.</p>
2942
</section>
3043
</body>
3144
</html>

‎DEVELOPERS.md‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,3 +5,12 @@ This is a new endeavor for Caltech Library. Our practices are evolving as we dev
55

66
See the [user manual](user_manual.md) for developer documentation.
77

8+
## Adding new components
9+
10+
New web components should be placed in the `src` directory. This is so they can be bundled into the complete `cl-web-components.js`. It also allows us to leverage other JavaScript or type script packages hosted at [jsr.io](https://jsr.io). Bundled versions of the components are presented in the root repository along side the `mod.js` file.
11+
12+
## Updating existing web components
13+
14+
If you need to update an existing web components you should do so in the `src` directory. If you "fix" the one in the root directory it'll get overwritten the next time the bundler is run.
15+
16+

‎INSTALL_NOTES_Windows.html‎

Lines changed: 86 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,86 @@
1+
<!DOCTYPE html>
2+
<html lang="en-US">
3+
<head>
4+
<title>CL-web-components</title>
5+
<link rel="stylesheet" href="/css/site.css">
6+
</head>
7+
<body>
8+
<nav>
9+
<ul>
10+
<li><a href="/">Home</a></li>
11+
<li><a href="index.html">README</a></li>
12+
<li><a href="LICENSE">LICENSE</a></li>
13+
<li><a href="user_manual.html">User Manual</a></li>
14+
<li><a href="INSTALL.html">INSTALL</a></li>
15+
<li><a href="about.html">About</a></li>
16+
<li><a href="search.html">Search</a></li>
17+
<li><a href="https://github.com/caltechlibrary/CL-web-components">GitHub</a></li>
18+
</ul>
19+
</nav>
20+
<section>
21+
<p>Installing an unsigned executable on Windows can also pose security
22+
risks, as Windows has built-in mechanisms to protect users from
23+
potentially harmful software. Here’s a general guide on how to do
24+
it:</p>
25+
<h3 id="steps-to-install-an-unsigned-executable-on-windows">Steps to
26+
Install an Unsigned Executable on Windows</h3>
27+
<ol type="1">
28+
<li><p><strong>Download the Executable</strong>: Download the unsigned
29+
executable file you want to install from a trusted source.</p></li>
30+
<li><p><strong>Locate the File</strong>: Use File Explorer to locate the
31+
downloaded file, which is often in the <code>Downloads</code> folder
32+
unless you specified a different location.</p></li>
33+
<li><p><strong>Attempt to Open the File</strong>: Double-click the file
34+
to open it. Windows may show a warning that the file is not commonly
35+
downloaded and could harm your computer.</p></li>
36+
<li><p><strong>Override Security Settings</strong>:</p>
37+
<ul>
38+
<li><strong>Option 1: Run Anyway</strong>
39+
<ul>
40+
<li>When you see the warning, click on <code>More info</code> in the
41+
dialog box.</li>
42+
<li>A new option will appear to <code>Run anyway</code>. Click this to
43+
proceed with the installation.</li>
44+
</ul></li>
45+
<li><strong>Option 2: Disable Windows Defender SmartScreen
46+
(Temporarily)</strong>
47+
<ul>
48+
<li>Open the Start menu and go to <code>Settings</code>.</li>
49+
<li>Navigate to <code>Update &amp; Security</code> &gt;
50+
<code>Windows Security</code> &gt;
51+
<code>App &amp; browser control</code>.</li>
52+
<li>Under <code>Check apps and files</code>, select <code>Off</code>.
53+
This will disable SmartScreen temporarily.</li>
54+
<li>Try running the executable again.</li>
55+
<li>Remember to turn SmartScreen back on after installation for
56+
continued protection.</li>
57+
</ul></li>
58+
</ul></li>
59+
<li><p><strong>Use Command Prompt (Advanced Users)</strong>: If the
60+
above methods don’t work, you can use the Command Prompt to run the
61+
executable directly:</p>
62+
<ul>
63+
<li>Open Command Prompt as an administrator.</li>
64+
<li>Navigate to the directory where the file is located using the
65+
<code>cd</code> command.</li>
66+
<li>Run the file by typing its name and pressing Enter.</li>
67+
</ul></li>
68+
</ol>
69+
<h3 id="important-considerations">Important Considerations</h3>
70+
<ul>
71+
<li><strong>Security Risks</strong>: Running unsigned executables can
72+
expose your system to malware and other security risks. Only proceed if
73+
you trust the source of the software.</li>
74+
<li><strong>User Account Control (UAC)</strong>: UAC might prompt you
75+
for permission to run the executable. Ensure you have administrative
76+
rights to proceed.</li>
77+
<li><strong>Antivirus Software</strong>: Your antivirus software might
78+
also block unsigned executables. You may need to temporarily disable it
79+
or add an exception for the file.</li>
80+
</ul>
81+
<p>If you’re unsure about any of these steps or the safety of the file,
82+
it’s best to consult with someone who has more experience with Windows
83+
or to contact the software developer for support.</p>
84+
</section>
85+
</body>
86+
</html>

‎INSTALL_NOTES_macOS.html‎

Lines changed: 93 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,93 @@
1+
<!DOCTYPE html>
2+
<html lang="en-US">
3+
<head>
4+
<title>CL-web-components</title>
5+
<link rel="stylesheet" href="/css/site.css">
6+
</head>
7+
<body>
8+
<nav>
9+
<ul>
10+
<li><a href="/">Home</a></li>
11+
<li><a href="index.html">README</a></li>
12+
<li><a href="LICENSE">LICENSE</a></li>
13+
<li><a href="user_manual.html">User Manual</a></li>
14+
<li><a href="INSTALL.html">INSTALL</a></li>
15+
<li><a href="about.html">About</a></li>
16+
<li><a href="search.html">Search</a></li>
17+
<li><a href="https://github.com/caltechlibrary/CL-web-components">GitHub</a></li>
18+
</ul>
19+
</nav>
20+
<section>
21+
<p>Installing an unsigned executable on macOS can be a bit tricky due to
22+
macOS’s security features designed to protect users from potentially
23+
harmful software. Here’s a general guide on how to do it:</p>
24+
<ol type="1">
25+
<li><p><strong>Download the Executable</strong>: First, download the
26+
unsigned executable file you want to install.</p></li>
27+
<li><p><strong>Locate the File</strong>: Use Finder to locate the
28+
downloaded file. It’s often in the <code>Downloads</code> folder unless
29+
you specified a different location.</p></li>
30+
<li><p><strong>Attempt to Open the File</strong>: Double-click the file
31+
to open it. macOS will likely show a warning that the file cannot be
32+
opened because it is from an unidentified developer.</p></li>
33+
<li><p><strong>Override Security Settings</strong>:</p>
34+
<ul>
35+
<li><strong>Option 1: Open via Context Menu</strong>
36+
<ul>
37+
<li>Right-click (or Control-click) the file.</li>
38+
<li>Select <code>Open</code> from the context menu.</li>
39+
<li>You’ll see another warning, but this time there will be an option to
40+
<code>Open</code> the file anyway. Click <code>Open</code>.</li>
41+
</ul></li>
42+
<li><strong>Option 2: Allow Apps from Anywhere (Temporarily)</strong>
43+
<ul>
44+
<li>Open <code>System Preferences</code> and go to
45+
<code>Security &amp; Privacy</code>.</li>
46+
<li>Click the lock icon in the bottom left corner and enter your
47+
password to make changes.</li>
48+
<li>Under the <code>General</code> tab, you might see a message about
49+
the app being blocked. Click <code>Open Anyway</code>.</li>
50+
<li>If you don’t see this option, you can temporarily change the setting
51+
to allow apps downloaded from <code>Anywhere</code>. However, this
52+
option is not available in the latest versions of macOS by default. You
53+
may need to use the Terminal to do this:
54+
<ul>
55+
<li>Open Terminal and type:
56+
<code>sudo spctl --master-disable</code></li>
57+
<li>Press Enter and provide your password.</li>
58+
<li>This will allow you to run apps from anywhere, but it’s recommended
59+
to re-enable security by typing <code>sudo spctl --master-enable</code>
60+
after installing your app.</li>
61+
</ul></li>
62+
</ul></li>
63+
</ul></li>
64+
<li><p><strong>Use Terminal (Advanced Users)</strong>: If the above
65+
methods don’t work, you can use the Terminal to run the executable
66+
directly:</p>
67+
<ul>
68+
<li>Open Terminal.</li>
69+
<li>Navigate to the directory where the file is located using the
70+
<code>cd</code> command.</li>
71+
<li>Make the file executable by typing:
72+
<code>chmod +x filename</code></li>
73+
<li>Run the file by typing: <code>./filename</code></li>
74+
</ul></li>
75+
<li><p><strong>Check for Updates</strong>: Sometimes, developers will
76+
sign their apps later. Check if there’s a signed version available to
77+
avoid these steps in the future.</p></li>
78+
</ol>
79+
<h3 id="important-considerations">Important Considerations</h3>
80+
<ul>
81+
<li><strong>Security Risks</strong>: Running unsigned executables can
82+
expose your system to malware and other security risks. Only proceed if
83+
you trust the source of the software.</li>
84+
<li><strong>System Integrity Protection (SIP)</strong>: Some steps might
85+
be restricted by SIP, which is designed to protect your system.
86+
Disabling SIP is not recommended unless absolutely necessary.</li>
87+
</ul>
88+
<p>If you’re unsure about any of these steps or the safety of the file,
89+
it’s best to consult with someone who has more experience with macOS or
90+
to contact the software developer for support.</p>
91+
</section>
92+
</body>
93+
</html>

‎codemeta.json‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -28,8 +28,8 @@
2828
}
2929
],
3030
"dateCreated": "2025-02-26",
31-
"dateModified": "2025-07-17",
32-
"datePublished": "2025-07-17",
31+
"dateModified": "2025-07-25",
32+
"datePublished": "2025-07-25",
3333
"description": "CL-web-components provides a collection of Web Components used by Caltech Library across sites and projects.\n\nThe following are the components currently provided.\n\n\n`ul-a-to-z`\n: 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.\n\n`textarea-csv`\n: This is a textarea like component who's innerHTML content is CSV data. The component will display this as an editable table. \n\n`textarea-agent-list`\n: This element wraps a textarea containing a list of agents expressed as JSON. \n\n`table-sortable`\n: This is a component that takes an innerHTML containing table. It makes the table sortable by the column headings and provides a filter input that lets you enter text to filter by and pick a column to filter on.",
3434
"funder": [
3535
"Caltech Library"
@@ -61,11 +61,11 @@
6161
"Pandoc >= 3.1",
6262
"PageFind >= 1.3"
6363
],
64-
"version": "0.0.12",
64+
"version": "0.0.13",
6565
"developmentStatus": "wip",
6666
"issueTracker": "https://github.com/caltechlibrary/CL-web-components/issues",
6767
"downloadUrl": "https://github.com/caltechlibrary/CL-web-components/releases",
68-
"releaseNotes": "This release includes a re-organization of the project source code. Editable code is now maintained in `src/`. The bundled versions\nare retained in the root of the repository. Distribution versions are generating in the `dist/` directory.\n\nDeno 2.4.1 or better is now a requirement to build the bundled versions.\n\nAdditional documentation has been updated and improved in preparation for eventual integration into the Caltech Library design system.\nThe web component, `textarea-csv` now uses the `jsr:@std/csv` library which provides robusts CSV support.",
68+
"releaseNotes": "This release includes a re-organization of the project source code. Editable code is now maintained in `src/`. The bundled versions\nare retained in the root of the repository. Distribution versions are generating in the `dist/` directory.\n\nDeno 2.4.2 or better is now a requirement to build the bundled versions.\n\nTwo new web components are now included, `<footer-global></footer-global>` and `<footer-global-lite></footer-global-lite>`.",
6969
"copyrightYear": 2025,
7070
"copyrightHolder": "California Institute of Technology"
7171
}

‎index.html‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,12 @@ <h1 id="cl-web-components">CL-web-components</h1>
4545
the table sortable by the column headings and provides a filter input
4646
that lets you enter text to filter by and pick a column to filter on.
4747
</dd>
48+
<dt><code>footer-global</code></dt>
49+
<dd>
50+
This is a component that inserts a library branded footer into
51+
applications maintained by the library. There is a full and lite version
52+
of the footer available.
53+
</dd>
4854
</dl>
4955
<h2 id="release-notes">Release Notes</h2>
5056
<ul>

‎pagefind/fragment/en-US_1137ab7.pf_fragment‎

1.37 KB
Binary file not shown.

‎pagefind/fragment/en-US_2657bc7.pf_fragment‎

1.22 KB
Binary file not shown.

‎pagefind/fragment/en-US_692f9b6.pf_fragment‎

697 Bytes
Binary file not shown.

‎pagefind/fragment/en-US_6de3b7c.pf_fragment‎

1.18 KB
Binary file not shown.

0 commit comments

Comments
 (0)