Skip to content

Commit a84a22b

Browse files
cdarve245cdarve245
committed
comment code in some documentation
1 parent 7f5d53c commit a84a22b

File tree

13 files changed

+300
-91
lines changed

13 files changed

+300
-91
lines changed

‎clinical/aortofemoral1.html‎

Lines changed: 21 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -16,12 +16,13 @@
1616
<!-- Bootstrap CSS -->
1717
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/[email protected]/dist/css/bootstrap.min.css" integrity="sha384-MCw98/SFnGE8fJT3GXwEOngsV7Zt27NXFoaoApmYm81iuXoPkFOJwJ8ERdknLPMO" crossorigin="anonymous">
1818

19-
<!-- Styles CSS -->
19+
<!-- This applies styling to the code that is not rendered by markdown -->
2020
<link rel="stylesheet" href="../css/bootstrap.css">
2121
<link rel="stylesheet" href="../css/grayscale.css">
2222
<link rel="stylesheet" href="../css/standards.css">
2323
<link rel="stylesheet" href="../css/documentation.css">
2424

25+
<!-- This applies styling to the markdown that is generated with the <zero-md> element -->
2526
<script>
2627
window.ZeroMd = {
2728
config: {
@@ -41,7 +42,8 @@
4142
},
4243
};
4344
</script>
44-
45+
46+
<!-- This is the CDN that imports the code for the <zero-md> element -->
4547
<script
4648
type="module"
4749
src="https://cdn.jsdelivr.net/gh/zerodevx/zero-md@1/src/zero-md.min.js"
@@ -76,6 +78,7 @@
7678
</div>
7779
</div>
7880
<div class="col-6 topRightBars">
81+
<!-- The following code defines the navigation bar in the header -->
7982
<div id="headerNavBar">
8083
<details>
8184
<summary><i class="fa-solid fa-bars" id="iconForSkip"></i></summary>
@@ -147,14 +150,19 @@
147150
</section>
148151

149152
<section class="mainSection">
153+
<!-- The following code defines the navigation section on the left of the page -->
150154
<section class="navigationSection" style="float: left">
155+
<!-- The link after the class "clickLink" is what will open
156+
if someone clicks on the <h4> element -->
151157
<div>
152158
<h3>Download</h3>
153159
<h4 class="clickLink https://simtk.org/frs/download_confirm.php/file/4303/AortofemoralNormal1.zip?group_id=930">Aortofemoral Normal - 1 (Data)</h4>
154160
</div>
155161
<div style="padding: 0">
156162
<h3>Aortofemoral Normal</h3>
157163
</div>
164+
<!-- The second class after "skipTo" is the ID of the <span> element
165+
of the <zero-md> element that renders the markdown file -->
158166
<div>
159167
<h4 class="skipTo sec1">Clinical Significance</h4>
160168
</div>
@@ -170,10 +178,18 @@ <h4 class="skipTo sec4">Boundary Conditions</h4>
170178
<div>
171179
<h4 class="skipTo sec5">Simulation and Results</h4>
172180
</div>
173-
174181
</section>
175182

183+
<!-- The following code defines the place where the markdown files are rendered -->
176184
<section class="docsSection" style="float: right">
185+
<!-- To reference the section linked in the <zero-md> element,
186+
reference the ID in the <span> element -->
187+
188+
<!-- All markdown files must be named readme.md -->
189+
190+
<!-- The first <zero-md> element should have the id="math" attribute -->
191+
<!-- All <zero-md> elements should have the "no-shadow" attribute -->
192+
177193
<span id="sec1">
178194
<zero-md id="math" src="aortofemoral1/significance/readme.md" no-shadow></zero-md>
179195
</span>
@@ -195,7 +211,8 @@ <h4 class="skipTo sec5">Simulation and Results</h4>
195211
<p id="skipToTop"><i class="fa-solid fa-arrow-up"></i></p>
196212
</section>
197213

