SDCObsidianTemplate
An Obsidian, Templater template for creating SDCStudio Markdown Templates.
SDCStudio Obsidian Template
Create SDC4-compliant dataset descriptions with ease using Obsidian
An interactive Templater template and professional CSS theme for creating SDC4 (Semantic Data Charter) compliant dataset descriptions in Obsidian.
š Quick Start
-
Install Prerequisites
- Obsidian v1.0.0+
- Templater Plugin v1.16.0+ (free community plugin)
-
Download Template
- Download latest release
- Or clone this repository
-
Install
- Copy
templates/ObsidianDataSetTemplate.mdto your vault'stemplates/folder - Copy
snippets/sdcstudio-theme.cssto your vault's.obsidian/snippets/folder - Enable CSS snippet in Obsidian Settings ā Appearance ā CSS Snippets
- Copy
-
Use
- Create new note in Obsidian
- Run Templater: Insert template ā ObsidianDataSetTemplate
- Follow the interactive prompts
- Upload resulting markdown to SDCStudio
š Full Installation Guide | š Usage Guide | šØ Theme Guide
⨠Features
Interactive Template (v4.3.0)
- ā Quick / Guided mode - Choose your pace: ~15 prompts for Quick, full control in Guided
- ā Domain-aware defaults - Pick Healthcare, get "Patient" pre-filled; pick Government, get "Citizen"
- ā Subject / Provider / Participation - Model who the record is about, who provided it, and other parties
- ā
User-friendly types -
text,integer,decimal,boolean,date,datetime,identifier,email,url - ā
Component reuse -
@ProjectName:ComponentLabelfor NIEM, FHIR, HL7v3, openEHR - ā Consolidated constraints - One prompt: No / Required / Required+Unique / Custom
- ā SDC4 named trees - Data, Subject, Provider, Participation, Workflow, Attestation, Audit, Links
- ā Unlimited loops - Add as many columns and participations as needed
- ā Clean output - Toast notifications for progress, no artifacts in the generated document
Professional Theme
- ā SDCStudio colors - Official design system (#0a2342, #2ca58d, #f0a500, #f7f9fb)
- ā Professional tables - Blue headers matching SDCStudio web app
- ā Special styling - Dataset columns and clusters get highlighted formatting
- ā Display-only - Does NOT modify your markdown files (safe for SDCStudio upload)
- ā WCAG compliant - Accessible colors and contrast ratios
š¦ What's Included
SDCObsidianTemplate/
āāā templates/
ā āāā ObsidianDataSetTemplate.md # Main Templater template (v4.3.0)
āāā snippets/
ā āāā sdcstudio-theme.css # CSS theme for SDCStudio styling
āāā docs/
ā āāā INSTALL.md # Installation guide
ā āāā USAGE.md # Usage guide with examples
ā āāā THEME.md # Theme customization guide
āāā LICENSE # Apache 2.0
āāā README.md # This file
š” Example Usage
Type Reference
| Type You Write | Maps To SDC4 | When to Use |
|---|---|---|
text | XdString, XdToken | Free text, strings, categorical with enum |
integer | XdCount, XdOrdinal, XdString | Whole numbers (add units for XdCount) |
decimal | XdQuantity, XdFloat, XdDouble | Decimals (add units for XdQuantity) |
boolean | XdBoolean | True/False, Yes/No |
date | XdTemporal | Dates only (YYYY-MM-DD) |
datetime | XdTemporal | Dates with time |
identifier | XdString | IDs, codes, UUIDs |
email | XdString (validated) | Email addresses |
url | XdLink | Web links, URLs, URIs |
Component Reuse
### Column: State
**ReuseComponent**: @NIEM:StateUSPostalServiceCode
**Type**: text
**Description**: US State postal code
### Column: PatientID
**ReuseComponent**: @HL7v3:PatientIdentifier
**Type**: identifier
**Description**: Unique patient identifier
š Version History
v4.3.0 (2026-02-19) - Current
Align with SDC4 named trees
## Root Cluster:renamed to## Data:to match SDC4 data model- Sub-clusters removed entirely ā all sections are flat columns only
- New optional sections: Workflow, Attestation, Audit, Links
- All 8 SDC4 named trees supported
v4.2.0 (2026-02-15)
Complete UX redesign
- Quick / Guided mode for controlling prompt depth
- Domain-aware defaults for Subject, Provider, and cluster names
- Single participation-scope decision replaces separate yes/no prompts
- Toast notifications instead of comment-based progress markers
- Unlimited column and participation loops
- Consolidated constraint prompt
- Clean, artifact-free output
v4.1.0 (2026-02-15)
- Subject/Provider/Participation sections for SDC4 participation model
- Function and Mode keywords for Participation sections
v4.0.1 (2025-11-03)
Documentation Enhancement
- Added comprehensive KEYWORD_REFERENCE.md (430+ lines)
- Complete documentation for all keywords and syntax
- Aligned with SDCStudio keyword documentation
- Added references in README, USAGE, and template
v4.0.0 (2025-11-02)
Major redesign fixing all v1.0 issues
Fixed:
- ā System hanging ā ā Non-blocking prompts with visual feedback
- ā Limited to 2 columns ā ā Unlimited scalability
- ā Confusing UX ā ā Clear, guided workflow
- ā No component reuse ā ā Full @ProjectName:ComponentLabel support
- ā Poor markdown structure ā ā Spec-compliant output
New Features:
- Component reuse from NIEM, FHIR, HL7v3, openEHR
- User-friendly type system with SDC4 mapping
- Complete YAML front matter
- Structured constraints (YAML format)
- LLM enrichment toggle
- Copy-paste templates for scalability
- SDCStudio design system theme
Breaking Changes: None (new major version)
š ļø Installation
Quick Install
-
Copy template file:
cp templates/ObsidianDataSetTemplate.md [your-vault]/templates/ -
Copy CSS theme:
cp snippets/sdcstudio-theme.css [your-vault]/.obsidian/snippets/ -
Configure Templater:
- Obsidian Settings ā Templater
- Set "Template folder location" to
templates
-
Enable CSS theme:
- Obsidian Settings ā Appearance ā CSS Snippets
- Toggle ON "sdcstudio-theme"
š Detailed Installation Guide
š Documentation
- Installation Guide - Step-by-step setup instructions
- Usage Guide - How to use the template with examples
- Keyword Reference - Complete keyword documentation and syntax guide
- Theme Guide - CSS theme setup and customization
- Changelog - Version history and changes
- Contributing - How to contribute to this project
š¤ Contributing
We welcome contributions! This project is part of Axius SDC, Inc.'s commitment to open source.
Ways to contribute:
- š Report bugs via GitHub Issues
- š” Suggest features or improvements
- š Improve documentation
- š§ Submit pull requests
See CONTRIBUTING.md for guidelines.
š¢ About
Project Information
- Maintained by: Axius SDC, Inc.
- Part of: Semantic Data Charter ecosystem
- Works with: SDCStudio v4.0.0+
- License: Apache 2.0 (see LICENSE)
Related Projects
- SDCStudio - Django application for creating SDC4 data models
- Semantic Data Charter - Core SDC4 reference model
- Axius SDC Website - Company website and resources
š Use Cases
Perfect for:
- š Data Architects - Building SDC4-compliant schemas
- š¬ Researchers - Documenting research datasets
- š„ Healthcare Teams - Creating clinical data models
- š¼ Enterprise Teams - Standardizing data documentation
- š Students - Learning semantic data modeling
š Workflow
1. Create note in Obsidian
ā
2. Insert SDCStudio template
ā
3. Answer interactive prompts
ā
4. Review with beautiful styling
ā
5. Upload markdown to SDCStudio
ā
6. Generate XSD, XML, JSON, RDF, SHACL, GQL
āļø System Requirements
- Obsidian: v1.0.0 or later
- Templater Plugin: v1.16.0 or later (free)
- Operating Systems: Windows, Mac, Linux
- Disk Space: ~70 KB
š Security & Privacy
- ā No telemetry - Template runs entirely locally
- ā No network calls - All processing in Obsidian
- ā No data collection - Your notes stay private
- ā Open source - Review the code yourself
š License
Copyright Ā© 2025 Axius SDC, Inc.
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
See LICENSE for full details.
š Acknowledgments
- Obsidian - For the amazing knowledge management platform
- Templater - For the powerful template plugin
- Semantic Data Charter - For the SDC4 reference model
- All contributors and users who provide feedback and improvements
š Support
- Documentation: Check the docs/ folder
- Issues: GitHub Issues
- Discussions: GitHub Discussions
- Website: axius-sdc.github.io
š Star This Repository
If you find this project useful, please consider giving it a āļø on GitHub!
Made with ā¤ļø by Axius SDC, Inc.
Empowering semantic data modeling for everyone
How to Install
- Download the repository ZIP below
- Unzip it and find the CSS snippet file
- Move the CSS file into your vault's
.obsidian/snippets/folder - Open Obsidian ā Settings ā Appearance ā CSS Snippets ā Enable it
Stats
Stars
2
Forks
1
License
Apache-2.0
Last updated 3mo ago
Categories