emacs-orgmode@gnu.org archives
 help / color / mirror / code / Atom feed
From: Anthony Carrico <acarrico@memebeam.org>
To: Bastien <bzg@gnu.org>
Cc: emacs-orgmode@gnu.org
Subject: Re: [PATCH] Include missing files when sitemap style is tree
Date: Mon, 26 Oct 2020 20:38:16 -0400	[thread overview]
Message-ID: <fd70421e-2794-50c6-54c9-3a4f92369d4d@memebeam.org> (raw)
In-Reply-To: <87blgrke6b.fsf@gnu.org>

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
       `(("test-export"
          :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
	    (concat
	     (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) root-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	other threads:[~2020-10-27  0:40 UTC|newest]

Thread overview: 3+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-09-12  3:26 Anthony Carrico
2020-10-24 12:21 ` Bastien
2020-10-27  0:38   ` Anthony Carrico [this message]

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

  List information: https://www.orgmode.org/

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=fd70421e-2794-50c6-54c9-3a4f92369d4d@memebeam.org \
    --to=acarrico@memebeam.org \
    --cc=bzg@gnu.org \
    --cc=emacs-orgmode@gnu.org \
    --subject='Re: [PATCH] Include missing files when sitemap style is tree' \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link

Code repositories for project(s) associated with this inbox:

	https://git.savannah.gnu.org/cgit/emacs/org-mode.git

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).