joplin-plugin-calendar-notes 0.9.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Henry Heino
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,204 @@
+# Calendar Notes
+
+Calendar Notes is a Joplin plugin that adds a small calendar panel for opening or creating day-based notes.
+
+Use it as a lightweight daily journal, work log, meeting diary, or any workflow where one note should represent one calendar day.
+
+## Features
+
+- Open a calendar from the note toolbar or the **Tools** menu.
+- Click any day to open the note for that date.
+- Automatically create the note if it does not exist yet.
+- Highlight calendar days that already have matching notes.
+- Navigate between months and jump back to today.
+- Configure the note title format.
+- Choose whether the week starts on Monday or Sunday.
+- Store new calendar notes in a dedicated notebook path.
+- Use an existing Joplin note as a template for newly created calendar notes.
+- Supports English and Russian UI text.
+
+## Requirements
+
+- Joplin **3.5** or newer.
+
+## Installation
+
+### From Joplin
+
+When the plugin is available in the Joplin plugin registry:
+
+1. Open **Tools → Options → Plugins**.
+2. Search for **Calendar Notes**.
+3. Install the plugin and restart Joplin if prompted.
+
+### Manual installation
+
+1. Download the plugin `.jpl` file from the release artifacts.
+2. Open **Tools → Options → Plugins**.
+3. Choose **Install from file**.
+4. Select the downloaded `.jpl` file.
+5. Restart Joplin if prompted.
+
+## Usage
+
+1. Click the calendar button in the note toolbar, or use **Tools → Toggle Calendar**.
+2. The calendar panel opens with the current month.
+3. Click a day:
+   - if a matching note already exists, it is opened;
+   - otherwise, a new note is created and opened.
+4. Use **Previous**, **Next**, and **Today** to navigate the calendar.
+5. Use **Refresh** if you want to update calendar markers manually.
+
+## How notes are matched
+
+Calendar Notes identifies existing notes by their title.
+
+For each visible day, the plugin builds the expected title using the configured note title format. If a note with exactly that title exists anywhere in Joplin, the day is marked as having a note.
+
+By default, notes are named using this format:
+
+```text
+{{YYYY-MM-dd}}
+```
+
+For example, the note for January 5, 2026 is created as:
+
+```text
+2026-01-05
+```
+
+> Existing calendar notes are searched globally by title in all notebooks. New notes are created in the configured notebook path, or in the currently selected notebook if no path is configured.
+
+## Settings
+
+Open **Tools → Options → Calendar Notes** to configure the plugin.
+
+### Note title format
+
+Controls how calendar note titles are generated.
+
+Date expressions must be wrapped in `{{...}}`. Text outside the braces is kept as-is.
+
+Examples:
+
+```text
+{{YYYY-MM-dd}}
+Daily note {{dd.MM.YYYY}}
+Journal / {{YYYY}}-{{MM}}-{{dd}}
+```
+
+Supported date tokens:
+
+| Token | Meaning | Example |
+| --- | --- | --- |
+| `YYYY`, `yyyy` | Four-digit year | `2026` |
+| `YY` | Two-digit year | `26` |
+| `MM`, `mm` | Two-digit month | `01` |
+| `M`, `m` | Month without leading zero | `1` |
+| `DD`, `dd` | Two-digit day | `05` |
+| `D`, `d` | Day without leading zero | `5` |
+
+### Week starts on
+
+Controls the first day of the week in the calendar panel.
+
+Available values:
+
+- Monday
+- Sunday
+
+### Calendar notes notebook path
+
+Controls where new calendar notes are created.
+
+Example:
+
+```text
+Calendar Notes/2026
+```
+
+If the path does not exist, the plugin creates the missing notebooks automatically.
+
+If this setting is empty, new notes are created in the currently selected notebook. If no notebook is selected, Joplin's first available notebook is used as a fallback.
+
+Notebook paths may use `/` or `\` as separators.
+
+### New calendar note template path
+
+Allows using an existing Joplin note as the body template for newly created calendar notes.
+
+Example:
+
+```text
+Templates/Calendar note
+```
+
+If this setting is empty, new calendar notes are created with an empty body.
+
+The value is a Joplin note path. The last path segment is treated as the template note title, and the previous segments are treated as notebook names.
+
+## Template placeholders
+
+Template note bodies support placeholders that are replaced when a calendar note is created.
+
+Example template:
+
+```markdown
+# {{title}}
+
+Date: {{date}}
+
+## Plan
+
+- 
+
+## Notes
+
+
+## Summary
+
+```
+
+Supported placeholders:
+
+| Placeholder | Meaning | Example |
+| --- | --- | --- |
+| `{{title}}`, `{{noteTitle}}` | Generated note title | `2026-01-05` |
+| `{{date}}`, `{{isoDate}}` | ISO date | `2026-01-05` |
+| `{{YYYY}}`, `{{yyyy}}` | Four-digit year | `2026` |
+| `{{YY}}` | Two-digit year | `26` |
+| `{{MM}}`, `{{mm}}` | Two-digit month | `01` |
+| `{{M}}`, `{{m}}` | Month without leading zero | `1` |
+| `{{DD}}`, `{{dd}}` | Two-digit day | `05` |
+| `{{D}}`, `{{d}}` | Day without leading zero | `5` |
+| `{{date:dd.MM.YYYY}}` | Custom date expression | `05.01.2026` |
+
+The `date:` placeholder accepts the same date tokens as the note title format.
+
+## Important notes
+
+- Matching is title-based. If several notes have the same generated title, the plugin opens the first matching note returned by Joplin.
+- Changing the note title format changes which existing notes are recognized as calendar notes.
+- Existing notes are searched in all notebooks, even when a calendar notes notebook path is configured.
+- New notes receive their user-created and user-updated timestamps set to the start of the selected local day.
+- The plugin does not move or rename existing notes automatically.
+
+## Development
+
+Install dependencies:
+
+```bash
+npm install
+```
+
+Build the plugin:
+
+```bash
+npm run dist
+```
+
+The build process creates the plugin package in the generated publish output used by the Joplin plugin tooling.
+
+## License
+
+MIT

package/package.json

@@ -0,0 +1,35 @@
+{
+  "name": "joplin-plugin-calendar-notes",
+  "version": "0.9.0",
+  "description": "Create notes for any day in the calendar",
+  "author": "Eugene Lesnov",
+  "scripts": {
+    "dist": "webpack --env joplin-plugin-config=buildMain && webpack --env joplin-plugin-config=buildExtraScripts && webpack --env joplin-plugin-config=createArchive",
+    "prepare": "npm run dist",
+    "updateVersion": "webpack --env joplin-plugin-config=updateVersion",
+    "update": "npm install -g generator-joplin && yo joplin --node-package-manager npm --update --force"
+  },
+  "license": "MIT",
+  "keywords": [
+    "joplin-plugin"
+  ],
+  "files": [
+    "publish"
+  ],
+  "homepage": "https://github.com/eugene-lesnov/joplin-plugin-calendar-notes",
+  "repository": {
+    "url": "https://github.com/eugene-lesnov/joplin-plugin-calendar-notes"
+  },
+  "devDependencies": {
+    "@types/node": "^18.7.13",
+    "chalk": "^4.1.0",
+    "copy-webpack-plugin": "^11.0.0",
+    "fs-extra": "^10.1.0",
+    "glob": "^8.0.3",
+    "tar": "^6.1.11",
+    "ts-loader": "^9.3.1",
+    "typescript": "^4.8.2",
+    "webpack": "^5.74.0",
+    "webpack-cli": "^4.10.0"
+  }
+}

package/publish/com.github.eugenelesnov.CalendarNotes.json

@@ -0,0 +1,18 @@
+{
+	"manifest_version": 1,
+	"id": "com.github.eugenelesnov.CalendarNotes",
+	"app_min_version": "3.5",
+	"version": "1.0.0",
+	"name": "Calendar Notes",
+	"description": "Create notes for any day in the calendar.",
+	"author": "Eugene Lesnov",
+	"homepage_url": "",
+	"repository_url": "",
+	"keywords": [],
+	"categories": [],
+	"screenshots": [],
+	"icons": {},
+	"promo_tile": {},
+	"_publish_hash": "sha256:f51b4c4f78a7b5cd1146b6658db394f377cfb79afe250e020859964d139f6d53",
+	"_publish_commit": "main:8f0d5859e4476bb189b4458321918a64a05e538e"
+}