Skip to content

Commit 20ff205

Browse files
nikoschamnikoscham
committed
Update tutorial text for consistency; replace code formatting with quotes
1 parent c164b54 commit 20ff205

6 files changed

+43
-45
lines changed

‎index.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -147,7 +147,7 @@ <h2 id="gettingstarted"><a name="Getting Started"></a>Getting Started</h2>
147147
<p>
148148
<strong>Quick Start:</strong> Include FEAScript in your HTML via CDN or download from
149149
<a href="https://github.com/FEAScript/FEAScript-core" target="_blank">GitHub</a> &#8594; add a canvas
150-
(e.g., <code>&lt;div id="solutionPlot">&lt;/div&gt;</code>) &#8594; add a mesh file (e.g., `your.msh`)
150+
(e.g., <code>&lt;div id="solutionPlot">&lt;/div&gt;</code>) &#8594; add a mesh file (e.g., "your.msh")
151151
or use FEAScript mesh generation tools &#8594; create and run a simulation using the JavaScript API (see
152152
<a href="#tutorials">tutorials</a> for detailed examples):
153153
</p>
@@ -229,7 +229,7 @@ <h2 id="features"><a name="Features"></a>Features</h2>
229229
"
230230
/>
231231
</a>
232-
(`.msh` file format)
232+
(".msh" file format)
233233
</li>
234234
</ul>
235235
</li>

‎tutorials/HeatConduction1DWall.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -183,8 +183,8 @@ <h2 id="solvingwithfeascript"><a name="Solving with FEAScript"></a>Solving with
183183
&lt;/body&gt;</pre
184184
>
185185
<p>
186-
The `solutionPlot` is the id of the div where the plot will be rendered. This id is passed as an
187-
argument to the `plotSolution` function to specify the target div for the plot.
186+
The "solutionPlot" is the id of the div where the plot will be rendered. This id is passed as an
187+
argument to the "plotSolution" function to specify the target div for the plot.
188188
</p>
189189

190190
<h2 id="results"><a name="Results"></a>Results</h2>

‎tutorials/HeatConduction1DWallPlatform.html

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -92,11 +92,11 @@ <h2 id="tutorial"><a name="Tutorial"></a>Step-by-Step Tutorial</h2>
9292

9393
<ol>
9494
<li>
95-
<strong>Visit the FEAScript platform</strong> in your browser at
95+
Visit the FEAScript platform in your browser at
9696
<a href="https://platform.feascript.com" target="_blank">https://platform.feascript.com</a>.
9797
</li>
9898
<li>
99-
<strong>Locate the Control Panel</strong> on the right side of the screen.
99+
Locate the Control Panel on the right side of the screen.
100100

101101
<!-- Control Panel Image -->
102102
<div class="image-container">
@@ -105,11 +105,11 @@ <h2 id="tutorial"><a name="Tutorial"></a>Step-by-Step Tutorial</h2>
105105
</div>
106106
</li>
107107
<li>
108-
<strong>Click the "Load Project" button</strong> in the Control Panel under the "Load/Save Project"
108+
Click the "Load Project" button in the Control Panel under the "Load/Save Project"
109109
folder.
110110
</li>
111111
<li>
112-
<strong>Select the `HeatConduction1DWall.xml` file</strong> from your computer.
112+
Select the "HeatConduction1DWall.xml" file from your computer.
113113
<p>
114114
You can download this file from the
115115
<a
@@ -121,7 +121,7 @@ <h2 id="tutorial"><a name="Tutorial"></a>Step-by-Step Tutorial</h2>
121121
</p>
122122
</li>
123123
<li>
124-
<strong>The blocks will be loaded</strong> into the editor, showing the complete simulation setup.
124+
The blocks will be loaded into the editor, showing the complete simulation setup.
125125

126126
<!-- Complete Simulation Setup Blocks Image -->
127127
<div class="image-container">
@@ -136,11 +136,11 @@ <h2 id="tutorial"><a name="Tutorial"></a>Step-by-Step Tutorial</h2>
136136
</p>
137137
</li>
138138
<li>
139-
<strong>Click "Evaluate"</strong> in the Control Panel to run the simulation.
139+
Click "Evaluate" in the Control Panel to run the simulation.
140140
<p>This will execute the blocks in sequence, performing the finite element analysis.</p>
141141
</li>
142142
<li>
143-
<strong>Switch to the "Solution" tab</strong> to view the results.
143+
Switch to the "Solution" tab to view the results.
144144

145145
<!-- Results Image -->
146146
<div class="image-container">

‎tutorials/HeatConduction2DFin.html

