wilderjds
/
ox-hugo
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Support setting the date in front-matter using the CLOSED property

Browse Source 
Fixes https://github.com/kaushalmodi/ox-hugo/issues/68
master
Kaushal Modi 9 years ago
parent 8eae65207b
commit fc15f0ca8e
6 changed files with 68 additions and 29 deletions
Whitespace
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Split View
Diff Options
Show Stats Download Patch File Download Diff File
  1. 30
      README.org
  2. 30
      doc/ox-hugo-manual.org
  3. 2
      doc/ox-hugo.wiki
  4. 12
      example-site/content-org/all-posts.org
  5. 13
      example-site/content/posts/parsing-date-from-closed-property.md
  6. 10
      ox-hugo.el

30
README.org
Unescape View File

@ -180,19 +180,23 @@ exported Markdown files.
When organizing the posts as Org *subtrees*, many Hugo front-matter
variables get set implicitly using the meta-data parsed from the posts
in Org.
|----------------------------------+------------------------------------+---------------------------------------------------------------------|
| Hugo front-matter (TOML) | Org | Org description |
|----------------------------------+------------------------------------+---------------------------------------------------------------------|
| =title = "foo"​= | =* foo= | Subtree heading (needs to have the =EXPORT_FILE_NAME= property set) |
| =date = 2017-07-24= | =:EXPORT_DATE: 2017-07-24= | Subtree property (or =#+DATE:=) |
| =tags = ["abc", "def"]= | =* foo :abc:def:= | Heading tags |
| =categories = ["x", "y"]= | =* foo :@x:@y:= | Heading tags with =@= prefix |
| =draft = true= | =* TODO foo= | Heading set to =TODO= (or =DRAFT=) |
| =draft = false= | =* foo= | Heading *not* set to =TODO= (or =DRAFT=) |
| =weight = 123= | =:EXPORT_HUGO_WEIGHT: auto= | When set to =auto=, weight is auto-calculated. |
| =weight = 123= (in =[menu.foo]=) | =:EXPORT_HUGO_MENU: :menu foo= | Menu weight is auto-calculated unless specified. |
| =lastmod = <current date>= | =:EXPORT_HUGO_AUTO_SET_LASTMOD: t= | Subtree property (or =#+HUGO_AUTO_SET_LASTMODE: t=) |
|----------------------------------+------------------------------------+---------------------------------------------------------------------|
|------------------------------------+------------------------------------+-------------------------------------------------------------------------|
| Hugo front-matter (TOML) | Org | Org description |
|------------------------------------+------------------------------------+-------------------------------------------------------------------------|
| =title = "foo"​= | =* foo= | Subtree heading (needs to have the =EXPORT_FILE_NAME= property set) |
| =date = 2017-09-11T14:32:00-04:00= | =CLOSED: [2017-09-11 Mon 14:32]= | Auto-inserted =CLOSED= subtree property when switch to Org *DONE* state |
| =date = 2017-07-24= | =:EXPORT_DATE: 2017-07-24= | Subtree property (or =#+DATE:=) |
| =tags = ["abc", "def"]= | =* foo :abc:def:= | Heading tags |
| =categories = ["x", "y"]= | =* foo :@x:@y:= | Heading tags with =@= prefix |
| =draft = true= | =* TODO foo= | Heading set to =TODO= (or =DRAFT=) |
| =draft = false= | =* foo= | Heading *not* set to =TODO= (or =DRAFT=) |
| =weight = 123= | =:EXPORT_HUGO_WEIGHT: auto= | When set to =auto=, weight is auto-calculated. |
| =weight = 123= (in =[menu.foo]=) | =:EXPORT_HUGO_MENU: :menu foo= | Menu weight is auto-calculated unless specified. |
| =lastmod = <current date>= | =:EXPORT_HUGO_AUTO_SET_LASTMOD: t= | Subtree property (or =#+HUGO_AUTO_SET_LASTMODE: t=) |
|------------------------------------+------------------------------------+-------------------------------------------------------------------------|
** Notes
- Precedence for =date= parsing: =CLOSED= subtree property /more than/
=EXPORT_DATE= subtree property /more than/ =#+DATE:= keyword.
* Formatting
Below table shows the translation of Org markup to Markdown markup in
the exported =.md= files.

30
doc/ox-hugo-manual.org
Unescape View File

@ -240,19 +240,23 @@ exported Markdown files.
When organizing the posts as Org *subtrees*, many Hugo front-matter
variables get set implicitly using the meta-data parsed from the posts
in Org.
|----------------------------------+------------------------------------+---------------------------------------------------------------------|
| Hugo front-matter (TOML) | Org | Org description |
|----------------------------------+------------------------------------+---------------------------------------------------------------------|
| =title = "foo"​= | =* foo= | Subtree heading (needs to have the =EXPORT_FILE_NAME= property set) |
| =date = 2017-07-24= | =:EXPORT_DATE: 2017-07-24= | Subtree property (or =#+DATE:=) |
| =tags = ["abc", "def"]= | =* foo :abc:def:= | Heading tags |
| =categories = ["x", "y"]= | =* foo :@x:@y:= | Heading tags with =@= prefix |
| =draft = true= | =* TODO foo= | Heading set to =TODO= (or =DRAFT=) |
| =draft = false= | =* foo= | Heading *not* set to =TODO= (or =DRAFT=) |
| =weight = 123= | =:EXPORT_HUGO_WEIGHT: auto= | When set to =auto=, weight is auto-calculated. |
| =weight = 123= (in =[menu.foo]=) | =:EXPORT_HUGO_MENU: :menu foo= | Menu weight is auto-calculated unless specified. |
| =lastmod = <current date>= | =:EXPORT_HUGO_AUTO_SET_LASTMOD: t= | Subtree property (or =#+HUGO_AUTO_SET_LASTMODE: t=) |
|----------------------------------+------------------------------------+---------------------------------------------------------------------|
|------------------------------------+------------------------------------+-------------------------------------------------------------------------|
| Hugo front-matter (TOML) | Org | Org description |
|------------------------------------+------------------------------------+-------------------------------------------------------------------------|
| =title = "foo"​= | =* foo= | Subtree heading (needs to have the =EXPORT_FILE_NAME= property set) |
| =date = 2017-09-11T14:32:00-04:00= | =CLOSED: [2017-09-11 Mon 14:32]= | Auto-inserted =CLOSED= subtree property when switch to Org *DONE* state |
| =date = 2017-07-24= | =:EXPORT_DATE: 2017-07-24= | Subtree property (or =#+DATE:=) |
| =tags = ["abc", "def"]= | =* foo :abc:def:= | Heading tags |
| =categories = ["x", "y"]= | =* foo :@x:@y:= | Heading tags with =@= prefix |
| =draft = true= | =* TODO foo= | Heading set to =TODO= (or =DRAFT=) |
| =draft = false= | =* foo= | Heading *not* set to =TODO= (or =DRAFT=) |
| =weight = 123= | =:EXPORT_HUGO_WEIGHT: auto= | When set to =auto=, weight is auto-calculated. |
| =weight = 123= (in =[menu.foo]=) | =:EXPORT_HUGO_MENU: :menu foo= | Menu weight is auto-calculated unless specified. |
| =lastmod = <current date>= | =:EXPORT_HUGO_AUTO_SET_LASTMOD: t= | Subtree property (or =#+HUGO_AUTO_SET_LASTMODE: t=) |
|------------------------------------+------------------------------------+-------------------------------------------------------------------------|
*** Notes
- Precedence for =date= parsing: =CLOSED= subtree property /more than/
=EXPORT_DATE= subtree property /more than/ =#+DATE:= keyword.
** Formatting :wiki:
:PROPERTIES:
:EXPORT_FILE_NAME: Formatting

2
doc/ox-hugo.wiki

@ -1 +1 @@
Subproject commit 286f175ee272deae678950055084a19a5592b929
Subproject commit caf810e426151d568b2312e156be21b860af1c54

12
example-site/content-org/all-posts.org
Unescape View File

@ -1372,6 +1372,18 @@ Below, the code block language name will show up before the code.
:EXPORT_HUGO_WEIGHT: 4567
:EXPORT_FILE_NAME: hugo-post-weight-4567
:END:
* DONE Parsing date from CLOSED property
CLOSED: [2017-09-11 Mon 14:32]
:PROPERTIES:
:EXPORT_FILE_NAME: parsing-date-from-closed-property
:END:
When an Org TODO item is switched to the =DONE= state, a =CLOSED=
property is auto-inserted (default behavior).
If such a property is non-nil, the value (time-stamp) of that is used
to set the =date= field in the exported front-matter.
- Reference :: [[http://orgmode.org/manual/Special-properties.html][(org) Special properties]] or =C-h i g (org) Special properties=
* TODO Pre-Draft State
:PROPERTIES:
:EXPORT_FILE_NAME: draft-state-todo

13
example-site/content/posts/parsing-date-from-closed-property.md
Unescape View File

@ -0,0 +1,13 @@
+++
title = "Parsing date from CLOSED property"
date = 2017-09-11T14:32:00-04:00
draft = false
+++
When an Org TODO item is switched to the `DONE` state, a `CLOSED`
property is auto-inserted (default behavior).
If such a property is non-nil, the value (time-stamp) of that is used
to set the `date` field in the exported front-matter.
- **Reference:** [(org) Special properties](http://orgmode.org/manual/Special-properties.html) or `C-h i g (org) Special properties`

10
ox-hugo.el
Unescape View File

@ -1114,9 +1114,15 @@ INFO is a plist used as a communication channel."
(let* ((fm-format (plist-get info :hugo-front-matter-format))
(hugo-date-fmt "%Y-%m-%dT%T%z")
(date-raw (or
;; Get the date from the subtree property `EXPORT_DATE' if available
;; Get the date from the "CLOSED" property;
;; generated automatically when switching a
;; headline to "DONE" state,
(org-entry-get (point) "CLOSED")
;; Else get the date from the subtree property,
;; `EXPORT_DATE' if available
(org-string-nw-p (org-export-data (plist-get info :date) info))
;; Else try to get it from the #+DATE keyword in the Org file
;; Else try to get it from the #+DATE keyword in
;; the Org file.
(org-string-nw-p (org-export-get-date info hugo-date-fmt))))
(date-nocolon (and (stringp date-raw)
(if (string-match-p "\\`[0-9T:-]+\\'" date-raw)

Write Preview
Loading…
Cancel
Save