[Top][All Lists]

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

Re: [PATCH] Include missing files when sitemap style is tree

From: Anthony Carrico
Subject: Re: [PATCH] Include missing files when sitemap style is tree
Date: Mon, 26 Oct 2020 20:38:16 -0400
User-agent: Mozilla/5.0 (X11; Linux x86_64; rv:68.0) Gecko/20100101 Thunderbird/68.12.0

On 10/24/20 8:21 AM, Bastien wrote:
Anthony Carrico <acarrico@memebeam.org> writes:

* ox-publish.el (org-publish-sitemap): Include files that have an
ancestor below base-directory with no published files and sitemap style
is tree.

thanks for the patch and sorry for the delay in replying.  I'm not
sure I understand the bug it fixes: can you briefly describe it or
provide a reproducible recipe?

#!/run/current-system/sw/bin/emacs --script

(require 'org)
(require 'ox-publish)

;;; create a source directory tree:
(make-directory "test-export/src/level1/level2/level3" t)

;;; create two source files, with an empty directory between:
(with-temp-file "test-export/src/level1/one.org"
  (insert "#+TITLE one"))

(with-temp-file "test-export/src/level1/level2/level3/three.org"
  (insert "#+TITLE three"))

;;; create a destination directory trees:
(make-directory "test-export/dest" t)

;;; publish the test-export:
(setq org-publish-project-alist
         :base-directory "test-export/src"
         :publishing-directory "test-export/dest"
         :publishing-function org-html-publish-to-html
         :sitemap-filename "index.org"
         :sitemap-title "test-export"
         :sitemap-style tree
         :auto-sitemap t
         :recursive t)))

;; ISSUE: Even with the force argument, org-publish still seems to generate a cache in ~/.org-timestamps which creates a sitemap with old titles and breaks reproducible builds. To avoid this problem delete the cache when publishing:
(defun org-publish-delete-cache-file (project-name)
    (let* ((cache-file
             (expand-file-name org-publish-timestamp-directory)
             project-name ".cache"))
           (cexists (file-exists-p cache-file)))
      (when (file-exists-p cache-file)
        (delete-file cache-file))))

(org-publish-delete-cache-file "test-export")
(org-publish "test-export" t)
(org-publish-delete-cache-file "test-export")

;; Now run:
;; $ firefox test-export/dest/index.html
;; You should see something like this:
;; test-export
;;     level1
;;         one

;; Now run again with my patch, and you will see something like this:
;; test-export
;;     level1
;;         one
;;         level2
;;             level3
;;                 three
;; As you can see, without the patch, "three" is missing from the index.

+(defun org-publish-dir-name-parent (dir-name)
+  (file-name-as-directory (expand-file-name (concat dir-name ".."))))
+(defun org-publish-dir-name-and-parents (dir-name root-dir-name)
+  (pcase dir-name
+     ("" nil)
+     ((or "./" "/" (pred (string= root-dir-name))) (list dir-name))
+     (_ (cons dir-name (org-publish-dir-name-and-parents
+                       (org-publish-dir-name-parent dir-name) 
+(defun org-publish-file-name-parents (file root)
+  (org-publish-dir-name-and-parents (file-name-directory file)
+                                   (file-name-as-directory root)))

You would need to add docstrings for each of the new functions.

I've run out of time today. These /seem/ like they should be standard procedures in elisp, not something in org-publish, but I couldn't find them in the manual. I'm not very experienced with elisp though.

I've run out of time today. Tell me if you have trouble with the test case. Thank you Bastien.

Anthony Carrico

reply via email to

[Prev in Thread] Current Thread [Next in Thread]