Lines changed: 13 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -173,10 +173,10 @@ <h2 id="solvingwithfeascript"><a name="Solving with FEAScript"></a>Solving with
173173
<p>
174174
In the boundary condition definition, the numbers at the left side (from 0 to 3) indicate the boundaries
175175
of the geometry (the mesh generator of FEAScript has assigned numbers to the boundaries, starting from
176-
the bottom boundary and proceeding clockwise). The `constantTemp` condition sets a constant temperature
177-
value. The `symmetry` boundary condition represents a zero-flux type. Finally, the `convection`
176+
the bottom boundary and proceeding clockwise). The "constantTemp" condition sets a constant temperature
177+
value. The "symmetry" boundary condition represents a zero-flux type. Finally, the "convection"
178178
condition describes a convective heat transfer scenario. In addition, the second argument of the
179-
`constantTemp` boundary condition corresponds to the constant temperature value. For a `convection`
179+
"constantTemp" boundary condition corresponds to the constant temperature value. For a "convection"
180180
boundary condition, the second argument represents the \({\frac{h}{k}}\) value, and the third argument
181181
indicates the external temperature \(T_0\).
182182
</p>
@@ -192,8 +192,8 @@ <h2 id="solvingwithfeascript"><a name="Solving with FEAScript"></a>Solving with
192192
&lt;/body&gt;</pre
193193
>
194194
<p>
195-
The `solutionPlot` is the id of the div where the plot will be rendered. This id is passed as an
196-
argument to the `plotSolution` function to specify the target div for the plot.
195+
The "solutionPlot" is the id of the div where the plot will be rendered. This id is passed as an
196+
argument to the "plotSolution" function to specify the target div for the plot.
197197
</p>
198198

199199
<h2 id="results"><a name="Results"></a>Results</h2>
@@ -215,16 +215,14 @@ <h2 id="results"><a name="Results"></a>Results</h2>
215215

216216
<br />
217217

218-
<!-- Link to worker-based implementation -->
219-
<div class="highlight-container">
220-
<p>
221-
See also the
222-
<a href="HeatConduction2DFinWorker.html" target="_blank"
223-
>Heat Conduction in a Two-Dimensional Fin (Web Worker version)</a
224-
>
225-
for an example using FEAScript in a separate thread for improved responsiveness.
226-
</p>
227-
</div>
218+
<!-- Links to worker-based and Gmsh implementation -->
219+
<p>
220+
See also
221+
<a href="https://feascript.com/tutorials/HeatConduction2DFinWorker.html" target="_blank">here</a>
222+
for a tutorial using FEAScript in a separate thread (web worker) for improved responsiveness and
223+
<a href="https://feascript.com/tutorials/HeatConduction2DFinGmsh.html" target="_blank">here</a>
224+
for a tutorial using an unstructured mesh generated by Gmsh.
225+
</p>
228226

229227
<ul id="menu">
230228
<li>

‎tutorials/HeatConduction2DFinGmsh.html

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212

1313
<html lang="en">
1414
<head>
15-
<title>FEAScript: Heat Conduction in a Two-Dimensional Fin Tutorial (Gmsh Example)</title>
15+
<title>FEAScript: Heat Conduction in a Two-Dimensional Fin Tutorial (Gmsh Mesh)</title>
1616
<link rel="icon" type="image/x-icon" href="../assets/favicon.ico" />
1717
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
1818
<meta
@@ -72,11 +72,11 @@ <h1 class="top">
7272
/>
7373
</a>
7474
</h1>
75-
<h1>Heat Conduction in a Two-Dimensional Fin (Gmsh Example)</h1>
75+
<h1>Heat Conduction in a Two-Dimensional Fin (Gmsh Mesh)</h1>
7676

7777
<ul id="menu">
7878
<li><a href="#gmshfileimport">Gmsh File Import</a></li>
79-
<li><a href="#gmshgeofile">Example Gmsh `.geo` File</a></li>
79+
<li><a href="#gmshgeofile">Example Gmsh ".geo" File</a></li>
8080
<li><a href="#generatedmesh">Generated Mesh</a></li>
8181
<li><a href="#results">Results</a></li>
8282
</ul>
@@ -92,7 +92,7 @@ <h1>Heat Conduction in a Two-Dimensional Fin (Gmsh Example)</h1>
9292

9393
<h2 id="gmshfileimport"><a name="gmshfileimport"></a>Gmsh File Import</h2>
9494
<p>
95-
This example demonstrates how to import a Gmsh-generated mesh (`.msh` file format) and solve a heat
95+
This example demonstrates how to import a Gmsh-generated mesh (".msh" file format) and solve a heat
9696
conduction problem.
9797
</p>
9898

@@ -162,7 +162,7 @@ <h2 id="gmshfileimport"><a name="gmshfileimport"></a>Gmsh File Import</h2>
162162
</p>
163163
<ol>
164164
<li>
165-
<strong>Physical Groups in Gmsh:</strong> In your `.geo` file, you need to define physical groups for
165+
<strong>Physical Groups in Gmsh:</strong> In your ".geo" file, you need to define physical groups for
166166
boundaries using commands like <code>Physical Line("bottom") = {1};</code>. These are mapped to tags
167167
in the imported mesh.
168168
</li>
@@ -181,13 +181,13 @@ <h2 id="gmshfileimport"><a name="gmshfileimport"></a>Gmsh File Import</h2>
181181
</ol>
182182

