SDCObsidianTemplate

An Obsidian, Templater template for creating SDCStudio Markdown Templates.

SDCStudio Obsidian Template

Version License SDC

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

  1. Install Prerequisites

  2. Download Template

  3. Install

    • Copy templates/ObsidianDataSetTemplate.md to your vault's templates/ folder
    • Copy snippets/sdcstudio-theme.css to your vault's .obsidian/snippets/ folder
    • Enable CSS snippet in Obsidian Settings → Appearance → CSS Snippets
  4. 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:ComponentLabel for 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 WriteMaps To SDC4When to Use
textXdString, XdTokenFree text, strings, categorical with enum
integerXdCount, XdOrdinal, XdStringWhole numbers (add units for XdCount)
decimalXdQuantity, XdFloat, XdDoubleDecimals (add units for XdQuantity)
booleanXdBooleanTrue/False, Yes/No
dateXdTemporalDates only (YYYY-MM-DD)
datetimeXdTemporalDates with time
identifierXdStringIDs, codes, UUIDs
emailXdString (validated)Email addresses
urlXdLinkWeb 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)

Full Changelog


šŸ› ļø Installation

Quick Install

  1. Copy template file:

    cp templates/ObsidianDataSetTemplate.md [your-vault]/templates/
    
  2. Copy CSS theme:

    cp snippets/sdcstudio-theme.css [your-vault]/.obsidian/snippets/
    
  3. Configure Templater:

    • Obsidian Settings → Templater
    • Set "Template folder location" to templates
  4. Enable CSS theme:

    • Obsidian Settings → Appearance → CSS Snippets
    • Toggle ON "sdcstudio-theme"

šŸ“š Detailed Installation Guide


šŸ“– Documentation


šŸ¤ 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

Related Projects


šŸ“Š 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


🌟 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

Related

How to Install

  1. Download the repository ZIP below
  2. Unzip it and find the CSS snippet file
  3. Move the CSS file into your vault's .obsidian/snippets/ folder
  4. Open Obsidian → Settings → Appearance → CSS Snippets → Enable it

Stats

Stars

2

Forks

1

License

Apache-2.0

Last updated 3mo ago

Categories