[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[elpa] externals/denote 17ad20f356 097/355: Document section on front ma
From: |
ELPA Syncer |
Subject: |
[elpa] externals/denote 17ad20f356 097/355: Document section on front matter |
Date: |
Sun, 26 Jun 2022 23:58:04 -0400 (EDT) |
branch: externals/denote
commit 17ad20f356eb8e113698a01226c211e426a4886c
Author: Protesilaos Stavrou <info@protesilaos.com>
Commit: Protesilaos Stavrou <info@protesilaos.com>
Document section on front matter
---
README.org | 47 ++++++++++++++++++++++++++++++++++++++++++-----
1 file changed, 42 insertions(+), 5 deletions(-)
diff --git a/README.org b/README.org
index f308b471ca..c1ca3ca0d3 100644
--- a/README.org
+++ b/README.org
@@ -196,12 +196,49 @@ in the template. Instead, they have to be assigned to
the user option
(setq denote-org-capture-specifiers "%l\n%i\n%?")
#+end_src
+* Front matter
+:PROPERTIES:
+:CUSTOM_ID: h:13218826-56a5-482a-9b91-5b6de4f14261
+:END:
+
Notes have their own "front matter". This is a block of data at the top
-of the file, which is automatically generated once producing a new
-note. The front matter includes the title and keywords which the user
-specified at the relevant prompts, as well as the date, the unique
-identifier and the file path. To ensure compatibility with the wider
-Org ecosystem, the keywords are recorded as the value of =#+filetags=.
+of the file, which is automatically generated at the creation of a new
+note. The front matter includes the title and keywords (aka "tags" or
+"filetags", depending on the file type) which the user specified at the
+relevant prompt, as well as the date and unique identifier which are
+derived automatically.
+
+This is how it looks for Org mode (~denote-file-type~ is nil):
+
+#+begin_example
+#+title: This is a sample note
+#+date: 2022-06-10
+#+filetags: denote testing
+#+identifier: 20220610T134640
+#+end_example
+
+For Markdown, it looks like this (~denote-file-type~ has the =markdown=
+value):
+
+#+begin_src emacs-lisp
+---
+title: This is a sample note
+date: 2022-06-10
+tags: denote testing
+identifier: 20220610T134718
+---
+#+end_src
+
+And for plain text, we have the following (~denote-file-type~ has the
+=text= value):
+
+#+begin_example
+title: This is a sample note
+date: 2022-06-10
+tags: denote testing
+identifier: 20220610T134829
+---------------------------
+#+end_example
#+vindex: denote-front-matter-date-format
The format of the date in the front matter is controlled by the user
- [elpa] externals/denote 6227df012f 100/355: Make org-capture always set .org extension, (continued)
- [elpa] externals/denote 6227df012f 100/355: Make org-capture always set .org extension, ELPA Syncer, 2022/06/27
- [elpa] externals/denote e840648623 098/355: Fix typo in the manual, ELPA Syncer, 2022/06/27
- [elpa] externals/denote 9f192263db 092/355: Remove file path from front matter; improve links, ELPA Syncer, 2022/06/27
- [elpa] externals/denote db9584f51d 093/355: BREAKING Change date/identifier pattern, ELPA Syncer, 2022/06/27
- [elpa] externals/denote 3e2b560548 099/355: Elaborate on the Overview of Denote, ELPA Syncer, 2022/06/27
- [elpa] externals/denote cfe6e98e7b 090/355: Stop recording the file path in the front matter, ELPA Syncer, 2022/06/27
- [elpa] externals/denote 2bc5df6011 103/355: denote-file-type: 'markdown-yaml', not 'markdown', ELPA Syncer, 2022/06/27
- [elpa] externals/denote d83c166c0d 125/355: Fix regexp for keywords, ELPA Syncer, 2022/06/27
- [elpa] externals/denote ebdacb3fea 073/355: Update doc string of denote-directory function, ELPA Syncer, 2022/06/27
- [elpa] externals/denote 91f4780779 083/355: Merge pull request #3 from kaushalmodi/add-gitignore, ELPA Syncer, 2022/06/27
- [elpa] externals/denote 17ad20f356 097/355: Document section on front matter,
ELPA Syncer <=
- [elpa] externals/denote 929157d424 089/355: Stop using link abbreviation, ELPA Syncer, 2022/06/27
- [elpa] externals/denote a809e9ea1d 087/355: Clarify active development; things might break, ELPA Syncer, 2022/06/27
- [elpa] externals/denote 3f9bfcb74e 101/355: Name the FSF as the copyright holder, ELPA Syncer, 2022/06/27
- [elpa] externals/denote 299b8970ee 095/355: Add support for notes in Markdown and Plain Text, ELPA Syncer, 2022/06/27
- [elpa] externals/denote 112a12e6e5 130/355: Remove duplicate word from face names, ELPA Syncer, 2022/06/27
- [elpa] externals/denote bca23b3e3d 115/355: Clarify how front matter variables are used, ELPA Syncer, 2022/06/27
- [elpa] externals/denote f91d2472c3 128/355: Make the field delimiter face a bit more subtle, ELPA Syncer, 2022/06/27
- [elpa] externals/denote 8a35382067 126/355: Rename internal variable for clarity, ELPA Syncer, 2022/06/27
- [elpa] externals/denote 308322afab 108/355: Fix markdown-toml identifier value, ELPA Syncer, 2022/06/27
- [elpa] externals/denote 11be1d6b40 123/355: Change "tml" to "toml" in denote-toml-front-matter, ELPA Syncer, 2022/06/27