* manual all on one HTML page
@ 2007-04-30 0:49 Dave Yost
2007-04-30 2:17 ` Phil Pennock
2007-04-30 6:13 ` Stephane Chazelas
0 siblings, 2 replies; 9+ messages in thread
From: Dave Yost @ 2007-04-30 0:49 UTC (permalink / raw)
To: zsh-workers
Hi.
There really should be an all-on-one-page HTML manual.
I tried to look for the exec command using the current divided-up
HTML and couldn't find it.
Thanks
Dave
^ permalink raw reply [flat|nested] 9+ messages in thread
* Re: manual all on one HTML page
2007-04-30 0:49 manual all on one HTML page Dave Yost
@ 2007-04-30 2:17 ` Phil Pennock
2007-04-30 5:24 ` Dave Yost
2007-04-30 6:13 ` Stephane Chazelas
1 sibling, 1 reply; 9+ messages in thread
From: Phil Pennock @ 2007-04-30 2:17 UTC (permalink / raw)
To: Dave Yost; +Cc: zsh-workers
On 2007-04-29 at 17:49 -0700, Dave Yost wrote:
> There really should be an all-on-one-page HTML manual.
>
> I tried to look for the exec command using the current divided-up HTML and
> couldn't find it.
Go to your zsh source, into the Doc subdirectory. Edit "Makefile"
(after configure, etc), find the TEXI2HTML line.
Change:
TEXI2HTML = texi2html --output . --ifinfo --split=chapter
to:
TEXI2HTML = texi2html --output zshall.html --ifinfo
Run "make html".
Peruse "zshall.html".
-Phil
^ permalink raw reply [flat|nested] 9+ messages in thread
* Re: manual all on one HTML page
2007-04-30 2:17 ` Phil Pennock
@ 2007-04-30 5:24 ` Dave Yost
0 siblings, 0 replies; 9+ messages in thread
From: Dave Yost @ 2007-04-30 5:24 UTC (permalink / raw)
To: Phil Pennock; +Cc: zsh-workers
At 07:17 PM -0700 2007-04-29, Phil Pennock wrote:
>On 2007-04-29 at 17:49 -0700, Dave Yost wrote:
>> There really should be an all-on-one-page HTML manual.
>>
>> I tried to look for the exec command using the current divided-up HTML and
>> couldn't find it.
>
>Go to your zsh source, into the Doc subdirectory. Edit "Makefile"
>(after configure, etc), find the TEXI2HTML line.
>
>Change:
> TEXI2HTML = texi2html --output . --ifinfo --split=chapter
>to:
> TEXI2HTML = texi2html --output zshall.html --ifinfo
>
>Run "make html".
>
>Peruse "zshall.html".
Thanks. It would be handy on the web site, too...
^ permalink raw reply [flat|nested] 9+ messages in thread
* Re: manual all on one HTML page
2007-04-30 0:49 manual all on one HTML page Dave Yost
2007-04-30 2:17 ` Phil Pennock
@ 2007-04-30 6:13 ` Stephane Chazelas
2007-04-30 7:24 ` Dave Yost
1 sibling, 1 reply; 9+ messages in thread
From: Stephane Chazelas @ 2007-04-30 6:13 UTC (permalink / raw)
To: Dave Yost; +Cc: zsh-workers
On Sun, Apr 29, 2007 at 05:49:07PM -0700, Dave Yost wrote:
> Hi.
>
> There really should be an all-on-one-page HTML manual.
>
> I tried to look for the exec command using the current divided-up
> HTML and couldn't find it.
[...]
That's the biggest problem with the HTML format. That's why
there exist more advanced formats like the "info" formats. The
info format is inspired from books. There is a table of content
and an index, both searchable with completion, and the whole
document can be searched as well.
See the "g", "i", "m", "s" keys in info.
Typically:
info zsh
iexec<Tab>
--
Stéphane
^ permalink raw reply [flat|nested] 9+ messages in thread
* Re: manual all on one HTML page
2007-04-30 6:13 ` Stephane Chazelas
@ 2007-04-30 7:24 ` Dave Yost
2007-04-30 8:01 ` Stephane Chazelas
0 siblings, 1 reply; 9+ messages in thread
From: Dave Yost @ 2007-04-30 7:24 UTC (permalink / raw)
To: zsh-workers
At 07:13 AM +0100 2007-04-30, Stephane Chazelas wrote:
>On Sun, Apr 29, 2007 at 05:49:07PM -0700, Dave Yost wrote:
>> Hi.
>>
>> There really should be an all-on-one-page HTML manual.
>>
>> I tried to look for the exec command using the current divided-up
>> HTML and couldn't find it.
>[...]
>
>That's the biggest problem with the HTML format.
The one-page format makes simple searches easy using the browser.
Also: the broken-up HTML is nicely searchable with a Google using the "site:" feature, like this:
foo site:zsh.org/doc/one-page.html
Dave
>That's why
>there exist more advanced formats like the "info" formats. The
>info format is inspired from books. There is a table of content
>and an index, both searchable with completion, and the whole
>document can be searched as well.
>
>See the "g", "i", "m", "s" keys in info.
>
>Typically:
>
>info zsh
>iexec<Tab>
>
>--
>Stéphane
^ permalink raw reply [flat|nested] 9+ messages in thread
* Re: manual all on one HTML page
2007-04-30 7:24 ` Dave Yost
@ 2007-04-30 8:01 ` Stephane Chazelas
2007-04-30 19:15 ` Dave Yost
2007-04-30 20:51 ` Phil Pennock
0 siblings, 2 replies; 9+ messages in thread
From: Stephane Chazelas @ 2007-04-30 8:01 UTC (permalink / raw)
To: Dave Yost; +Cc: zsh-workers
On Mon, Apr 30, 2007 at 12:24:41AM -0700, Dave Yost wrote:
> At 07:13 AM +0100 2007-04-30, Stephane Chazelas wrote:
> >On Sun, Apr 29, 2007 at 05:49:07PM -0700, Dave Yost wrote:
> >> Hi.
> >>
> >> There really should be an all-on-one-page HTML manual.
> >>
> >> I tried to look for the exec command using the current divided-up
> >> HTML and couldn't find it.
> >[...]
> >
> >That's the biggest problem with the HTML format.
>
> The one-page format makes simple searches easy using the browser.
Yes, but makes the browsing (reaching the section you're
interested in) difficult.
> Also: the broken-up HTML is nicely searchable with a Google using the "site:" feature, like this:
> foo site:zsh.org/doc/one-page.html
Yes, we agree that's the problem, you need some external tool to
index your pages, as HTML has not such thing built in.
The index and search are built in "info". I'd agree the "info"
client command is not the best that one could have come up to,
but at least the "info" format makes it very easy and direct to
reach the information you're looking for.
And zsh has completion support (to some extent) for info.
--
Stéphane
^ permalink raw reply [flat|nested] 9+ messages in thread
* Re: manual all on one HTML page
2007-04-30 8:01 ` Stephane Chazelas
@ 2007-04-30 19:15 ` Dave Yost
2007-04-30 20:51 ` Phil Pennock
1 sibling, 0 replies; 9+ messages in thread
From: Dave Yost @ 2007-04-30 19:15 UTC (permalink / raw)
To: Stephane Chazelas; +Cc: zsh-workers
At 09:01 AM +0100 2007-04-30, Stephane Chazelas wrote:
>On Mon, Apr 30, 2007 at 12:24:41AM -0700, Dave Yost wrote:
>> At 07:13 AM +0100 2007-04-30, Stephane Chazelas wrote:
>> >On Sun, Apr 29, 2007 at 05:49:07PM -0700, Dave Yost wrote:
>> >> Hi.
>> >>
>> >> There really should be an all-on-one-page HTML manual.
>> >>
>> >> I tried to look for the exec command using the current divided-up
>> >> HTML and couldn't find it.
>> >[...]
>> >
>> >That's the biggest problem with the HTML format.
>>
>> The one-page format makes simple searches easy using the browser.
>
>Yes, but makes the browsing (reaching the section you're
>interested in) difficult.
Sure, but I'm not suggesting removing the link to the piecewise HTML. I'm just suggesting adding one little extra link on the web page, to a format that is supported in the downloaded source.
Dave
^ permalink raw reply [flat|nested] 9+ messages in thread
* Re: manual all on one HTML page
2007-04-30 8:01 ` Stephane Chazelas
2007-04-30 19:15 ` Dave Yost
@ 2007-04-30 20:51 ` Phil Pennock
2007-05-01 14:09 ` Stephane Chazelas
1 sibling, 1 reply; 9+ messages in thread
From: Phil Pennock @ 2007-04-30 20:51 UTC (permalink / raw)
To: zsh-workers; +Cc: Dave Yost
On 2007-04-30 at 09:01 +0100, Stephane Chazelas wrote:
> The index and search are built in "info". I'd agree the "info"
> client command is not the best that one could have come up to,
> but at least the "info" format makes it very easy and direct to
> reach the information you're looking for.
pinfo(1).
"Ncurses based, lynx style info documentation browser"
I switched a while back, it's a great relief. Almost makes info-doc
browsing painless.
http://pinfo.alioth.debian.org/
-Phil
^ permalink raw reply [flat|nested] 9+ messages in thread
* Re: manual all on one HTML page
2007-04-30 20:51 ` Phil Pennock
@ 2007-05-01 14:09 ` Stephane Chazelas
0 siblings, 0 replies; 9+ messages in thread
From: Stephane Chazelas @ 2007-05-01 14:09 UTC (permalink / raw)
To: zsh-workers, Dave Yost
On Mon, Apr 30, 2007 at 01:51:42PM -0700, Phil Pennock wrote:
> On 2007-04-30 at 09:01 +0100, Stephane Chazelas wrote:
> > The index and search are built in "info". I'd agree the "info"
> > client command is not the best that one could have come up to,
> > but at least the "info" format makes it very easy and direct to
> > reach the information you're looking for.
>
> pinfo(1).
>
> "Ncurses based, lynx style info documentation browser"
>
> I switched a while back, it's a great relief. Almost makes info-doc
> browsing painless.
>
> http://pinfo.alioth.debian.org/
[...]
Last time I checked pinfo had neither of "i" or "g" or "m" or
completions, which are the very features that make info better
than HTML for documentation, so it was pretty useless.
It may have changed since then. ?
--
Stéphane
^ permalink raw reply [flat|nested] 9+ messages in thread
end of thread, other threads:[~2007-05-01 14:10 UTC | newest]
Thread overview: 9+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2007-04-30 0:49 manual all on one HTML page Dave Yost
2007-04-30 2:17 ` Phil Pennock
2007-04-30 5:24 ` Dave Yost
2007-04-30 6:13 ` Stephane Chazelas
2007-04-30 7:24 ` Dave Yost
2007-04-30 8:01 ` Stephane Chazelas
2007-04-30 19:15 ` Dave Yost
2007-04-30 20:51 ` Phil Pennock
2007-05-01 14:09 ` Stephane Chazelas
Code repositories for project(s) associated with this public inbox
https://git.vuxu.org/mirror/zsh/
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 NNTP newsgroup(s).