Template:Boilerplate-Firmware-Changelog: Difference between revisions

[checked revision]

← Older edit Newer edit →

VisualWikitext

Revision as of 06:43, 19 May 2026

Template:TemplateData

4 mandatory sections (== H2 ==):

Description
Version History
Compatibility
Related Pages

SOJI Electronics

@@ Line 1: / Line 1: @@
 <noinclude>
 {{TemplateData
-|description=Boilerplate for product Firmware Changelog page. Includes inline placeholders and edit hints for each section.
+|description=Boilerplate for product Firmware Changelog page.
 }}
+mandatory sections (== H2 ==):
+# Description
+# Version History
+# Compatibility
+# Related Pages
+[[Category:Boilerplates]]
 </noinclude><includeonly>
 == Description ==
-<!-- WHAT TO WRITE: Brief 1-2 paragraph intro about this changelog. Mention the product, the standard used (e.g., Keep a Changelog), and any naming conventions. -->
+<div class="dim">
-{{Placeholder|e.g., This page lists all firmware releases for the '''LIGO AIR''' fuel level sensor. The changelog follows the [https://keepachangelog.com Keep a Changelog] standard and uses [https://semver.org Semantic Versioning] (MAJOR.MINOR.PATCH). Firmware files are distributed via authorized SOJI partners — contact your sales representative for access.}}
+''Brief intro to the firmware changelog per Keep a Changelog standard.''
+'''What to fill in:'''
+* 1–2 paragraph intro explaining the purpose of this page
+* Specify which product line this firmware changelog covers
+* Mention the standards used:
+** [https://keepachangelog.com Keep a Changelog] for format
+** [https://semver.org Semantic Versioning] (MAJOR.MINOR.PATCH) for version numbering
+* Note how firmware files are distributed (authorized partners, downloadable links, etc.)
+'''Example structure:''' "This page lists all firmware releases for the [Product Name] [type]. The changelog follows the Keep a Changelog standard and uses Semantic Versioning (MAJOR.MINOR.PATCH). Firmware files are distributed via authorized SOJI partners — contact your sales representative for access."
+</div>
 == Version History ==
-<!-- WHAT TO WRITE: One row per firmware version (most recent first).
+<div class="dim">
-     Format for Description cell: bullet list with categories Added/Changed/Fixed/Security/Known Issues
-     Copy a row block (|- to next |-) and paste to add new version. -->
+''Chronological list of all firmware releases (most recent first).''
-{| class="wikitable sortable" style="width:100%; font-size:0.95em"
-|-
+'''What to fill in:''' sortable table with columns:
-! style="width:8%"  | Version
+* '''Version''' — version number per SemVer (e.g., '''1.2.0''', '''1.1.2''')
-! style="width:10%" | Date
+* '''Date''' — release date (YYYY-MM-DD)
-! Description
+* '''Description''' — bullet list grouped by change category
-|-
-| '''1.2.0'''
+'''Description format — use these standard categories:'''
-| 2026-05-01
+* <code><nowiki>* '''Added'''</nowiki></code> — new features
-|
+* <code><nowiki>* '''Changed'''</nowiki></code> — behavior changes / improvements
-* '''Added'''
+* <code><nowiki>* '''Fixed'''</nowiki></code> — bug fixes (link to PCN if applicable)
-** {{Placeholder|e.g., BLE fast-connect pairing — 60% faster pairing time}}
+* <code><nowiki>* '''Security'''</nowiki></code> — security patches (include CVE if applicable)
-** {{Placeholder|e.g., Support for external 1-Wire temperature probe}}
+* <code><nowiki>* '''Known Issues'''</nowiki></code> — limitations with workarounds
-** {{Placeholder|e.g., Configurable sampling rate: 1 / 5 / 10 Hz}}
+* <code><nowiki>* '''Deprecated'''</nowiki></code> — features being phased out
-* '''Changed'''
+* <code><nowiki>* '''Removed'''</nowiki></code> — features removed in this version
-** {{Placeholder|e.g., Measurement accuracy improved from ±0.5% to ±0.3% (full-scale)}}
-** {{Placeholder|e.g., Sleep-mode power consumption reduced by 15%}}
+'''Versioning rules:'''
-* '''Fixed'''
+* MAJOR — incompatible API/protocol changes (requires re-qualification)
-** {{Placeholder|e.g., Fixed BLE disconnect after 30+ days uptime — see PCN-2025-002}}
+* MINOR — new features, backward-compatible
-** {{Placeholder|e.g., Memory leak in logging subsystem causing reboot every ~14 days}}
+* PATCH — bug fixes only
-* '''Security'''
+* Pre-release — append <code>-alpha.N</code>, <code>-beta.N</code>, <code>-rc.N</code>
-** {{Placeholder|e.g., Updated BLE pairing to LE Secure Connections}}
-** {{Placeholder|e.g., Buffer overflow in OTA routine (CVE-2026-XXXX)}}
+'''How to add a new version:''' copy a row block (from <code>|-</code> to next <code>|-</code>) and paste at top of table. Update Version, Date, and Description fields.
-* '''Known Issues'''
-** {{Placeholder|e.g., OTA update fails on iOS 17.4.1 — use Android/USB as workaround}}
+</div>
-** {{Placeholder|e.g., Calibration UI button occasionally unresponsive}}
-|-
-| '''1.1.2'''
-| 2026-03-20
-|
-* '''Fixed'''
-** {{Placeholder|e.g., Hot-fix for boot loop on hardware revision Rev B}}
-** {{Placeholder|e.g., Corrected RTC time drift after low-battery event}}
-|-
-| '''1.1.0'''
-| 2026-02-15
-|
-* '''Added'''
-** {{Placeholder|e.g., Support for Hardware Revision B with improved antenna}}
-* '''Changed'''
-** {{Placeholder|e.g., Default BLE TX power reduced from +4 to 0 dBm}}
-* '''Fixed'''
-** {{Placeholder|e.g., Battery percentage incorrect when below 20%}}
-|-
-| '''1.0.0'''
-| 2025-12-01
-|
-* '''Added'''
-** {{Placeholder|e.g., Initial production release}}
-** {{Placeholder|e.g., BLE 5.0 connectivity}}
-** {{Placeholder|e.g., USB configuration interface}}
-|-
-| '''0.9.0'''
-| 2025-10-10
-| {{Placeholder|e.g., Pre-production beta — engineering samples only}}
-|}
 == Compatibility ==
-<!-- WHAT TO WRITE: Matrix showing which firmware versions work on which hardware revisions.
+<div class="dim">
-     Use ✅ Supported, ⚠️ Known issue, ❌ Not supported.
-     Add columns for each hardware revision your product has. -->
+''Matrix showing which firmware versions work on which hardware revisions.''
-{| class="wikitable"
-|-
+'''What to fill in:''' table with columns:
-! Firmware Version !! Hardware Rev A !! Hardware Rev B !! Hardware Rev C
+* '''Firmware Version''' — version number
-|-
+* '''Hardware Rev A''', '''Rev B''', '''Rev C''', etc. — one column per hardware revision
-| 1.2.0 || {{Placeholder|✅ Supported}} || {{Placeholder|✅ Supported}} || {{Placeholder|✅ Supported}}
-|-
-| 1.1.2 || {{Placeholder|✅ Supported}} || {{Placeholder|✅ Supported}} || {{Placeholder|❌ Not supported}}
-|-
-|}
-{{Placeholder|e.g., If your firmware version is not listed in the compatibility matrix, contact technical support to confirm which hardware revisions are supported.}}
+'''Status indicators:'''
+* ✅ Supported — works without issues
+* ⚠️ Known issue — works but has documented bug
+* ❌ Not supported — incompatible
+'''Note:''' Add as many hardware revision columns as your product has. Remove unused columns.
+'''Closing note suggestion:''' "If your firmware version is not listed in the compatibility matrix, contact technical support to confirm which hardware revisions are supported."
+</div>
 == Related Pages ==
-<!-- WHAT TO WRITE: Cross-links to related wiki pages and external documents (PDFs uploaded via Special:Upload). -->
+<div class="dim">
-* [[{{SUBPAGENAME}} User Guide|User Guide]] {{Placeholder|e.g., installation and operation manual}}
-* [[{{SUBPAGENAME}} Datasheet|Datasheet]] {{Placeholder|e.g., technical specifications}}
+''Cross-links to related wiki pages and downloadable documents.''
-* [[Product Change Notification|PCN List]] {{Placeholder|e.g., notifications of hardware/firmware changes}}
+'''What to fill in:''' bullet list of relevant resources
+* '''Product User Guide''' — installation and operation manual
+* '''Product Datasheet''' — technical specifications
+* '''PCN List''' — notifications of hardware/firmware changes
+* '''Configuration Guide''' — software setup instructions
+* '''Firmware update procedure''' — how to apply firmware updates
+* Optional: link to media files (firmware update guide PDF, release notes archive)
+'''Link format:''' <code><nowiki>[[{{PAGENAME}} User Guide|User Guide]]</nowiki></code> — auto-uses current page parent name
+</div>
 == Revision History ==
 <div class="revision-history-auto">
-<span class="dim">
+<span class="dim">Loading revision history...</span>
-Loading revision history...
-</span>
 </div>
 [[Category:{{subst:#replace:{{subst:PAGENAME}}| Firmware Changelog|}}]]
 </includeonly>