emacs-orgmode@gnu.org archives
 help / color / mirror / code / Atom feed
* Documentation references to htmlize and htmlize vs. htmlfontify
@ 2018-01-08 14:44 Tim Landscheidt
  2018-01-08 14:57 ` Nicolas Goaziou
  0 siblings, 1 reply; 4+ messages in thread
From: Tim Landscheidt @ 2018-01-08 14:44 UTC (permalink / raw)
  To: emacs-orgmode

Hi,

the Org Mode Manual (here: Emacs master's 9.1.4) refers to
htmlize in several places in slightly different ways; for
example, in one place it says:

| This works automatically for the HTML back-end (it requires
| version 1.34 of the ‘htmlize.el’ package, which you need to
| install).

This is problematic as 1.34 does not work with Emacs 23+;
also it could be interpreted as saying that (current) ver-
sion 1.51 is not supported.

Additionally, there is confusing language throughout whether
it is called "htmlize" or "htmlize.el", whether it is a file
or a package, and whether one needs to download it from the
author's GitHub page.  I assume for most users it is prefer-
able to install it using the MELPA or Debian package.

I wanted to propose to move instructions on how to install
htmlize to the "Installation" node and refer to that section
everywhere else until I noted the section "Packages that Org
cooperates with" that on the other hand does not list
htmlize :-).

There may be other packages referenced in this inconsistent
way; it would be nice to have them all in one place ("Pack-
ages that Org cooperates with"?) and use uniform language.

Finally, Emacs already ships with htmlfontify.  On (non-Org)
files, I see small, but not significant differences between
it and htmlize.  Are there features that only htmlize of-
fers?  Otherwise it would be very convenient to replace
calls to htmlize with a wrapper that tests if the user set
some configurable variable org-htmlize-function (and calls
that), otherwise tries to load htmlize and use that, and
falls back to using htmlfontify.  Glancing at the code, org-
mode seems to use htmlize-region (with (point-min) (point-
max), but on narrowed buffers) which htmlfontify does not
offer, but it is unclear to me whether that would kill 100 %
of all use cases or only some.  (If it works out of the box
with htmlfontify for the most common ones, IMHO that would
be preferable to the current situation where it does not
work at all unless one installs htmlize.)

Tim

^ permalink raw reply	[flat|nested] 4+ messages in thread

* Re: Documentation references to htmlize and htmlize vs. htmlfontify
  2018-01-08 14:44 Documentation references to htmlize and htmlize vs. htmlfontify Tim Landscheidt
@ 2018-01-08 14:57 ` Nicolas Goaziou
  2018-01-08 15:53   ` Kaushal Modi
  0 siblings, 1 reply; 4+ messages in thread
From: Nicolas Goaziou @ 2018-01-08 14:57 UTC (permalink / raw)
  To: emacs-orgmode

Hello,

Tim Landscheidt <tim@tim-landscheidt.de> writes:

> Finally, Emacs already ships with htmlfontify.  On (non-Org)
> files, I see small, but not significant differences between
> it and htmlize.  Are there features that only htmlize of-
> fers?  Otherwise it would be very convenient to replace
> calls to htmlize with a wrapper that tests if the user set
> some configurable variable org-htmlize-function (and calls
> that), otherwise tries to load htmlize and use that, and
> falls back to using htmlfontify.  Glancing at the code, org-
> mode seems to use htmlize-region (with (point-min) (point-
> max), but on narrowed buffers) which htmlfontify does not
> offer, but it is unclear to me whether that would kill 100 %
> of all use cases or only some.  (If it works out of the box
> with htmlfontify for the most common ones, IMHO that would
> be preferable to the current situation where it does not
> work at all unless one installs htmlize.)

FWIW, I'm in favour of replacing entirely htmlize with htmlfontify,
since the latter is bundled with Emacs.

Regards,

-- 
Nicolas Goaziou

^ permalink raw reply	[flat|nested] 4+ messages in thread

* Re: Documentation references to htmlize and htmlize vs. htmlfontify
  2018-01-08 14:57 ` Nicolas Goaziou
@ 2018-01-08 15:53   ` Kaushal Modi
  2018-04-26 23:34     ` Bastien
  0 siblings, 1 reply; 4+ messages in thread
From: Kaushal Modi @ 2018-01-08 15:53 UTC (permalink / raw)
  To: Nicolas Goaziou; +Cc: emacs-orgmode, Rasmus

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

On Mon, Jan 8, 2018 at 9:58 AM Nicolas Goaziou <mail@nicolasgoaziou.fr>
wrote:

>
> FWIW, I'm in favour of replacing entirely htmlize with htmlfontify,
> since the latter is bundled with Emacs.
>

There was a discussion on this (htmlize vs htmlfontify) 2 years back on
emacs-devel:
https://lists.gnu.org/archive/html/emacs-devel/2016-01/msg00691.html

+1 to transition to htmlfontify. Copying Rasmus for comments on efforts
needed to update ox-html to use htmlfontify..


-- 

Kaushal Modi

[-- Attachment #2: Type: text/html, Size: 996 bytes --]

^ permalink raw reply	[flat|nested] 4+ messages in thread

* Re: Documentation references to htmlize and htmlize vs. htmlfontify
  2018-01-08 15:53   ` Kaushal Modi
@ 2018-04-26 23:34     ` Bastien
  0 siblings, 0 replies; 4+ messages in thread
From: Bastien @ 2018-04-26 23:34 UTC (permalink / raw)
  To: Kaushal Modi; +Cc: emacs-orgmode, Rasmus, Nicolas Goaziou

Kaushal Modi <kaushal.modi@gmail.com> writes:

> +1 to transition to htmlfontify. Copying Rasmus for comments on
> efforts needed to update ox-html to use htmlfontify..

+1!

-- 
 Bastien

^ permalink raw reply	[flat|nested] 4+ messages in thread

end of thread, other threads:[~2018-04-26 23:34 UTC | newest]

Thread overview: 4+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2018-01-08 14:44 Documentation references to htmlize and htmlize vs. htmlfontify Tim Landscheidt
2018-01-08 14:57 ` Nicolas Goaziou
2018-01-08 15:53   ` Kaushal Modi
2018-04-26 23:34     ` Bastien

Code repositories for project(s) associated with this public inbox

	https://git.savannah.gnu.org/cgit/emacs/org-mode.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).