From: Toon Claes <toon@iotcl.com>
To: emacs-orgmode@gnu.org
Subject: Re: [PATCH] Suggestion to self-link headlines exported to HTML
Date: Fri, 28 Dec 2018 22:32:16 +0100 [thread overview]
Message-ID: <87o9951gnz.fsf@iotcl.com> (raw)
In-Reply-To: <871s6dyz6o.fsf@nicolasgoaziou.fr> (Nicolas Goaziou's message of "Wed, 19 Dec 2018 22:38:39 +0100")
[-- Attachment #1.1: Type: text/plain, Size: 141 bytes --]
Thanks Nicolas for taking time to have look at my patch.
I'm a attaching a second version of the patch. Please have another look.
-- Toon
[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #1.2: Patch to self-link headlines --]
[-- Type: text/x-diff, Size: 5498 bytes --]
From 094576d4c082fc384aa56bf2f4ec2749fec540a7 Mon Sep 17 00:00:00 2001
From: Toon Claes <toon@iotcl.com>
Date: Sun, 16 Dec 2018 21:55:40 +0100
Subject: [PATCH] ox-html: Make it possible to self link headlines
* lisp/ox-html.el (org-html-self-link-headlines): New variable.
(org-html-headline): Create a hyperlink on headlines
when :html-self-link-headlines is set.
---
doc/org-manual.org | 16 ++++++++++++++++
etc/ORG-NEWS | 5 +++++
lisp/ox-html.el | 18 +++++++++++++++---
3 files changed, 36 insertions(+), 3 deletions(-)
diff --git a/doc/org-manual.org b/doc/org-manual.org
index 59e31d8b3..884975d8f 100644
--- a/doc/org-manual.org
+++ b/doc/org-manual.org
@@ -12495,6 +12495,21 @@ For larger raw HTML code blocks, use these HTML export code blocks:
,#+END_EXPORT
#+end_example
+*** Headlines in HTML export
+:PROPERTIES:
+:DESCRIPTION: Formatting headlines.
+:END:
+#+cindex: headlines, in HTML export
+
+Headlines are exported to ~<h1>~, ~<h2>~, etc. Each headline will get
+the ~id~ attribute from =CUSTOM_ID= property, or a unique generated
+value, see [[*Internal Links]].
+
+#+vindex: org-html-self-link-headlines
+When ~org-html-self-link-headlines~ is set to a non-~nil~ value, the
+text of the headlines is also wrapped in ~<a>~ tags. These tags have
+a ~href~ attribute making the headlines link to the headline itself.
+
*** Links in HTML export
:PROPERTIES:
:DESCRIPTION: Inserting and formatting links.
@@ -15610,6 +15625,7 @@ Settings]]), however, override everything.
| ~:html-postamble~ | ~org-html-postamble~ |
| ~:html-preamble-format~ | ~org-html-preamble-format~ |
| ~:html-preamble~ | ~org-html-preamble~ |
+| ~:html-self-link-headlines~ | ~org-html-self-link-headlines~ |
| ~:html-table-align-individual-field~ | ~de{org-html-table-align-individual-fields~ |
| ~:html-table-attributes~ | ~org-html-table-default-attributes~ |
| ~:html-table-caption-above~ | ~org-html-table-caption-above~ |
diff --git a/etc/ORG-NEWS b/etc/ORG-NEWS
index 811e98147..817d6eacc 100644
--- a/etc/ORG-NEWS
+++ b/etc/ORG-NEWS
@@ -312,6 +312,11 @@ beginning of a headline when using Org speed commands. Now, if there
is already a restriction at point, hitting =<= again (or =C-x C-x <=) will
remove it.
+*** Headlines can now link to themselves in HTML export
+
+When enabling ~org-html-self-link-headlines~ the headlines exported to
+HTML contain a hyperlink to themselves.
+
** New commands and functions
*** ~org-insert-structure-template~
diff --git a/lisp/ox-html.el b/lisp/ox-html.el
index b4ec25786..728e156f1 100644
--- a/lisp/ox-html.el
+++ b/lisp/ox-html.el
@@ -152,6 +152,7 @@
(:html-metadata-timestamp-format nil nil org-html-metadata-timestamp-format)
(:html-postamble-format nil nil org-html-postamble-format)
(:html-preamble-format nil nil org-html-preamble-format)
+ (:html-self-link-headlines nil nil org-html-self-link-headlines)
(:html-table-align-individual-fields
nil nil org-html-table-align-individual-fields)
(:html-table-caption-above nil nil org-html-table-caption-above)
@@ -802,6 +803,13 @@ but without \"name\" attribute."
:package-version '(Org . "8.0")
:type 'boolean)
+(defcustom org-html-self-link-headlines nil
+ "When non-nil, the headlines contain a hyperlink to themselves."
+ :group 'org-export-html
+ :package-version '(Org . "9.3")
+ :type 'boolean
+ :safe #'booleanp)
+
;;;; Inlinetasks
(defcustom org-html-format-inlinetask-function
@@ -2592,7 +2600,11 @@ holding contextual information."
todo todo-type priority text tags info))
(contents (or contents ""))
(id (or (org-element-property :CUSTOM_ID headline)
- (org-export-get-reference headline info))))
+ (org-export-get-reference headline info)))
+ (formatted-text
+ (if (plist-get info :html-self-link-headlines)
+ (format "<a href=\"#%s\">%s</a>" id full-text)
+ full-text)))
(if (org-export-low-level-p headline info)
;; This is a deep sub-tree: export it as a list item.
(let* ((html-type (if numberedp "ol" "ul")))
@@ -2603,7 +2615,7 @@ holding contextual information."
(org-html-format-list-item
contents (if numberedp 'ordered 'unordered)
nil info nil
- (concat (org-html--anchor id nil nil info) full-text)) "\n"
+ (concat (org-html--anchor id nil nil info) formatted-text)) "\n"
(and (org-export-last-sibling-p headline info)
(format "</%s>\n" html-type))))
;; Standard headline. Export it as a section.
@@ -2625,7 +2637,7 @@ holding contextual information."
"<span class=\"section-number-%d\">%s</span> "
level
(mapconcat #'number-to-string numbers ".")))
- full-text)
+ formatted-text)
level)
;; When there is no section, pretend there is an
;; empty one to get the correct <div
--
2.19.0.rc0.2.g29d9e3e2c.dirty
[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 832 bytes --]
next prev parent reply other threads:[~2018-12-28 21:55 UTC|newest]
Thread overview: 4+ messages / expand[flat|nested] mbox.gz Atom feed top
2018-12-16 21:23 [PATCH] Suggestion to self-link headlines exported to HTML Toon Claes
2018-12-19 21:38 ` Nicolas Goaziou
2018-12-28 21:32 ` Toon Claes [this message]
2018-12-29 14:00 ` Nicolas Goaziou
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=87o9951gnz.fsf@iotcl.com \
--to=toon@iotcl.com \
--cc=emacs-orgmode@gnu.org \
/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
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this public 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).