Where to put the documentation of shr.el?

Where to put the documentation of shr.el?

[Lars Magne Ingebrigtsen]

shr.el (Simple HTML Renderer) is a standalone package for rendering
HTML, based on the libxml-parse-html-region parse tree.  It's not
dependent on anything else much, and isn't (in principle) a
Gnus-specific thing, so where should I stick the documentation?  There
isn't a lot to document -- just a handful of commands and one
entry-point, so doing a separate info file seems odd.

-- 
(domestic pets only, the antidote for overdose, milk.)
  larsi@gnus.org * Lars Magne Ingebrigtsen

Re: Where to put the documentation of shr.el?

[Andreas Schwab]

Lars Magne Ingebrigtsen <larsi@gnus.org> writes:

> There isn't a lot to document -- just a handful of commands and one
> entry-point, so doing a separate info file seems odd.

There are already other small info files, the smallest one having only 6
nodes.

Andreas.

-- 
Andreas Schwab, schwab@linux-m68k.org
GPG Key fingerprint = 58CA 54C7 6D53 942B 1756  01D3 44D5 214B 8276 4ED5
"And now for something completely different."

Re: Where to put the documentation of shr.el?

[Lars Magne Ingebrigtsen]

Andreas Schwab <schwab@linux-m68k.org> writes:

> There are already other small info files, the smallest one having only 6
> nodes.

This would be one or two nodes.

-- 
(domestic pets only, the antidote for overdose, milk.)
  larsi@gnus.org * Lars Magne Ingebrigtsen

Re: Where to put the documentation of shr.el?

[Andreas Schwab]

Lars Magne Ingebrigtsen <larsi@gnus.org> writes:

> Andreas Schwab <schwab@linux-m68k.org> writes:
>
>> There are already other small info files, the smallest one having only 6
>> nodes.
>
> This would be one or two nodes.

So what?  The smallest info file installed on my system has 2 nodes.

Andreas.

-- 
Andreas Schwab, schwab@linux-m68k.org
GPG Key fingerprint = 58CA 54C7 6D53 942B 1756  01D3 44D5 214B 8276 4ED5
"And now for something completely different."

Re: Where to put the documentation of shr.el?

[Ted Zlatanov]

On Wed, 20 Oct 2010 13:50:23 +0200 Lars Magne Ingebrigtsen <larsi@gnus.org> wrote: 

LMI> Andreas Schwab <schwab@linux-m68k.org> writes:
>> There are already other small info files, the smallest one having only 6
>> nodes.

LMI> This would be one or two nodes.

I think shr.el will grow much larger.  It has lots of potential
to render HTML and even interact with it IMHO, more than emacs-w3m or W3
ever had, because of the fast libxml parsing.  It needs lots of work to
parse and render HTML, especially broken pages and CSS styles, but IMHO
it's the right path for Emacs work with HTML.

The HTML editing modes, in particular, can benefit from shr.el.  So my
point is, it should definitely have a separate manual.

Ted

Re: Where to put the documentation of shr.el?

[Stefan Monnier]

> shr.el (Simple HTML Renderer) is a standalone package for rendering
> HTML, based on the libxml-parse-html-region parse tree.  It's not
> dependent on anything else much, and isn't (in principle) a
> Gnus-specific thing, so where should I stick the documentation?  There
> isn't a lot to document -- just a handful of commands and one
> entry-point, so doing a separate info file seems odd.

You can start by adding it to the lispref manual and when/if it grows
enough, we can move it into its own manual.  If that's likely to happen,
you may want to immediately put it into its own texi file (but still
part of lispref).


        Stefan