[PATCH][DOC]: Add footnote on how to enable described functionality

[PATCH][DOC]: Add footnote on how to enable described functionality

[Nick Dokos]

[-- Attachment #1: Type: text/plain, Size: 774 bytes --]

I previously submitted a bug on what I thought was a code bug, but which
turned out to be (partly) a mistake on my part and was canceled:

   https://list.orgmode.org/878r2b4dpy.fsf@localhost/T/#m48b7ea939117f241069fafbcf3726587837f3e70

But there is still a doc bug: since the default value of
`org-html-head-include-scripts' was changed to `nil' in Org 9.5, the
functionality described in the `Literal Examples' section of the manual
is no longer enabled by default. The attached patch adds a footnote to
describe how to enable that functionality. Thanks to user @JeanPierre on
Emacs SE for the original question and the push for the doc patch:

   https://emacs.stackexchange.com/questions/80783/org-mode-export-to-html-onmouseover-highlighting-of-referenced-code-lines


[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: PATCH (org-manual): Add footnote on how to enable described functionality --]
[-- Type: text/x-patch, Size: 1724 bytes --]

From 127d9628b9b1e8be54cdc715ab4e6bdcc012d716 Mon Sep 17 00:00:00 2001
From: Nick Dokos <ndokos@gmail.com>
Date: Fri, 22 Mar 2024 09:08:22 -0400
Subject: [PATCH] org-manual: Add footnote on how to enable described
 functionality.

* doc/manual.org (Literal Examples): The functionality of having
`ref:' links remote-highlighted in HTML is disabled by default (since
version 9.5). Add a footnote to explain how to enable it.

Link: https://emacs.stackexchange.com/questions/80783/org-mode-export-to-html-onmouseover-highlighting-of-referenced-code-lines
---
 doc/org-manual.org | 9 ++++++---
 1 file changed, 6 insertions(+), 3 deletions(-)

diff --git a/doc/org-manual.org b/doc/org-manual.org
index 211208c424c8..c4f62644f8db 100644
--- a/doc/org-manual.org
+++ b/doc/org-manual.org
@@ -11623,9 +11623,12 @@ to determine the starting line number.
 
 In literal examples, Org interprets strings like =(ref:name)= as
 labels, and use them as targets for special hyperlinks like
-=[[(name)]]=---i.e., the reference name enclosed in single parenthesis.
-In HTML, hovering the mouse over such a link remote-highlights the
-corresponding code line, which is kind of cool.
+=[[(name)]]=---i.e., the reference name enclosed in single
+parentheses.  In HTML, hovering the mouse over such a link
+remote-highlights the corresponding code line[fn:: This requires some
+Javascript which is /not/ automatically included in the HTML output:
+you have to customize the variable =org-html-head-include-scripts= to
+~t~ to have it included (it is ~nil~ by default).], which is kind of cool.
 
 You can also add a =-r= switch which /removes/ the labels from the
 source code[fn:: Adding =-k= to =-n -r= /keeps/ the labels in the
-- 
2.43.0


[-- Attachment #3: Type: text/plain, Size: 12 bytes --]


-- 
Nick

Re: [PATCH][DOC]: Add footnote on how to enable described functionality

[Ihor Radchenko]

Nick Dokos <ndokos@gmail.com> writes:

> But there is still a doc bug: since the default value of
> `org-html-head-include-scripts' was changed to `nil' in Org 9.5, the
> functionality described in the `Literal Examples' section of the manual
> is no longer enabled by default. The attached patch adds a footnote to
> describe how to enable that functionality. Thanks to user @JeanPierre on
> Emacs SE for the original question and the push for the doc patch:

Thanks!
Applied, onto bugfix, after fixing minor formatting issues with the
commit message.
https://git.savannah.gnu.org/cgit/emacs/org-mode.git/commit/?id=01b540e21

-- 
Ihor Radchenko // yantar92,
Org mode contributor,
Learn more about Org mode at <https://orgmode.org/>.
Support Org development at <https://liberapay.com/org-mode>,
or support my work at <https://liberapay.com/yantar92>