在组织模式下,如何折叠/隐藏脚注?

时间:2013-03-06 21:06:32

标签: emacs lisp elisp org-mode footnotes

在Emacs组织模式中,有没有办法让内联脚注定义显示为折叠状态?

例如,这样的一行:

This effect is due to the strength of weak ties[fn:: Newman, Mark, Albert-László Barabási, and Duncan J. Watts. 2006. The Structure and Dynamics of Networks. Princeton, NJ: Princeton University Press].

可能只是这样:

This effect is due to the strength of weak ties[✭].

我还需要一个命令来在必要时显示脚注。所以可能需要的是两个命令:org-hide-footnotesorg-show-footnotes

2 个答案:

答案 0 :(得分:3)

我不相信这是可能的。同时使用TAB作为扩展密钥,可能会导致更多的密钥重载。

另一方面,有没有特别的理由不在脚注中使用脚注部分?

C-c C-x f将创建/与您拥有的任何脚注互动。

  

(org-footnote-action& optional SPECIAL)

     

为脚注做正确的事。

     

在脚注参考时,跳转到定义。

     

在定义时,跳转到引用(如果存在),提供给   否则就创造它们。

     

如果既没有定义也没有引用,请创建一个新的脚注,   交互。

     

使用前缀arg SPECIAL,在菜单中提供其他命令。

附加命令为:

      s   Sort the footnote definitions by reference sequence.  During editing,
          Org makes no effort to sort footnote definitions into a particular
          sequence.  If you want them sorted, use this command, which will
          also move entries according to org-footnote-section.  Automatic
          sorting after each insertion/deletion can be configured using the
          variable org-footnote-auto-adjust.
      r   Renumber the simple fn:N footnotes.  Automatic renumbering
          after each insertion/deletion can be configured using the variable
          org-footnote-auto-adjust.
      S   Short for first r, then s action.
      n   Normalize the footnotes by collecting all definitions (including
          inline definitions) into a special section, and then numbering them
          in sequence.  The references will then also be numbers.  This is
          meant to be the final step before finishing a document (e.g., sending
          off an email).  The exporters do this automatically, and so could
          something like message-send-hook.
      d   Delete the footnote at point, and all definitions of and references
          to it.

答案 1 :(得分:2)

INITIAL (2014年2月6日):第一份工作草案。

编辑 2014年2月18日:修改了函数lawlist-toggle-block-visibility,使其包含正确的if / then / else语句 - 即,如果该行包含必需的起始区域regexp,然后将切换块可见性,否则显示对不起的消息。 。 。 。添加了一个相关线程的引文,用于代码折叠。修改了错误消息以引用一个点而不是一行。

以下答案的源代码也存储在Github上:https://github.com/lawlist/lawlist-org-block-toggle/blob/master/lawlist-org-block-toggle.el

在相关问题上(即要完全隐藏包含单词:PROPERTIES:的属性抽屉),请参阅以下主题:Completely hide the :PROPERTIES: drawer in org-mode

在半相关问题上(例如,要创建代码折叠的自定义块),另请参阅:https://tex.stackexchange.com/a/161196/26911

此解决方案使用最新版本的Emacs Trunk(建于2014年1月19日)进行测试,其中包含org-mode版本8.2.5c。由于:PROPERTIES:抽屉通过其:END:与脚注和html块分开折叠,此解决方案考虑到脚注和/或html代码块将在任何地方在属性抽屉里面。脚注可以出现在文本段落的任何位置,但脚注内不能有另一对方括号 - 因为此代码查找第一个结束方括号以标记折叠区域的末尾。此代码考虑#+BEGIN_HTML#+END_HTML将左侧边距 flush-left 。启动视图的工作方式仍然相同 - 例如,变量org-startup-foldedorg-hide-block-startup

