ps-wiki · jinningwang · Nov 2, 2025 · Nov 1, 2025 · Nov 1, 2025 · Nov 1, 2025
diff --git a/.github/workflows/deploy.yml b/.github/workflows/deploy.yml
@@ -86,10 +86,23 @@ jobs:
           valueFile: "_config.yml"
           propertyPath: "giscus.repo"
           value: ${{ github.repository }}
-      - name: Install and Build 🔧
+      - name: Install OS packages (ImageMagick)
+        run: |
+          sudo apt-get update
+          sudo apt-get install -y imagemagick
+      - name: Install Python deps
         run: |
-          sudo apt-get update && sudo apt-get install -y imagemagick
           pip3 install --upgrade nbconvert
+          pip3 install -r database/requirements.txt
+      - name: Convert JSON → Markdown
+        run: |
+          python database/pyscripts/json2md_all.py \
+            --in-dir database/json \
+            --out-dir _wiki \
+            --pattern "*.json" \
+            --fail-fast
+      - name: Build Jekyll site
+        run: |
           export JEKYLL_ENV=production
           bundle exec jekyll build
       - name: Purge unused CSS 🧹

diff --git a/.gitignore b/.gitignore
@@ -10,4 +10,10 @@ Gemfile.lock
 assets/libs/
 node_modules/
 vendor
-.idea
+.idea
+
+# Ignore python cache files
+__pycache__/
+
+# local test wiki markdown files
+_wikitest/
diff --git a/README.md b/README.md
@@ -26,6 +26,105 @@ A custom [wiki layout](./_layouts/wiki.liquid) adapted from the `distill` layout
 - **Direct Editing**: A link to edit the term directly on GitHub
 - **Community Engagement**: Integrated Giscus comments
 
+## Database
+
+The folder `database` contains the source data and scripts for generating the wiki:
+
+- Folder `database/json` contains the source JSON files for the wiki.
+- Folder `database/pyscripts` contains Python scripts for processing the data.
+
+### Example JSON File
+
+Use [stability.json](./database/json/stability.json) as a reference for creating new term entries.
+Below is an example structure of a JSON file for a term:
+
+```json
+{
+  "id": "example-term",
+  "title": "Example Term",
+  "description": "A concise description of this concept.",
+  "language": "en",
+  "tags": [
+    // existing tags: https://ps-wiki.github.io/wiki-tag/#all-tags
+    "tag1",
+    "tag2"
+  ],
+  "related": ["other-term-id-1", "other-term-id-2"],
+  "version": "1.0.0", // SemVer version of this term entry
+  "breaking": false, // set to true if there are breaking changes of this term compared to previous version
+  "dates": {
+    "created": "2025-11-01",
+    "last_modified": "2025-11-01"
+  },
+  "authors": [
+    {
+      "name": "Contributor Name",
+      "url": "https://example.com"
+    },
+    {
+      "name": "Another Contributor",
+      "url": "https://example.org"
+    }
+  ],
+  "content": {
+    "sections": [
+      {
+        "order": 1,
+        "id": "definition-by-institution1",
+        "title": "Definition by Institution 1",
+        "type": "definition", // "definition" for quoted content, "note" for others
+        "source_keys": [
+          "key1" // ensure the key exists in assets/bibliography/papers.bib
+        ],
+        "page": "p45", // or "p45, Revision 2" if applicable to indicate specific revision
+        "body_md": "> The ability of an electric power system to maintain a state of equilibrium during normal and abnormal conditions or disturbances.\n",
+        "figures": []
+      },
+      {
+        "order": 2,
+        "id": "elaboration-in-article",
+        "title": "Elaboration in an Article",
+        "type": "definition",
+        "source_keys": [],
+        "page": null,
+        "body_md": "This section elaborates on the concept, its relevance, or provides historical context.\n",
+        "figures": [
+          {
+            "path": "/assets/img/pswiki/example-figure.png",
+            "caption_md": "Fig. 1. Example figure caption. (from <d-cite key=\"example2024reference\"></d-cite>)",
+            "zoomable": true,
+            "source_keys": ["example2024reference"]
+          }
+        ]
+      }
+    ]
+  }
+}
+```
+
+Following conventions should be observed when creating or editing term JSON files:
+
+- File Naming: Each term is stored in a separate JSON file named `<term-id>.json`.
+- The `id` field should match the filename, e.g. stability.json → "id": "stability".
+- The `source_keys` in each section and figure should correspond to entries in the bibliography file located at `assets/bibliography/papers.bib`.
+- The `body_md` field contains the main content in Markdown format. Use standard Markdown syntax for headings, lists, and formatting.
+- Figures should be stored in the `assets/img/pswiki/` directory, and their paths should be correctly referenced in the JSON.
+- In each figure entry: 1) Use a relative path such as "/assets/img/pswiki/example-figure.png". 2) Include a concise caption_md (in Markdown) and the relevant source_keys. 3) Set "zoomable": true for figures intended to support click-to-zoom in Jekyll.
+
+### Conda Environment
+
+Use the following command to create the conda environment for local development:
+
+```
+conda env create --file ./pswiki/database/environment.yml
+```
+
+Use the following command to export minimal-history export (only explicit user-installed packages)
+
+```
+conda env export --from-history --file ./pswiki/database/environment.yml
+```
+
 ## License
 
 This project is licensed under the [CC-BY-NC 4.0](./LICENSE).
