On-line manual

On-line manual

[Ludovic Courtès]

Hi,

As a followup to a recent discussion on `guile-user', I made the manual
for 1.8.1 available from the web in a way that is similar to what other
GNU projects do:

  http://www.gnu.org/software/guile/manual/

I also updated http://www.gnu.org/manual/ so that it points to this
address (the update has not propagated yet).

The way to do it is documented here:

  http://www.gnu.org/prep/maintain/maintain.html#Invoking-gendocs_002esh

However, the current doc page [0] has more information (manual for 1.6
and for GOOPS, tutorial, book) so we need to find a way to "merge" both
pages.  For GOOPS, I think we could add an entry in `/manual' and have
that point to `/software/guile/manual/goops'.  For the other docs, we
could add pointers in http://www.gnu.org/software/guile/manual/ and have
that point to subdirectories.  Finally, the Guile web site could refer
to that page as well, rather than having a separate `docs.html' page.

Opinions?

Thanks,
Ludovic.

[0] http://www.gnu.org/software/guile/docs/docs.html


_______________________________________________
Guile-devel mailing list
Guile-devel@gnu.org
http://lists.gnu.org/mailman/listinfo/guile-devel

Re: On-line manual

[Neil Jerram]

ludovic.courtes@laas.fr (Ludovic Courtès) writes:

> As a followup to a recent discussion on `guile-user', I made the manual
> for 1.8.1 available from the web in a way that is similar to what other
> GNU projects do:
>
>   http://www.gnu.org/software/guile/manual/

Nice.

> I also updated http://www.gnu.org/manual/ so that it points to this
> address (the update has not propagated yet).

My feeling is that the "guile" link in http://www.gnu.org/manual
should always go to the same page as the "Manuals" link in
http://www.gnu.org/software/guile.

> However, the current doc page [0] has more information (manual for 1.6
> and for GOOPS, tutorial, book) so we need to find a way to "merge" both
> pages.  For GOOPS, I think we could add an entry in `/manual' and have
> that point to `/software/guile/manual/goops'.  For the other docs, we
> could add pointers in http://www.gnu.org/software/guile/manual/ and have
> that point to subdirectories.  Finally, the Guile web site could refer
> to that page as well, rather than having a separate `docs.html' page.
>
> Opinions?

That sounds fine from a usage point of view, but it also sounds
unnecessarily hard to implement, if pages like
http://www.gnu.org/software/guile/manual are generated as a whole by
gendocs.sh.  It sounds to me as though it would be easier to keep the
existing http://www.gnu.org/software/guile/docs/docs.html as the main
Manuals page, and modify its "Reference Manual for Guile 1.8" link to
point to http://www.gnu.org/software/guile/manual.

Then later, if we want, we can progressively create parallels of
http://www.gnu.org/software/guile/manual for the GOOPS and 1.6
manuals, and so on, and just update the links on
http://www.gnu.org/software/guile/docs/docs.html to point to them.

Regards,
     Neil



_______________________________________________
Guile-devel mailing list
Guile-devel@gnu.org
http://lists.gnu.org/mailman/listinfo/guile-devel

Re: On-line manual

[Kevin Ryde]

ludovic.courtes@laas.fr (Ludovic Courtès) writes:
>
>   http://www.gnu.org/software/guile/manual/

It looks like cross-manual links don't come out quite right, eg.

	http://www.gnu.org/software/guile/manual/html_node/Internationalization.html#Internationalization

which links across to the gettext manual as

	http://www.gnu.org/software/guile/manual/gettext/Introduction.html#Introduction

where it should be

	http://www.gnu.org/software/gettext/manual/html_node/gettext_1.html#SEC1

I made the "docs/mung-html.scm" program in the guile web cvs to mung
that sort of thing.  Perhaps gendocs.sh could do something similar, or
perhaps it's up to each project.  I think makeinfo was perhaps going
to get its own features for where to direct external links go, but
that might not be ready yet.


_______________________________________________
Guile-devel mailing list
Guile-devel@gnu.org
http://lists.gnu.org/mailman/listinfo/guile-devel