[patchattached] Store link to url of eww

[patchattached] Store link to url of eww

[marcowahlsoft]

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

Hello all,

since eww comes bundled with Emacs nowadays it feels natural to be able
store a link to the current url of an eww buffer.  This functionality
has already been in place for w3m for a while.

Find a respective patch attached.  I hope the fact that the patch is
attached is acceptable as well as the patch itself.


Best wishes,  Marco
-- 
http://www.wahlzone.de
PGP: 0x0A3AE6F2

[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: [PATCH] org-eww: Org-module to store url from eww --]
[-- Type: text/x-diff, Size: 4162 bytes --]

From a4ead864a14931ef2a8dd43719fb6ee90861d346 Mon Sep 17 00:00:00 2001
From: Marco Wahl <marcowahlsoft@gmail.com>
Date: Tue, 23 Sep 2014 09:46:34 +0200
Subject: [PATCH] org-eww: Org-module to store url from eww

* contrib/lisp/org-eww.el: New file

* contrib/lisp/org-eww.el(org-eww-store-link): Hook to store a link.

* contrib/README: Added a line for the org-eww.

* lisp/org.el (org-modules): Add org-eww to the pool of org-modules.

The hook gets hooked in the module.

The file is more or less a fraction of the org-w3m module with 'w3m'
replaced by 'eww'.

TINYCHANGE
---
 contrib/README          |  1 +
 contrib/lisp/org-eww.el | 54 +++++++++++++++++++++++++++++++++++++++++++++++++
 lisp/org.el             |  1 +
 3 files changed, 56 insertions(+)
 create mode 100644 contrib/lisp/org-eww.el

diff --git a/contrib/README b/contrib/README
index e92da14..7bffeee 100644
--- a/contrib/README
+++ b/contrib/README
@@ -29,6 +29,7 @@ org-element.el           --- Parser and applications for Org syntax
 org-elisp-symbol.el      --- Org links to emacs-lisp symbols
 org-eval-light.el        --- Evaluate in-buffer code on demand
 org-eval.el              --- The <lisp> tag, adapted from Muse
+org-eww.el               --- Store link to url of eww
 org-expiry.el            --- Expiry mechanism for Org entries
 org-export-generic.el    --- Export framework for configurable backends
 org-git-link.el          --- Provide org links to specific file version
diff --git a/contrib/lisp/org-eww.el b/contrib/lisp/org-eww.el
new file mode 100644
index 0000000..c25057d
--- /dev/null
+++ b/contrib/lisp/org-eww.el
@@ -0,0 +1,54 @@
+;;; org-eww.el --- Storing link in eww-mode for Org-mode
+
+;; Copyright (C) 2014 Free Software Foundation, Inc.
+
+;; Author: Marco Wahl <marcowahlsoft>a<gmailcom>
+;; Keywords: link, eww
+;; Homepage: http://orgmode.org
+;;
+;; This file is not part of GNU Emacs.
+;;
+;; This program is free software: you can redistribute it and/or modify
+;; it under the terms of the GNU General Public License as published by
+;; the Free Software Foundation, either version 3 of the License, or
+;; (at your option) any later version.
+
+;; This program is distributed in the hope that it will be useful,
+;; but WITHOUT ANY WARRANTY; without even the implied warranty of
+;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+;; GNU General Public License for more details.
+
+;; You should have received a copy of the GNU General Public License
+;; along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.
+
+\f
+;;; Commentary:
+
+;; When this module is active `org-store-link' (often on key C-c l) in
+;; a eww buffer stores a link to the current url of the eww buffer.
+
+;; `org-eww-store-link' below is almost the same as
+;; `org-w3m-store-link' of the org-w3m module.
+
+;; Hint: There are further features in module org-w3m which might be
+;; interesting for org-eww also.
+
+\f
+;;; Code:
+
+(require 'org)
+
+(add-hook 'org-store-link-functions 'org-eww-store-link)
+(defun org-eww-store-link ()
+  "Store a link to the url of a eww buffer."
+  (when (eq major-mode 'eww-mode)
+    (org-store-link-props
+     :type "eww"
+     :link eww-current-url
+     :url (url-view-url t)
+     :description (or eww-current-title eww-current-url))))
+
+\f
+(provide 'org-eww)
+
+;;; org-eww.el ends here
diff --git a/lisp/org.el b/lisp/org.el
index b09e72d..0bf91d3 100644
--- a/lisp/org.el
+++ b/lisp/org.el
@@ -640,6 +640,7 @@ For export specific modules, see also `org-export-backends'."
 	(const :tag "C  eshell             Support for links to working directories in eshell" org-eshell)
 	(const :tag "C  eval-light:        Evaluate inbuffer-code on demand" org-eval-light)
 	(const :tag "C  eval:              Include command output as text" org-eval)
+	(const :tag "C  eww:               Store link to url of eww" org-eww)
 	(const :tag "C  expiry:            Expiry mechanism for Org-mode entries" org-expiry)
 	(const :tag "C  favtable:          Lookup table of favorite references and links" org-favtable)
 	(const :tag "C  git-link:          Provide org links to specific file version" org-git-link)
-- 
2.1.0

Re: [patchattached] Store link to url of eww

[Aaron Ecay]

Hi Marco,

