Template:Boilerplate-Datasheet: Difference between revisions

[checked revision]

← Older edit

VisualWikitext

Latest revision as of 09:01, 25 May 2026

Template:TemplateData

7 mandatory sections (== H2 ==):

Product Overview
Key Features
Applications
Product Variants / Ordering Information
Technical Specifications
Compliance and Certifications
Related Documents

SOJI Electronics

@@ Line 1: / Line 1: @@
 <noinclude>
 {{TemplateData
-|description=Boilerplate template for product datasheet pages following SOJI standard structure. Yellow placeholders auto-hide when filled.
+|description=Boilerplate template for product datasheet pages following SOJI standard structure.
 }}
-</noinclude><includeonly>
-== Product Overview ==
+mandatory sections (== H2 ==):
-{{Placeholder|e.g., The [Product Name] is a [type] device designed for [primary application]. It features [key technology] and is built for [target environment]. Include product name, category, primary function, and key value proposition in 1–2 paragraphs.}}
+# Product Overview
+# Key Features
+# Applications
+# Product Variants / Ordering Information
+# Technical Specifications
+# Compliance and Certifications
+# Related Documents
+[[Category:Boilerplates]]
+</noinclude><includeonly>== Product Overview ==
+<div class="dim">
+''Brief 1–2 paragraph introduction to the product per IEC/IEEE 82079-1.''
+'''What to fill in:'''
+* Product name, category, primary function
+* Key technology and target environment
+* Value proposition for B2B customers
+'''Example structure:''' "The [Product Name] is a [type] device designed for [primary application]. It features [key technology] and is built for [target environment]."
+</div>
 == Key Features ==
-* {{Placeholder|e.g., Ultrasonic fuel level measurement with ±0.3% accuracy}}
+<div class="dim">
-* {{Placeholder|e.g., Bluetooth 5.0 LE connectivity, range up to 50m line-of-sight}}
-* {{Placeholder|e.g., 5+ years battery life on a single CR2 battery}}
+''Bullet list of top 5–7 differentiating features.''
-* {{Placeholder|e.g., IP67 rated for outdoor industrial environments}}
-* {{Placeholder|e.g., Compatible with standard fleet telematics platforms}}
+'''What to fill in:'''
+* Each bullet = 1 key feature with measurable value
+* Focus on: accuracy, connectivity, durability, compatibility
+* Examples of features to cover:
+** Measurement specifications (accuracy, range, response time)
+** Connectivity (Bluetooth/WiFi/Cellular protocol + version)
+** Power (battery life, voltage range)
+** Environmental rating (IP, operating temperature)
+** Compatibility (telematics platforms, software)
+</div>
 == Applications ==
-* {{Placeholder|e.g., Commercial truck and fleet vehicle fuel monitoring}}
+<div class="dim">
-* {{Placeholder|e.g., Backup generator monitoring at telecom sites}}
-* {{Placeholder|e.g., Industrial storage tank level tracking}}
+''Typical use cases and industries the product serves.''
-* {{Placeholder|e.g., Marine bunker fuel monitoring}}
+'''What to fill in:''' bullet list of applications (4–6 items)
+* Each bullet = 1 specific industry/use case
+* Common categories:
+** Transportation/Fleet (trucks, buses, trailers)
+** Telecom (backup generators, base stations)
+** Industrial (storage tanks, process monitoring)
+** Marine (bunker fuel, hydraulic systems)
+** Mining (heavy equipment, refueling stations)
+</div>
 == Product Variants / Ordering Information ==
-{| class="wikitable"
+<div class="dim">
-|-
-! Model !! Part Number !! Description !! Region
+''Table of all product SKUs available for ordering.''
-|-
-| {{Placeholder|e.g., LIGO-AIR-STD}} || {{Placeholder|e.g., SKU-001}} || {{Placeholder|e.g., Standard cabled variant, 2m cable}} || {{Placeholder|e.g., Global}}
+'''What to fill in:''' table with columns:
-|-
+* '''Model''' — short product code (e.g., LIGO-AIR-STD)
-| {{Placeholder|e.g., LIGO-AIR-EXT}} || {{Placeholder|e.g., SKU-002}} || {{Placeholder|e.g., Extended cable variant, 5m cable}} || {{Placeholder|e.g., EU/APAC}}
+* '''Part Number''' — internal SKU (e.g., SKU-001)
-|-
+* '''Description''' — variant differences (cable length, certification, etc.)
-| {{Placeholder|e.g., LIGO-AIR-IND}} || {{Placeholder|e.g., SKU-003}} || {{Placeholder|e.g., Industrial-grade with ATEX certification}} || {{Placeholder|e.g., Global}}
+* '''Region''' — geographic availability (Global, EU/APAC, US only, etc.)
-|}
+'''Common variants:''' Standard / Extended / Industrial-grade / ATEX-certified
+</div>
 == Technical Specifications ==
