Skip to content

Commit

Permalink
Use org-done-keywords; Remove 2 recently added defcustoms
Browse files Browse the repository at this point in the history 
- Removed defcustoms: org-hugo-todo-keywords and
  org-hugo-default-draft-state

Ref:
#171 (comment)
  • Loading branch information
@kaushalmodi
kaushalmodi committed Jul 10, 2018
1 parent d25d5d5 commit 41710e5
Show file tree
Hide file tree
Showing 5 changed files with 75 additions and 109 deletions.
78 changes: 39 additions & 39 deletions doc/ox-hugo-manual.org
View file
Original file line number Diff line number Diff line change
Expand Up @@ -841,28 +841,28 @@ subtree* i.e. an Org subtree that has the =EXPORT_FILE_NAME= property
set.
#+caption: Hugo front-matter translation for subtree-based exports
#+attr_html: :class sane-table
|------------------------------------+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------|
| Hugo front-matter (TOML) | Org | Org description |
|------------------------------------+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------|
| =title = "foo"= | =* foo= | Subtree heading |
| =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 |
| =publishDate = 2018-01-26= | =SCHEDULED: <2018-01-26 Fri>= | Auto-inserted =SCHEDULED= subtree property using default =C-c C-s= binding |
| =publishDate = 2018-01-26= | =:EXPORT_HUGO_PUBLISHDATE: 2018-01-26:= | Subtree property |
| =expiryDate = 2999-01-01= | =DEADLINE: <2999-01-01 Tue>= | Auto-inserted =DEADLINE= subtree property using default =C-c C-d= binding |
| =expiryDate = 2999-01-01= | =:EXPORT_HUGO_EXPIRYDATE: 2999-01-01:= | Subtree property |
| =lastmod = <current date>= | =:EXPORT_HUGO_AUTO_SET_LASTMOD: t= | Subtree property |
| =lastmod = <current date>= | =#+hugo_auto_set_lastmod: t= | Org keyword |
| =tags = ["toto", "zulu"]= | =* foo :toto:zulu:= | Subtree heading tags |
| =categories = ["x", "y"]= | =* foo :@x:@y:= | Subtree heading tags with =@= prefix |
| =draft = true= | =* TODO foo= | Subtree heading Org TODO state set to =TODO= (or =DRAFT=). See ~org-hugo-todo-keywords~ and ~org-hugo-default-draft-state~. |
| =draft = false= | =* DONE foo= | Subtree heading Org TODO state set to =DONE=. See ~org-hugo-todo-keywords~ and ~org-hugo-default-draft-state~. |
| =weight = 123= (manual) | =:EXPORT_HUGO_WEIGHT: 123= | Manual setting of page weight |
| =weight = 123= (auto-calc) | =:EXPORT_HUGO_WEIGHT: auto= | When set to =auto=, page weight is auto-calculated |
| =tags_weight = 123= (manual) | =:EXPORT_HUGO_WEIGHT: :tags 123= | Manual setting of /FOO/ taxonomy weight, by setting to =:FOO VALUE= |
| =tags_weight = 123= (auto-calc) | =:EXPORT_HUGO_WEIGHT: :tags auto= | When set to =:FOO auto=, /FOO/ taxonomy weight is auto-calculated |
| =weight = 123= (in =[menu.foo]=) | =:EXPORT_HUGO_MENU: :menu foo= | Menu weight is auto-calculated unless specified |
|------------------------------------+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------|
|------------------------------------+----------------------------------------+----------------------------------------------------------------------------|
| Hugo front-matter (TOML) | Org | Org description |
|------------------------------------+----------------------------------------+----------------------------------------------------------------------------|
| =title = "foo"= | =* foo= | Subtree heading |
| =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 |
| =publishDate = 2018-01-26= | =SCHEDULED: <2018-01-26 Fri>= | Auto-inserted =SCHEDULED= subtree property using default =C-c C-s= binding |
| =publishDate = 2018-01-26= | =:EXPORT_HUGO_PUBLISHDATE: 2018-01-26:= | Subtree property |
| =expiryDate = 2999-01-01= | =DEADLINE: <2999-01-01 Tue>= | Auto-inserted =DEADLINE= subtree property using default =C-c C-d= binding |
| =expiryDate = 2999-01-01= | =:EXPORT_HUGO_EXPIRYDATE: 2999-01-01:= | Subtree property |
| =lastmod = <current date>= | =:EXPORT_HUGO_AUTO_SET_LASTMOD: t= | Subtree property |
| =lastmod = <current date>= | =#+hugo_auto_set_lastmod: t= | Org keyword |
| =tags = ["toto", "zulu"]= | =* foo :toto:zulu:= | Subtree heading tags |
| =categories = ["x", "y"]= | =* foo :@x:@y:= | Subtree heading tags with =@= prefix |
| =draft = true= | =* TODO foo= | Subtree heading Org TODO state set to =TODO=. |
| =draft = false= | =* foo= or =* DONE foo= | Subtree heading Org TODO state not set or set to =DONE=. |
| =weight = 123= (manual) | =:EXPORT_HUGO_WEIGHT: 123= | Manual setting of page weight |
| =weight = 123= (auto-calc) | =:EXPORT_HUGO_WEIGHT: auto= | When set to =auto=, page weight is auto-calculated |
| =tags_weight = 123= (manual) | =:EXPORT_HUGO_WEIGHT: :tags 123= | Manual setting of /FOO/ taxonomy weight, by setting to =:FOO VALUE= |
| =tags_weight = 123= (auto-calc) | =:EXPORT_HUGO_WEIGHT: :tags auto= | When set to =:FOO auto=, /FOO/ taxonomy weight is auto-calculated |
| =weight = 123= (in =[menu.foo]=) | =:EXPORT_HUGO_MENU: :menu foo= | Menu weight is auto-calculated unless specified |
|------------------------------------+----------------------------------------+----------------------------------------------------------------------------|
***** Notes
- Precedence for =date= parsing :: =CLOSED= subtree property /more
than/ =EXPORT_DATE= subtree property /more than/ =#+date:=
Expand All @@ -872,23 +872,23 @@ set.
**** For file-based exports
#+caption: Hugo front-matter translation for file-based exports
#+attr_html: :class sane-table
|----------------------------------+-------------------------------------------------------------|
| Hugo front-matter (TOML) | Org |
|----------------------------------+-------------------------------------------------------------|
| =title = "foo"= | =#+title: foo= |
| =date = 2017-07-24= | =#+date: 2017-07-24= |
| =publishDate = 2018-01-26= | =#+hugo_publishdate: 2018-01-26= |
| =expiryDate = 2999-01-01= | =#+hugo_expirydate: 2999-01-01= |
| =lastmod = <current date>= | =#+hugo_auto_set_lastmod: t= |
| =tags = ["toto", "zulu"]= | =#+hugo_tags: toto zulu= |
| =categories = ["x", "y"]= | =#+hugo_categories: x y= |
| =draft = true= | =#+hugo_draft: true= |
| =draft = false= | =#+hugo_draft: false= (See ~org-hugo-default-draft-state~.) |
| =weight = 123= | =#+hugo_weight: 123= |
| =tags_weight = 123= | =#+hugo_weight: :tags 123= |
| =categories_weight = 123= | =#+hugo_weight: :categories 123= |
| =weight = 123= (in =[menu.foo]=) | =#+hugo_menu: :menu foo :weight 123= |
|----------------------------------+-------------------------------------------------------------|
|----------------------------------+--------------------------------------|
| Hugo front-matter (TOML) | Org |
|----------------------------------+--------------------------------------|
| =title = "foo"= | =#+title: foo= |
| =date = 2017-07-24= | =#+date: 2017-07-24= |
| =publishDate = 2018-01-26= | =#+hugo_publishdate: 2018-01-26= |
| =expiryDate = 2999-01-01= | =#+hugo_expirydate: 2999-01-01= |
| =lastmod = <current date>= | =#+hugo_auto_set_lastmod: t= |
| =tags = ["toto", "zulu"]= | =#+hugo_tags: toto zulu= |
| =categories = ["x", "y"]= | =#+hugo_categories: x y= |
| =draft = true= | =#+hugo_draft: true= |
| =draft = false= | =#+hugo_draft: false= |
| =weight = 123= | =#+hugo_weight: 123= |
| =tags_weight = 123= | =#+hugo_weight: :tags 123= |
| =categories_weight = 123= | =#+hugo_weight: :categories 123= |
| =weight = 123= (in =[menu.foo]=) | =#+hugo_menu: :menu foo :weight 123= |
|----------------------------------+--------------------------------------|
***** Notes
- The *auto calculation* of weights for pages, taxonomies and menu
items works *only* for subtree-based exports.
Expand Down
76 changes: 6 additions & 70 deletions ox-hugo.el
View file
Original file line number Diff line number Diff line change
Expand Up @@ -434,60 +434,6 @@ directory where all Hugo posts should go by default."
:type 'directory
:safe #'stringp)

