emacs-orgmode@gnu.org archives
 help / color / mirror / code / Atom feed

From: Tim Landscheidt <tim@tim-landscheidt.de>
To: emacs-orgmode@gnu.org
Subject: Documentation references to htmlize and htmlize vs. htmlfontify
Date: Mon, 08 Jan 2018 14:44:39 +0000	[thread overview]
Message-ID: <878td8beaw.fsf@passepartout.tim-landscheidt.de> (raw)

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

next             reply	other threads:[~2018-01-08 14:45 UTC|newest]

Thread overview: 4+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2018-01-08 14:44 Tim Landscheidt [this message]
2018-01-08 14:57 ` Documentation references to htmlize and htmlize vs. htmlfontify Nicolas Goaziou
2018-01-08 15:53   ` Kaushal Modi
2018-04-26 23:34     ` Bastien

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:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

  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=878td8beaw.fsf@passepartout.tim-landscheidt.de \
    --to=tim@tim-landscheidt.de \
    --cc=emacs-orgmode@gnu.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link

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