org-cycle-internal-local的修改可以在组织模式下为所有形式的折叠启用制表符循环。我们所做的就是修复函数​​的分页以使其更具可读性,并添加以下条件:((eq org-cycle-subtree-status 'subtree) (org-show-subtree) (message "ALL") (setq org-cycle-subtree-status 'all))。交互式功能org-cycle仍用于在所有各种折叠/展开视图之间循环切换。函数lawlist-block-org-cycle-internal-localorg-cycle使用的非交互式支持函数。为了使一切正常工作,需要此解决方案中代码的两个defalias部分。用户还可以直接在标题或子标题的开头调用交互式函数,而不是使用制表符循环:M-x org-cycle RET

要直接切换脚注或html块的可见性,我们使用交互式函数lawlist-toggle-block-visibility。将光标放在包含脚注的开头或html块的开头的行上的任意位置,然后键入:M-x lawlist-toggle-block-visibility RET

(require 'org)

(defalias 'org-cycle-hide-drawers 'lawlist-block-org-cycle-hide-drawers)

(defun lawlist-block-org-cycle-hide-drawers (state)
  "Re-hide all drawers, footnotes or html blocks after a visibility state change."
  (when
    (and
      (derived-mode-p 'org-mode)
      (not (memq state '(overview folded contents))))
    (save-excursion
      (let* (
          (globalp (memq state '(contents all)))
          (beg (if globalp (point-min) (point)))
          (end
            (cond
              (globalp
                (point-max))
              ((eq state 'children)
                (save-excursion (outline-next-heading) (point)))
              (t (org-end-of-subtree t)) )))
        (goto-char beg)
        (while
          (re-search-forward
            ".*\\[fn\\|^\\#\\+BEGIN_HTML.*$\\|^[ \t]*:PROPERTIES:[ \t]*$" end t)
          (lawlist-org-flag t))))))

(defalias 'org-cycle-internal-local 'lawlist-block-org-cycle-internal-local)

(defun lawlist-block-org-cycle-internal-local ()
  "Do the local cycling action."
  (let ((goal-column 0) eoh eol eos has-children children-skipped struct)
    (save-excursion
      (if (org-at-item-p)
        (progn
          (beginning-of-line)
          (setq struct (org-list-struct))
          (setq eoh (point-at-eol))
          (setq eos (org-list-get-item-end-before-blank (point) struct))
          (setq has-children (org-list-has-child-p (point) struct)))
        (org-back-to-heading)
        (setq eoh (save-excursion (outline-end-of-heading) (point)))
        (setq eos (save-excursion (1- (org-end-of-subtree t t))))
        (setq has-children
          (or
            (save-excursion
              (let ((level (funcall outline-level)))
                (outline-next-heading)
                (and
                  (org-at-heading-p t)
                  (> (funcall outline-level) level))))
            (save-excursion
              (org-list-search-forward (org-item-beginning-re) eos t)))))
      (beginning-of-line 2)
      (if (featurep 'xemacs)
        (while
            (and
              (not (eobp))
              (get-char-property (1- (point)) 'invisible))
          (beginning-of-line 2))
        (while
            (and
              (not (eobp))
              (get-char-property (1- (point)) 'invisible))
          (goto-char (next-single-char-property-change (point) 'invisible))
          (and
            (eolp)
            (beginning-of-line 2))))
      (setq eol (point)))
    (cond
      ((= eos eoh)
        (unless (org-before-first-heading-p)
          (run-hook-with-args 'org-pre-cycle-hook 'empty))
        (org-unlogged-message "EMPTY ENTRY")
        (setq org-cycle-subtree-status nil)
        (save-excursion
          (goto-char eos)
          (outline-next-heading)
          (if (outline-invisible-p)
            (org-flag-heading nil))))
      ((and
          (or
            (>= eol eos)
            (not (string-match "\\S-" (buffer-substring eol eos))))
          (or
            has-children
            (not (setq children-skipped
              org-cycle-skip-children-state-if-no-children))))
        (unless (org-before-first-heading-p)
          (run-hook-with-args 'org-pre-cycle-hook 'children))
        (if (org-at-item-p)
          ;; then
          (org-list-set-item-visibility (point-at-bol) struct 'children)
          ;; else
          (org-show-entry)
          (org-with-limited-levels (show-children))
          (when (eq org-cycle-include-plain-lists 'integrate)
            (save-excursion
              (org-back-to-heading)
              (while (org-list-search-forward (org-item-beginning-re) eos t)
                (beginning-of-line 1)
                (let* (
                    (struct (org-list-struct))
                    (prevs (org-list-prevs-alist struct))
                    (end (org-list-get-bottom-point struct)))
                  (mapc (lambda (e) (org-list-set-item-visibility e struct 'folded))
                    (org-list-get-all-items (point) struct prevs))
                  (goto-char (if (< end eos) end eos)))))))
        (org-unlogged-message "CHILDREN")
        (save-excursion
          (goto-char eos)
          (outline-next-heading)
          (if (outline-invisible-p)
            (org-flag-heading nil)))
        (setq org-cycle-subtree-status 'children)
        (unless (org-before-first-heading-p)
          (run-hook-with-args 'org-cycle-hook 'children)))
      ((or
          children-skipped
          (and
            (eq last-command this-command)
            (eq org-cycle-subtree-status 'children)))
        (unless (org-before-first-heading-p)
          (run-hook-with-args 'org-pre-cycle-hook 'subtree))
        (outline-flag-region eoh eos nil)
        (org-unlogged-message
        (if children-skipped
          "SUBTREE (NO CHILDREN)"
          "SUBTREE"))
        (setq org-cycle-subtree-status 'subtree)
        (unless (org-before-first-heading-p)
          (run-hook-with-args 'org-cycle-hook 'subtree)))
      ((eq org-cycle-subtree-status 'subtree)
        (org-show-subtree)
        (message "ALL")
        (setq org-cycle-subtree-status 'all))
      (t
        (run-hook-with-args 'org-pre-cycle-hook 'folded)
        (outline-flag-region eoh eos t)
        (org-unlogged-message "FOLDED")
        (setq org-cycle-subtree-status 'folded)
        (unless (org-before-first-heading-p)
        (run-hook-with-args 'org-cycle-hook 'folded))))))

(defun lawlist-org-flag (flag)
  "When FLAG is non-nil, hide any of the following:  html code block;
footnote; or, the properties drawer.  Otherwise make it visible."
  (save-excursion
    (beginning-of-line 1)
    (cond
      ((looking-at ".*\\[fn")
        (let* (
          (begin (match-end 0))
          end-footnote)
          (if (re-search-forward "\\]"
                (save-excursion (outline-next-heading) (point)) t)
            (progn
              (setq end-footnote (point))
              (outline-flag-region begin end-footnote flag))
            (user-error "Error beginning at point %s." begin))))
      ((looking-at "^\\#\\+BEGIN_HTML.*$\\|^[ \t]*:PROPERTIES:[ \t]*$")
        (let* ((begin (match-end 0)))
          (if (re-search-forward "^\\#\\+END_HTML.*$\\|^[ \t]*:END:"
                (save-excursion (outline-next-heading) (point)) t)
            (outline-flag-region begin (point-at-eol) flag)
            (user-error "Error beginning at point %s." begin)))))))

(defun lawlist-toggle-block-visibility ()
"For this function to work, the cursor must be on the same line as the regexp."
(interactive)
  (if
      (save-excursion
        (beginning-of-line 1)
          (looking-at
            ".*\\[fn\\|^\\#\\+BEGIN_HTML.*$\\|^[ \t]*:PROPERTIES:[ \t]*$"))
    (lawlist-org-flag (not (get-char-property (match-end 0) 'invisible)))
    (message "Sorry, you are not on a line containing the beginning regexp.")))