Skip to content

Commit 4d02a8e

Browse files
svijayakumar2023svijayakumar2023
committed
Updating the workflow landing page
1 parent f7a6764 commit 4d02a8e

34 files changed

Lines changed: 718 additions & 132 deletions

‎Models/LLCConverter/LLCResonantConverterFullBridge.slx‎

-16 Bytes
Binary file not shown.

‎Overview/Images/GFMControllerLib.png‎

14.5 KB
Loading

‎Overview/Images/GridFormingConverter.png‎

44.3 KB
Loading

‎Overview/Images/LLCControllerBode.png‎

62.9 KB
Loading

‎Overview/Images/LLCControllerComponent.png‎

20.3 KB
Loading

‎Overview/Images/LLCControllerLib.png‎

5.71 KB
Loading

‎Overview/Images/LLCConverterLib.png‎

20 KB
Loading

‎Overview/Images/MATLAB_VERSION.png‎

6.12 KB
Loading

‎Overview/ListOfComponents.html‎

Lines changed: 220 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,220 @@
1+
<!DOCTYPE html>
2+
<html lang="en">
3+
<head>
4+
<meta charset="utf-8">
5+
<title>Power Converter Component Library</title>
6+
<!--
7+
============================================================
8+
COMPONENT LIBRARY TABLE - MathWorks Style
9+
============================================================
10+
11+
PURPOSE:
12+
Lists all custom Simscape components in this project with
13+
clickable links to open their Documentation (via web()) or
14+
Test Harness (via open_system()) directly in MATLAB.
15+
16+
HOW TO ADD A NEW COMPONENT:
17+
1. Add a new entry to the COMPONENT DATA array in the <script>
18+
section at the bottom of this file.
19+
2. Each entry is an array with 4 elements:
20+
["ComponentName", "Library", "DocFile.html", "TestHarnessName"]
21+
3. The table (including row numbers) is auto-generated from
22+
the data array — no manual HTML editing needed.
23+
24+
EXAMPLE — Adding a component called "My New Block":
25+
In the componentData array, add:
26+
["My New Block", "Power Converter", "DocumentationMyNewBlock.html", "TestMyNewBlock"],
27+
28+
AVAILABLE LIBRARIES:
29+
- Grid Forming Converter
30+
- LLC Converter
31+
32+
HYPERLINK BEHAVIOR:
33+
- Documentation links call: matlab:web('DocFile.html')
34+
- Test Harness links call: matlab:open_system('TestHarnessName')
35+
36+
STYLE REFERENCE (matches projectDocumentationPage.html):
37+
- Page title: 28px, orange (#c04c0b)
38+
- Headings h1: 20px, bold, orange (#c04c0b)
39+
- Body text: 12px, dark (#212121)
40+
- Links: blue (#0076a8), hover (#004c6d)
41+
- Code block: 12px monospace, gray bg (#f5f5f5), blue left border
42+
- Table header: blue bg (#0076a8), white text
43+
44+
============================================================
45+
-->
46+
<style>
47+
/* ──────────────────────────────────────────────────────────
48+
BASE STYLES (reusable across project documentation pages)
49+
────────────────────────────────────────────────────────── */
50+
body { margin: 0; font-family: Arial, Helvetica, sans-serif; font-size: 12px; color: #212121; }
51+
a { color: #0076a8; text-decoration: none; }
52+
a:hover { color: #004c6d; text-decoration: underline; }
53+
54+
/* ──────────────────────────────────────────────────────────
55+
TITLE BAR (fixed, full-width)
56+
────────────────────────────────────────────────────────── */
57+
.page-title {
58+
position: fixed; top: 0; left: 0; right: 0;
59+
background: #fff; border-bottom: 1px solid #e0e0e0;
60+
margin: 0; z-index: 200;
61+
display: flex; align-items: center; justify-content: space-between;
62+
}
63+
.page-title .title-text {
64+
font-size: 28px; font-weight: 400; color: #c04c0b;
65+
padding: 14px 20px;
66+
}
67+
.page-title .title-logo { padding: 6px 20px; }
68+
.page-title .title-logo img { height: 50px; width: auto; }
69+
70+
/* ──────────────────────────────────────────────────────────
71+
CONTENT AREA
72+
────────────────────────────────────────────────────────── */
73+
.content {
74+
padding: 90px 40px 30px;
75+
max-width: 1100px;
76+
}
77+
h1 { font-size: 20px; font-weight: 700; color: #c04c0b; margin: 30px 0 8px;
78+
border-bottom: 1px solid #e0e0e0; padding-bottom: 8px; }
79+
p { margin: 8px 0; line-height: 1.6; color: #212121; }
80+
.code {
81+
background: #f5f5f5; border-left: 3px solid #0076a8;
82+
padding: 10px 14px; margin: 10px 0 20px;
83+
font-family: 'Courier New', monospace; font-size: 12px; color: #212121;
84+
}
85+
86+
/* ──────────────────────────────────────────────────────────
87+
TABLE STYLES
88+
────────────────────────────────────────────────────────── */
89+
table {
90+
width: 100%;
91+
border-collapse: collapse;
92+
margin: 16px 0;
93+
font-size: 12px;
94+
}
95+
th {
96+
background: #0076a8;
97+
color: #fff;
98+
font-weight: 600;
99+
text-align: left;
100+
padding: 10px 12px;
101+
}
102+
td {
103+
padding: 8px 12px;
104+
border-bottom: 1px solid #e0e0e0;
105+
vertical-align: top;
106+
}
107+
tr:hover td { background: #f0f8fc; }
108+
td:first-child { font-weight: 500; }
109+
</style>
110+
</head>
111+
<body>
112+
113+
<!-- ============================================================
114+
TITLE BAR
115+
============================================================ -->
116+
<div class="page-title">
117+
<span class="title-text">Power Converter Component Library</span>
118+
<span class="title-logo"><img src="Images/MATLAB_VERSION.png" alt="MATLAB Version"></span>
119+
</div>
120+
121+
<!-- ============================================================
122+
CONTENT
123+
============================================================ -->
124+
<main class="content">
125+
126+
<h1>List of Components</h1>
127+
<p>
128+
The table below lists all custom components available in this project.
129+
These components are used for power converter circuit design and control,
130+
including LLC resonant converters and grid-forming converters built with Simscape.
131+
The combined library (<b>ConverterLibrary</b>) is located in the
132+
<code>Components/Utilities</code> folder, while individual component libraries
133+
reside in their respective folders under <code>Components/</code>.
134+
</p>
135+
<p>
136+
Click on the <b>Documentation</b> link to view the component documentation,
137+
or the <b>Test Harness</b> link to open the component test model.
138+
</p>
139+
140+
<table>
141+
<thead>
142+
<tr>
143+
<th>#</th>
144+
<th>Component Name</th>
145+
<th>Library</th>
146+
<th>Documentation</th>
147+
<th>Test Harness</th>
148+
</tr>
149+
</thead>
150+
<tbody id="component-table-body">
151+
</tbody>
152+
</table>
153+
154+
<p>
155+
<br> <br>
156+
<i>Copyright 2025 - 2026 The MathWorks, Inc.</i>
157+
</p>
158+
159+
</main>
160+
161+
<!-- ============================================================
162+
COMPONENT DATA & TABLE GENERATION SCRIPT
163+
164+
HOW TO ADD A NEW COMPONENT:
165+
Append a new entry to the componentData array below.
166+
Format: ["ComponentName", "Library", "DocFile.html", "TestHarnessName"]
167+
168+
- ComponentName: display name shown in the table
169+
- Library: top-level library folder name
170+
- DocFile.html: documentation HTML filename (opened via web())
171+
- TestHarnessName: Simulink model name without .slx (opened via open_system())
172+
173+
The script auto-generates table rows with correct row numbers
174+
and matlab: hyperlinks. No other changes needed.
175+
============================================================ -->
176+
<script>
177+
var componentData = [
178+
// Format: ["ComponentName", "Library", "DocFile.html", "TestHarnessName"]
179+
180+
// ── Grid Forming Converter ────────────────────────────────────────────
181+
["Grid-Forming Converter Controller", "Grid Forming Converter", "GFMController.html", "ModelGridFormingController"],
182+
183+
// ── LLC Converter ─────────────────────────────────────────────────────
184+
["LLC Controller", "LLC Converter", "LLCController.html", "ModelLLCResonantControllerAndPowerCircuit"],
185+
["LLC Converter Power Circuit", "LLC Converter", "LLCPowerCircuit.html", "ModelLLCResonantControllerAndPowerCircuit"]
186+
187+
// ── ADD NEW COMPONENTS HERE ────────────────────────────────────────────
188+
// ["New Component Name", "Library", "DocFile.html", "TestHarnessName"],
189+
];
190+
191+
/* ──────────────────────────────────────────────────────────────────────────
192+
buildTable() — Generates table rows from componentData.
193+
Called once on page load. Row numbers are auto-incremented.
194+
- Documentation links use: matlab:web('DocFile.html')
195+
- Test Harness links use: matlab:open_system('TestHarnessName')
196+
────────────────────────────────────────────────────────────────────────── */
197+
function buildTable() {
198+
var tbody = document.getElementById('component-table-body');
199+
var html = '';
200+
for (var i = 0; i < componentData.length; i++) {
201+
var name = componentData[i][0];
202+
var library = componentData[i][1];
203+
var docFile = componentData[i][2];
204+
var testModel = componentData[i][3];
205+
html += '<tr>'
206+
+ '<td>' + (i + 1) + '</td>'
207+
+ '<td>' + name + '</td>'
208+
+ '<td>' + library + '</td>'
209+
+ '<td><a href="matlab:web(\'' + docFile + '\')">' + docFile + '</a></td>'
210+
+ '<td><a href="matlab:open_system(\'' + testModel + '\')">' + testModel + '</a></td>'
211+
+ '</tr>';
212+
}
213+
tbody.innerHTML = html;
214+
}
215+
216+
buildTable();
217+
</script>
218+
219+
</body>
220+
</html>

‎Overview/PowerConverterCircuitAndControlDesignCoverPage.html‎

Lines changed: 400 additions & 126 deletions
Large diffs are not rendered by default.

0 commit comments

Comments
 (0)