Commit graph

33 commits

Author SHA1 Message Date
Protesilaos Stavrou d83c166c0d
Fix regexp for keywords
Regression was caused by commit 7cba33e.  Thanks to svnsbck for
reporting the problem in issue 9 over at the GitHub mirror:
<https://github.com/protesilaos/denote/issues/9>.
2022-06-11 17:43:09 +03:00
Protesilaos Stavrou a107fbf5d7
Make minor tweaks in the manual 2022-06-11 14:41:15 +03:00
Protesilaos Stavrou 7cba33e08e
LAST BREAKING CHANGE to file-naming scheme
The pattern now is:

    DATE--TITLE__KEYWORDS.EXTENSION

Multiple keywords are separated by underscores.  A multi-word keyword is
separated by hyphens:

    _two_keywords
    one-keyword-many-words

Also see the enforcement of sluggified keywords in commit 6000313.
2022-06-11 12:56:27 +03:00
Protesilaos Stavrou 6000313eec
Enforce sluggification of keywords; document it 2022-06-11 12:19:26 +03:00
Protesilaos Stavrou 60d64ca07c
Document ways to change the front matter 2022-06-11 09:38:13 +03:00
Protesilaos Stavrou 254a6cd0f3
Update date function; enforce RFC3339 when needed
Thanks ot Kaushal Modi for the feedback in issue 7 over at the GitHub
mirror: <https://github.com/protesilaos/denote/issues/7>.
2022-06-11 08:33:46 +03:00
Protesilaos Stavrou 82eeb381dc
Make all front matter abstractions consistent 2022-06-10 20:27:59 +03:00
Protesilaos Stavrou f1f9f757ef
Include markdown-toml sample in the manual
This concludes the work done on issue 4 over at the GitHub mirror with
the help of Kaushal Modi: <https://github.com/protesilaos/denote/issues/4>.
2022-06-10 20:16:11 +03:00
Protesilaos Stavrou 2bc5df6011
denote-file-type: 'markdown-yaml', not 'markdown'
This makes it specific that the front matter is YAML-compliant.  It also
gives us the option to support TOML.

Thanks to Kaushal Modi for the feedback in issue 4 over at the GitHub
mirror: <https://github.com/protesilaos/denote/issues/4>.
2022-06-10 17:32:24 +03:00
Protesilaos Stavrou f9b86149fc
Rephrase package overview 2022-06-10 16:10:07 +03:00
Protesilaos Stavrou 6227df012f
Make org-capture always set .org extension 2022-06-10 15:04:10 +03:00
Protesilaos Stavrou 3e2b560548
Elaborate on the Overview of Denote 2022-06-10 14:21:55 +03:00
Protesilaos Stavrou e840648623
Fix typo in the manual 2022-06-10 14:21:35 +03:00
Protesilaos Stavrou 17ad20f356
Document section on front matter 2022-06-10 14:21:09 +03:00
Protesilaos Stavrou 3df88a05d0
Make linking aware of file types (extends 299b897)
I think this is a cool feature, especially the ability to read the
relevant file in order to use the correct link format.
2022-06-10 13:30:05 +03:00
Protesilaos Stavrou 299b8970ee
Add support for notes in Markdown and Plain Text
The new user option 'denote-file-type' lets the user pick between the
aforementioned two or Org (which remains the default).
2022-06-10 13:29:36 +03:00
Protesilaos Stavrou e1bd4c9cb8
BREAKING Put keywords after the title
Putting the tags/keywords at the end of the file has several advantages:

1. It is consistent with how such interfaces are designed, such as with
   the 'elfeed', 'notmuch', and 'mu4e' Emacs packages.

2. It makes it easier to read the title of the file even if it is
   truncated.

3. Makes fontification look better, as the more intensely coloured
   keywords are further apart from the date/identifier which is also
   colourful.

One way to update existing file names in Dired:

* Switch to wdired (C-x C-q by default)
* M-x isearch-forward-regexp (bound to C-M-s by default)
* Search for (without the quotes) '--\(.*?\)--\(.*?\)\.org'
* While in isearch, type M-%
* For the replacement use (without the quotes) '--\2--\1.org'
* Verify the conversion as you go through the query-replace.

A similar series of steps can be followed for file contents (e.g. by
making the grep buffer editable with the wgrep package).
2022-06-10 08:08:37 +03:00
Protesilaos Stavrou db9584f51d
BREAKING Change date/identifier pattern
Before it was like 20220531_091625, but now it is 20220531T091625.

I also introduced a new face, in case someone wants to style the time
part separately.
2022-06-10 07:46:52 +03:00
Protesilaos Stavrou a809e9ea1d
Clarify active development; things might break 2022-06-09 08:36:13 +03:00
Protesilaos Stavrou ab27f5a547
Tweak sample configuration 2022-06-09 08:33:54 +03:00
Protesilaos Stavrou 5dace99b8d
Acknowledge Kaushal Modi for commit f97f1f8 2022-06-08 19:41:15 +03:00
Protesilaos Stavrou d8b2903fa9
Acknowledge Jack Baty for commit dfc3a8f
Jack's contribution is below the ~15 line threshold that is required for
projects that are distributed via GNU ELPA (denote will be one of them
in the near future).

Contributions exceeding that limit require that the author assigns
copyright to the Free Software Foundation.
2022-06-08 14:36:23 +03:00
Protesilaos Stavrou 69e35281da
Document denote-front-matter-date-format 2022-06-08 12:33:07 +03:00
Protesilaos Stavrou 52fd454153
Document denote-sort-keywords 2022-06-08 12:32:52 +03:00
Protesilaos Stavrou 96eee4aeba
Change placement of findex keyword in the manual 2022-06-08 12:18:20 +03:00
Protesilaos Stavrou f8ea03abfb
Add documentation about renaming non-notes 2022-06-08 12:16:24 +03:00
Protesilaos Stavrou 3ef51e9cd7
Update documentation about denote-dired-mode 2022-06-08 11:59:55 +03:00
Protesilaos Stavrou 431124fea1
Generalise dired fontification
There is no need to limit it to the denote-directory.  We ultimately
want to fontify all Denote-style file names, not just the notes created
by Denote.

For example, I have been recording all my longer-term storage using such
a naming scheme: this mode gives me the extra faces for .pdf, .mp3, and
other files.

Users of Denote may want this for attachments.

The upside of having this as a buffer-local mode is that the user can
write a wrapper function that applies the mode only in a given
directory (like we were doing before).

Thanks to Ypot for suggesting a kernel of this idea in issue 1 over at
the GitHub mirror: <https://github.com/protesilaos/denote/issues/1>.
2022-06-08 10:45:46 +03:00
Protesilaos Stavrou 9bf10437e0
Add denote-front-matter-date-format user option
Thanks to Kaushal Modi for proposing the use of an Org timestamp.  (It
was done via email and this information is shared with permission.)
2022-06-08 07:50:36 +03:00
Protesilaos Stavrou bf342a1d39
Correct factual statement about command args 2022-06-07 21:29:48 +03:00
Protesilaos Stavrou 610c2f1670
Comment out inactive link to change log
We will have one eventually.
2022-06-07 18:47:24 +03:00
Protesilaos Stavrou f33f8a7040
Rewrite README as a manual 2022-06-07 17:22:03 +03:00
Protesilaos Stavrou d0dbbab603
Update short descriptions 2022-06-07 14:15:45 +03:00
Renamed from README.md (Browse further)