aboutsummaryrefslogtreecommitdiff
path: root/CHANGELOG.org
diff options
context:
space:
mode:
Diffstat (limited to 'CHANGELOG.org')
-rw-r--r--CHANGELOG.org102
1 files changed, 102 insertions, 0 deletions
diff --git a/CHANGELOG.org b/CHANGELOG.org
new file mode 100644
index 0000000..2ddf21c
--- /dev/null
+++ b/CHANGELOG.org
@@ -0,0 +1,102 @@
+** Changes since 0.1.0
+
+*** Breaking changes
+
+- Seam's code has been moved to the =lisp/= subdirectory, where it
+ should have been all along. Make sure to update your =init.el=
+ accordingly.
+
+- Seam now uses [[https://github.com/Wilfred/mustache.el][mustache.el]] for templating. In Mustache,
+ double-bracketed variables are escaped, so you must use
+ triple-brackets for variables that include raw HTML. Please see the
+ updated =seam-export-default-template-string= for reference.
+
+- Your =seam-title-formatter= function should now take three arguments
+ instead of two: the third arg (=draft-p=) will be non-nil if the
+ note is a draft.
+
+**** Renamed variables
+
+- =seam-export-time-format-datetime= is now
+ =seam-export-time-format-dt=.
+
+**** Renamed functions
+
+- =seam-make-note= is now =seam-create-note=.
+
+- =seam-replace-string-in-notes= is now
+ =seam-replace-string-in-all-notes=.
+
+- =seam-visited-files= is now =seam-visited-notes=.
+
+*** New features
+
+- Notes can now be set as drafts for finer-grained control over
+ exporting. If =seam-create-as-draft= is non-nil, new notes will be
+ created as drafts. See =seam-note-types= for info on overriding
+ this per type. A note's draft status can be toggled with the new
+ command =seam-toggle-draft=. A new =seam-export-alist= option,
+ =:include-drafts=, controls whether drafts are included in a given
+ export profile.
+
+- Custom template variables can now be defined, and built-in ones
+ overridden. This is done globally with
+ =seam-export-template-values=, or per profile with
+ =:template-values=.
+
+- Added two new optional properties: =SEAM_CREATED= and
+ =SEAM_MODIFIED=. These can be accessed within templates using
+ ={{created}}=, ={{created-dt}}=, ={{modified}}=, and
+ ={{modified-dt}}=. If the new properties are not specified,
+ defaults will be pulled from filesystem metadata as before. (There
+ is no reliable way to know a file's true creation date, so in the
+ absence of =SEAM_CREATED=, creation date is assumed to be the same
+ as modification.)
+
+- An option has been added to export internal links with a custom CSS
+ class. The default is set by =seam-export-internal-link-class=, and
+ can overridden per profile using =:internal-link-class=.
+
+- Custom slugs can now be set by adding the =SEAM_SLUG= property to a
+ note's title headline.
+
+*** Improvements
+
+- Notes are no longer re-exported unnecessarily whenever a linked note
+ is changed.
+
+- In HTML templates, ={{title}}= now strips out formatting, so that it
+ is more suitable for use in =<title>= tags. To get a raw
+ HTML-formatted title for =<h1>= tags and the like, you should use
+ the new ={{{raw-title}}}=. As mentioned above, triple brackets are
+ the Mustache syntax for interpolating raw HTML.
+
+- When invoking =seam-delete-note=, the note's title is now mentioned.
+ This is to reduce the risk of deleting the wrong note by mistake.
+
+- Completion support is somewhat improved. =ido-completing-read= now
+ works properly, and Seam no longer binds =completion-ignore-case=.
+
+- Changes to =seam-export-alist= are now respected when forcibly
+ re-exporting (e.g. with =seam-export-all-notes=). This is done by
+ always deleting old HTML files before exporting, thus avoiding the
+ situation where notes of no-longer-exported types still have files
+ hanging around.
+
+*** Bugfixes
+
+- Notes with single quotes in the name (') are no longer broken.
+
+- =seam-visited-notes= no longer returns buffers that visit non-note
+ files within =seam-note-directory=. This could have resulted in
+ Seam inappropriately modifying those files (e.g. updating links).
+
+- Buffer titles are now set correctly from narrowed buffers.
+
+- An issue with regexp escape sequences being interpreted in template
+ variable replacements has been fixed.
+
+- Seam now validates note types entered with =C-u seam-set-note-type=,
+ averting any mishaps if an invalid type is entered.
+
+- It is no longer possible to create a note with an empty slug.