diff --git a/_layouts/wiki.liquid b/_layouts/wiki.liquid
@@ -167,7 +167,13 @@
 
           <div class="col-12 mb-2">
             {% if site.repo and site.branch %}
-              <a href="https://github.com/{{ site.repo }}/edit/{{ site.branch }}/{{ page.path }}" class="wiki-nav-link"> Edit This Page </a>
+              {% assign json_path = page.path | replace: '_wiki/', 'database/json/' | replace: '.md', '.json' %}
+              <a
+                href="https://github.com/{{ site.repo }}/edit/{{ site.branch }}/{{ json_path }}"
+                class="wiki-nav-link"
+              >
+                Edit Source JSON
+              </a>
             {% endif %}
           </div>
 

diff --git a/_pages/changelog.md b/_pages/changelog.md
@@ -13,6 +13,11 @@ This page records major changes in this wiki.
 
 ## 2025
 
+### 11-01
+
+- Add JSON based database, now the term is mainly stored in JSON files
+- Add pyscripts to convert between JSON and MD
+
 ### 10-30
 
 - Add terms

diff --git a/_pages/wiki-quicklink.md b/_pages/wiki-quicklink.md
diff --git a/_wiki/30-minutes-reserve-service.md → _wiki/30-minute-reserve-service.md b/_wiki/30-minutes-reserve-service.md → _wiki/30-minute-reserve-service.md
diff --git a/_wiki/adequacy.md b/_wiki/adequacy.md
@@ -4,6 +4,7 @@ description: The ability to supply the demand and energy requirements of the end
 tags:
   - reliability
   - nerc
+related: []
 authors:
   - name: Jinning Wang
     url: https://jinningwang.github.io

diff --git a/_wiki/ambient-adjusted-ratings.md b/_wiki/ambient-adjusted-ratings.md
@@ -1,10 +1,11 @@
 ---
 title: Ambient-Adjusted Ratings
-description:
+description: 
 tags:
   - system-operator
   - grid-enhancing-technology
   - transmission
+related: []
 authors:
   - name: Jinning Wang
     url: https://jinningwang.github.io

diff --git a/_wiki/ancillary-service.md → _wiki/ancillary-services.md b/_wiki/ancillary-service.md → _wiki/ancillary-services.md
@@ -6,6 +6,7 @@ tags:
   - reliability
   - ferc
   - nerc
+related: []
 authors:
   - name: Jinning Wang
     url: https://jinningwang.github.io

diff --git a/_wiki/area-control-error.md b/_wiki/area-control-error.md
@@ -4,6 +4,7 @@ description: ACE. The instantaneous difference between net actual and scheduled
 tags:
   - frequency-control
   - nerc
+related: []
 authors:
   - name: Jinning Wang
     url: https://jinningwang.github.io

diff --git a/_wiki/balancing-authority-area.md b/_wiki/balancing-authority-area.md
@@ -10,13 +10,12 @@ related:
   - region
   - subregions
   - control-area
-  - balancing-authority-area
   - reliability-coordinator-area
 authors:
   - name: Jinning Wang
     url: https://jinningwang.github.io
 date: 2025-03-15
-lastmod: 2025-06-20
+lastmod: 2025-11-01
 ---
 
 ### Definition by NERC

diff --git a/_wiki/balancing-authority.md b/_wiki/balancing-authority.md
@@ -1,15 +1,17 @@
 ---
-title: Balancing Authoritiy
+title: Balancing Authority
 description: The responsible entity within a Balancing Authority Area.
 tags:
   - entity
   - balancing-authority
   - nerc
+related:
+  - balancing-authority-area
 authors:
   - name: Jinning Wang
     url: https://jinningwang.github.io
 date: 2025-03-15
