Hi, is it possible to make documentation for pdftex and hyperref accessible to texdoc(1)? While the pdftex manual can be accessed if people know that it is called "pdftex-a" (it sounds like a joke if people say "Read the documentation" on a mailing list), the hyperref manual is inaccessible. On my system I get: $ locate manual.pdf | wc -l 164 Is it possible to solve it before TL is released? I would expect that "texdoc <packagename>" or "texdoc <progname>" provides something useful. Regards, Reinhard -- ---------------------------------------------------------------------------- Reinhard Kotucha Phone: +49-511-4592165 Marschnerstr. 25 D-30167 Hannover mailto:reinhard.kotucha@web.de ---------------------------------------------------------------------------- Microsoft isn't the answer. Microsoft is the question, and the answer is NO. ----------------------------------------------------------------------------
$ locate manual.pdf | wc -l 164 Yeah. I don't know what can be done about the plethora of manual.pdf's except encourage authors to use a better name. Is it possible to solve it before TL is released? Well, if you can make a patch for the texdoc .dat file, I can install it :). (Personally I am not sure that so many people use texdoc that it is worth a superhuman effort, but there's certainly no harm in making it as good as we can.)
"Karl" == Karl Berry
writes:
Well, if you can make a patch for the texdoc .dat file, I can install it :).
I fear that, unlike texdoctk, texdoc simply uses ls-R as a database. Thomas recently mentioned that one can define aliases, but I think that it is best if the authors provide fixes. Regards, Reinhard -- ---------------------------------------------------------------------------- Reinhard Kotucha Phone: +49-511-4592165 Marschnerstr. 25 D-30167 Hannover mailto:reinhard.kotucha@web.de ---------------------------------------------------------------------------- Microsoft isn't the answer. Microsoft is the question, and the answer is NO. ----------------------------------------------------------------------------
Thomas recently mentioned that one can define aliases, but I think that it is best if the authors provide fixes.
teTeX currently has % documentation TETEXDOC.pdf teTeX.pdf etex-man.pdf etex.pdf pdftex-a.pdf pdftex.pdf testeuro.dvi eurosym.dvi layman.dvi layouts.dvi mfpman.pdf mfpic.pdf psgomanual.pdf psgo.pdf koma-script.pdf komascr.pdf koma-script.pdf komascript.pdf gerbibtx.dvi bibgerm.dvi All this in texmf-dist/aliases (which TeX Live has dropped). Thomas
Quoting Reinhard Kotucha
"Karl" == Karl Berry
writes: Well, if you can make a patch for the texdoc .dat file, I can install it :).
I fear that, unlike texdoctk, texdoc simply uses ls-R as a database.
Thomas recently mentioned that one can define aliases, but I think that it is best if the authors provide fixes.
It may be best, but is it practical? Will aliases help when you have dozens of manual.pdf files? I suspect it is much easier to make changes in texdoc to support "package/manual". On systems that support symlinks one could process the doc tree to make package/manual.pdf -> package/package.pdf. -- George N. White III Head of St. Margarets Bay, Nova Scotia
On Thu, Oct 27, 2005 at 07:00:54AM -0300, George White wrote:
Quoting Reinhard Kotucha
: > "Karl" == Karl Berry
writes: Well, if you can make a patch for the texdoc .dat file, I can install it :).
I fear that, unlike texdoctk, texdoc simply uses ls-R as a database.
Thomas recently mentioned that one can define aliases, but I think that it is best if the authors provide fixes.
It may be best, but is it practical? Will aliases help when you have dozens of manual.pdf files?
I suspect it is much easier to make changes in texdoc to support "package/manual". On systems that support symlinks one could process the doc tree to make package/manual.pdf -> package/package.pdf.
And how you want to solve the problem of several documentation
files? One symlink can point to just *one* file.
Yours sincerely
Heiko
"Heiko" == Heiko Oberdiek
writes:
And how you want to solve the problem of several documentation files? One symlink can point to just *one* file.
I do not claim that "mv manual.pdf hyperref.pdf" solves all problems. But it is better than what we have now. If there are more files, names like hyperref-example.pdf would not be bad. They can be remembered easily. But the main problem is that the name "manual.pdf" is not unique. But the main doc file should have a name which people expext. TeXLive will be released in a few days, so we certainly will not be able to have a perfect solution, but I think that "mv manual.pdf hyperref.pdf" is a significant improvement. Regards, Reinhard -- ---------------------------------------------------------------------------- Reinhard Kotucha Phone: +49-511-4592165 Marschnerstr. 25 D-30167 Hannover mailto:reinhard.kotucha@web.de ---------------------------------------------------------------------------- Microsoft isn't the answer. Microsoft is the question, and the answer is NO. ----------------------------------------------------------------------------
On Fri, Oct 28, 2005 at 01:35:30AM +0200, Reinhard Kotucha wrote:
"Heiko" == Heiko Oberdiek
writes: And how you want to solve the problem of several documentation files? One symlink can point to just *one* file.
I do not claim that "mv manual.pdf hyperref.pdf" solves all problems. But it is better than what we have now.
You forget about hyperref.dtx --> hyperref.pdf. Therefore I think my solution is better (see one of my previous mails).
If there are more files, names like hyperref-example.pdf would not be bad. They can be remembered easily. But the main problem is that the name "manual.pdf" is not unique.
We have already "package/manual". This are not more chars than "package-manual". But I don't know, why some versions of texdoc understand "package/manual" and others don't.
But the main doc file should have a name which people expext.
TeXLive will be released in a few days, so we certainly will not be
I don't know about release dates.
able to have a perfect solution, but I think that "mv manual.pdf hyperref.pdf" is a significant improvement.
hyperref.pdf is the document, generated from hyperref.dtx.
Thus this solution leads to confusion.
Yours sincerely
Heiko
"Heiko" == Heiko Oberdiek
writes:
hyperref.pdf is the document, generated from hyperref.dtx. Thus this solution leads to confusion.
There is no file hyperref.pdf in TeXLive or teTeX. Karl? Thomas? Regards, Reinhard -- ---------------------------------------------------------------------------- Reinhard Kotucha Phone: +49-511-4592165 Marschnerstr. 25 D-30167 Hannover mailto:reinhard.kotucha@web.de ---------------------------------------------------------------------------- Microsoft isn't the answer. Microsoft is the question, and the answer is NO. ----------------------------------------------------------------------------
Reinhard Kotucha
is it possible to make documentation for pdftex and hyperref accessible to texdoc(1)?
While the pdftex manual can be accessed if people know that it is called "pdftex-a" (it sounds like a joke if people say "Read the documentation" on a mailing list), the hyperref manual is inaccessible.
On my system I get:
$ locate manual.pdf | wc -l 164
Is it possible to solve it before TL is released?
texdoc hyperref/manual
I would expect that "texdoc <packagename>" or "texdoc <progname>" provides something useful.
Seems desirable. -- David Kastrup, Kriemhildstr. 15, 44793 Bochum
David Kastrup
Reinhard Kotucha
writes: is it possible to make documentation for pdftex and hyperref accessible to texdoc(1)?
While the pdftex manual can be accessed if people know that it is called "pdftex-a" (it sounds like a joke if people say "Read the documentation" on a mailing list), the hyperref manual is inaccessible.
On my system I get:
$ locate manual.pdf | wc -l 164
Is it possible to solve it before TL is released?
texdoc hyperref/manual
Or, if you don't know that by heart, texdoc -s hyperref texdoc hyperref/manual
I would expect that "texdoc <packagename>" or "texdoc <progname>" provides something useful.
Seems desirable.
Heiko Oberdiek (hyperref's maintainer) argued that there is not one piece of documentation for hyperref, and therefore there's no good solution as to what "texdoc hyperref" should show. The other documents are not only developers' information, there's also some interesting user docs in there (especially but not only in README), and a real solution would require to rewrite the manual (which is outdated, anyway). I'm sure he welcomes offers for help; I myself have done that once and have the sources for the docs on my system, but in fact I never found time. Regards, Frank -- Frank Küster Inst. f. Biochemie der Univ. Zürich Debian Developer
On Thu, Oct 27, 2005 at 12:52:59AM +0200, Reinhard Kotucha wrote:
is it possible to make documentation for pdftex and hyperref accessible to texdoc(1)?
hyperref: Next version, this is almost done.
* The source code documentation hyperref.pdf from hyperref.dtx
will contain a section with links and bookmarks that point
to the other docus.
Thus you can then use "texdoc hyperref.pdf".
* And README and ChangeLog will also be available as
README.pdf and ChangeLog.pdf. (The conversions are done
automatically).
Yours sincerely
Heiko
participants (7)
-
David Kastrup
-
Frank Küster
-
George White
-
Heiko Oberdiek
-
karl@freefriends.org
-
Reinhard Kotucha
-
Thomas Esser