-{| class="wikitable"
+<div class="dim">
-|-
-! Parameter !! Value !! Unit !! Descriptions
+''Detailed technical parameters of the product.''
-|-
-| {{Placeholder|e.g., Operating voltage}} || {{Placeholder|e.g., 9–32}} || V || {{Placeholder|e.g., DC, reverse-polarity protected}}
-|-
-| {{Placeholder|e.g., Operating current}} || {{Placeholder|e.g., 25}} || mA || {{Placeholder|e.g., Average during measurement}}
-|-
-| {{Placeholder|e.g., Operating temperature}} || {{Placeholder|e.g., −40 to +85}} || °C || {{Placeholder|e.g., Industrial range}}
-|-
-| {{Placeholder|e.g., Wireless protocol}} || {{Placeholder|e.g., Bluetooth 5.0 LE}} || — || {{Placeholder|e.g., LE Secure Connections}}
-|-
-| {{Placeholder|e.g., Ingress protection}} || {{Placeholder|e.g., IP67}} || — || {{Placeholder|e.g., Per IEC 60529}}
-|}
-{{Placeholder|If your product has many specs that need grouping (e.g., Performance / Electrical / Wireless / Environmental / Memory / Mechanical / Interface), you can split this section into sub-sections by adding === Sub-section Name === headings, each with its own table. Otherwise, keep all specs in the single table above.}}
+'''What to fill in:''' specification table with columns Parameter / Value / Unit / Descriptions
+'''Parameters to cover:'''
+* '''Electrical''': Operating voltage, Operating current (avg/peak/sleep), Power consumption
+* '''Performance''': Measurement range, Accuracy, Resolution, Response time, Sampling rate
+* '''Wireless''' (if applicable): Protocol, Frequency band, Output power, Receiver sensitivity, Range
+* '''Environmental''': Operating temperature, Storage temperature, Humidity, Ingress protection (IP)
+* '''Mechanical''': Dimensions (L × W × H), Weight, Mounting interface
+* '''Service life''': Expected years at typical operation
-=== Interface / Connectivity ===
+'''Optional sub-sections:''' If product has many specs, split into <code><nowiki>=== Performance ===</nowiki></code>, <code><nowiki>=== Electrical ===</nowiki></code>, <code><nowiki>=== Wireless ===</nowiki></code>, <code><nowiki>=== Environmental ===</nowiki></code>, <code><nowiki>=== Memory ===</nowiki></code>, <code><nowiki>=== Mechanical Dimensions ===</nowiki></code>, <code><nowiki>=== Interface / Connectivity ===</nowiki></code>, each with its own table.
-{| class="wikitable"
-|-
-! Interface !! Specification
-|-
-| Power connector || {{Placeholder|e.g., 4-pin M12 A-coded, IP67}}
-|-
-| Data interface || {{Placeholder|e.g., RS485 (Modbus RTU) + BLE}}
-|-
-| Configuration interface || {{Placeholder|e.g., USB Type-C (Service port, hidden)}}
-|-
-| Status indicator || {{Placeholder|e.g., Multi-color LED (Power / Status / BLE)}}
-|}
-''Remove this sub-section if all interfaces are covered above.''
+</div>
 == Compliance and Certifications ==
