Standard path for documentation installation
- From: Federico Mena Quintero <federico ximian com>
- To: gnome-doc-list gnome org
- Cc: gtk-doc-list gnome org
- Subject: Standard path for documentation installation
- Date: 13 Feb 2002 20:46:46 -0600
Maybe this is something that is defined somewhere and I'm too lazy to
look, but...
Things seem to be installing their documentation in disparate places.
E.g.
$(prefix)/share/gtk-doc/html/glib/index.html
$(prefix)/share/gtk-doc/html/gobject/index.html
$(prefix)/share/gtk-doc/html/linc/index.html
$(prefix)/share/gtk-doc/html/atk/book1.html
$(prefix)/share/gtk-doc/html/pango/index.html
$(prefix)/share/gtk-doc/html/gdk-pixbuf/index.html
$(prefix)/share/gtk-doc/html/gdk/index.html
$(prefix)/share/gtk-doc/html/gtk/index.html
$(prefix)/share/gtk-doc/html/gconf/index.html
$(prefix)/share/gtk-doc/html/libbonobo/index.html
$(prefix)/share/gtk-doc/html/gnome-vfs/index.html
$(prefix)/share/gtk-doc/html/libglade/libglade.html
$(prefix)/share/gtk-doc/html/libgnome/index.html
$(prefix)/share/gtk-doc/html/libgnomecanvas/index.html
$(prefix)/share/gtk-doc/html/libgnomeui/index.html
$(prefix)/share/gtk-doc/html/libgda/index.html
$(prefix)/share/gtk-doc/html/libgnomedb/index.html
$(prefix)/share/gtk-doc/html/panel-applet/libpanel-applet.html
$(prefix)/share/bonobo-activation/html/bonobo-activation/book1.html
$(prefix)/share/gnome/help/gnome-mines/C/usage.html
$(prefix)/share/gnome/help/same-gnome/C/index.html
$(prefix)/share/gnome/help/mahjongg/C/index.html
$(prefix)/share/gnome/help/gtali/C/index.html
$(prefix)/share/gnome/help/gnobots2/C/index.html
$(prefix)/share/gnome/help/gnome-stones/C/index.html
$(prefix)/share/gnome/help/gataxx/C/index.html
$(prefix)/share/gnome/help/gnotravex/C/index.html
$(prefix)/share/gnome/help/gnibbles/C/index.html
$(prefix)/share/gnome/help/iagno/C/index.html
$(prefix)/share/gnome/help/aisleriot/C/index.html
$(prefix)/share/gnome/help/bug-buddy/C/index.html
$(prefix)/share/gnome/help/nautilus-user-manual/C/index.html
$(prefix)/share/gnome/help/nautilus-quick-reference/C/index.html
$(prefix)/share/gnome/help/nautilus-screenshot-guidelines/C/index.html
$(prefix)/share/gnome/help/nautilus-release-notes/C/index.html
$(prefix)/share/gnome/help/eog/C/index.html
$(prefix)/share/gnome/help/gnome-db/C/index.html
$(prefix)/doc/gettext/gettext_toc.html
$(prefix)/doc/libxml2-2.4.13/html/book1.html
$(prefix)/doc/libxslt-1.0.10/html/book1.html
Note the following:
- we have things in $(prefix)/share/gtk-doc/html/*
- we have things in $(prefix)/share/modulename-without-version/html/*
- we have things in $(prefix)/share/gnome/help/appname/<lang>/*
- we have things in $(prefix)/doc/modulename-with-version/html/*
Also:
- We have index.html, book1.html, modulename.html, ...
So, this is a plea for consistency. Where should things go? What
should the main file be called?
Also, for things like nautilus-user-manual, nautilus-quick-reference,
etc.: why not just have
nautilus/
index.html
quick-reference.html
screenshot-guidelines.html
release-notes.html
etc., where all the subsections are of course linked from index.html?
My proposal, to be ignored if this is already standarized/defined
somewhere and it's just that modules are not following the standard:
- Things should go in $(prefix)/share/doc.
- So you have $(prefix)/share/doc/modulename/<lang>/index.html.
That's all. index.html links to everything else for that module.
It could be argued that this is a moot point because with OMF files we
can find everything easily. But then again not every module installs
OMF files and we should be consistent anyways and blah blah.
Federico
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]