Updates for first release

.gitignore

@@ -14,6 +14,7 @@
 .env.development.local
 .env.test.local
 .env.production.local
+.vscode
 
 npm-debug.log*
 yarn-debug.log*

docs/more/glossary.md

@@ -4,17 +4,39 @@ sidebar_position: 1
 
 # Glossary
 
+## Templating
+
+### System
+
+See [below](#component-system).
+
+### Configuration
+
+A system configuration corresponds to the specification of the type and layout of the equipment and the corresponding control logic. Systems with different capacities may have the same configuration, provided they have the same control software and hardware type.
+
+### Parameterization
+
+By parameterization we mean all possible class modifications, such as changing parameter values and redeclaring components or classes, which we refer to as class parameterization.
+
+### Structural and value parameters
+
+We use the term structural parameters if a parameter affects the number and structure of the equations, and value parameters if they do not. An example of a structural parameter is a parameter used to specify an array size.
+
+###  Template
+
+A template, or template class, is defined as a Modelica model that can be parameterized (as defined above) to represent a particular system configuration.
+
+
+## HVAC Systems
+
 ### Source, Load
 
 We adopt the definitions from [ASHRAE (2021)](./references#Ashrae21) Section 5.1.19.1.
 
-> A component is a “source” if it provides resources to a downstream component, such as a chiller providing chilled water (CHW) to an AHU.
->
-> A component is a “load” if it receives resources from an upstream component, such as an AHU that receives CHW from a chiller.
->
+> A component is a “source” if it provides resources to a downstream component, such as a chiller providing chilled water (CHW) to an AHU.<br />
+> A component is a “load” if it receives resources from an upstream component, such as an AHU that receives CHW from a chiller.<br />
 > The same component may be both a load (receiving resources from an upstream source) and a source (providing resources to a downstream load).
 
-
 ### Component, System
 
 We adopt the definitions from [ASHRAE (2021)](./references#Ashrae21) Section 5.1.19.1.

docs/more/nomenclature.md

@@ -4,7 +4,14 @@ sidebar_position: 2
 
 # Nomenclature
 
-This provides conventions mainly for variable naming, marginally for component naming.
+This section provides conventions mainly for variable naming, marginally for component naming.
+
+
+## Example of Control Point Naming
+
+By way of introduction, here is an example of how the following rules translate into practical nomenclature for the CHW plant template.
+
+<iframe src="https://docs.google.com/document/d/1LeutsY9__ClaIEjmvRHkIAMGX5dlW0Xo1BFGvJTHjs4/preview" frameborder="0" allowfullscreen width="100%" height="500"></iframe>
 
 
 ## Control Points
@@ -68,7 +75,7 @@ In the CamelCase instance name:
 
     Similarly (exhaustive list):
 
-    - `TOut` (air implied)
+    - `TOut` or `phiOut` (air implied)
     - `TZon` (air implied)
     - `pBui_rel` (air implied)
 
@@ -80,7 +87,7 @@ All CamelCase morphemes should be used before the first underscore&mdash;such as
 
 :::danger NO
 
-Three-letter capital abbreviations are only allowed&mdash;and encouraged&mdash;in documentation and description strings.
+3-letter capital abbreviations are only allowed&mdash;and encouraged&mdash;in documentation and description strings.
 
 :::
 
@@ -96,13 +103,13 @@ For variable and instance names:
 | Eco        | WSE        |
 | Hex        | HX         |
 | AirHan     | AHU        |
-| Tow        | CT         |
-| yLoa       | PLR        |
+| Coo        | CT         |
 
 Tolerated exceptions:
 
 - COP
 - VAV
+- PLR
 
 
 ## Fixed Position or Non-abbreviated Forms
@@ -112,6 +119,7 @@ Tolerated exceptions:
   <details>
 
   `min` and `max` are attributes of primitive types in Modelica, same as `nominal`, and should have the same notation, not Min and Max in CamelCase.
+
   </details>
 
 - For design conditions use `_nominal` not `Des`
@@ -157,11 +165,11 @@ For instance a sensor for supply air temperature should be named `TAirSup` inste
 
 ### Various
 
-`Set` for a set point, always as the last morpheme. So `TZonHeaOccSet` not `TZonHeaSetOcc`.
+`Set` for a set point, always as the last morpheme: so `TZonHeaOccSet` not `TZonHeaSetOcc`.
 
-The letter `n` is used to represent a number of something (as opposed to num).
+The letter `n` is used to represent a number of something (as opposed to `num`).
 
-The letter `y` is used  to represent a fractional quantity (speed, opening, load) taking 1 as maximum value, for instance `yLoa` for PLR.
+The letter `y` is used to represent a fractional quantity (speed, opening, load) taking $1$ as maximum value, for instance `yLoa` for PLR.
 
 :::tip
 
@@ -170,6 +178,7 @@ The letter `y` is used  to represent a fractional quantity (speed, opening, load
   - Prefer `cfg` to `con` for a configuration.
 
   - Prefer `lck` to `loc` for lock-out as the latter is too loose: local, etc.
+
 :::
 
 

docs/more/references.md

@@ -6,22 +6,16 @@ sidebar_position: 3
 
 ## Published
 
-<a id="Ashrae21"></a>
+###### ASHRAE (2021). Guideline 36 &ndash; High-performance sequences of operation for HVAC systems. ASHRAE. {#Ashrae21}
 
-ASHRAE (2021). Guideline 36 &ndash; High-performance sequences of operation for HVAC systems. ASHRAE.
+###### Gautier, A., Wetter, M., Hu, J., & Tummescheit, H. (In press). HVAC and control templates for the Modelica Buildings library. *Proceedings of the 15th International Modelica Conference*. {#Gautier23}
 
-<!-- <a id="Gautier23"></a>
-
-[Gautier, A., Wetter, M., Hu, J., & Tummescheit, H. (In press). HVAC and control templates for the Modelica Buildings library. *Proceedings of the 15th International Modelica Conference*.](/pdf/2023_modelica_templates.pdf) -->
-
-<a id="Modelica21"></a>
-
-Modelica Association (2021). Modelica &ndash; A unified object-oriented language for systems modeling &ndash; Language specification (Version 3.5). https://specification.modelica.org/maint/3.5/MLS.html
+###### Modelica Association (2021). Modelica &ndash; A unified object-oriented language for systems modeling &ndash; Language specification (Version 3.5). https://specification.modelica.org/maint/3.5/MLS.html {#Modelica21}
 
 ## Internal Resources
 
-[Specification of the Modelica Export](https://docs.google.com/document/d/11U0WLoYjK5e1qSmSc87V1GTrteD40b7__k1ulSDa7kk/edit?usp=sharing)
+###### [Specification of the Modelica Export](https://docs.google.com/document/d/11U0WLoYjK5e1qSmSc87V1GTrteD40b7__k1ulSDa7kk/edit?usp=sharing)
 
-[Specification of the Equipment Schedule](https://docs.google.com/document/d/16Z8HqTi3vNV3HUaa4ijBPVSQvA4MyGTu8bxoGTBD2YI/edit?usp=sharing)
+###### [Specification of the Equipment Schedule](https://docs.google.com/document/d/16Z8HqTi3vNV3HUaa4ijBPVSQvA4MyGTu8bxoGTBD2YI/edit?usp=sharing)
 
-[Specification of Parameter Dialogs](https://docs.google.com/document/d/1eFkCcZLmoi3Pkj9no54RaoPtwLqClGfx7cp7g8ORnZQ/edit?usp=sharing)
+###### [Specification of Parameter Dialogs](https://docs.google.com/document/d/1eFkCcZLmoi3Pkj9no54RaoPtwLqClGfx7cp7g8ORnZQ/edit?usp=sharing)

docusaurus.config.js

@@ -28,6 +28,9 @@ const config = {
   tagline: 'Modelica Template Development Guide',
   favicon: 'img/favicon.ico',
 
+  onBrokenLinks: 'throw',
+  onBrokenMarkdownLinks: 'throw',
+
   // Set the production url of your site here
   url: 'https://antoinegautier.github.io',
   // Set the /<baseUrl>/ pathname under which your site is served
@@ -64,6 +67,8 @@ const config = {
           sidebarPath: require.resolve('./sidebars.js'),
           remarkPlugins: [math],
           rehypePlugins: [katex],
+          showLastUpdateAuthor: true,
+          showLastUpdateTime: true,
         },
         theme: {
           customCss: require.resolve('./src/css/custom.css'),

src/components/HomepageFeatures/index.js

@@ -15,7 +15,7 @@ const FeatureList = [
     title: 'Version',
     description: (
       <>
-        0.x (draft)
+        1.0 (first release)
       </>
     ),
   }

src/css/custom.css

@@ -5,6 +5,7 @@
  */
 
 /* You can override the default Infima variables here. */
+
 :root {
   --ifm-color-primary: #2e8555;
   --ifm-color-primary-dark: #29784c;
@@ -36,3 +37,17 @@
 [data-theme="dark"] .shiki.light-plus {
   display: none;
 }
+
+article {
+  max-width: 700px;
+  margin-left: auto;
+  margin-right: auto;
+}
+
+h1 { font-size: 2.5rem !important; }
+
+/* h6 is used for entries in the reference list. */
+h6 {
+  font-size: 1rem !important;
+  font-weight: 400 !important;
+}

src/pages/index.js

@@ -2,6 +2,7 @@ import React from 'react';
 import clsx from 'clsx';
 import Link from '@docusaurus/Link';
 import useDocusaurusContext from '@docusaurus/useDocusaurusContext';
+import Heading from '@theme/Heading';
 import Layout from '@theme/Layout';
 import HomepageFeatures from '@site/src/components/HomepageFeatures';
 
@@ -18,7 +19,7 @@ function HomepageHeader() {
           <Link
             className="button button--secondary button--lg"
             to="/guide">
-            Go to guide
+            Get Started
           </Link>
         </div>
       </div>
@@ -30,7 +31,7 @@ export default function Home() {
   const {siteConfig} = useDocusaurusContext();
   return (
     <Layout
-      title={`Hello from ${siteConfig.title}`}
+      title={`Home`}
       description="Description will go into a meta tag in <head />">
       <HomepageHeader />
       <main>