search

kaushalmodi / ox-hugo

A carefully crafted Org exporter back-end for Hugo
https://ox-hugo.scripter.co
GNU General Public License v3.0
867 stars 130 forks source link

Properties in a property drawer at the start of a file #685

Closed ericd23 closed 1 year ago

ericd23 commented 1 year ago

It seems HUGO_DRAFT property in property drawer at the start of a file does not get picked up. #+hugo_draft works fine.

The reason why I use a property drawer in the first place is that it's org-entry-put's behavior, which I uses in some part of my emacs config.

Actual Behavior

Converted md files get front matter draft = false

Expected Behavior

Converted md files get front matter draft = true

Example Org File

:PROPERTIES:
:ID:       7609e428-8568-4fa6-8c3c-99da28510d49
:HUGO_DRAFT: TRUE
:END:
#+title: ARM Cortex
#+hugo_categories: ok

* CMSIS
  ...

Generated Markdown File or Error

+++
title = "ARM Cortex"
author = ["xxx"]
categories = ["ok"]
draft = false
+++

## CMSIS {#cmsis}

...

Ox-Hugo Debug Information

Debug Info # Debug information for `ox-hugo` ## Emacs Version GNU Emacs 28.2 (build 1, x86_64-pc-linux-gnu, GTK+ Version 3.24.34, cairo version 1.17.6) of 2022-09-13 ## Org Version Org mode version 9.6 (9.6-??-bed47b4 @ /home/user/.config/emacs/.local/straight/build-28.2/org/) ## Hugo Version hugo v0.105.0+extended linux/amd64 BuildDate=unknown ### Org `load-path` shadows **Warning**: Possible mixed installation of Org /home/user/.config/emacs/.local/straight/build-28.2/org/ob-ditaa hides /usr/share/emacs/28.2/lisp/org/ob-ditaa /home/user/.config/emacs/.local/straight/build-28.2/org/ox-ascii hides /usr/share/emacs/28.2/lisp/org/ox-ascii /home/user/.config/emacs/.local/straight/build-28.2/org/ob-makefile hides /usr/share/emacs/28.2/lisp/org/ob-makefile /home/user/.config/emacs/.local/straight/build-28.2/org/ob-awk hides /usr/share/emacs/28.2/lisp/org/ob-awk /home/user/.config/emacs/.local/straight/build-28.2/org/org-agenda hides /usr/share/emacs/28.2/lisp/org/org-agenda /home/user/.config/emacs/.local/straight/build-28.2/org/oc-natbib hides /usr/share/emacs/28.2/lisp/org/oc-natbib /home/user/.config/emacs/.local/straight/build-28.2/org/org-duration hides /usr/share/emacs/28.2/lisp/org/org-duration /home/user/.config/emacs/.local/straight/build-28.2/org/org-inlinetask hides /usr/share/emacs/28.2/lisp/org/org-inlinetask /home/user/.config/emacs/.local/straight/build-28.2/org/ob-processing hides /usr/share/emacs/28.2/lisp/org/ob-processing /home/user/.config/emacs/.local/straight/build-28.2/org/ol-gnus hides /usr/share/emacs/28.2/lisp/org/ol-gnus /home/user/.config/emacs/.local/straight/build-28.2/org/org-id hides /usr/share/emacs/28.2/lisp/org/org-id /home/user/.config/emacs/.local/straight/build-28.2/org/ox-publish hides /usr/share/emacs/28.2/lisp/org/ox-publish /home/user/.config/emacs/.local/straight/build-28.2/org/ol-mhe hides /usr/share/emacs/28.2/lisp/org/ol-mhe /home/user/.config/emacs/.local/straight/build-28.2/org/ob-exp hides /usr/share/emacs/28.2/lisp/org/ob-exp /home/user/.config/emacs/.local/straight/build-28.2/org/org-table hides /usr/share/emacs/28.2/lisp/org/org-table /home/user/.config/emacs/.local/straight/build-28.2/org/ob-comint hides /usr/share/emacs/28.2/lisp/org/ob-comint /home/user/.config/emacs/.local/straight/build-28.2/org/ob-css hides /usr/share/emacs/28.2/lisp/org/ob-css /home/user/.config/emacs/.local/straight/build-28.2/org/ob-julia hides /usr/share/emacs/28.2/lisp/org/ob-julia /home/user/.config/emacs/.local/straight/build-28.2/org/org-archive hides /usr/share/emacs/28.2/lisp/org/org-archive /home/user/.config/emacs/.local/straight/build-28.2/org/org-goto hides /usr/share/emacs/28.2/lisp/org/org-goto /home/user/.config/emacs/.local/straight/build-28.2/org/ox-man hides /usr/share/emacs/28.2/lisp/org/ox-man /home/user/.config/emacs/.local/straight/build-28.2/org/org-src hides /usr/share/emacs/28.2/lisp/org/org-src /home/user/.config/emacs/.local/straight/build-28.2/org/org-faces hides /usr/share/emacs/28.2/lisp/org/org-faces /home/user/.config/emacs/.local/straight/build-28.2/org/ox-org hides /usr/share/emacs/28.2/lisp/org/ox-org /home/user/.config/emacs/.local/straight/build-28.2/org/org-protocol hides /usr/share/emacs/28.2/lisp/org/org-protocol /home/user/.config/emacs/.local/straight/build-28.2/org/org-plot hides /usr/share/emacs/28.2/lisp/org/org-plot /home/user/.config/emacs/.local/straight/build-28.2/org/org-num hides /usr/share/emacs/28.2/lisp/org/org-num /home/user/.config/emacs/.local/straight/build-28.2/org/ob-js hides /usr/share/emacs/28.2/lisp/org/ob-js /home/user/.config/emacs/.local/straight/build-28.2/org/org-indent hides /usr/share/emacs/28.2/lisp/org/org-indent /home/user/.config/emacs/.local/straight/build-28.2/org/ol-bibtex hides /usr/share/emacs/28.2/lisp/org/ol-bibtex /home/user/.config/emacs/.local/straight/build-28.2/org/ob-octave hides /usr/share/emacs/28.2/lisp/org/ob-octave /home/user/.config/emacs/.local/straight/build-28.2/org/ob-core hides /usr/share/emacs/28.2/lisp/org/ob-core /home/user/.config/emacs/.local/straight/build-28.2/org/ol-irc hides /usr/share/emacs/28.2/lisp/org/ol-irc /home/user/.config/emacs/.local/straight/build-28.2/org/ox-texinfo hides /usr/share/emacs/28.2/lisp/org/ox-texinfo /home/user/.config/emacs/.local/straight/build-28.2/org/ob-sqlite hides /usr/share/emacs/28.2/lisp/org/ob-sqlite /home/user/.config/emacs/.local/straight/build-28.2/org/ox-latex hides /usr/share/emacs/28.2/lisp/org/ox-latex /home/user/.config/emacs/.local/straight/build-28.2/org/ob-fortran hides /usr/share/emacs/28.2/lisp/org/ob-fortran /home/user/.config/emacs/.local/straight/build-28.2/org/ob-plantuml hides /usr/share/emacs/28.2/lisp/org/ob-plantuml /home/user/.config/emacs/.local/straight/build-28.2/org/ox-html hides /usr/share/emacs/28.2/lisp/org/ox-html /home/user/.config/emacs/.local/straight/build-28.2/org/org-list hides /usr/share/emacs/28.2/lisp/org/org-list /home/user/.config/emacs/.local/straight/build-28.2/org/ob-emacs-lisp hides /usr/share/emacs/28.2/lisp/org/ob-emacs-lisp /home/user/.config/emacs/.local/straight/build-28.2/org/ob-eshell hides /usr/share/emacs/28.2/lisp/org/ob-eshell /home/user/.config/emacs/.local/straight/build-28.2/org/ox-md hides /usr/share/emacs/28.2/lisp/org/ox-md /home/user/.config/emacs/.local/straight/build-28.2/org/ox hides /usr/share/emacs/28.2/lisp/org/ox /home/user/.config/emacs/.local/straight/build-28.2/org/ol-eshell hides /usr/share/emacs/28.2/lisp/org/ol-eshell /home/user/.config/emacs/.local/straight/build-28.2/org/ol-w3m hides /usr/share/emacs/28.2/lisp/org/ol-w3m /home/user/.config/emacs/.local/straight/build-28.2/org/org-refile hides /usr/share/emacs/28.2/lisp/org/org-refile /home/user/.config/emacs/.local/straight/build-28.2/org/ob-perl hides /usr/share/emacs/28.2/lisp/org/ob-perl /home/user/.config/emacs/.local/straight/build-28.2/org/ob-shell hides /usr/share/emacs/28.2/lisp/org/ob-shell /home/user/.config/emacs/.local/straight/build-28.2/org/ob-eval hides /usr/share/emacs/28.2/lisp/org/ob-eval /home/user/.config/emacs/.local/straight/build-28.2/org/org-pcomplete hides /usr/share/emacs/28.2/lisp/org/org-pcomplete /home/user/.config/emacs/.local/straight/build-28.2/org/oc-basic hides /usr/share/emacs/28.2/lisp/org/oc-basic /home/user/.config/emacs/.local/straight/build-28.2/org/org-tempo hides /usr/share/emacs/28.2/lisp/org/org-tempo /home/user/.config/emacs/.local/straight/build-28.2/org/ob-sql hides /usr/share/emacs/28.2/lisp/org/ob-sql /home/user/.config/emacs/.local/straight/build-28.2/org/org-lint hides /usr/share/emacs/28.2/lisp/org/org-lint /home/user/.config/emacs/.local/straight/build-28.2/org/ob-matlab hides /usr/share/emacs/28.2/lisp/org/ob-matlab /home/user/.config/emacs/.local/straight/build-28.2/org/ol-rmail hides /usr/share/emacs/28.2/lisp/org/ol-rmail /home/user/.config/emacs/.local/straight/build-28.2/org/ob-python hides /usr/share/emacs/28.2/lisp/org/ob-python /home/user/.config/emacs/.local/straight/build-28.2/org/org-mobile hides /usr/share/emacs/28.2/lisp/org/org-mobile /home/user/.config/emacs/.local/straight/build-28.2/org/org-attach hides /usr/share/emacs/28.2/lisp/org/org-attach /home/user/.config/emacs/.local/straight/build-28.2/org/org-crypt hides /usr/share/emacs/28.2/lisp/org/org-crypt /home/user/.config/emacs/.local/straight/build-28.2/org/ob-C hides /usr/share/emacs/28.2/lisp/org/ob-C /home/user/.config/emacs/.local/straight/build-28.2/org/ob-org hides /usr/share/emacs/28.2/lisp/org/ob-org /home/user/.config/emacs/.local/straight/build-28.2/org/ol-man hides /usr/share/emacs/28.2/lisp/org/ol-man /home/user/.config/emacs/.local/straight/build-28.2/org/oc-biblatex hides /usr/share/emacs/28.2/lisp/org/oc-biblatex /home/user/.config/emacs/.local/straight/build-28.2/org/ob-lilypond hides /usr/share/emacs/28.2/lisp/org/ob-lilypond /home/user/.config/emacs/.local/straight/build-28.2/org/ob-R hides /usr/share/emacs/28.2/lisp/org/ob-R /home/user/.config/emacs/.local/straight/build-28.2/org/ob-sass hides /usr/share/emacs/28.2/lisp/org/ob-sass /home/user/.config/emacs/.local/straight/build-28.2/org/org-habit hides /usr/share/emacs/28.2/lisp/org/org-habit /home/user/.config/emacs/.local/straight/build-28.2/org/ol-eww hides /usr/share/emacs/28.2/lisp/org/ol-eww /home/user/.config/emacs/.local/straight/build-28.2/org/org-version hides /usr/share/emacs/28.2/lisp/org/org-version /home/user/.config/emacs/.local/straight/build-28.2/org/ol-bbdb hides /usr/share/emacs/28.2/lisp/org/ol-bbdb /home/user/.config/emacs/.local/straight/build-28.2/org/ol-doi hides /usr/share/emacs/28.2/lisp/org/ol-doi /home/user/.config/emacs/.local/straight/build-28.2/org/ob-gnuplot hides /usr/share/emacs/28.2/lisp/org/ob-gnuplot /home/user/.config/emacs/.local/straight/build-28.2/org/ox-odt hides /usr/share/emacs/28.2/lisp/org/ox-odt /home/user/.config/emacs/.local/straight/build-28.2/org/ob-ref hides /usr/share/emacs/28.2/lisp/org/ob-ref /home/user/.config/emacs/.local/straight/build-28.2/org/ob-sed hides /usr/share/emacs/28.2/lisp/org/ob-sed /home/user/.config/emacs/.local/straight/build-28.2/org/org-timer hides /usr/share/emacs/28.2/lisp/org/org-timer /home/user/.config/emacs/.local/straight/build-28.2/org/ob-maxima hides /usr/share/emacs/28.2/lisp/org/ob-maxima /home/user/.config/emacs/.local/straight/build-28.2/org/org-macro hides /usr/share/emacs/28.2/lisp/org/org-macro /home/user/.config/emacs/.local/straight/build-28.2/org/org-footnote hides /usr/share/emacs/28.2/lisp/org/org-footnote /home/user/.config/emacs/.local/straight/build-28.2/org/ob-lua hides /usr/share/emacs/28.2/lisp/org/ob-lua /home/user/.config/emacs/.local/straight/build-28.2/org/ob-ruby hides /usr/share/emacs/28.2/lisp/org/ob-ruby /home/user/.config/emacs/.local/straight/build-28.2/org/ob hides /usr/share/emacs/28.2/lisp/org/ob /home/user/.config/emacs/.local/straight/build-28.2/org/ob-dot hides /usr/share/emacs/28.2/lisp/org/ob-dot /home/user/.config/emacs/.local/straight/build-28.2/org/org-element hides /usr/share/emacs/28.2/lisp/org/org-element /home/user/.config/emacs/.local/straight/build-28.2/org/ob-lisp hides /usr/share/emacs/28.2/lisp/org/ob-lisp /home/user/.config/emacs/.local/straight/build-28.2/org/ol-docview hides /usr/share/emacs/28.2/lisp/org/ol-docview /home/user/.config/emacs/.local/straight/build-28.2/org/org-loaddefs hides /usr/share/emacs/28.2/lisp/org/org-loaddefs /home/user/.config/emacs/.local/straight/build-28.2/org/org hides /usr/share/emacs/28.2/lisp/org/org /home/user/.config/emacs/.local/straight/build-28.2/org/org-attach-git hides /usr/share/emacs/28.2/lisp/org/org-attach-git /home/user/.config/emacs/.local/straight/build-28.2/org/org-entities hides /usr/share/emacs/28.2/lisp/org/org-entities /home/user/.config/emacs/.local/straight/build-28.2/org/org-keys hides /usr/share/emacs/28.2/lisp/org/org-keys /home/user/.config/emacs/.local/straight/build-28.2/org/ob-calc hides /usr/share/emacs/28.2/lisp/org/ob-calc /home/user/.config/emacs/.local/straight/build-28.2/org/org-capture hides /usr/share/emacs/28.2/lisp/org/org-capture /home/user/.config/emacs/.local/straight/build-28.2/org/ox-koma-letter hides /usr/share/emacs/28.2/lisp/org/ox-koma-letter /home/user/.config/emacs/.local/straight/build-28.2/org/ox-icalendar hides /usr/share/emacs/28.2/lisp/org/ox-icalendar /home/user/.config/emacs/.local/straight/build-28.2/org/ox-beamer hides /usr/share/emacs/28.2/lisp/org/ox-beamer /home/user/.config/emacs/.local/straight/build-28.2/org/ob-ocaml hides /usr/share/emacs/28.2/lisp/org/ob-ocaml /home/user/.config/emacs/.local/straight/build-28.2/org/ob-haskell hides /usr/share/emacs/28.2/lisp/org/ob-haskell /home/user/.config/emacs/.local/straight/build-28.2/org/ob-latex hides /usr/share/emacs/28.2/lisp/org/ob-latex /home/user/.config/emacs/.local/straight/build-28.2/org/ol hides /usr/share/emacs/28.2/lisp/org/ol /home/user/.config/emacs/.local/straight/build-28.2/org/org-clock hides /usr/share/emacs/28.2/lisp/org/org-clock /home/user/.config/emacs/.local/straight/build-28.2/org/oc-csl hides /usr/share/emacs/28.2/lisp/org/oc-csl /home/user/.config/emacs/.local/straight/build-28.2/org/org-macs hides /usr/share/emacs/28.2/lisp/org/org-macs /home/user/.config/emacs/.local/straight/build-28.2/org/org-feed hides /usr/share/emacs/28.2/lisp/org/org-feed /home/user/.config/emacs/.local/straight/build-28.2/org/ob-tangle hides /usr/share/emacs/28.2/lisp/org/ob-tangle /home/user/.config/emacs/.local/straight/build-28.2/org/org-colview hides /usr/share/emacs/28.2/lisp/org/org-colview /home/user/.config/emacs/.local/straight/build-28.2/org/ol-info hides /usr/share/emacs/28.2/lisp/org/ol-info /home/user/.config/emacs/.local/straight/build-28.2/org/ob-screen hides /usr/share/emacs/28.2/lisp/org/ob-screen /home/user/.config/emacs/.local/straight/build-28.2/org/ob-java hides /usr/share/emacs/28.2/lisp/org/ob-java /home/user/.config/emacs/.local/straight/build-28.2/org/ob-table hides /usr/share/emacs/28.2/lisp/org/ob-table /home/user/.config/emacs/.local/straight/build-28.2/org/org-ctags hides /usr/share/emacs/28.2/lisp/org/org-ctags /home/user/.config/emacs/.local/straight/build-28.2/org/ob-clojure hides /usr/share/emacs/28.2/lisp/org/ob-clojure /home/user/.config/emacs/.local/straight/build-28.2/org/ob-forth hides /usr/share/emacs/28.2/lisp/org/ob-forth /home/user/.config/emacs/.local/straight/build-28.2/org/org-compat hides /usr/share/emacs/28.2/lisp/org/org-compat /home/user/.config/emacs/.local/straight/build-28.2/org/ob-lob hides /usr/share/emacs/28.2/lisp/org/ob-lob /home/user/.config/emacs/.local/straight/build-28.2/org/org-mouse hides /usr/share/emacs/28.2/lisp/org/org-mouse /home/user/.config/emacs/.local/straight/build-28.2/org/ob-scheme hides /usr/share/emacs/28.2/lisp/org/ob-scheme /home/user/.config/emacs/.local/straight/build-28.2/org/oc hides /usr/share/emacs/28.2/lisp/org/oc /home/user/.config/emacs/.local/straight/build-28.2/org/org-datetree hides /usr/share/emacs/28.2/lisp/org/org-datetree /home/user/.config/emacs/.local/straight/build-28.2/org/ob-groovy hides /usr/share/emacs/28.2/lisp/org/ob-groovy Study the output of `M-x list-load-path-shadows`. ## `ox-hugo` defcustoms
org-hugo-section “posts”
org-hugo-use-code-for-kbd nil
org-hugo-preserve-filling t
org-hugo-delete-trailing-ws t
org-hugo-prefer-hyphen-in-tags t
org-hugo-allow-spaces-in-tags t
org-hugo-tag-processing-functions (org-hugo–tag-processing-fn-replace-with-spaces-maybe org-hugo–tag-processing-fn-replace-with-hyphens-maybe)
org-hugo-auto-set-lastmod nil
org-hugo-export-with-toc nil
org-hugo-export-with-section-numbers nil
org-hugo-front-matter-format “toml”
org-hugo-default-static-subdirectory-for-externals “ox-hugo”
org-hugo-external-file-extensions-allowed-for-copying (“jpg” “jpeg” “tiff” “png” “svg” “gif” “mp4” “pdf” “odt” “doc” “ppt” “xls” “docx” “pptx” “xlsx”)
org-hugo-date-format “%Y-%m-%dT%T%z”
org-hugo-paired-shortcodes “”
org-hugo-suppress-lastmod-period 0.0
org-hugo-front-matter-format “toml”
kaushalmodi commented 1 year ago

It seems HUGO_DRAFT property in property drawer at the start of a file does not get picked up. #+hugo_draft works fine.

That's correct. The property drawers are parsed only for the subtree based export flow. (The top-of-the-file ID property is a special case though, and that will work as expected.)

In the example you shared, you are using the file based flow, so the #+hugo_draft keyword will need to be used.

Corrected version:

:PROPERTIES:
:ID:       7609e428-8568-4fa6-8c3c-99da28510d49
:END:

#+title: ARM Cortex
#+hugo_categories: ok
#+hugo_draft: true

* CMSIS
...

Documentation: https://ox-hugo.scripter.co/doc/org-meta-data-to-hugo-front-matter/#for-file-based-exports

ericd23 commented 1 year ago

I see. Just found some solid utility functions in Org-roam to work with #+xxx-like properties. Thanks for replying. I'll close for now: )