alphapapa / pocket-reader.el

Emacs client for Pocket reading list (getpocket.com)
GNU General Public License v3.0
223 stars 12 forks source link

Mention the dependency on pandoc in the Readme #26

Open oantolin opened 3 years ago

oantolin commented 3 years ago

It's a little surprising to install this package and try to use it only to be told pandoc cannot be found. A sentence mentioning you need pandoc in the Readme or package commentary (ideally both), would be welcome.

alphapapa commented 3 years ago

Pandoc is not required to use this package. The issue is that pocket-reader-open-url-default-function and pocket-reader-pop-to-url-default-function default to org-web-tools-read-url-as-org, which uses Pandoc. It would probably be better to change those options' defaults to call Emacs's built-in functions instead.

oantolin commented 3 years ago

I see, thanks! I'll try it again, then.

oantolin commented 3 years ago

Sorry, I should have closed this long ago. I tried setting both pocket-reader-open-url-default-function and pocket-reader-pop-to-url-default-function to #'eww and so far so good.

alphapapa commented 3 years ago

Thanks. I'll leave this open to consider changing the defaults.

oantolin commented 2 years ago

It seems to me that this package does not require org-web-tools other than for the default value of pocket-reader-open-url-default-function and pocket-reader-pop-to-url-default-function. I'd suggest:

(defcustom pocket-reader-open-url-default-function
  #'eww
  "Default function to open items."
  :type '(choice
          (const :tag "Use eww" eww)
          (const :tag "Use org-web-tools" org-web-tools-read-url-as-org)
          function))

I also don't think this is big deal at all, so feel free to ignore this suggestion (and to close this issue as well).

pataquets commented 1 year ago

Anyway, mentioning in docs that pandoc/org-web-tools enables better web handling would be worth mentioning. Otherwise, the feature might go unnoticed.

alphapapa commented 1 year ago

As much as I'd like to promote the use of org-web-tools, I'm leaning towards Omar's suggestion of defaulting to using eww and removing the dependency. I doubt many people actually want to run the pages through Pandoc and read the output as Org, anyway, and EWW's better than it used to be.

pataquets commented 1 year ago

Fair enough. Honestly, I can't come up with any use case which might benefit, I was just assuming that org-web-tools handling was superior. But if EWW is better nowadays and org-web-tools can't bring any substantial improvement, keeping dependencies lean makes the most sense. It would be useful only as a pocket-reader-open-url-default-function usage example, at most. Thanks for considering and for the information.