198-
214+
<!-- The following code adds the Mathjax CDN to the html once it has been
215+
rendered by the markdown files -->
199216
<script>
200217
math.addEventListener('zero-md-rendered', () => {
201218
var el = document.createElement('script');

‎clinical/aortofemoral2.html‎

Lines changed: 24 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -13,15 +13,16 @@
1313
<link href="https://fonts.googleapis.com/css?family=Montserrat:400,700" rel="stylesheet" type="text/css">
1414
<link href="//vjs.zencdn.net/4.8/video-js.css" rel="stylesheet">
1515

16-
<!-- Bootstrap CSS -->
16+
<!-- This applies styling to the code that is not rendered by markdown -->
1717
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/[email protected]/dist/css/bootstrap.min.css" integrity="sha384-MCw98/SFnGE8fJT3GXwEOngsV7Zt27NXFoaoApmYm81iuXoPkFOJwJ8ERdknLPMO" crossorigin="anonymous">
1818

19-
<!-- Styles CSS -->
19+
<!-- This applies styling to the markdown that is generated with the <zero-md> element -->
2020
<link rel="stylesheet" href="../css/bootstrap.css">
2121
<link rel="stylesheet" href="../css/grayscale.css">
2222
<link rel="stylesheet" href="../css/standards.css">
2323
<link rel="stylesheet" href="../css/documentation.css">
2424

25+
<!-- This applies styling to the markdown that is generated with the <zero-md> element -->
2526
<script>
2627
window.ZeroMd = {
2728
config: {
@@ -42,10 +43,11 @@
4243
};
4344
</script>
4445

45-
<script
46-
type="module"
47-
src="https://cdn.jsdelivr.net/gh/zerodevx/zero-md@1/src/zero-md.min.js"
48-
></script>
46+
<!-- This is the CDN that imports the code for the <zero-md> element -->
47+
<script
48+
type="module"
49+
src="https://cdn.jsdelivr.net/gh/zerodevx/zero-md@1/src/zero-md.min.js"
50+
></script>
4951

5052
<!-- browser tab labels -->
5153
<link rel="shortcut icon" type="image/jpg" href="../img/svlogo/svIcon.png"></link>
@@ -76,6 +78,7 @@
7678
</div>
7779
</div>
7880
<div class="col-6 topRightBars">
81+
<!-- The following code defines the navigation bar in the header -->
7982
<div id="headerNavBar">
8083
<details>
8184
<summary><i class="fa-solid fa-bars" id="iconForSkip"></i></summary>
@@ -147,14 +150,19 @@
147150
</section>
148151

149152
<section class="mainSection">
153+
<!-- The following code defines the navigation section on the left of the page -->
150154
<section class="navigationSection" style="float: left">
155+
<!-- The link after the class "clickLink" is what will open
156+
if someone clicks on the <h4> element -->
151157
<div>
152158
<h3>Download</h3>
153159
<h4 class="clickLink https://simtk.org/frs/download_confirm.php/file/4301/AortofemoralNormal2.zip?group_id=930">Aortofemoral Normal - 2 (Data)</h4>
154160
</div>
155161
<div style="padding: 0">
156162
<h3>Aortofemoral Normal</h3>
157163
</div>
164+
<!-- The second class after "skipTo" is the ID of the <span> element
165+
of the <zero-md> element that renders the markdown file -->
158166
<div>
159167
<h4 class="skipTo sec1">Clinical Significance</h4>
160168
</div>
@@ -170,10 +178,17 @@ <h4 class="skipTo sec4">Boundary Conditions</h4>
170178
<div>
171179
<h4 class="skipTo sec5">Simulation and Results</h4>
172180
</div>
173-
174181
</section>
175182

183+
<!-- The following code defines the place where the markdown files are rendered -->
176184
<section class="docsSection" style="float: right">
185+
<!-- To reference the section linked in the <zero-md> element,
186+
reference the ID in the <span> element -->
187+
188+
<!-- All markdown files must be named readme.md -->
189+
190+
<!-- The first <zero-md> element should have the id="math" attribute -->
191+
<!-- All <zero-md> elements should have the "no-shadow" attribute -->
177192
<span id="sec1">
178193
<zero-md id="math" src="aortofemoral2/significance/readme.md" no-shadow></zero-md>
179194
</span>
@@ -195,7 +210,8 @@ <h4 class="skipTo sec5">Simulation and Results</h4>
195210
<p id="skipToTop"><i class="fa-solid fa-arrow-up"></i></p>
196211
</section>
197212

198-
213+
<!-- The following code adds the Mathjax CDN to the html once it has been
214+
rendered by the markdown files -->
199215
<script>
200216
math.addEventListener('zero-md-rendered', () => {
201217
var el = document.createElement('script');

‎clinical/coronary.html‎

Lines changed: 23 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -16,12 +16,13 @@
1616
<!-- Bootstrap CSS -->
1717
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/[email protected]/dist/css/bootstrap.min.css" integrity="sha384-MCw98/SFnGE8fJT3GXwEOngsV7Zt27NXFoaoApmYm81iuXoPkFOJwJ8ERdknLPMO" crossorigin="anonymous">
1818

19-
<!-- Styles CSS -->
19+
<!-- This applies styling to the markdown that is generated with the <zero-md> element -->
2020
<link rel="stylesheet" href="../css/bootstrap.css">
2121
<link rel="stylesheet" href="../css/grayscale.css">
2222
<link rel="stylesheet" href="../css/standards.css">
2323
<link rel="stylesheet" href="../css/documentation.css">
2424

25+
<!-- This applies styling to the markdown that is generated with the <zero-md> element -->
2526
<script>
2627
window.ZeroMd = {
2728
config: {
@@ -42,10 +43,11 @@
4243
};
4344
</script>
4445

45-
<script
46-
type="module"
47-
src="https://cdn.jsdelivr.net/gh/zerodevx/zero-md@1/src/zero-md.min.js"
48-
></script>
46+
<!-- This is the CDN that imports the code for the <zero-md> element -->
47+
<script
48+
type="module"
49+
src="https://cdn.jsdelivr.net/gh/zerodevx/zero-md@1/src/zero-md.min.js"
50+
></script>
4951

5052
<!-- browser tab labels -->
5153
<link rel="shortcut icon" type="image/jpg" href="../img/svlogo/svIcon.png"></link>
@@ -76,6 +78,7 @@
7678
</div>
7779
</div>
7880
<div class="col-6 topRightBars">
81+
<!-- The following code defines the navigation bar in the header -->
7982
<div id="headerNavBar">
8083
<details>
8184
<summary><i class="fa-solid fa-bars" id="iconForSkip"></i></summary>
@@ -147,14 +150,19 @@
147150
</section>
148151

149152
<section class="mainSection">
153+
<!-- The following code defines the navigation section on the left of the page -->
150154
<section class="navigationSection" style="float: left">
155+
<!-- The link after the class "clickLink" is what will open
156+
if someone clicks on the <h4> element -->
151157
<div>
152158
<h3>Download</h3>
153159
<h4 class="clickLink https://simtk.org/frs/download_confirm.php/file/5115/CoronaryProject.zip?group_id=930">Coronary Project</h4>
154160
</div>
155161
<div style="padding: 0">
156162
<h3>Coronary Normal</h3>
157163
</div>
164+
<!-- The second class after "skipTo" is the ID of the <span> element
165+
of the <zero-md> element that renders the markdown file -->
158166
<div>
159167
<h4 class="skipTo introduction">Introduction</h4>
160168
</div>
@@ -185,10 +193,17 @@ <h4 class="skipTo conclusion">Conclusion</h4>
185193
<div>
186194
<h4 class="skipTo references">References</h4>
187195
</div>
188-
189196
</section>
190197

198+
<!-- The following code defines the place where the markdown files are rendered -->
191199
<section class="docsSection" style="float: right">
200+
<!-- To reference the section linked in the <zero-md> element,
201+
reference the ID in the <span> element -->
202+
203+
<!-- All markdown files must be named readme.md -->
204+
205+
<!-- The first <zero-md> element should have the id="math" attribute -->
206+
<!-- All <zero-md> elements should have the "no-shadow" attribute -->
192207
<span id="introduction">
193208
<zero-md id="math" src="coronary/intro/readme.md" no-shadow></zero-md>
194209
</span>
@@ -231,15 +246,14 @@ <h4 class="skipTo references">References</h4>
231246
<span id="references">
232247
<zero-md src="coronary/refs/readme.md" no-shadow></zero-md>
233248
</span>
234-
235-
236249
</section>
237250
</section>
238251
<section class="skipToTopSection">
239252
<p id="skipToTop"><i class="fa-solid fa-arrow-up"></i></p>
240253
</section>
241254

242-
255+
<!-- The following code adds the Mathjax CDN to the html once it has been
256+
rendered by the markdown files -->
243257
<script>
244258
math.addEventListener('zero-md-rendered', () => {
245259
var el = document.createElement('script');

‎clinical/pulmonary.html‎

Lines changed: 24 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -16,12 +16,13 @@
1616
<!-- Bootstrap CSS -->
1717
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/[email protected]/dist/css/bootstrap.min.css" integrity="sha384-MCw98/SFnGE8fJT3GXwEOngsV7Zt27NXFoaoApmYm81iuXoPkFOJwJ8ERdknLPMO" crossorigin="anonymous">
1818

19-
<!-- Styles CSS -->
19+
<!-- This applies styling to the markdown that is generated with the <zero-md> element -->
2020
<link rel="stylesheet" href="../css/bootstrap.css">
2121
<link rel="stylesheet" href="../css/grayscale.css">
2222
<link rel="stylesheet" href="../css/standards.css">
2323
<link rel="stylesheet" href="../css/documentation.css">
2424

25+
<!-- This applies styling to the markdown that is generated with the <zero-md> element -->
2526
<script>
2627
window.ZeroMd = {
2728
config: {
@@ -42,10 +43,11 @@
4243
};
4344
</script>
4445

45-
<script
46-
type="module"
47-
src="https://cdn.jsdelivr.net/gh/zerodevx/zero-md@1/src/zero-md.min.js"
48-
></script>
46+
<!-- This is the CDN that imports the code for the <zero-md> element -->
47+
<script
48+
type="module"
49+
src="https://cdn.jsdelivr.net/gh/zerodevx/zero-md@1/src/zero-md.min.js"
50+
></script>
4951

5052
<!-- browser tab labels -->
5153
<link rel="shortcut icon" type="image/jpg" href="../img/svlogo/svIcon.png"></link>
@@ -76,6 +78,7 @@
7678
</div>
7779
</div>
7880
<div class="col-6 topRightBars">
81+
<!-- The following code defines the navigation bar in the header -->
7982
<div id="headerNavBar">
8083
<details>
8184
<summary><i class="fa-solid fa-bars" id="iconForSkip"></i></summary>
@@ -145,15 +148,21 @@
145148
</div>
146149
</div>
147150
</section>
151+
148152
<section class="mainSection">
153+
<!-- The following code defines the navigation section on the left of the page -->
149154
<section class="navigationSection" style="float: left">
155+
<!-- The link after the class "clickLink" is what will open
156+
if someone clicks on the <h4> element -->
150157
<div>
151158
<h3>Download</h3>
152159
<h4 class="clickLink https://simtk.org/frs/download_confirm.php/file/4302/HealthyPulmonary.zip?group_id=930">Healthy Pulmonary (Data)</h4>
153160
</div>
154161
<div style="padding: 0">
155162
<h3>Healthy Pulmonary</h3>
156163
</div>
164+
<!-- The second class after "skipTo" is the ID of the <span> element
165+
of the <zero-md> element that renders the markdown file -->
157166
<div>
158167
<h4 class="skipTo sec1">Clinical Significance</h4>
159168
</div>
@@ -169,10 +178,17 @@ <h4 class="skipTo sec4">Boundary Conditions</h4>
169178
<div>
170179
<h4 class="skipTo sec5">Simulation and Results</h4>
171180
</div>
172-
173181
</section>
174182

183+
<!-- The following code defines the place where the markdown files are rendered -->
175184
<section class="docsSection" style="float: right">
185+
<!-- To reference the section linked in the <zero-md> element,
186+
reference the ID in the <span> element -->
187+
188+
<!-- All markdown files must be named readme.md -->
189+
190+
<!-- The first <zero-md> element should have the id="math" attribute -->
191+
<!-- All <zero-md> elements should have the "no-shadow" attribute -->
176192
<span id="sec1">
177193
<zero-md id="math" src="pulmonary/significance/readme.md" no-shadow></zero-md>
178194
</span>
@@ -194,7 +210,8 @@ <h4 class="skipTo sec5">Simulation and Results</h4>
194210
<p id="skipToTop"><i class="fa-solid fa-arrow-up"></i></p>
195211
</section>
196212

197-
213+
<!-- The following code adds the Mathjax CDN to the html once it has been
214+
rendered by the markdown files -->
198215
<script>
199216
math.addEventListener('zero-md-rendered', () => {
200217
var el = document.createElement('script');

0 commit comments

Comments
 (0)