From 04fc526881fc68f6758be3e5af6e747aac17cfae Mon Sep 17 00:00:00 2001 From: Gamosoft Date: Wed, 26 Nov 2025 15:03:17 +0100 Subject: [PATCH] added templating info --- README.md | 1 + documentation/FEATURES.md | 2 + documentation/TEMPLATES.md | 135 +++++++++++++++++++++++ documentation/templates/daily-journal.md | 25 +++++ documentation/templates/meeting-notes.md | 24 ++++ documentation/templates/project-plan.md | 34 ++++++ 6 files changed, 221 insertions(+) create mode 100644 documentation/TEMPLATES.md create mode 100644 documentation/templates/daily-journal.md create mode 100644 documentation/templates/meeting-notes.md create mode 100644 documentation/templates/project-plan.md diff --git a/README.md b/README.md index a42a0b9..31991e6 100644 --- a/README.md +++ b/README.md @@ -210,6 +210,7 @@ Want to learn more? - 🎨 **[THEMES.md](documentation/THEMES.md)** - Theme customization and creating custom themes - ✨ **[FEATURES.md](documentation/FEATURES.md)** - Complete feature list and keyboard shortcuts - 🏷️ **[TAGS.md](documentation/TAGS.md)** - Organize notes with tags and combined filtering +- 📋 **[TEMPLATES.md](documentation/TEMPLATES.md)** - Create notes from reusable templates with dynamic placeholders - 🧮 **[MATHJAX.md](documentation/MATHJAX.md)** - LaTeX/Math notation examples and syntax reference - 📊 **[MERMAID.md](documentation/MERMAID.md)** - Diagram creation with Mermaid (flowcharts, sequence diagrams, and more) - 🔌 **[PLUGINS.md](documentation/PLUGINS.md)** - Plugin system and available plugins diff --git a/documentation/FEATURES.md b/documentation/FEATURES.md index 8685a02..9b6be0a 100644 --- a/documentation/FEATURES.md +++ b/documentation/FEATURES.md @@ -206,6 +206,8 @@ date: {{date}} - **daily-journal** - Daily journal with morning goals and evening reflection - **project-plan** - Project planning template with objectives and timeline +📚 **See [TEMPLATES.md](TEMPLATES.md)** for detailed documentation and example templates you can copy to your instance. + ## ⚡ Keyboard Shortcuts ### General diff --git a/documentation/TEMPLATES.md b/documentation/TEMPLATES.md new file mode 100644 index 0000000..fb88c5a --- /dev/null +++ b/documentation/TEMPLATES.md @@ -0,0 +1,135 @@ +# 📋 Note Templates + +Create notes from reusable templates with dynamic placeholder replacement. + +## Overview + +Templates allow you to quickly create notes with predefined structures and content. Perfect for recurring note types like meeting notes, daily journals, project plans, and more. + +## How to Use Templates + +### 1. Create Template Files + +Templates are stored in the `data/_templates/` folder as markdown files. You will need to create such folder if it doesn't exist: + +``` +data/ +└── _templates/ + ├── meeting-notes.md + ├── daily-journal.md + └── project-plan.md +``` + +### 2. Access Templates + +Click the **"New"** button (or **+** on any folder) and select **"New from Template"**: + +1. Choose a template from the dropdown +2. Enter a name for your new note +3. Click "Create Note" + +The template will be copied with all placeholders replaced automatically! + +### 3. Use Placeholders + +Templates support dynamic placeholders that are replaced when you create a note: + +| Placeholder | Description | Example | +|------------|-------------|---------| +| `{{date}}` | Current date | `2025-11-26` | +| `{{time}}` | Current time | `14:30:45` | +| `{{datetime}}` | Current date and time | `2025-11-26 14:30:45` | +| `{{timestamp}}` | Unix timestamp | `1732632645` | +| `{{title}}` | Note name (without .md) | `Weekly Meeting` | +| `{{folder}}` | Parent folder name | `Projects` | + +### Example Template + +```markdown +--- +tags: [meeting] +date: {{date}} +--- + +# Meeting Notes - {{title}} + +**Date:** {{datetime}} +**Participants:** +- + +## Agenda +- + +## Discussion + + +## Action Items +- [ ] + +## Next Steps + + +``` + +When you create a note called "Team Sync" from this template, it becomes: + +```markdown +--- +tags: [meeting] +date: 2025-11-26 +--- + +# Meeting Notes - Team Sync + +**Date:** 2025-11-26 14:30:45 +**Participants:** +- + +## Agenda +- + +## Discussion + + +## Action Items +- [ ] + +## Next Steps + + +``` + +## Example Templates + +We provide three example templates in `documentation/templates/` that you can copy to your `data/_templates/` folder: + +1. **meeting-notes.md** - Structured meeting notes with agenda, discussion, and action items +2. **daily-journal.md** - Daily journal with morning goals and evening reflection +3. **project-plan.md** - Project planning template with objectives, timeline, and status tracking + +### Using Example Templates + +**Option 1: Copy Manually** +```bash +cp documentation/templates/*.md data/_templates/ +``` + +**Option 2: Create Your Own** +1. Create a `.md` file in `data/_templates/` +2. Add content and placeholders +3. Save and it's ready to use! + +## Tips + +- ✅ Templates can include YAML frontmatter for tags and metadata +- ✅ Use descriptive template names (they appear in the dropdown) +- ✅ Templates work in any folder - the context is preserved +- ✅ You can edit templates anytime - changes apply to new notes only +- ✅ Combine templates with tags for powerful organization + +--- + +**See also:** +- [Tags Documentation](TAGS.md) - Learn about organizing with tags +- [Features Overview](FEATURES.md) - All application features + diff --git a/documentation/templates/daily-journal.md b/documentation/templates/daily-journal.md new file mode 100644 index 0000000..f3843e9 --- /dev/null +++ b/documentation/templates/daily-journal.md @@ -0,0 +1,25 @@ +--- +tags: [journal, daily] +date: {{date}} +--- + +# Daily Journal - {{date}} + +## 🌅 Morning +**Time:** {{time}} + +### Goals for Today +- [ ] +- [ ] +- [ ] + +## 📝 Notes + + +## 🌙 Evening Reflection + + +## 💡 Ideas + + + diff --git a/documentation/templates/meeting-notes.md b/documentation/templates/meeting-notes.md new file mode 100644 index 0000000..220ec44 --- /dev/null +++ b/documentation/templates/meeting-notes.md @@ -0,0 +1,24 @@ +--- +tags: [meeting] +date: {{date}} +--- + +# Meeting Notes - {{title}} + +**Date:** {{datetime}} +**Participants:** +- + +## Agenda +- + +## Discussion + + +## Action Items +- [ ] + +## Next Steps + + + diff --git a/documentation/templates/project-plan.md b/documentation/templates/project-plan.md new file mode 100644 index 0000000..25cee3d --- /dev/null +++ b/documentation/templates/project-plan.md @@ -0,0 +1,34 @@ +--- +tags: [project] +created: {{datetime}} +folder: {{folder}} +--- + +# Project: {{title}} + +## 📋 Overview + + +## 🎯 Objectives +- + +## 📅 Timeline +- **Start Date:** {{date}} +- **Target Completion:** + +## 📦 Deliverables +- + +## 👥 Team + + +## 📊 Status +- [ ] Planning +- [ ] In Progress +- [ ] Review +- [ ] Completed + +## 📝 Notes + + +