emacs-orgmode@gnu.org archives
 help / color / mirror / code / Atom feed
From: Tom Gillespie <tgbugs@gmail.com>
To: emacs-orgmode@gnu.org
Subject: [PATCH] org-manual: Use ol-man.el in "Adding Hyperlink Types"
Date: Wed, 8 Jan 2020 17:14:30 -0800	[thread overview]
Message-ID: <CA+G3_PNr_xdrXdaZkg+SuSNswFiO0mOr2sTu5y82A-SwH0G5Xg@mail.gmail.com> (raw)

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

This is a tiny change to the manual to account for the change from org
-> ol in the org-man example. There may be other references in the
manual that have similar issues but I did not check.

[-- Attachment #2: 0001-org-manual-Use-ol-man.el-in-Adding-Hyperlink-Types.patch --]
[-- Type: text/x-patch, Size: 1994 bytes --]

From b2b8088f958379552f5c9dc228dcda56b7e6f738 Mon Sep 17 00:00:00 2001
From: Tom Gillespie <tgbugs@gmail.com>
Date: Wed, 8 Jan 2020 16:13:49 -0800
Subject: org-manual: Use ol-man.el in "Adding Hyperlink Types"

doc/org-manual.org (Adding Hyperlink Types): Update the name of the
example file from org-man.el to ol-man.el to reflect the renaming of
files related to org links.

I found this thorougly confusing when trying to (require 'org-man)
since it was clearly referenced as being in contrib, hopefully this
change will prevent anyone else from encountering the same confusion.

 doc/org-manual.org | 17 ++++++++++-------
 1 file changed, 10 insertions(+), 7 deletions(-)

diff --git a/doc/org-manual.org b/doc/org-manual.org
index 22c2a9fb6..f9437976c 100644
--- a/doc/org-manual.org
+++ b/doc/org-manual.org
@@ -19695,10 +19695,11 @@ process of adding Org links to Unix man pages, which look like this
 : [[man:printf][The printf manual]]
 #+texinfo: @noindent
-The following =org-man.el= file implements it
+The following =ol-man.el= file implements it
 #+begin_src emacs-lisp
-;;; org-man.el - Support for links to man pages in Org mode
+;;; ol-man.el - Support for links to man pages in Org mode
+(require 'ol)
 (require 'org)
 (org-link-set-parameters "man"
@@ -19741,8 +19742,8 @@ The following =org-man.el= file implements it
       (`ascii (format "%s (%s)" desc path))
       (t path))))
-(provide 'org-man)
-;;; org-man.el ends here
+(provide ol-man)
+;;; ol-man.el ends here
 #+texinfo: @noindent
@@ -19750,13 +19751,15 @@ To activate links to man pages in Org, enter this in the Emacs init
 #+begin_src emacs-lisp
-(require 'org-man)
+(require 'ol-man)
 #+texinfo: @noindent
-A review of =org-man.el=:
+A review of =ol-man.el=:
+1. First, =(require 'ol)= ensures that =ol.el= is loaded and
+   =(require 'org)= ensures =org.el= is loaded.
-1. First, =(require 'org)= ensures =org.el= is loaded.

             reply	other threads:[~2020-01-09  1:14 UTC|newest]

Thread overview: 3+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-01-09  1:14 Tom Gillespie [this message]
2020-01-09 16:50 ` [PATCH] org-manual: Use ol-man.el in "Adding Hyperlink Types" Nicolas Goaziou
2020-01-10  5:13   ` Tom Gillespie

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:

  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=CA+G3_PNr_xdrXdaZkg+SuSNswFiO0mOr2sTu5y82A-SwH0G5Xg@mail.gmail.com \
    --to=tgbugs@gmail.com \
    --cc=emacs-orgmode@gnu.org \


* 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


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).