183183
<p>
184-
You can create your own Gmsh files by writing `.geo` scripts or using Gmsh's GUI. For this example, we
185-
used a simple rectangular domain defined in a `.geo` file with specific physical groups for each boundary.
184+
You can create your own Gmsh files by writing ".geo" scripts or using Gmsh's GUI. For this example, we
185+
used a simple rectangular domain defined in a ".geo" file with specific physical groups for each boundary.
186186
</p>
187187

188-
<h3 id="gmshgeofile"><a name="gmshgeofile"></a>Example Gmsh `.geo` File</h3>
188+
<h3 id="gmshgeofile"><a name="gmshgeofile"></a>Example Gmsh ".geo" File</h3>
189189
<p>
190-
Below is the `rect.geo` file used in this tutorial. It defines a 4m × 2m rectangular domain with physical
190+
Below is the "rect.geo" file used in this tutorial. It defines a 4m × 2m rectangular domain with physical
191191
lines for each boundary edge:
192192
</p>
193193

@@ -253,8 +253,8 @@ <h3 id="gmshgeofile"><a name="gmshgeofile"></a>Example Gmsh `.geo` File</h3>
253253
</ul>
254254

255255
<p>
256-
To generate a mesh file from this `.geo` script, you would run: <code>gmsh rect.geo -2</code> in your
257-
terminal, which creates a `rect.msh` file that can be imported into FEAScript.
256+
To generate a mesh file from this ".geo" script, you would run: <code>gmsh rect.geo -2</code> in your
257+
terminal, which creates a "rect.msh" file that can be imported into FEAScript.
258258
</p>
259259

260260
<h2 id="generatedmesh"><a name="generatedmesh"></a>Generated Mesh</h2>
@@ -270,7 +270,7 @@ <h2 id="generatedmesh"><a name="generatedmesh"></a>Generated Mesh</h2>
270270
style="max-width: 40%; height: auto"
271271
/>
272272
<p class="image-caption">
273-
Quadrilateral mesh (`rect_quad_unstruct.msh`) generated using the `rect.geo` script with Gmsh
273+
Quadrilateral mesh ("rect_quad_unstruct.msh") generated using the "rect.geo" script with Gmsh
274274
</p>
275275
</div>
276276

‎tutorials/HeatConduction2DFinPlatform.html

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -91,11 +91,11 @@ <h2 id="tutorial"><a name="Tutorial"></a>Step-by-Step Tutorial</h2>
9191

9292
<ol>
9393
<li>
94-
<strong>Visit the FEAScript platform</strong> in your browser at
94+
Visit the FEAScript platform in your browser at
9595
<a href="https://platform.feascript.com" target="_blank">https://platform.feascript.com</a>.
9696
</li>
9797
<li>
98-
<strong>Locate the Control Panel</strong> on the right side of the screen.
98+
Locate the Control Panel on the right side of the screen.
9999

100100
<!-- Control Panel Image -->
101101
<div class="image-container">
@@ -104,11 +104,11 @@ <h2 id="tutorial"><a name="Tutorial"></a>Step-by-Step Tutorial</h2>
104104
</div>
105105
</li>
106106
<li>
107-
<strong>Click the "Load Project" button</strong> in the Control Panel under the "Load/Save Project"
107+
Click the "Load Project" button in the Control Panel under the "Load/Save Project"
108108
folder.
109109
</li>
110110
<li>
111-
<strong>Select the `HeatConduction2DFin.xml` file</strong> from your computer.
111+
Select the "HeatConduction2DFin.xml" file from your computer.
112112
<p>
113113
You can download this file from the
114114
<a
@@ -120,7 +120,7 @@ <h2 id="tutorial"><a name="Tutorial"></a>Step-by-Step Tutorial</h2>
120120
</p>
121121
</li>
122122
<li>
123-
<strong>The blocks will be loaded</strong> into the editor, showing the complete simulation setup.
123+
The blocks will be loaded into the editor, showing the complete simulation setup.
124124

125125
<!-- Complete Simulation Setup Blocks Image -->
126126
<div class="image-container">
@@ -135,11 +135,11 @@ <h2 id="tutorial"><a name="Tutorial"></a>Step-by-Step Tutorial</h2>
135135
</p>
136136
</li>
137137
<li>
138-
<strong>Click "Evaluate"</strong> in the Control Panel to run the simulation.
138+
Click "Evaluate" in the Control Panel to run the simulation.
139139
<p>This will execute the blocks in sequence, performing the finite element analysis.</p>
140140
</li>
141141
<li>
142-
<strong>Switch to the "Solution" tab</strong> to view the results.
142+
Switch to the "Solution" tab to view the results.
143143

144144
<!-- Results Image -->
145145
<div class="image-container">

0 commit comments

Comments
 (0)