Chore/docs2 (#202)

* update docs * add links to docs in readme. * fix thermo link
mussonindustrial · Nov 20, 2024 · 8f93be4 · 8f93be4
1 parent 2daa7d5
commit 8f93be4
Show file tree

Hide file tree

Showing 6 changed files with 55 additions and 22 deletions.
diff --git a/.changeset/curly-olives-fail.md b/.changeset/curly-olives-fail.md
@@ -0,0 +1,5 @@
+---
+"@embr-modules/thermo": patch
+---
+
+(docs) Fix scripting hint signature for `specificGibbsFreeEnergy`.
diff --git a/README.md b/README.md
@@ -12,9 +12,11 @@
 
 [![Build](https://github.com/mussonindustrial/embr/actions/workflows/build.yml/badge.svg)]()
 [![Kotlin](https://img.shields.io/badge/kotlin-2.0.0-blue.svg?logo=kotlin)](http://kotlinlang.org)
-[![Ignition](https://img.shields.io/badge/Ignition-8.1.33+-purple.svg)](https://inductiveautomation.com/)
+[![Ignition](https://img.shields.io/badge/Ignition-8.1.33+-rebeccapurple.svg)](https://inductiveautomation.com/)
 [![License](https://img.shields.io/badge/License-MIT-yellow.svg)](https://github.com/mussonindustrial/embr/blob/main/LICENSE)
 
+[![Documentation](https://img.shields.io/badge/Documentation-docs.mussonindustrial.com-white.svg?logo=docusaurus&style=for-the-badge)](https://docs.mussonindustrial.com/)
+
 </p>
 </div>
 

diff --git a/modules/charts/README.md b/modules/charts/README.md
@@ -1,37 +1,42 @@
 # Embr Charts Module [<img src="https://cdn.mussonindustrial.com/files/public/images/emblem.svg" alt="Musson Industrial Logo" width="90" height="40" align="right">][embr]
 
+[![Build](https://github.com/mussonindustrial/embr/actions/workflows/build.yml/badge.svg)]()
+[![version](https://img.shields.io/github/v/release/mussonindustrial/embr?filter=*charts*&label=Latest)](CHANGELOG.md)
+[![Ignition](https://img.shields.io/badge/Ignition-8.1.33+-rebeccapurple.svg)](https://inductiveautomation.com/)
+[![Documentation](https://img.shields.io/badge/Documentation-docs.mussonindustrial.com-white.svg?logo=docusaurus)](https://docs.mussonindustrial.com/docs/ignition-modules/embr-charts)
+
 An Ignition module that adds a collection of enhanced Perspective charting components.
 
 ## Getting Started
+
 1. Download the [latest version] from [releases].
 2. Install the module through the Ignition Gateway web interface.
 
 ### Module Documentation
-- `#TODO` [Module documentation][documentation]
+
+- [Module documentation] is available at [docs.mussonindustrial.com].
 
 ### Component Directory
+
 | Name                                               | Category  | Description                                                                                                                                                                                                                                                                                       |
 |----------------------------------------------------|-----------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
 | [Chart.js Component](./docs/components/chartjs.md) | Charting  | Chart.js renders chart elements on an HTML5 canvas unlike other D3.js-based charting libraries that render as SVG. Canvas rendering makes Chart.js very performant, especially for large datasets and complex visualizations that would otherwise require thousands of SVG nodes in the DOM tree. |  |
 
 ---
+
 ## Changelog
-The [changelog](./CHANGELOG.md) is regularly updated to reflect what's changed in each new release.
 
+The [changelog](./CHANGELOG.md) is regularly updated to reflect what's changed in each new release.
 
 ## Sponsors
-Maintenance of this project is made possible by all the [contributors] and [sponsors]. 
-If you'd like to sponsor this project and have your avatar or company logo appear below [click here](https://github.com/sponsors/mussonindustrial). 💖
 
+Maintenance of this project is made possible by all the [contributors] and [sponsors].
+If you'd like to sponsor this project and have your avatar or company logo appear below [click here](https://github.com/sponsors/mussonindustrial). 💖
 
 [embr]: https://github.com/mussonindustrial/embr
 [releases]: https://github.com/mussonindustrial/embr/releases
-[documentation]: https://docs.mussonindustrial.com/
+[docs.mussonindustrial.com]: https://docs.mussonindustrial.com
+[Module documentation]: https://docs.mussonindustrial.com/docs/ignition-modules/embr-charts
 [contributors]: https://github.com/JamesIves/github-pages-deploy-action/graphs/contributors
 [sponsors]: https://github.com/sponsors/mussonindustrial
 [latest version]: https://github.com/mussonindustrial/embr/releases?q=embr-charts&expanded=true
-[Chart.js]: https://www.chartjs.org/
-[Chart.js documentation]: https://www.chartjs.org/docs/latest/
-[Chart.js Addons]: https://github.com/chartjs/awesome
-[Swiper]: https://swiperjs.com/
-[Swiper documentation]: https://swiperjs.com/swiper-api#parameters
diff --git a/modules/periscope/README.md b/modules/periscope/README.md
@@ -1,5 +1,10 @@
 # Embr Periscope Module [<img src="https://cdn.mussonindustrial.com/files/public/images/emblem.svg" alt="Musson Industrial Logo" width="90" height="40" align="right">][embr]
 
+[![Build](https://github.com/mussonindustrial/embr/actions/workflows/build.yml/badge.svg)]()
+[![version](https://img.shields.io/github/v/release/mussonindustrial/embr?filter=*periscope*&label=Latest)](CHANGELOG.md)
+[![Ignition](https://img.shields.io/badge/Ignition-8.1.33+-rebeccapurple.svg)](https://inductiveautomation.com/)
+[![Documentation](https://img.shields.io/badge/Documentation-docs.mussonindustrial.com-white.svg?logo=docusaurus)](https://docs.mussonindustrial.com/docs/ignition-modules/embr-periscope)
+
 <div style="border-left: 4px solid #4CAF50; padding: 10px; font-family: Arial, sans-serif;">
 <h3 style="color: #red; margin-top: 0;">Periscope</h3>
   <p><em>A periscope provides a new perspective</em> by allowing users to see over, around, or through obstacles, offering a unique view otherwise obstructed.</p>
@@ -14,7 +19,8 @@ An Ignition module that includes design extensions and enhancements for Perspect
 
 ### Module Documentation
 
-- `#TODO` [Module documentation][documentation]
+- [Module documentation] is available at [docs.mussonindustrial.com].
+
 
 ### Component Directory
 
@@ -35,7 +41,8 @@ If you'd like to sponsor this project and have your avatar or company logo appea
 
 [embr]: https://github.com/mussonindustrial/embr
 [releases]: https://github.com/mussonindustrial/embr/releases
-[documentation]: https://docs.mussonindustrial.com/
+[docs.mussonindustrial.com]: https://docs.mussonindustrial.com
+[Module documentation]: https://docs.mussonindustrial.com/docs/ignition-modules/embr-thermo
 [contributors]: https://github.com/JamesIves/github-pages-deploy-action/graphs/contributors
 [sponsors]: https://github.com/sponsors/mussonindustrial
 [latest version]: https://github.com/mussonindustrial/embr/releases?q=periscope&expanded=true
diff --git a/modules/thermo/README.md b/modules/thermo/README.md
@@ -1,32 +1,44 @@
 # Embr Thermodynamics Module [<img src="https://cdn.mussonindustrial.com/files/public/images/emblem.svg" alt="Musson Industrial Logo" width="90" height="40" align="right">][embr]
 
+[![Build](https://github.com/mussonindustrial/embr/actions/workflows/build.yml/badge.svg)]()
+[![version](https://img.shields.io/github/v/release/mussonindustrial/embr?filter=*thermo*&label=Latest)](CHANGELOG.md)
+[![Ignition](https://img.shields.io/badge/Ignition-8.1.33+-rebeccapurple.svg)](https://inductiveautomation.com/)
+[![Documentation](https://img.shields.io/badge/Documentation-docs.mussonindustrial.com-white.svg?logo=docusaurus)](https://docs.mussonindustrial.com/docs/ignition-modules/embr-thermodynamics)
+
 An Ignition module containing scripting and expression functions for computing properties of steam via an IF97 implementation.
 
+
+
+
 ## Getting Started
+
 1. Download the latest version from [releases].
 2. Install the module through the Ignition Gateway web interface.
 
-## Module Documentation
-- `#TODO` [Module documentation][documentation]
+### Module Documentation
+
+- [Module documentation] is available at [docs.mussonindustrial.com].
 
 ---
 
 ## IAPWS-IF97
+
 IAPWS (_The International Association for the Properties of Water and Steam_) is an international non-profit association of national organizations concerned with the properties of water and steam, particularly thermophysical properties, cycle chemistry guidelines, and other aspects of high-temperature steam, water and aqueous mixtures relevant to thermal power cycles and other industrial and scientific applications.
 
 This formulation ([IAPWS-IF97]) is recommended for industrial use (primarily the steam power industry) for the calculation of thermodynamic properties of ordinary water in its fluid phases, including vapor-liquid equilibrium.
-The formulation is a close approximation to the [IAPWS-IF95] formulation for general and scientific use, but is designed for much greater computational speed. 
+The formulation is a close approximation to the [IAPWS-IF95] formulation for general and scientific use, but is designed for much greater computational speed.
 
-The range of validity is divided into several regions (with close tolerances for consistency at region boundaries), each of which is represented by a different fundamental equation. 
+The range of validity is divided into several regions (with close tolerances for consistency at region boundaries), each of which is represented by a different fundamental equation.
 Appropriate combinations of derivatives from this equation can produce any thermodynamic property desired (density or specific volume, sound speed, heat capacity, enthalpy, entropy, etc.).
-The formulation is valid from 273.15 K to 1073.15 K at pressures to 100 MPa, and there is a high-temperature region extending to 2273.15 K at pressures to 50 MPa. 
+The formulation is valid from 273.15 K to 1073.15 K at pressures to 100 MPa, and there is a high-temperature region extending to 2273.15 K at pressures to 50 MPa.
 There is also a separate equation for metastable steam at pressures up to 10 MPa.
 
 ### Valid Regions
+
 ![if97 regions](docs/if97-regions.png)
 
+### Supported Properties and Parameters
 
-### Supported Properties and Parameters 
 | Property                                   | Symbol | Units       | (p, T) | (p, h) | (p, s) | (h, s) | (T, s) | (ρ, T) | (p, x) | (T, x) |
 |--------------------------------------------|--------|-------------|--------|--------|--------|--------|--------|--------|--------|--------|
 | Absolute pressure                          | p      | Pa          |        |        |        | ✓      |        |        | ✓      | ✓ sat. |
@@ -60,7 +72,6 @@ The following scripting functions are available in all Ignition scopes.
 Each scripting function has a variety of overloads to match the [Table of Supported Properties](#supported-properties-and-parameters).
 The designer scripting hints also list the accepted parameters sets.
 
-
 ```python
 system.thermo.if97.compressibility(h, p, s, t)
 system.thermo.if97.compressionFactor(p, t)
@@ -95,6 +106,7 @@ system.thermo.if97.vaporFraction(h, p, s, t)
 ```
 
 ### Expression Functions
+
 Because expression functions do not support operator overloading (and adding functions to cover all possibilities of parameters is impractical), this module provides a single expression function for accessing all `if97` properties.
 
 `property` is case-insensitive and parameters can be specified in any order.
@@ -110,6 +122,7 @@ if97("vaporFraction", "p", 110000, "t", 1150000)
 ```
 
 ---
+
 ## Changelog
 
 The [changelog](./CHANGELOG.md) is regularly updated to reflect what's changed in each new release.
@@ -122,6 +135,7 @@ Free use of this software is granted under the terms of the MIT License.
 
 [embr]: https://github.com/mussonindustrial/embr
 [releases]: https://github.com/mussonindustrial/embr/releases
-[documentation]: https://docs.mussonindustrial.com/
+[docs.mussonindustrial.com]: https://docs.mussonindustrial.com
+[Module documentation]: https://docs.mussonindustrial.com/docs/ignition-modules/embr-thermo
 [IAPWS-IF97]: http://www.iapws.org/relguide/IF97-Rev.html
 [IAPWS-IF95]: http://www.iapws.org/relguide/IAPWS-95.html
diff --git a/...src/main/resources/com/mussonindustrial/embr/thermo/scripting/IF97ScriptModule.properties b/...src/main/resources/com/mussonindustrial/embr/thermo/scripting/IF97ScriptModule.properties
@@ -69,7 +69,7 @@ specificEntropySaturatedLiquid.returns=specific entropy for saturated liquid (J/
 specificEntropySaturatedVapor.desc=Calculates the specific entropy for saturated vapor.<br><br><b>Accepted parameters:</b><br>specificEntropySaturatedVapor(p)<br>specificEntropySaturatedVapor(t)<br>
 specificEntropySaturatedVapor.returns=specific entropy for saturated vapor (J/(kg·K))
 
-specificGibbsFreeEnergy.desc=Calculates specific Gibbs free energy.<br><br><b>Accepted parameters:</b><br>specificGibbsFreeEnergy(p)<br>specificGibbsFreeEnergy(t)<br>
+specificGibbsFreeEnergy.desc=Calculates specific Gibbs free energy.<br><br><b>Accepted parameters:</b><br>specificGibbsFreeEnergy(p, t)<br>
 specificGibbsFreeEnergy.returns=specific Gibbs free energy (J/kg)
 
 specificInternalEnergy.desc=Calculates specific internal energy.<br><br><b>Accepted parameters:</b><br>specificInternalEnergy(p, h)<br>specificInternalEnergy(p, s)<br>specificInternalEnergy(p, t)<br>specificInternalEnergy(p, x)<br>specificInternalEnergy(t, x)<br>