+<div class="dim">
+''Regulatory certifications and standards compliance.''
-=== Wireless / Radio ===
+'''What to fill in (sub-sections):'''
-* CE RED (EU) — {{Placeholder|e.g., certificate number}}
-* FCC Part 15 (US) — {{Placeholder|e.g., FCC ID 2AXXX-XXXX}}
-* IC (Canada) — {{Placeholder|e.g., IC number 12345A-XXXX}}
-* Bluetooth SIG QDID — {{Placeholder|e.g., QDID 123456}}
-* RoHS 3 (Directive 2015/863/EU)
-=== Environmental ===
+* '''Wireless / Radio''' — bullet list of certifications by region:
-* RoHS 3 (Directive 2015/863/EU)
+** CE RED (EU) — certificate number
-* REACH (EC 1907/2006)
+** FCC Part 15 (US) — FCC ID
-* WEEE (Directive 2012/19/EU)
+** IC (Canada) — IC number
-* IP rating: {{Placeholder|e.g., IP67 per IEC 60529}}
+** Bluetooth SIG QDID (if BLE)
+** RoHS 3
-=== Mechanical / Safety ===
+* '''Environmental''' — standards compliance:
-* IEC 60068-2-6 — Vibration test
+** RoHS 3 (Directive 2015/863/EU)
-* IEC 60068-2-27 — Shock test
+** REACH (EC 1907/2006)
-* IEC 60068-2-30 — Damp heat cyclic
+** WEEE (Directive 2012/19/EU)
-* IEC 61010-1 — Safety requirements for electrical equipment
+** IP rating per IEC 60529
-=== Industry-Specific ===
+* '''Mechanical / Safety''' — test standards:
-* {{Placeholder|e.g., ATEX / IECEx — Zone 2 II 3G Ex nA IIC T4 Gc}}
+** IEC 60068-2-6 — Vibration
-* {{Placeholder|e.g., MID (Measuring Instruments Directive) — if used for trade}}
+** IEC 60068-2-27 — Shock
-* {{Placeholder|e.g., Automotive E-Mark — E1 R10}}
+** IEC 60068-2-30 — Damp heat
-* {{Placeholder|e.g., Marine certification — DNV / ABS / Lloyd's Register}}
+** IEC 61010-1 — Electrical safety
-''Remove items that don't apply to the product.''
+* '''Industry-Specific''' (remove if N/A):
+** ATEX / IECEx — for hazardous environments
+** MID — Measuring Instruments Directive
+** Automotive E-Mark — for vehicle applications
+** Marine certification — DNV / ABS / Lloyd's Register
-=== Warranty ===
+* '''Warranty''':
-* '''Standard warranty''': {{Placeholder|e.g., 2}} years from date of shipment
+** Standard warranty period (years from shipment)
-* '''Extended warranty available''': {{Placeholder|e.g., 5}} years (optional)
+** Extended warranty options
-* '''Warranty terms''': see [[Warranty Terms and Conditions]]
+** NOT covered items
+** Void conditions
+** Cross-reference to [[Warranty Terms and Conditions]]
+</div>
+<div class="noprint">
 == Related Documents ==
-* [[User Guide|User Guide]]
+''Cross-references to other documents.''
-* [[Certification & Approvals|Certification & Approvals]]
+{{RelatedDocuments}}
-* [[Frequently Asked Questions - FAQ|FAQ]]
+</div>
-* {{Placeholder|e.g., [[Media:Product-Mechanical-Drawing.pdf|Mechanical Drawing PDF]]}}
-* {{Placeholder|e.g., [[Media:Product-Declaration-of-Conformity.pdf|EU Declaration of Conformity]]}}
 == Revision History ==
-{| class="wikitable"
+<div class="revision-history-auto">
-|-
+<span class="dim">Loading revision history...</span>
-! Version !! Date !! Author !! Changes
+</div>
-|-
-| 1.0 || {{CURRENTYEAR}}-{{CURRENTMONTH}}-{{CURRENTDAY2}} || {{Placeholder|e.g., Cuongnv}} || Initial release
-|-
-| 1.1 || {{Placeholder|e.g., 2026-06-15}} || {{Placeholder|e.g., Author name}} || {{Placeholder|e.g., Updated electrical specs after revision B release}}
-|}
-{{Placeholder|Add product category below. The page will appear under that product in CategoryTree and sidebar. Delete this hint after replacing the category line.}}
+[[Category:{{subst:#replace:{{subst:PAGENAME}}| Datasheet|}}]]
-[[Category:Main Page]]
 </includeonly>