layer: org: README.org: Org-journal support: rw body text

This commit is contained in:
Anton-Latukha 2018-07-25 00:59:29 +03:00 committed by Sylvain Benner
parent a78c8fec01
commit 026ba14691
1 changed files with 27 additions and 24 deletions

View File

@ -138,10 +138,15 @@ Alternatively, add the following line to each =.org= file you want to process:
#+END_EXAMPLE
** Org-journal support
[[https://github.com/bastibe/org-journal][org-journal]] is a simple journal management system for keeping a seperate journal
file for each day inside a directory.
[[https://github.com/bastibe/org-journal][org-journal]] is a simple journal management system that:
* Keeps a separate journal file for each day inside a directory
* New daily file would always migrate entries with chosen TODO states
* Has journal encryption functionality
* Easily integrates with org-agenda and Emacs calendar, iCalendar,
allows scheduling
* Easily integrates with org-capture
To install org-journal set the variable =org-enable-org-journal-support= to =t=.
To install org-journal - set the variable =org-enable-org-journal-support= to =t=.
#+BEGIN_SRC emacs-lisp
(setq-default dotspacemacs-configuration-layers '(
@ -149,35 +154,33 @@ To install org-journal set the variable =org-enable-org-journal-support= to =t=.
org-enable-org-journal-support t)))
#+END_SRC
By default journal files are stored in =~/Documents/journal/=. You can override
this by setting =org-journal-dir= in =dotspacemacs/user-config=
By default, journal files are stored in =~/Documents/journal/=. To override
this - set =org-journal-dir= variable in the =dotspacemacs/user-config=:
#+BEGIN_SRC emacs-lisp
(setq org-journal-dir "~/org/journal/")
#+END_SRC
You can change the journal file name format by altering
=org-journal-file-format=.
To change the journal file name format - alter =org-journal-file-format=:
#+BEGIN_SRC emacs-lisp
(setq org-journal-file-format "%Y-%m-%d")
#+END_SRC
*Warning:* setting =org-journal-file-format= to include a file extension like
=%Y-%m-%d.org= breaks calender search functionality.
=%Y-%m-%d.org= would break the calendar search functionality.
By default journal files are started with a first level heading (=*=) followed
by the date formatted for the locale. If you prefer that your journal files are
formatted differently you can alter =org-journal-date-prefix= and
=org-journal-date-format=.
By default, journal files are started with a first level heading (=*=) followed
by the date in the form set by locale. To format journal files differently
- alter =org-journal-date-prefix= and =org-journal-date-format=.
For example, to have your new journal files created with this header:
For example, to have new journal files created with this header:
#+BEGIN_EXAMPLE
#+TITLE: Tuesday, September 06 2016
#+END_EXAMPLE
Simply define the following in =dotspacemacs/user-config=
- define the following in =dotspacemacs/user-config=:
#+BEGIN_SRC emacs-lisp
(setq org-journal-date-prefix "#+TITLE: ")
@ -195,7 +198,7 @@ the timestamp.
#+END_SRC
Any of the org-journal settings can be configured in =dotspacemacs/user-config=
or defined along side the layer itself.
or defined alongside the layer itself.
For example:
@ -203,15 +206,15 @@ For example:
#+BEGIN_SRC emacs-lisp
(setq-default dotspacemacs-configuration-layers '(
(org :variables
org-enable-org-journal-support t
org-journal-dir "~/org/journal/"
org-journal-file-format "%Y-%m-%d"
org-journal-date-prefix "#+TITLE: "
org-journal-date-format "%A, %B %d %Y"
org-journal-time-prefix "* "
org-journal-time-format "")
)
(org :variables
org-enable-org-journal-support t
org-journal-dir "~/org/journal/"
org-journal-file-format "%Y-%m-%d"
org-journal-date-prefix "#+TITLE: "
org-journal-date-format "%A, %B %d %Y"
org-journal-time-prefix "* "
org-journal-time-format "")
)
#+END_SRC
** Hugo support