-
Notifications
You must be signed in to change notification settings - Fork 1
Expand file tree
/
Copy pathREADME.html
More file actions
576 lines (529 loc) · 25.8 KB
/
Copy pathREADME.html
File metadata and controls
576 lines (529 loc) · 25.8 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>README | Industrial Automation Field Guide</title>
<style>
/* ── Reset ───────────────────────────────────────────────────────────────── */
*, *::before, *::after { box-sizing: border-box; margin: 0; padding: 0; }
html { font-size: 16px; }
body {
font-family: -apple-system, BlinkMacSystemFont, "Segoe UI", Roboto,
"Helvetica Neue", Arial, sans-serif;
line-height: 1.7;
color: #1a1a1a;
background: #f4f4f0;
}
a { color: #1a56a0; text-decoration: none; }
a:hover { text-decoration: underline; }
/* ── Layout ──────────────────────────────────────────────────────────────── */
#layout {
display: grid;
grid-template-columns: 260px 1fr;
min-height: 100vh;
}
/* ── Sidebar ─────────────────────────────────────────────────────────────── */
#sidebar {
background: #1e2736;
color: #c8d0dc;
position: sticky;
top: 0;
height: 100vh;
overflow-y: auto;
border-right: 1px solid #141b27;
scrollbar-width: thin;
scrollbar-color: #2e3a4e transparent;
}
#sidebar::-webkit-scrollbar { width: 5px; }
#sidebar::-webkit-scrollbar-thumb { background: #2e3a4e; border-radius: 3px; }
#sidebar-header {
padding: 1.4rem 1.25rem 1.1rem;
border-bottom: 1px solid #2e3a4e;
}
.site-title {
color: #e8ecf1;
font-weight: 700;
font-size: 0.82rem;
line-height: 1.45;
letter-spacing: 0.06em;
text-transform: uppercase;
display: block;
}
.site-title:hover { text-decoration: none; color: #fff; }
#toc { padding: 1rem 1.25rem; }
#toc ul { list-style: none; padding: 0; margin: 0; }
#toc ul li { margin: 0.1rem 0; }
#toc ul li a {
color: #9aa5b4;
font-size: 0.8rem;
display: block;
padding: 0.2rem 0.4rem;
border-radius: 3px;
transition: background 0.12s, color 0.12s;
line-height: 1.4;
}
#toc ul li a:hover { background: #2e3a4e; color: #e8ecf1; text-decoration: none; }
#toc ul ul { padding-left: 0.85rem; margin-top: 0.05rem; }
#toc ul ul li a { font-size: 0.75rem; }
#toc ul ul ul li a { font-size: 0.71rem; color: #6b7585; }
/* ── Main area ───────────────────────────────────────────────────────────── */
#main {
background: #ffffff;
padding: 2.5rem 3.5rem;
max-width: 960px;
min-height: 100vh;
}
/* ── Breadcrumb ──────────────────────────────────────────────────────────── */
.breadcrumb {
display: flex;
flex-wrap: wrap;
align-items: center;
gap: 0.1rem;
font-size: 0.76rem;
color: #888;
margin-bottom: 0.8rem;
}
.bc-sep { color: #ccc; margin: 0 0.05rem; }
.bc-part { color: #888; }
.bc-current { color: #444; font-weight: 500; }
/* ── Page title ──────────────────────────────────────────────────────────── */
.page-title {
font-size: 2.1rem;
font-weight: 700;
line-height: 1.2;
letter-spacing: -0.02em;
color: #111;
margin-bottom: 1.1rem;
}
/* ── Meta block ──────────────────────────────────────────────────────────── */
.meta-block {
border: 1px solid #e4e4de;
border-radius: 6px;
padding: 0.8rem 1.1rem;
margin-bottom: 2rem;
background: #fafaf7;
display: flex;
flex-wrap: wrap;
gap: 0.45rem 1.8rem;
}
.meta-row {
display: flex;
align-items: baseline;
gap: 0.35rem;
font-size: 0.8rem;
}
.meta-label {
font-weight: 700;
color: #666;
text-transform: uppercase;
font-size: 0.67rem;
letter-spacing: 0.05em;
white-space: nowrap;
}
.meta-value { color: #333; }
.status-badge {
display: inline-block;
padding: 0.1em 0.5em;
border-radius: 3px;
font-size: 0.69rem;
font-weight: 700;
text-transform: uppercase;
letter-spacing: 0.05em;
}
.status-final { background: #d4edda; color: #155724; }
.status-draft { background: #fff3cd; color: #856404; }
.status-inreview { background: #cce5ff; color: #004085; }
.status-review { background: #cce5ff; color: #004085; }
.tag {
display: inline-block;
background: #eef1f8;
color: #3b5ea6;
padding: 0.1em 0.45em;
border-radius: 3px;
font-size: 0.71rem;
font-family: ui-monospace, "SFMono-Regular", Consolas, monospace;
}
/* ── Article typography ──────────────────────────────────────────────────── */
#content h1,
#content h2,
#content h3,
#content h4,
#content h5,
#content h6 {
font-weight: 700;
line-height: 1.25;
color: #111;
margin-top: 2.25rem;
margin-bottom: 0.65rem;
}
#content h1 {
font-size: 1.8rem;
border-bottom: 2px solid #e6e6e2;
padding-bottom: 0.4rem;
}
#content h2 {
font-size: 1.35rem;
border-bottom: 1px solid #ebebeb;
padding-bottom: 0.3rem;
}
#content h3 { font-size: 1.1rem; }
#content h4 { font-size: 1rem; }
#content h5 { font-size: 0.9rem; }
#content h6 { font-size: 0.85rem; color: #555; }
#content p { margin-bottom: 1rem; }
#content strong { font-weight: 700; }
#content em { font-style: italic; }
#content code {
font-family: ui-monospace, "SFMono-Regular", Consolas, "Courier New", monospace;
font-size: 0.84em;
background: #f0f0ec;
padding: 0.15em 0.38em;
border-radius: 3px;
border: 1px solid #deded8;
}
#content pre {
background: #1e2736;
color: #c8d0dc;
padding: 1.15rem 1.4rem;
border-radius: 6px;
overflow-x: auto;
margin: 1.1rem 0 1.4rem;
font-size: 0.84rem;
line-height: 1.55;
border: 1px solid #141b27;
}
#content pre code {
background: none;
padding: 0;
border: none;
border-radius: 0;
color: inherit;
font-size: inherit;
}
#content blockquote {
border-left: 4px solid #b8c4d0;
padding: 0.55rem 1.1rem;
margin: 1.1rem 0;
background: #f6f7fa;
color: #555;
border-radius: 0 5px 5px 0;
}
#content blockquote p:last-child { margin-bottom: 0; }
/* ── Tables ──────────────────────────────────────────────────────────────── */
.table-wrap {
overflow-x: auto;
margin: 1rem 0 1.6rem;
}
#content table {
width: 100%;
border-collapse: collapse;
font-size: 0.875rem;
}
#content thead th {
background: #1e2736;
color: #e8ecf1;
text-align: left;
padding: 0.6rem 0.85rem;
font-weight: 600;
font-size: 0.77rem;
text-transform: uppercase;
letter-spacing: 0.04em;
border: 1px solid #141b27;
}
#content tbody tr:nth-child(even) { background: #f8f9fa; }
#content tbody tr:hover { background: #edf1f8; }
#content tbody td {
padding: 0.5rem 0.85rem;
border: 1px solid #e0e2e6;
vertical-align: top;
line-height: 1.55;
}
/* ── Lists ───────────────────────────────────────────────────────────────── */
#content ul,
#content ol {
padding-left: 1.7rem;
margin-bottom: 1rem;
}
#content li { margin-bottom: 0.3rem; }
#content li > ul,
#content li > ol { margin-top: 0.2rem; margin-bottom: 0; }
/* ── Task / checklist ────────────────────────────────────────────────────── */
#content li.task {
list-style: none;
margin-left: -1.7rem;
padding-left: 2rem;
position: relative;
}
#content li.task .checkbox {
position: absolute;
left: 0.15rem;
font-size: 1rem;
line-height: 1.4;
}
#content li.task.checked { color: #555; }
#content li.task.checked .checkbox { color: #2e7d32; }
#content li.task.unchecked .checkbox { color: #888; }
/* ── Horizontal rule ─────────────────────────────────────────────────────── */
#content hr {
border: none;
border-top: 1px solid #e6e6e2;
margin: 1.75rem 0;
}
/* ── Broken wikilinks ────────────────────────────────────────────────────── */
.broken-link {
color: #b22222;
border-bottom: 1px dashed #b22222;
font-style: italic;
cursor: not-allowed;
}
/* ── Footer ──────────────────────────────────────────────────────────────── */
#page-footer {
margin-top: 3.5rem;
padding-top: 1rem;
border-top: 1px solid #e6e6e2;
font-size: 0.76rem;
color: #aaa;
text-align: center;
}
/* ── Responsive: tablet / mobile ─────────────────────────────────────────── */
@media (max-width: 900px) {
#layout { grid-template-columns: 1fr; }
#sidebar { position: static; height: auto; }
#main { padding: 1.75rem 1.5rem; max-width: 100%; }
.page-title { font-size: 1.6rem; }
}
@media (max-width: 600px) {
#main { padding: 1.25rem 1rem; }
.page-title { font-size: 1.35rem; }
.meta-block { flex-direction: column; gap: 0.35rem; }
}
/* ── Print ───────────────────────────────────────────────────────────────── */
@media print {
#sidebar { display: none; }
#layout { grid-template-columns: 1fr; }
#main { max-width: 100%; padding: 0; box-shadow: none; }
#content a::after { content: " (" attr(href) ")"; font-size: 0.75em; color: #666; }
#content pre { background: #f4f4f0; color: #222; border: 1px solid #ccc; }
#page-header, #page-footer { page-break-inside: avoid; }
}
</style>
</head>
<body>
<div id="layout">
<!-- Sidebar / page TOC -->
<nav id="sidebar" aria-label="Page contents">
<div id="sidebar-header">
<a href="./index.html" class="site-title">
Industrial Automation<br>Field Guide
</a>
</div>
<div id="toc">
<div class="toc">
<ul>
<li><a href="#browse-the-field-guide">Browse the Field Guide</a><ul>
<li><a href="#sections-at-a-glance">Sections at a Glance</a></li>
</ul></li>
<li><a href="#repository-layout">Repository Layout</a></li>
<li><a href="#instructions-templates">Instructions & Templates</a><ul>
<li><a href="#contributing-workflow-short-version">Contributing workflow</a></li>
</ul></li>
<li><a href="#versioning-system">Versioning System</a><ul>
<li><a href="#examples-of-versions">Examples of Versions</a></li>
</ul></li>
<li><a href="#license">License</a></li>
<li><a href="#contributing">Contributing</a></li>
</ul>
</div>
</div>
</nav>
<!-- Main content -->
<div id="main">
<header id="page-header">
<nav class="breadcrumb" aria-label="Location"><span class="bc-current">README</span></nav>
<h1 class="page-title">README</h1>
<div class="meta-block">
<div class="meta-row"><span class="meta-label">Status</span><span class="meta-value"><span class="status-badge status-draft">Draft</span></span></div>
<div class="meta-row"><span class="meta-label">Version</span><span class="meta-value">1.4.0</span></div>
<div class="meta-row"><span class="meta-label">Category</span><span class="meta-value">Documentation, Meta</span></div>
<div class="meta-row"><span class="meta-label">Author</span><span class="meta-value">Yusuf Talan Saunders</span></div>
<div class="meta-row"><span class="meta-label">Last Updated</span><span class="meta-value">2026-04-14</span></div>
<div class="meta-row"><span class="meta-label">Tags</span><span class="meta-value"><span class="tag">#readme</span> <span class="tag">#docs</span> <span class="tag">#meta</span> <span class="tag">#guide</span></span></div>
</div>
</header>
<article id="content">
<h1 id="industrial-automation-field-guide">Industrial Automation Field Guide</h1>
<p>A living, open-source field guide for industrial controls, automation, electrical, process, and systems technicians and engineers.</p>
<p>This guide covers:</p>
<ul>
<li>Basic electrical theory, wiring, and power distribution</li>
<li>Motor control systems, VFDs, and starters</li>
<li>PLC hardware, programming, and troubleshooting</li>
<li>HMI & SCADA basics</li>
<li>Industrial protocols and networking</li>
<li>Safety systems and standards</li>
<li>Troubleshooting methodologies</li>
<li>Preventive & predictive maintenance</li>
</ul>
<hr />
<h2 id="browse-the-field-guide">Browse the Field Guide</h2>
<ul>
<li><strong><a href="markdown/00_Index/Index.md">Master Table of Contents</a></strong> — full index of every topic, rendered in markdown for GitHub.</li>
<li><strong><a href="00_Index/Index.html">HTML Site Index</a></strong> — same TOC, rendered for the website.</li>
<li><strong><a href="index.html">Site Landing Page</a></strong> — quick-browse landing page (HTML).</li>
<li><strong><a href="markdown/">Markdown Source Mirror</a></strong> — every <code>.md</code> file in a parallel tree, ready to be extracted as a standalone repo.</li>
</ul>
<h3 id="sections-at-a-glance">Sections at a Glance</h3>
<p>The guide is organized into 14 sections. Each row links to the markdown source (best for reading directly on GitHub) and the rendered HTML pages.</p>
<table>
<thead>
<tr><th>#</th><th>Section</th><th>Source (Markdown)</th><th>Rendered (HTML)</th></tr>
</thead>
<tbody>
<tr><td>I</td><td>Electrical Fundamentals</td><td><a href="markdown/01_Electrical_Fundamentals/">markdown/01_Electrical_Fundamentals/</a></td><td><a href="01_Electrical_Fundamentals/">01_Electrical_Fundamentals/</a></td></tr>
<tr><td>II</td><td>Power Distribution & Wiring</td><td><a href="markdown/02_Power_Distribution/">markdown/02_Power_Distribution/</a></td><td><a href="02_Power_Distribution/">02_Power_Distribution/</a></td></tr>
<tr><td>III</td><td>Control Devices & Circuits</td><td><a href="markdown/03_Control_Devices/">markdown/03_Control_Devices/</a></td><td><a href="03_Control_Devices/">03_Control_Devices/</a></td></tr>
<tr><td>IV</td><td>Motor Control Systems</td><td><a href="markdown/04_Motor_Control/">markdown/04_Motor_Control/</a></td><td><a href="04_Motor_Control/">04_Motor_Control/</a></td></tr>
<tr><td>V</td><td>PLCs & Automation Hardware</td><td><a href="markdown/05_PLCs%20%26%20Automation%20Hardware/">markdown/05_PLCs & Automation Hardware/</a></td><td><a href="05_PLCs%20%26%20Automation%20Hardware/">05_PLCs & Automation Hardware/</a></td></tr>
<tr><td>VI</td><td>PLC Programming & Logic</td><td><a href="markdown/06_PLC_Programming_%26_Logic/">markdown/06_PLC_Programming_&_Logic/</a></td><td><a href="06_PLC_Programming_%26_Logic/">06_PLC_Programming_&_Logic/</a></td></tr>
<tr><td>VII</td><td>HMI / SCADA Systems</td><td><a href="markdown/07_HMI_SCADA_Systems/">markdown/07_HMI_SCADA_Systems/</a></td><td><a href="07_HMI_SCADA_Systems/">07_HMI_SCADA_Systems/</a></td></tr>
<tr><td>VIII</td><td>Industrial Networks & Protocols</td><td><a href="markdown/08_Industrial_Networks_%26_Protocols/">markdown/08_Industrial_Networks_&_Protocols/</a></td><td><a href="08_Industrial_Networks_%26_Protocols/">08_Industrial_Networks_&_Protocols/</a></td></tr>
<tr><td>IX</td><td>Troubleshooting & Diagnostics</td><td><a href="markdown/09_Troubleshooting_%26_Diagnostics/">markdown/09_Troubleshooting_&_Diagnostics/</a></td><td><a href="09_Troubleshooting_%26_Diagnostics/">09_Troubleshooting_&_Diagnostics/</a></td></tr>
<tr><td>X</td><td>System Integration & Commissioning</td><td><a href="markdown/10_System_Integration_%26_Commissioning/">markdown/10_System_Integration_&_Commissioning/</a></td><td><a href="10_System_Integration_%26_Commissioning/">10_System_Integration_&_Commissioning/</a></td></tr>
<tr><td>XI</td><td>Standards & Codes</td><td><a href="markdown/11_Standards_and_Codes/">markdown/11_Standards_and_Codes/</a></td><td><a href="11_Standards_and_Codes/">11_Standards_and_Codes/</a></td></tr>
<tr><td>XII</td><td>Safety Systems (Advanced)</td><td><a href="markdown/12_Safety_Systems_Advanced/">markdown/12_Safety_Systems_Advanced/</a></td><td><a href="12_Safety_Systems_Advanced/">12_Safety_Systems_Advanced/</a></td></tr>
<tr><td>XIII</td><td>Specialty Topics</td><td><a href="markdown/13_Specialty_Topics/">markdown/13_Specialty_Topics/</a></td><td><a href="13_Specialty_Topics/">13_Specialty_Topics/</a></td></tr>
<tr><td>XIV</td><td>Soft Skills & Workflow</td><td><a href="markdown/14_Soft_Skills_Workflow/">markdown/14_Soft_Skills_Workflow/</a></td><td><a href="14_Soft_Skills_Workflow/">14_Soft_Skills_Workflow/</a></td></tr>
</tbody>
</table>
<blockquote><p>For the full per-topic list with every page linked, open the <strong><a href="markdown/00_Index/Index.md">Master Table of Contents</a></strong>.</p></blockquote>
<hr />
<h2 id="repository-layout">Repository Layout</h2>
<pre><code>.
├── 00_Index/ Table of Contents (HTML, rendered for the site)
├── 01_Electrical_Fundamentals/ … through …
├── 14_Soft_Skills_Workflow/ Section folders — rendered HTML pages for the site
├── instructions/ Vault guide, folder structure doc, page templates (HTML)
├── markdown/ Full mirror of every .md file (standalone-repo ready)
│ ├── 00_Index/Index.md Master TOC (markdown)
│ ├── instructions/ Markdown copies of the four guide documents
│ └── 01_… 14_…/ Section folders with all topic markdown files
├── scripts/ Python generators (convert_to_html.py, generate_pages.py, content_*.py)
├── index.html Site landing page
├── README.md / README.html This file
├── CHANGELOG.md / CHANGELOG.html
├── LICENSE CC BY-SA 4.0 (docs, prose, diagrams)
└── LICENSE-CODE GPL-3.0 (code samples and scripts)
</code></pre>
<hr />
<h2 id="instructions-templates">Instructions & Templates</h2>
<p>The <a href="instructions/"><code>instructions/</code></a> folder holds the meta-documentation that used to live at the root of the repo. Each document is available as both HTML (rendered for the site) and Markdown (in <a href="markdown/instructions/"><code>markdown/instructions/</code></a>, best for reading on GitHub).</p>
<table>
<thead>
<tr><th>#</th><th>Document</th><th>Markdown (GitHub)</th><th>HTML (site)</th></tr>
</thead>
<tbody>
<tr>
<td>01</td>
<td><strong>How to Use This Vault</strong> — versioning, YAML frontmatter, editing conventions, local changelog format.</td>
<td><a href="markdown/instructions/01%20How%20to%20Use%20This%20Vault.md">MD</a></td>
<td><a href="instructions/01%20How%20to%20Use%20This%20Vault.html">HTML</a></td>
</tr>
<tr>
<td>02</td>
<td><strong>Top-Level Folder Structure</strong> — map of section folders and what belongs where.</td>
<td><a href="markdown/instructions/02%20Top-Level%20Folder%20Structure.md">MD</a></td>
<td><a href="instructions/02%20Top-Level%20Folder%20Structure.html">HTML</a></td>
</tr>
<tr>
<td>03</td>
<td><strong>TEMPLATE for Industrial Engineers Field Guide</strong> — filled-out example page showing every section.</td>
<td><a href="markdown/instructions/03%20TEMPLATE%20for%20Industrial%20Engineers%20Field%20Guide.md">MD</a></td>
<td><a href="instructions/03%20TEMPLATE%20for%20Industrial%20Engineers%20Field%20Guide.html">HTML</a></td>
</tr>
<tr>
<td>04</td>
<td><strong>BLANK TEMPLATE for Industrial Engineers Field Guide</strong> — empty page skeleton to copy for new topics.</td>
<td><a href="markdown/instructions/04%20BLANK%20TEMPLATE%20for%20Industrial%20Engineers%20Field%20Guide.md">MD</a></td>
<td><a href="instructions/04%20BLANK%20TEMPLATE%20for%20Industrial%20Engineers%20Field%20Guide.html">HTML</a></td>
</tr>
</tbody>
</table>
<h3 id="contributing-workflow-short-version">Contributing workflow (short version)</h3>
<ol>
<li>Read <strong><a href="markdown/instructions/01%20How%20to%20Use%20This%20Vault.md">01 How to Use This Vault</a></strong> for versioning + YAML rules.</li>
<li>Check <strong><a href="markdown/instructions/02%20Top-Level%20Folder%20Structure.md">02 Top-Level Folder Structure</a></strong> to place your page in the right section.</li>
<li>Copy <strong><a href="markdown/instructions/04%20BLANK%20TEMPLATE%20for%20Industrial%20Engineers%20Field%20Guide.md">04 BLANK TEMPLATE</a></strong> into the right <a href="markdown/"><code>markdown/</code></a> section folder and fill it out. Reference <strong><a href="markdown/instructions/03%20TEMPLATE%20for%20Industrial%20Engineers%20Field%20Guide.md">03 TEMPLATE</a></strong> for a complete example.</li>
<li>Run <code>python scripts/convert_to_html.py</code> to regenerate the HTML output.</li>
<li>Update the master <a href="markdown/00_Index/Index.md">Index</a> and <a href="CHANGELOG.md">CHANGELOG.md</a>.</li>
<li>Submit a pull request.</li>
</ol>
<hr />
<h2 id="versioning-system">Versioning System</h2>
<p>The version system follows this structure:</p>
<p><code>XX.YY.ZZ</code></p>
<ul>
<li><code>XX</code> = MAJOR: Major milestone releases. Significant new sections, major structure changes, or complete reorganizations (for example, adding an entire Robotics section, or restructuring all troubleshooting content).</li>
<li><code>YY</code> = MINOR: Adding new topics, new subsections, major new examples, substantial improvements to explanations, or new diagrams and illustrations in existing topics.</li>
<li><code>ZZ</code> = PATCH: Minor edits, typo fixes, slight wording changes, small new examples, or other incremental additions.</li>
</ul>
<h3 id="examples-of-versions">Examples of Versions</h3>
<table>
<thead>
<tr><th>Version</th><th>Meaning</th></tr>
</thead>
<tbody>
<tr><td>1.0.0</td><td>First "official" complete draft of the field guide with all core sections.</td></tr>
<tr><td>1.1.0</td><td>Added a whole new section on IO-Link Devices.</td></tr>
<tr><td>1.1.3</td><td>Fixed typos in the PLC chapter, added two example diagrams.</td></tr>
<tr><td>2.0.0</td><td>Major overhaul: moved Troubleshooting to top, added Learning Paths.</td></tr>
<tr><td>2.1.0</td><td>Added SCADA Cloud chapter.</td></tr>
<tr><td>2.1.1</td><td>Added two photos of control panels.</td></tr>
</tbody>
</table>
<p>See the full instructions in <a href="markdown/instructions/01%20How%20to%20Use%20This%20Vault.md">01 How to Use This Vault</a> for YAML property reference, local changelog format, and editing best practices.</p>
<p>For project-wide history, see <a href="CHANGELOG.html">CHANGELOG</a>.</p>
<hr />
<h2 id="license">License</h2>
<p>This repository uses a <strong>split-license model</strong>:</p>
<ul>
<li><strong>Documentation content</strong> (prose, explanations, diagrams, tables, and other non-code educational material) is licensed under <strong>Creative Commons Attribution-ShareAlike 4.0 International (CC BY-SA 4.0)</strong>. See <a href="LICENSE">LICENSE</a>.</li>
<li><strong>Code content</strong> (code snippets, scripts, automation utilities, and executable examples) is licensed under <strong>GNU General Public License v3.0 (GPL-3.0)</strong>. See <a href="LICENSE-CODE">LICENSE-CODE</a>.</li>
</ul>
<h3 id="what-this-means-in-plain-english">What this means in plain English</h3>
<p>You are welcome to copy, share, and adapt this project.</p>
<ul>
<li>If you use or remix the <strong>documentation</strong>, you must:
<ul>
<li>Give appropriate credit,</li>
<li>Link to the CC BY-SA 4.0 license,</li>
<li>Indicate if changes were made,</li>
<li>Release adaptations under the same or a compatible ShareAlike license.</li>
</ul></li>
<li>If you use or redistribute <strong>code</strong>, GPL-3.0 terms apply, including making source available and keeping the same license on derivative code distributions.</li>
</ul>
<h3 id="what-you-can-do">What you can do</h3>
<ul>
<li>Use this material for learning, internal training, and published derivative work.</li>
<li>Reuse and adapt documentation with attribution and ShareAlike.</li>
<li>Reuse and modify code under GPL-3.0 requirements.</li>
</ul>
<h3 id="what-you-cannot-do">What you cannot do</h3>
<ul>
<li>Remove attribution or imply the original authors endorse your derivative.</li>
<li>Re-license CC BY-SA documentation as proprietary/closed.</li>
<li>Distribute GPL-covered code derivatives under a non-GPL proprietary license.</li>
</ul>
<h2 id="contributing">Contributing</h2>
<p>Contributions are welcome. Please fork the repository, make your changes, and submit a pull request. For style and metadata conventions, see <a href="markdown/instructions/01%20How%20to%20Use%20This%20Vault.md"><code>markdown/instructions/01 How to Use This Vault.md</code></a>.</p>
<hr />
<p><em>Created and maintained by Yusuf Talan Saunders.</em></p>
<p><em>Industrial Automation Field Guide: A living, open-source field guide for industrial controls, automation, electrical, and process technicians and engineers. Covers everything from basic electrical theory, motor control, PLCs, HMIs, SCADA, VFDs, troubleshooting methods, to industrial networking and safety systems.</em></p>
</article>
<footer id="page-footer">
<p>Industrial Automation Field Guide — v1.4.0 — Draft</p>
</footer>
</div>
</div>
</body>
</html>