* [NonGNU ELPA] New package org-transclusion-http @ 2024-04-08 8:01 Joseph Turner 2024-06-09 2:57 ` Joseph Turner 0 siblings, 1 reply; 6+ messages in thread From: Joseph Turner @ 2024-04-08 8:01 UTC (permalink / raw) To: Emacs Devel Mailing List; +Cc: me Hello! I'd like to submit org-transclusion-http to NonGNU ELPA: https://git.sr.ht/~ushin/org-transclusion-http org-transclusion-http builds on top of org-transclusion, allowing users to transclude content over HTTP. It uses Pandoc to convert HTML documents to Org mode so that webpages can be seamlessly transcluded into an Org buffer. Non-HTML transclusions are also supported. org-transclusion-http depends on unreleased changes made on the tip of the org-transclusion master branch. I'm submitting this package for review now in advance of the next org-transclusion release (v1.4.0). Thank you!! Joseph Turner ^ permalink raw reply [flat|nested] 6+ messages in thread
* Re: [NonGNU ELPA] New package org-transclusion-http 2024-04-08 8:01 [NonGNU ELPA] New package org-transclusion-http Joseph Turner @ 2024-06-09 2:57 ` Joseph Turner 2024-06-15 13:21 ` Philip Kaludercic 0 siblings, 1 reply; 6+ messages in thread From: Joseph Turner @ 2024-06-09 2:57 UTC (permalink / raw) To: Emacs Devel Mailing List; +Cc: me [-- Attachment #1: Type: text/plain, Size: 790 bytes --] Joseph Turner <joseph@ushin.org> writes: > Hello! > > I'd like to submit org-transclusion-http to NonGNU ELPA: > > https://git.sr.ht/~ushin/org-transclusion-http > > org-transclusion-http builds on top of org-transclusion, allowing > users > to transclude content over HTTP. It uses Pandoc to convert HTML > documents to Org mode so that webpages can be seamlessly transcluded > into an Org buffer. Non-HTML transclusions are also supported. > > org-transclusion-http depends on unreleased changes made on the tip of > the org-transclusion master branch. I'm submitting this package for > review now in advance of the next org-transclusion release (v1.4.0). Now that org-transclusion v1.4.0 is out, I'd like to submit org-transclusion-http to NonGNU ELPA. Thank you!! Joseph Turner [-- Warning: decoded text below may be mangled, UTF-8 assumed --] [-- Attachment #2: 0001-Add-org-transclusion-http.patch --] [-- Type: text/x-diff, Size: 688 bytes --] From cf1a823b9c2aeb931c48f880247a687276c15608 Mon Sep 17 00:00:00 2001 From: Joseph Turner <joseph@breatheoutbreathe.in> Date: Sat, 8 Jun 2024 19:48:35 -0700 Subject: [PATCH] Add org-transclusion-http --- elpa-packages | 2 ++ 1 file changed, 2 insertions(+) diff --git a/elpa-packages b/elpa-packages index d9db9366ef..d6e4047b39 100644 --- a/elpa-packages +++ b/elpa-packages @@ -586,6 +586,8 @@ :news "ChangeLog" :ignored-files ("LICENSE" ".github")) + (org-transclusion-http :url "https://git.sr.ht/~ushin/org-transclusion-http") + (orgit :url "https://github.com/magit/orgit.git") (p4-16-mode :url "https://github.com/SohamG/p4_16-mode.el") -- 2.41.0 ^ permalink raw reply related [flat|nested] 6+ messages in thread
* Re: [NonGNU ELPA] New package org-transclusion-http 2024-06-09 2:57 ` Joseph Turner @ 2024-06-15 13:21 ` Philip Kaludercic 2024-06-15 18:46 ` Joseph Turner 0 siblings, 1 reply; 6+ messages in thread From: Philip Kaludercic @ 2024-06-15 13:21 UTC (permalink / raw) To: Joseph Turner; +Cc: Emacs Devel Mailing List, me Joseph Turner <joseph@ushin.org> writes: > Joseph Turner <joseph@ushin.org> writes: > >> Hello! >> >> I'd like to submit org-transclusion-http to NonGNU ELPA: >> >> https://git.sr.ht/~ushin/org-transclusion-http >> >> org-transclusion-http builds on top of org-transclusion, allowing >> users >> to transclude content over HTTP. It uses Pandoc to convert HTML >> documents to Org mode so that webpages can be seamlessly transcluded >> into an Org buffer. Non-HTML transclusions are also supported. >> >> org-transclusion-http depends on unreleased changes made on the tip of >> the org-transclusion master branch. I'm submitting this package for >> review now in advance of the next org-transclusion release (v1.4.0). > > Now that org-transclusion v1.4.0 is out, I'd like to submit > org-transclusion-http to NonGNU ELPA. There is really not much I can comment on, since it is mainly API I am not familiar with. One note is that the package description doesn't make much sense to me, since I don't know what "transcluding" means. Also, not everyone knows that "plz" is a HTTP library (the name remains elusive), so a brief comment reminding the reader of that would be appropriate. Another note is that if you already have a .dir-locals.el file, you could add a few more variables that might vary from system to system. In Compat, the .dir-locals.el lists: --8<---------------cut here---------------start------------->8--- ((nil (fill-column . 72) (sentence-end-double-space . t) (show-trailing-whitespace . t) (indent-tabs-mode . nil))) --8<---------------cut here---------------end--------------->8--- Also, I think an .elpaigore file would be appropriate to have in the repo, at least to avoid bundling the build-time dependencies. > > Thank you!! > > Joseph Turner > > -- Philip Kaludercic on peregrine ^ permalink raw reply [flat|nested] 6+ messages in thread
* Re: [NonGNU ELPA] New package org-transclusion-http 2024-06-15 13:21 ` Philip Kaludercic @ 2024-06-15 18:46 ` Joseph Turner 2024-06-15 19:15 ` Philip Kaludercic 0 siblings, 1 reply; 6+ messages in thread From: Joseph Turner @ 2024-06-15 18:46 UTC (permalink / raw) To: Philip Kaludercic; +Cc: Emacs Devel Mailing List, me Thank you for the review! Philip Kaludercic <philipk@posteo.net> writes: > There is really not much I can comment on, since it is mainly API I am > not familiar with. One note is that the package description doesn't > make much sense to me, since I don't know what "transcluding" means. > Also, not everyone knows that "plz" is a HTTP library (the name remains > elusive), so a brief comment reminding the reader of that would be > appropriate. I've updated the package description. > Another note is that if you already have a .dir-locals.el file, you > could add a few more variables that might vary from system to system. > In Compat, the .dir-locals.el lists: > > --8<---------------cut here---------------start------------->8--- > ((nil > (fill-column . 72) > (sentence-end-double-space . t) > (show-trailing-whitespace . t) > (indent-tabs-mode . nil))) > --8<---------------cut here---------------end--------------->8--- I've added all these variables except show-trailing-whitespace, as I don't personally use it. ws-butler takes care of whitespace without adding visuals. > Also, I think an .elpaigore file would be appropriate to have in the > repo, at least to avoid bundling the build-time dependencies. I've added .elpaignore and pushed a new release v0.3. Thank you!!! Joseph ^ permalink raw reply [flat|nested] 6+ messages in thread
* Re: [NonGNU ELPA] New package org-transclusion-http 2024-06-15 18:46 ` Joseph Turner @ 2024-06-15 19:15 ` Philip Kaludercic 2024-06-15 21:08 ` Joseph Turner 0 siblings, 1 reply; 6+ messages in thread From: Philip Kaludercic @ 2024-06-15 19:15 UTC (permalink / raw) To: Joseph Turner; +Cc: Emacs Devel Mailing List, me Joseph Turner <joseph@ushin.org> writes: > Thank you for the review! > > Philip Kaludercic <philipk@posteo.net> writes: > >> There is really not much I can comment on, since it is mainly API I am >> not familiar with. One note is that the package description doesn't >> make much sense to me, since I don't know what "transcluding" means. >> Also, not everyone knows that "plz" is a HTTP library (the name remains >> elusive), so a brief comment reminding the reader of that would be >> appropriate. > > I've updated the package description. This is the commit you are referring to? diff --git a/org-transclusion-http.el b/org-transclusion-http.el index 5f240ad31c..293e705615 100644 --- a/org-transclusion-http.el +++ b/org-transclusion-http.el @@ -25,8 +25,8 @@ ;;; Commentary: -;; This file contains functionality related to transcluding content over HTTP -;; using plz.el. Features include: +;; This file extends the `org-transclusion' package to allow for transcluding +;; content over HTTP. Features include: ;; ;; - Transclude plain text ;; + Transclude only Org headings matching search options I don't know if this is just me, but I am not familiar with what "transcluding" is supposed to mean. I get that it has something to do with networking, and if I had to guess you are fetching remote files and including them while exporting, but a package description shouldn't leave the reader with the impression that they have to guess what is going on. >> Another note is that if you already have a .dir-locals.el file, you >> could add a few more variables that might vary from system to system. >> In Compat, the .dir-locals.el lists: >> >> --8<---------------cut here---------------start------------->8--- >> ((nil >> (fill-column . 72) >> (sentence-end-double-space . t) >> (show-trailing-whitespace . t) >> (indent-tabs-mode . nil))) >> --8<---------------cut here---------------end--------------->8--- > > I've added all these variables except show-trailing-whitespace, as I > don't personally use it. ws-butler takes care of whitespace without > adding visuals. No problem, I like `show-trailing-whitespace' because I know that all contributors will see that there is a whitespacing issue, but I admit that my recommendations might be opinionated. >> Also, I think an .elpaigore file would be appropriate to have in the >> repo, at least to avoid bundling the build-time dependencies. > > I've added .elpaignore and pushed a new release v0.3. > > Thank you!!! > > Joseph > > -- Philip Kaludercic on peregrine ^ permalink raw reply related [flat|nested] 6+ messages in thread
* Re: [NonGNU ELPA] New package org-transclusion-http 2024-06-15 19:15 ` Philip Kaludercic @ 2024-06-15 21:08 ` Joseph Turner 0 siblings, 0 replies; 6+ messages in thread From: Joseph Turner @ 2024-06-15 21:08 UTC (permalink / raw) To: Philip Kaludercic; +Cc: Emacs Devel Mailing List, me Philip Kaludercic <philipk@posteo.net> writes: > Joseph Turner <joseph@ushin.org> writes: > >> Thank you for the review! >> >> Philip Kaludercic <philipk@posteo.net> writes: >> >>> There is really not much I can comment on, since it is mainly API I am >>> not familiar with. One note is that the package description doesn't >>> make much sense to me, since I don't know what "transcluding" means. >>> Also, not everyone knows that "plz" is a HTTP library (the name remains >>> elusive), so a brief comment reminding the reader of that would be >>> appropriate. >> >> I've updated the package description. > > This is the commit you are referring to? > > diff --git a/org-transclusion-http.el b/org-transclusion-http.el > index 5f240ad31c..293e705615 100644 > --- a/org-transclusion-http.el > +++ b/org-transclusion-http.el > @@ -25,8 +25,8 @@ > > ;;; Commentary: > > -;; This file contains functionality related to transcluding content over HTTP > -;; using plz.el. Features include: > +;; This file extends the `org-transclusion' package to allow for transcluding > +;; content over HTTP. Features include: > ;; > ;; - Transclude plain text > ;; + Transclude only Org headings matching search options > > I don't know if this is just me, but I am not familiar with what > "transcluding" is supposed to mean. I get that it has something to do > with networking, and if I had to guess you are fetching remote files and > including them while exporting, but a package description shouldn't > leave the reader with the impression that they have to guess what is > going on. Transclusion is the inclusion of part or all of an electronic document into one or more other documents by reference via hypertext: https://en.wikipedia.org/wiki/Transclusion Since this package is just a minor extension of the org-transclusion package, I think it's fine to direct users to learn more by reading the package description for org-transclusion. If there's a specific specific phrase you'd like to add, I'll be happy to apply a patch. >>> Another note is that if you already have a .dir-locals.el file, you >>> could add a few more variables that might vary from system to system. >>> In Compat, the .dir-locals.el lists: >>> >>> --8<---------------cut here---------------start------------->8--- >>> ((nil >>> (fill-column . 72) >>> (sentence-end-double-space . t) >>> (show-trailing-whitespace . t) >>> (indent-tabs-mode . nil))) >>> --8<---------------cut here---------------end--------------->8--- >> >> I've added all these variables except show-trailing-whitespace, as I >> don't personally use it. ws-butler takes care of whitespace without >> adding visuals. > > No problem, I like `show-trailing-whitespace' because I know that all > contributors will see that there is a whitespacing issue, but I admit > that my recommendations might be opinionated. Sounds good! Thanks! Joseph ^ permalink raw reply [flat|nested] 6+ messages in thread
end of thread, other threads:[~2024-06-15 21:08 UTC | newest] Thread overview: 6+ messages (download: mbox.gz follow: Atom feed -- links below jump to the message on this page -- 2024-04-08 8:01 [NonGNU ELPA] New package org-transclusion-http Joseph Turner 2024-06-09 2:57 ` Joseph Turner 2024-06-15 13:21 ` Philip Kaludercic 2024-06-15 18:46 ` Joseph Turner 2024-06-15 19:15 ` Philip Kaludercic 2024-06-15 21:08 ` Joseph Turner
Code repositories for project(s) associated with this public inbox https://git.savannah.gnu.org/cgit/emacs.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).