Thanks for your patch.  TINYCHANGES can only be smaller than 15 lines,
though, and your patch has more than that (even if we discount
boilerplate like the license notice).  So you should probably do the
copyright assignment which is described at
<http://orgmode.org/worg/org-contribute.html#sec-2>.

-- 
Aaron Ecay

Re: [patchattached] Store link to url of eww

[Aaron Ecay]

Hi again,

2014ko irailak 23an, Aaron Ecay-ek idatzi zuen:
> 
> Hi Marco,
> 
> Thanks for your patch.  TINYCHANGES can only be smaller than 15 lines,
> though, and your patch has more than that (even if we discount
> boilerplate like the license notice).  So you should probably do the
> copyright assignment which is described at
> <http://orgmode.org/worg/org-contribute.html#sec-2>.

I should have said: the copyright assignment isn’t strictly needed for
code in contrib.  But since this module is an interface between two emacs
built-in modules, it is a good candidate for moving to core eventually,
where the copyright assignment would be needed.

So, I didn’t mean to imply that the copyright assignment would be a hard
condition on merging your patch, but IMO it would be helpful.

-- 
Aaron Ecay

Re: [patchattached] Store link to url of eww

[Rasmus]

Aaron Ecay <aaronecay@gmail.com> writes:

> Hi Marco,
>
> Thanks for your patch.  TINYCHANGES can only be smaller than 15 lines,
> though, and your patch has more than that (even if we discount
> boilerplate like the license notice).  So you should probably do the
> copyright assignment which is described at
> <http://orgmode.org/worg/org-contribute.html#sec-2>.

I think he did:

Patch:
> From: Marco Wahl <marcowahlsoft@gmail.com>

Worg:
> 14. Marco Wahl

Marco, you don't need to write TINYCHANGE if you have done the
paperwork.

—Rasmus

-- 
Dobbelt-A

Re: [patchattached] Store link to url of eww

[Aaron Ecay]

Hi Rasmus,

2014ko irailak 23an, Rasmus-ek idatzi zuen:
> I think he did:
> 
> Patch:
>> From: Marco Wahl <marcowahlsoft@gmail.com>
> 
> Worg:
>> 14. Marco Wahl

...that’s in the section for tinychange contributors without papers on
file though.

-- 
Aaron Ecay

Re: [patchattached] Store link to url of eww

[Marco Wahl]

Aaron Ecay <aaronecay@gmail.com> writes:

> 2014ko irailak 23an, Rasmus-ek idatzi zuen:
>> I think he did:
>> 
>> Patch:
>>> From: Marco Wahl <marcowahlsoft@gmail.com>
>> 
>> Worg:
>>> 14. Marco Wahl
>
> ...that’s in the section for tinychange contributors without papers on
> file though.

I just initiated the assignment process according to your hint.  AFAICS
it's time for some patience now.  I will tell you when it's done.


Thanks,  Marco
-- 
http://www.wahlzone.de
PGP: 0x0A3AE6F2

Re: [patchattached] Store link to url of eww

[Marco Wahl]

Hi!

Marco Wahl <marcowahlsoft@gmail.com> writes:
> Aaron Ecay <aaronecay@gmail.com> writes:
>> 2014ko irailak 23an, Rasmus-ek idatzi zuen:
>> ...that’s in the section for tinychange contributors without papers on
>> file though.
>
> I just initiated the assignment process according to your hint.  AFAICS
> it's time for some patience now.  I will tell you when it's done.

The assignment process is complete.  The id is 946878.


All the best,  Marco
-- 
http://www.wahlzone.de
PGP: 0x0A3AE6F2

Re: [patchattached] Store link to url of eww

[Aaron Ecay]

Hi Marco,

Excellent.  I have pushed your patch to the master branch of the org-mode
repo.  If you want commit access, you can follow the instructions in the
wiki: <http://orgmode.org/worg/org-contribute.html#devs>.

Org’s maintainer Bastien (cc’d) is the only one who can actually verify
the assignment with the FSF, AFAIK.  He’s been busy lately, but when he’s
back he can do that and officially add you to the list of contributors.
(Or maybe someone else who has this ability will do so.)

Thanks,

-- 
Aaron Ecay

Re: [patchattached] Store link to url of eww

[Bastien]

Hi Aaron and Marco,

I confirm you are listed in the FSF contributors and we can now accept
patches with no restriction.

I added you to the list of contributors here:
http://orgmode.org/worg/org-contribute.html#contributors_with_fsf_papers

Thanks for contributing!

-- 
 Bastien

Re: [patchattached] Store link to url of eww

[Marco Wahl]

Hi Bastien,

> I added you to the list of contributors here:
> http://orgmode.org/worg/org-contribute.html#contributors_with_fsf_papers
>
> Thanks for contributing!

Thanks for adding me!


Best wishes,  Marco
-- 
http://www.wahlzone.de
PGP: 0x0A3AE6F2

Re: [patchattached] Store link to url of eww

[Marco Wahl]

Hi Aaron,

> [...] I have pushed your patch to the master branch of the org-mode
> repo.  If you want commit access, you can follow the instructions in the
> wiki: <http://orgmode.org/worg/org-contribute.html#devs>.

Thank you for your action and the hint about committing.  For my next
contribution (which hopefully will come to existence) I'll try out the
push access.


Best regards,  Marco
-- 
http://www.wahlzone.de
PGP: 0x0A3AE6F2