(defcustom org-hugo-todo-keywords '((todo . ("TODO"))
(draft . ("DRAFT"))
(done . ("DONE")))
"List of Org TODO keywords for Hugo draft states.
This variable is relevant only for the per-subtree export flow.
It is of the form:
((todo . (\"TODO_KWD1\" \"TODO_KWD2\" ..))
(draft . (\"DRAFT_KWD1\" \"DRAFT_KWD2\" ..))
(done . (\"DONE_KWD1\" \"DONE_KWD2\" ..)))
The Hugo draft state is set to true if the Org TODO keyword
matches any of the keywords associated with `todo' or `draft'
above. The only difference between those two sets of keywords is
that for the `draft' keywords, a message like:
[ox-hugo] <POST TITLE> post is marked as a DRAFT
is displayed in the echo area.
If the Org TODO keyword matches any of the keywords associated
with `done', the Hugo draft state is set to false.
The default value of this variable works with the default set of
Org TODO keywords (just that the `draft' state will not exist in
that case). If the `draft' state is desired, one suggested
setting for your Org file to work well with the default value of
this variable is:
#+seq_todo: TODO DRAFT DONE
If this variable's value is changed, it is the user's
responsibility to update \"#+seq_todo\" or `org-todo-keywords'
accordingly. See `org-todo-keywords' for more."
:group 'org-export-hugo
:type '(list cons cons cons))

(defcustom org-hugo-default-draft-state nil
"Default value of a post's draft state.
When nil, a post is considered to be a draft only when its TODO
state is set to one of the keywords associated with `todo' or
`draft' states explicitly (see `org-hugo-todo-keywords'), or if
it is drafted explicitly using the HUGO_DRAFT keyword/property.
When non-nil, a post is considered to be a draft, unless its TODO
state is set to one of the keywords associated with `done' state
explicitly, or if it is undrafted explicitly using the HUGO_DRAFT
keyword/property."
:group 'org-export-hugo
:type 'boolean
:safe #'booleanp)

(defcustom org-hugo-footer ""
"String to be appended at the end of each Hugo post.
Expand Down Expand Up @@ -1466,21 +1412,13 @@ INFO is a plist used as a communication channel."
(let* ((todo-keyword (org-entry-get (point) "TODO"))
(draft (cond
((stringp todo-keyword)
(let ((todo-kwds (cdr (assoc 'todo org-hugo-todo-keywords)))
(draft-kwds (cdr (assoc 'draft org-hugo-todo-keywords)))
(done-kwds (cdr (assoc 'done org-hugo-todo-keywords))))
(cond
((member todo-keyword (append todo-kwds draft-kwds))
(when (member todo-keyword draft-kwds)
(if (member todo-keyword org-done-keywords)
nil
(progn
(when (string= "DRAFT" todo-keyword)
(let ((title (org-entry-get (point) "ITEM"))) ;Post title
(message "[ox-hugo] `%s' post is marked as a DRAFT" title)))
t)
((member todo-keyword done-kwds)
nil)
(t
(user-error (concat "The Org TODO keyword %S is invalid; "
"it needs to be one of %S. See `org-hugo-todo-keywords'")
todo-keyword (append todo-kwds draft-kwds done-kwds))))))
t)))
(;; If the HUGO_DRAFT keyword/property *is* set, but
;; not to nil.
(plist-get info :hugo-draft)
Expand All @@ -1495,7 +1433,7 @@ INFO is a plist used as a communication channel."
(message "[ox-hugo] `%s' post is marked as a DRAFT" title)))
is-draft))
(t ;Neither of Org TODO state and HUGO_DRAFT keyword/property are set
org-hugo-default-draft-state)))
nil)))
(draft-bool-str (org-hugo--front-matter-value-booleanize (symbol-name draft))))
;; (message "dbg: draft-state: todo keyword=%S HUGO_DRAFT=%S draft=%S"
;; todo-keyword (plist-get info :hugo-draft) draft-bool-str)
Expand Down Expand Up @@ -3709,8 +3647,6 @@ buffer and returned as a string in Org format."
"No Org mode shadows found in =load-path="))
"** =ox-hugo= defcustoms"
,(format "|org-hugo-default-section-directory |%S|" org-hugo-default-section-directory)
,(format "|org-hugo-default-draft-state |%S|" org-hugo-default-draft-state)
,(format "|org-hugo-todo-keywords |%S|" org-hugo-todo-keywords)
,(format "|org-hugo-use-code-for-kbd |%S|" org-hugo-use-code-for-kbd)
,(format "|org-hugo-preserve-filling |%S|" org-hugo-preserve-filling)
,(format "|org-hugo-delete-trailing-ws |%S|" org-hugo-delete-trailing-ws)
Expand Down
13 changes: 13 additions & 0 deletions test/site/content-org/all-posts.org
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6299,13 +6299,26 @@ This post does not have any Org TODO state. So it uses the value of
:EXPORT_FILE_NAME: hugo-draft-none-todo-state-draft
:END:
This post is marked as draft as the Org TODO state is set to ~DRAFT~.
*** TEST__TODO HUGO_DRAFT not set, TEST__TODO state :todo:test:
:PROPERTIES:
:EXPORT_FILE_NAME: hugo-draft-none-todo-state-test-todo
:END:
This post is marked as draft as the Org TODO state is set to
~TEST__TODO~.
*** DONE HUGO_DRAFT not set, DONE state :todo:done:
CLOSED: [2018-07-09 Mon 11:00]
:PROPERTIES:
:EXPORT_FILE_NAME: hugo-draft-none-todo-state-done
:END:
This post is not marked as draft as the Org TODO state is set to
~DONE~.
*** TEST__DONE HUGO_DRAFT not set, TEST__DONE state :todo:done:test:
CLOSED: [2018-07-10 Tue 10:42]
:PROPERTIES:
:EXPORT_FILE_NAME: hugo-draft-none-todo-state-test-done
:END:
This post is not marked as draft as the Org TODO state is set to
~TEST__DONE~.
*** HUGO_DRAFT not set, no TODO state either :default:
:PROPERTIES:
:EXPORT_FILE_NAME: hugo-draft-none-todo-state-none
Expand Down
9 changes: 9 additions & 0 deletions test/site/content/posts/hugo-draft-none-todo-state-test-done.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
+++
title = "HUGO_DRAFT not set, TEST__DONE state"
date = 2018-07-10T10:42:00+00:00
tags = ["draft", "todo", "done", "test"]
draft = false
+++

This post is not marked as draft as the Org TODO state is set to
`TEST__DONE`.
8 changes: 8 additions & 0 deletions test/site/content/posts/hugo-draft-none-todo-state-test-todo.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
+++
title = "HUGO_DRAFT not set, TEST__TODO state"
tags = ["draft", "todo", "test"]
draft = true
+++

This post is marked as draft as the Org TODO state is set to
`TEST__TODO`.

0 comments on commit 41710e5

Please sign in to comment.