Skip to content

Commit

Permalink
docs: release notes
Browse files Browse the repository at this point in the history
  • Loading branch information
danielo515 committed Jun 22, 2024
1 parent dd86283 commit 388450c
Show file tree
Hide file tree
Showing 7 changed files with 54 additions and 2 deletions.
2 changes: 2 additions & 0 deletions docs/blog/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
# Blog

Original file line number Diff line number Diff line change
@@ -1,11 +1,12 @@
---
title: Release notes for 1.46.0
date: 2024-06-15
tags: release-notes
---

This release contains one little change that was easy to make, but I think that it unlocks a very interesting use case for modal forms.
There is a not very well documented feature in the FormEditor that allows to define a specific (and simple) template linked to that form.
I implemented it partially for fun, because I love coding parsers but also partially because many times I only need very basic templating
I implemented it partially for fun, because I love coding parsers but also partially because many times I only need very basic templating
functionality and I don't want to have to write another templater template.
Also, I find very appealing the idea of having both the form and the template visible and linked in the same place, which is not the case when you use templater templates.
Up until now, the only thing you can use this templates for was for creating new notes from that template.
Expand Down
43 changes: 43 additions & 0 deletions docs/blog/posts/Release_1_47_0.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
---
title: Release notes for 1.47.0 and a statement of intent
date: 2024-06-22
tags: release-notes
---

## Release notes for 1.47.0

This is mostly a technical release that also includes some minor improvements.

The technical part of it is that now the fields of the form are rendered using svelte rather than manually calling DOM manipulation methods
or the obsidian `Setting` class.
I made this because it simplifies the creation of the view, it will be more maintainable, but the most important reason is that it will
make much much easier to implement functionalities that require atomic re-renders of the form.
The most important and requested feature this will enable is the ability to have dynamic fields that depend on the value of other fields.
**This is not implemented yet**, but it will be much easier to do now and I will start working on it soon.

For the minor improvements, I added some more color to the form fields, so now the stars that indicate required fields are colorful.

![colorful stars](<Screenshot 2024-06-22 at 13.42.07.png>)

I also improved the error messages when submitting a form with errors.
Now the error message appears below the field in red color:

![better field errors](<Screenshot 2024-06-22 at 13.41.51.png>)

Also related to errors, the notifications that appear when submitting a form with errors are now grouped in a single notification containing all the errors:

![grouped notification errors](<Screenshot 2024-06-22 at 13.41.42.png>)

### Statement of intent

When I started this project, I had not much experience with Obsidian and absolute no experience with Obsidian plugin development.
Also, my initial idea was to create a very simple plugin, basically something wrapping some basic existing Obsidian functionality and glueing it with some other tools I like to use (templater mainly) while making the process streamlined and more user friendly.
Since then, the plugin has gained a lot of popularity, it has some thousand of installs, making it my most popular project by far.
Coming from a web development background, I was imposing myself some limitations that I learned that do not make any sense in Obsidian.
For example, at first I was very worried about the bundle size of the plugin (which is still very small) and I was trying to avoid using external libraries as much as possible.
However, some of the most popular plugins weight several MBs and nobody seems to care.
Also, many plugins diverge significantly from the Obsidian default appearance, and that is not a problem at all.
What does that mean for modal form? That I will try to build better functionalities, always trying to keep the plugin simple and focused, but I will no longer
limit myself to what Obsidian offers out of the box, and I will not be afraid of using external libraries if they make sense.

Hope you like the direction I'm taking with the plugin. I'm very excited about the future of it.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
8 changes: 7 additions & 1 deletion mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,13 @@ nav:
- Manging results: managing-results.md
- Change log: changelog.md
- Importing a form: import-forms.md

- Blog:
- blog/index.md
plugins:
- search
- tags
- blog:
blog_toc: true
theme:
name: material
icon:
Expand Down

0 comments on commit 388450c

Please sign in to comment.