-last_updat: 2025-06-20
+lastmod: 2025-10-29
 ---
 
 ### Definition by NERC

diff --git a/_wiki/bilateral-transaction.md b/_wiki/bilateral-transaction.md
@@ -4,6 +4,7 @@ description: A direct contract between a seller and buyer outside of a centraliz
 tags:
   - market
   - ferc
+related: []
 authors:
   - name: Jinning Wang
     url: https://jinningwang.github.io

diff --git a/_wiki/black-start.md b/_wiki/black-start.md
@@ -5,6 +5,7 @@ tags:
   - operation
   - ieee
   - ieee-standard
+related: []
 authors:
   - name: Jinning Wang
     url: https://jinningwang.github.io

diff --git a/_wiki/bulk-electric-system.md b/_wiki/bulk-electric-system.md
@@ -5,6 +5,7 @@ tags:
   - entity
   - transmission
   - nerc
+related: []
 authors:
   - name: Jinning Wang
     url: https://jinningwang.github.io

diff --git a/_wiki/bulk-power-system.md b/_wiki/bulk-power-system.md
@@ -6,6 +6,7 @@ tags:
   - ieee
   - ieee-standard
   - nerc
+related: []
 authors:
   - name: Jinning Wang
     url: https://jinningwang.github.io

diff --git a/_wiki/capacity-markets.md b/_wiki/capacity-markets.md
@@ -4,6 +4,7 @@ description: A market for trading capacity credits.
 tags:
   - market
   - ferc
+related: []
 authors:
   - name: Jinning Wang
     url: https://jinningwang.github.io

diff --git a/_wiki/co-located-load.md b/_wiki/co-located-load.md
@@ -6,6 +6,7 @@ tags:
   - transmission
   - system-operator
   - pjm
+related: []
 authors:
   - name: Jinning Wang
     url: https://jinningwang.github.io

diff --git a/_wiki/common-format-for-event-data-exchange.md b/_wiki/common-format-for-event-data-exchange.md
@@ -6,6 +6,7 @@ tags:
   - inactive
   - ieee-standard
   - standard
+related: []
 authors:
   - name: Jinning Wang
     url: https://jinningwang.github.io
@@ -15,8 +16,6 @@ lastmod: 2025-06-20
 
 ### Definition in an IEEE Standard
 
-Source: <d-cite key="ieee2010comfede"></d-cite
-
 > This standard defines a common format for the data files needed for the exchange of various types of power network events in order to facilitate event data integration and analysis from multiple data sources and from different vendor devices. The flexibility provided by digital devices in recording network fault event data in the electric utility industry has generated the need for a standard format for the exchange of data. These data are being used with various devices to enhance and automate the analysis, testing, evaluation, and simulation of power systems and related protection schemes during fault and disturbance conditions. Since each source of data may use a different proprietary format, a common data format is necessary to facilitate the exchange of such data between applications. This will facilitate the use of proprietary data in diverse applications and allow users of one proprietary system to use digital data from other systems.
 
 <!-- prettier-ignore-start -->

diff --git a/_wiki/common-format-for-exchange-of-solved-load-flow-data.md b/_wiki/common-format-for-exchange-of-solved-load-flow-data.md
@@ -5,6 +5,7 @@ tags:
   - data-format
   - ieee-standard
   - standard
+related: []
 authors:
   - name: Jinning Wang
     url: https://jinningwang.github.io

diff --git a/_wiki/common-format-for-transient-data-exchange.md b/_wiki/common-format-for-transient-data-exchange.md
@@ -7,6 +7,7 @@ tags:
   - ieee
   - ieee-standard
   - standard
+related: []
 authors:
   - name: Jinning Wang
     url: https://jinningwang.github.io

diff --git a/_wiki/common-grid-model-exchange-standard.md b/_wiki/common-grid-model-exchange-standard.md
@@ -6,6 +6,7 @@ tags:
   - iec
   - iec-standard
   - standard
+related: []
 authors:
   - name: Jinning Wang
     url: https://jinningwang.github.io

diff --git a/_wiki/common-information-model.md b/_wiki/common-information-model.md
@@ -3,6 +3,7 @@ title: Common Information Model
 description: CIM. A set of open standards for representing power system components
 tags:
   - data-format
+related: []
 authors:
   - name: Jinning Wang
     url: https://jinningwang.github.io

diff --git a/_wiki/compliance-factor.md b/_wiki/compliance-factor.md
@@ -5,6 +5,7 @@ tags:
   - frequency-control
   - system-operator
   - pjm
+related: []
 authors:
   - name: Jinning Wang
     url: https://jinningwang.github.io