ox-texinfo: Fix menus
* lisp/ox-texinfo.el (org-texinfo-make-menu): Change signature. Remove some intermediate functions. Generate the full master menu when asked. (org-texinfo--build-menu): Use a simpler algorithm. (org-texinfo--format-entries): Fix entries when both node and title are different. (org-texinfo--menu-entries): Renamed from `org-texinfo--generate-menu-list'. (org-texinfo-headline): Move menu handling to next function. (org-texinfo-section): Handle menu for current parent. (org-texinfo--menu-headlines, org-texinfo--generate-detailed): Remove functions. (org-texinfo--normalize-headlines): New function.
This commit is contained in:
Nicolas Goaziou
parent
6326697f4e
commit
ee5c224017
|
|
@ -83,6 +83,7 @@
|
|||
:export-block "TEXINFO"
|
||||
:filters-alist
|
||||
'((:filter-headline . org-texinfo-filter-section-blank-lines)
|
||||
(:filter-parse-tree . org-texinfo--normalize-headlines)
|
||||
(:filter-section . org-texinfo-filter-section-blank-lines))
|
||||
:menu-entry
|
||||
'(?i "Export to Texinfo"
|
||||
|
|
@ -405,6 +406,28 @@ If two strings share the same prefix (e.g. \"ISO-8859-1\" and
|
|||
(let ((blanks (make-string 2 ?\n)))
|
||||
(replace-regexp-in-string "\n\\(?:\n[ \t]*\\)*\\'" blanks headline)))
|
||||
|
||||
(defun org-texinfo--normalize-headlines (tree back-end info)
|
||||
"Normalize headlines in TREE.
|
||||
|
||||
BACK-END is the symbol specifying back-end used for export. INFO
|
||||
is a plist used as a communication channel.
|
||||
|
||||
Make sure every headline in TREE contains a section, since those
|
||||
are required to install a menu.
|
||||
|
||||
Return new tree."
|
||||
(org-element-map tree 'headline
|
||||
(lambda (hl)
|
||||
(let ((contents (org-element-contents hl)))
|
||||
(when contents
|
||||
(let ((first (org-element-map contents '(headline section)
|
||||
#'identity info t)))
|
||||
(unless (eq (org-element-type first) 'section)
|
||||
(org-element-set-contents
|
||||
hl (cons `(section (:parent ,hl)) contents)))))))
|
||||
info)
|
||||
tree)
|
||||
|
||||
(defun org-texinfo--find-verb-separator (s)
|
||||
"Return a character not used in string S.
|
||||
This is used to choose a separator for constructs like \\verb."
|
||||
|
|
@ -508,152 +531,6 @@ Based on Texinfo specifications, the following must be removed:
|
|||
Escape characters are: @ { }"
|
||||
(replace-regexp-in-string "\\\([@{}]\\\)" "@\\1" text))
|
||||
|
||||
;;;; Menu creation
|
||||
|
||||
(defun org-texinfo--build-menu (tree level info &optional detailed)
|
||||
"Create the @menu/@end menu information from TREE at headline
|
||||
level LEVEL.
|
||||
|
||||
TREE contains the parse-tree to work with, either of the entire
|
||||
document or of a specific parent headline. LEVEL indicates what
|
||||
level of headlines to look at when generating the menu. INFO is
|
||||
a plist containing contextual information.
|
||||
|
||||
Detailed determines whether to build a single level of menu, or
|
||||
recurse into all children as well."
|
||||
(let ((menu (org-texinfo--generate-menu-list tree level info))
|
||||
output text-menu)
|
||||
(cond
|
||||
(detailed
|
||||
;; Looping is done within the menu generation.
|
||||
(setq text-menu (org-texinfo--generate-detailed menu level info)))
|
||||
(t
|
||||
(setq text-menu (org-texinfo--generate-menu-items menu info))))
|
||||
(when text-menu
|
||||
(setq output (org-texinfo--format-menu text-menu))
|
||||
(mapconcat 'identity output "\n"))))
|
||||
|
||||
(defun org-texinfo--generate-detailed (menu level info)
|
||||
"Generate a detailed listing of all subheadings within MENU starting at LEVEL.
|
||||
|
||||
MENU is the parse-tree to work with. LEVEL is the starting level
|
||||
for the menu headlines and from which recursion occurs. INFO is
|
||||
a plist containing contextual information."
|
||||
(when level
|
||||
(let ((max-depth (min org-texinfo-max-toc-depth
|
||||
(plist-get info :headline-levels))))
|
||||
(when (> max-depth level)
|
||||
(loop for headline in menu append
|
||||
(let* ((title (org-texinfo--menu-headlines headline info))
|
||||
;; Create list of menu entries for the next level
|
||||
(sublist (org-texinfo--generate-menu-list
|
||||
headline (1+ level) info))
|
||||
;; Generate the menu items for that level. If
|
||||
;; there are none omit that heading completely,
|
||||
;; otherwise join the title to it's related entries.
|
||||
(submenu (if (org-texinfo--generate-menu-items sublist info)
|
||||
(append (list title)
|
||||
(org-texinfo--generate-menu-items sublist info))
|
||||
'nil))
|
||||
;; Start the process over the next level down.
|
||||
(recursion (org-texinfo--generate-detailed sublist (1+ level) info)))
|
||||
(setq recursion (append submenu recursion))
|
||||
recursion))))))
|
||||
|
||||
(defun org-texinfo--generate-menu-list (tree level info)
|
||||
"Generate the list of headlines that are within a given level
|
||||
of the tree for further formatting.
|
||||
|
||||
TREE is the parse-tree containing the headlines. LEVEL is the
|
||||
headline level to generate a list of. INFO is a plist holding
|
||||
contextual information."
|
||||
(org-element-map tree 'headline
|
||||
(lambda (head)
|
||||
(and (= (org-export-get-relative-level head info) level)
|
||||
;; Do not take note of footnotes or copying headlines.
|
||||
(not (org-not-nil (org-element-property :COPYING head)))
|
||||
(not (org-element-property :footnote-section-p head))
|
||||
;; Collect headline.
|
||||
head))
|
||||
info))
|
||||
|
||||
(defun org-texinfo--generate-menu-items (items info)
|
||||
"Generate a list of headline information from the listing ITEMS.
|
||||
|
||||
ITEMS is a list of the headlines to be converted into entries.
|
||||
INFO is a plist containing contextual information.
|
||||
|
||||
Returns a list containing the following information from each
|
||||
headline: length, title, description. This is used to format the
|
||||
menu using `org-texinfo--format-menu'."
|
||||
(loop for headline in items collect
|
||||
(let* ((menu-title (org-texinfo--sanitize-menu
|
||||
(org-export-data
|
||||
(org-export-get-alt-title headline info)
|
||||
info)))
|
||||
(title (org-texinfo--sanitize-menu
|
||||
(org-texinfo--sanitize-headline
|
||||
(org-element-property :title headline) info)))
|
||||
(descr (org-export-data
|
||||
(org-element-property :DESCRIPTION headline)
|
||||
info))
|
||||
(menu-entry (if (string= "" menu-title) title menu-title))
|
||||
(len (length menu-entry))
|
||||
(output (list len menu-entry descr)))
|
||||
output)))
|
||||
|
||||
(defun org-texinfo--menu-headlines (headline info)
|
||||
"Retrieve the title from HEADLINE.
|
||||
|
||||
INFO is a plist holding contextual information.
|
||||
|
||||
Return the headline as a list of (length title description) with
|
||||
length of -1 and nil description. This is used in
|
||||
`org-texinfo--format-menu' to identify headlines as opposed to
|
||||
entries."
|
||||
(let ((title (org-export-data
|
||||
(org-element-property :title headline) info)))
|
||||
(list -1 title 'nil)))
|
||||
|
||||
(defun org-texinfo--format-menu (text-menu)
|
||||
"Format the TEXT-MENU items to be properly printed in the menu.
|
||||
|
||||
Each entry in the menu should be provided as (length title
|
||||
description).
|
||||
|
||||
Headlines in the detailed menu are given length -1 to ensure they
|
||||
are never confused with other entries. They also have no
|
||||
description.
|
||||
|
||||
Other menu items are output as:
|
||||
Title:: description
|
||||
|
||||
With the spacing between :: and description based on the length
|
||||
of the longest menu entry."
|
||||
|
||||
(let (output)
|
||||
(setq output
|
||||
(mapcar (lambda (name)
|
||||
(let* ((title (nth 1 name))
|
||||
(desc (nth 2 name))
|
||||
(length (nth 0 name))
|
||||
(column (max
|
||||
;;6 is "* " ":: " for inserted text
|
||||
length
|
||||
(-
|
||||
org-texinfo-node-description-column
|
||||
6)))
|
||||
(spacing (- column length)
|
||||
))
|
||||
(if (> length -1)
|
||||
(concat "* " title ":: "
|
||||
(make-string spacing ?\s)
|
||||
(if desc
|
||||
(concat desc)))
|
||||
(concat "\n" title "\n"))))
|
||||
text-menu))
|
||||
output))
|
||||
|
||||
;;; Template
|
||||
|
||||
(defun org-texinfo-template (contents info)
|
||||
|
|
@ -765,17 +642,8 @@ holding export options."
|
|||
(and copying "@insertcopying\n")
|
||||
"@end ifnottex\n\n"
|
||||
;; Menu.
|
||||
(let ((menu (org-texinfo-make-menu info 'main))
|
||||
(detail-menu (org-texinfo-make-menu info 'detailed)))
|
||||
(and menu
|
||||
(concat "@menu\n"
|
||||
menu "\n"
|
||||
(and detail-menu
|
||||
(concat "\n@detailmenu\n"
|
||||
" --- The Detailed Node Listing ---\n"
|
||||
detail-menu "\n"
|
||||
"@end detailmenu\n"))
|
||||
"@end menu\n\n")))
|
||||
(org-texinfo-make-menu (plist-get info :parse-tree) info 'master)
|
||||
"\n"
|
||||
;; Document's body.
|
||||
contents "\n"
|
||||
;; Creator.
|
||||
|
|
@ -920,33 +788,11 @@ holding contextual information."
|
|||
;; Create node info, to insert it before section formatting.
|
||||
;; Use custom menu title if present.
|
||||
(node (format "@node %s\n" (org-texinfo--get-node headline info)))
|
||||
;; Menus must be generated with first child, otherwise they
|
||||
;; will not nest properly.
|
||||
(menu (let* ((first (org-export-first-sibling-p headline info))
|
||||
(parent (org-export-get-parent-headline headline))
|
||||
(title (org-texinfo--sanitize-headline
|
||||
(org-element-property :title parent) info))
|
||||
heading listing
|
||||
(tree (plist-get info :parse-tree)))
|
||||
(if first
|
||||
(org-element-map (plist-get info :parse-tree) 'headline
|
||||
(lambda (ref)
|
||||
(if (member title (org-element-property :title ref))
|
||||
(push ref heading)))
|
||||
info t))
|
||||
(setq listing (org-texinfo--build-menu
|
||||
(car heading) level info))
|
||||
(if listing
|
||||
(setq listing (replace-regexp-in-string
|
||||
"%" "%%" listing)
|
||||
listing (format
|
||||
"\n@menu\n%s\n@end menu\n\n" listing))
|
||||
'nil)))
|
||||
;; Section formatting will set two placeholders: one for the
|
||||
;; title and the other for the contents.
|
||||
(section-fmt
|
||||
(if (org-not-nil (org-element-property :APPENDIX headline))
|
||||
(concat menu node "@appendix %s\n%s")
|
||||
(concat node "@appendix %s\n%s")
|
||||
(let ((sec (if (and (symbolp (nth 2 class-sectioning))
|
||||
(fboundp (nth 2 class-sectioning)))
|
||||
(funcall (nth 2 class-sectioning) level numberedp)
|
||||
|
|
@ -958,8 +804,7 @@ holding contextual information."
|
|||
((stringp sec) sec)
|
||||
;; (numbered-section . unnumbered-section)
|
||||
((not (consp (cdr sec)))
|
||||
(concat menu
|
||||
node
|
||||
(concat node
|
||||
;; An index is always unnumbered.
|
||||
(if (or index (not numberedp)) (cdr sec) (car sec))
|
||||
"\n%s"))))))
|
||||
|
|
@ -1227,23 +1072,93 @@ INFO is a plist holding contextual information. See
|
|||
|
||||
;;;; Menu
|
||||
|
||||
(defun org-texinfo-make-menu (info level)
|
||||
"Create the menu for inclusion in the texifo document.
|
||||
(defun org-texinfo-make-menu (scope info &optional master)
|
||||
"Create the menu for inclusion in the Texinfo document.
|
||||
|
||||
INFO is the parsed buffer that contains the headlines. LEVEL
|
||||
determines whether to make the main menu, or the detailed menu.
|
||||
SCOPE is a headline or a full parse tree. INFO is the
|
||||
communication channel, as a plist.
|
||||
|
||||
This is only used for generating the primary menu. In-Node menus
|
||||
are generated directly."
|
||||
(let ((parse (plist-get info :parse-tree)))
|
||||
(cond
|
||||
;; Generate the main menu
|
||||
((eq level 'main) (org-texinfo--build-menu parse 1 info))
|
||||
;; Generate the detailed (recursive) menu
|
||||
((eq level 'detailed)
|
||||
;; Requires recursion
|
||||
;;(org-texinfo--build-detailed-menu parse top info)
|
||||
(org-texinfo--build-menu parse 1 info 'detailed)))))
|
||||
When optional argument MASTER is non-nil, generate a master menu,
|
||||
including detailed node listing."
|
||||
(let ((menu (org-texinfo--build-menu scope info)))
|
||||
(when (org-string-nw-p menu)
|
||||
(org-element-normalize-string
|
||||
(format
|
||||
"@menu\n%s@end menu"
|
||||
(concat menu
|
||||
(when master
|
||||
(let ((detailmenu
|
||||
(org-texinfo--build-menu
|
||||
scope info
|
||||
(let ((toc-depth (plist-get info :with-toc)))
|
||||
(if (wholenump toc-depth) toc-depth
|
||||
org-texinfo-max-toc-depth)))))
|
||||
(when (org-string-nw-p detailmenu)
|
||||
(concat "\n@detailmenu\n"
|
||||
"--- The Detailed Node Listing ---\n\n"
|
||||
detailmenu
|
||||
"@end detailmenu\n"))))))))))
|
||||
|
||||
(defun org-texinfo--build-menu (scope info &optional level)
|
||||
"Build menu for entries within SCOPE.
|
||||
SCOPE is a headline or a full parse tree. INFO is a plist
|
||||
containing contextual information. When optional argument LEVEL
|
||||
is an integer, build the menu recursively, down to this depth."
|
||||
(cond
|
||||
((not level)
|
||||
(org-texinfo--format-entries (org-texinfo--menu-entries scope info) info))
|
||||
((zerop level) nil)
|
||||
(t
|
||||
(org-element-normalize-string
|
||||
(mapconcat
|
||||
(lambda (h)
|
||||
(let ((entries (org-texinfo--menu-entries h info)))
|
||||
(when entries
|
||||
(concat
|
||||
(format "%s\n\n%s\n"
|
||||
(org-export-data (org-export-get-alt-title h info) info)
|
||||
(org-texinfo--format-entries entries info))
|
||||
(org-texinfo--build-menu h info (1- level))))))
|
||||
(org-texinfo--menu-entries scope info) "")))))
|
||||
|
||||
(defun org-texinfo--format-entries (entries info)
|
||||
"Format all direct menu entries in SCOPE, as a string.
|
||||
SCOPE is either a headline or a full Org document. INFO is
|
||||
a plist containing contextual information."
|
||||
(org-element-normalize-string
|
||||
(mapconcat
|
||||
(lambda (h)
|
||||
(let* ((title (org-export-data
|
||||
(org-export-get-alt-title h info) info))
|
||||
(node (org-texinfo--get-node h info))
|
||||
(entry (concat "* " title ":"
|
||||
(if (string= title node) ":"
|
||||
(concat " " node ". "))))
|
||||
(desc (org-element-property :DESCRIPTION h)))
|
||||
(if (not desc) entry
|
||||
(format (format "%%-%ds %%s" org-texinfo-node-description-column)
|
||||
entry desc))))
|
||||
entries "\n")))
|
||||
|
||||
(defun org-texinfo--menu-entries (scope info)
|
||||
"List direct children in SCOPE needing a menu entry.
|
||||
SCOPE is a headline or a full parse tree. INFO is a plist
|
||||
holding contextual information."
|
||||
(let* ((cache (or (plist-get info :texinfo-entries-cache)
|
||||
(plist-get (plist-put info :texinfo-entries-cache
|
||||
(make-hash-table :test #'eq))
|
||||
:texinfo-entries-cache)))
|
||||
(cached-entries (gethash scope cache 'no-cache)))
|
||||
(if (not (eq cached-entries 'no-cache)) cached-entries
|
||||
(puthash scope
|
||||
(org-element-map (org-element-contents scope) 'headline
|
||||
(lambda (h)
|
||||
(and (not (org-not-nil (org-element-property :COPYING h)))
|
||||
(not (org-element-property :footnote-section-p h))
|
||||
(not (org-export-low-level-p h info))
|
||||
h))
|
||||
info nil 'headline)
|
||||
cache))))
|
||||
|
||||
;;;; Paragraph
|
||||
|
||||
|
|
@ -1388,7 +1303,9 @@ contextual information."
|
|||
"Transcode a SECTION element from Org to Texinfo.
|
||||
CONTENTS holds the contents of the section. INFO is a plist
|
||||
holding contextual information."
|
||||
contents)
|
||||
(concat contents
|
||||
(let ((parent (org-export-get-parent-headline section)))
|
||||
(and parent (org-texinfo-make-menu parent info)))))
|
||||
|
||||
;;;; Special Block
|
||||
|
||||
|
|
|
|||
Loading…
Reference in New Issue