Bug#1001557: Ship html documentation
On Fri, Dec 17, 2021 at 12:16:44AM +0100, Bill Allombert wrote: > On Thu, Dec 16, 2021 at 10:09:48PM +0100, Julien Puydt wrote: > > Well, here is the list of things the upstream Debian package contains > > about pari: > > drwxr-xr-x root/root 0 2021-03-02 08:52 > > ./usr/share/giac/doc/pari/ > > -rw-r--r-- root/root175325 2021-03-02 08:52 > > ./usr/share/giac/doc/pari/Arithmetic_functions.html > > This is indeed the pari.math version, not the one in the source tarball. > > > So it's a pretty huge list ; it's visible online here: > > https://www-fourier.ujf-grenoble.fr/~parisse/giac/doc/pari/index.html > > > > I'm tempted to just link the documentation to the author's site > > (privacy breach, I know) -- but at least the package will be more > > usable than if I cut everything. > > It does not have to be a privacy breach... > Using link is fine a long as the user has a chance to notice they > point to an external URL. > What should be avoided are , ,font, etc that are loaded > automatically. Maybe we can close this bug ? Cheers, -- Bill. Imagine a large red swirl here.
Bug#1001557: Ship html documentation
On Thu, Dec 16, 2021 at 10:09:48PM +0100, Julien Puydt wrote: > Well, here is the list of things the upstream Debian package contains > about pari: > drwxr-xr-x root/root 0 2021-03-02 08:52 > ./usr/share/giac/doc/pari/ > -rw-r--r-- root/root175325 2021-03-02 08:52 > ./usr/share/giac/doc/pari/Arithmetic_functions.html This is indeed the pari.math version, not the one in the source tarball. > So it's a pretty huge list ; it's visible online here: > https://www-fourier.ujf-grenoble.fr/~parisse/giac/doc/pari/index.html > > I'm tempted to just link the documentation to the author's site > (privacy breach, I know) -- but at least the package will be more > usable than if I cut everything. It does not have to be a privacy breach... Using link is fine a long as the user has a chance to notice they point to an external URL. What should be avoided are , ,font, etc that are loaded automatically. Cheers, Bill.
Bug#1001557: Ship html documentation
Le dimanche 12 décembre 2021 à 13:29 +0100, Bill Allombert a écrit : > > So fonctionaly, you only need a single URL, not the whole set of URL > provided by https://pari.math.u-bordeaux.fr/dochtml/html-stable/ ? > > This is important, because it is possible to convert PARI > documentation to HTML instead of PDF (with pod2html) but it will not > look like https://pari.math.u-bordeaux.fr/dochtml/html-stable/ > at all... In particular it is missing an index.html page. > > > I noticed that Debian's src:giac does not ship it (because it's an > > embedding), hence the link is dead. > > > > My plan is to depend on pari-doc and link to what's there. In the > > mean > > time, I'm linking to pari's homepage (a privacy breach, but better > > than > > a broken link). > > I suggest you write a simple HTML document which lists the links to > the PDF files in > file:///usr/share/doc/pari-doc and then patches giac to open this > URL. > (or use doc-base to do it for you, after all, all the pari documents > are registered with > doc-base). > > If you feel this to be inadequate for, then I can consider shipping > the pod2html-generated fils in the packages. Well, here is the list of things the upstream Debian package contains about pari: drwxr-xr-x root/root 0 2021-03-02 08:52 ./usr/share/giac/doc/pari/ -rw-r--r-- root/root175325 2021-03-02 08:52 ./usr/share/giac/doc/pari/Arithmetic_functions.html -rw-r--r-- root/root 87018 2021-03-02 08:52 ./usr/share/giac/doc/pari/Associative_and_central_simple_algebras.html -rw-r--r-- root/root 9666 2021-03-02 08:52 ./usr/share/giac/doc/pari/Combinatorics.html -rw-r--r-- root/root 82096 2021-03-02 08:52 ./usr/share/giac/doc/pari/Conversions_and_similar_elementary_functions_ or_commands.html -rw-r--r-- root/root135373 2021-03-02 08:52 ./usr/share/giac/doc/pari/Elliptic_curves.html -rw-r--r-- root/root 40933 2021-03-02 08:52 ./usr/share/giac/doc/pari/GP_defaults.html -rw-r--r-- root/root307455 2021-03-02 08:52 ./usr/share/giac/doc/pari/General_number_fields.html -rw-r--r-- root/root 57981 2021-03-02 08:52 ./usr/share/giac/doc/pari/ModRewrite-table -rw-r--r-- root/root100486 2021-03-02 08:52 ./usr/share/giac/doc/pari/Modular_forms.html -rw-r--r-- root/root 57882 2021-03-02 08:52 ./usr/share/giac/doc/pari/Modular_symbols.html -rw-r--r-- root/root 10707 2021-03-02 08:52 ./usr/share/giac/doc/pari/Parallel_programming.html -rw-r--r-- root/root 38773 2021-03-02 08:52 ./usr/share/giac/doc/pari/Plotting_functions.html -rw-r--r-- root/root 60799 2021-03-02 08:52 ./usr/share/giac/doc/pari/Polynomials_and_power_series.html -rw-r--r-- root/root 47582 2021-03-02 08:52 ./usr/share/giac/doc/pari/Programming_in_GP__control_statements.html -rw-r--r-- root/root 98958 2021-03-02 08:52 ./usr/share/giac/doc/pari/Programming_in_GP__other_specific_functions.h tml -rw-r--r-- root/root 21572 2021-03-02 08:52 ./usr/share/giac/doc/pari/Standard_monadic_or_dyadic_operators.html -rw-r--r-- root/root 92157 2021-03-02 08:52 ./usr/share/giac/doc/pari/Sums__products__integrals_and_similar_functio ns.html -rw-r--r-- root/root 58541 2021-03-02 08:52 ./usr/share/giac/doc/pari/Transcendental_functions.html -rw-r--r-- root/root101790 2021-03-02 08:52 ./usr/share/giac/doc/pari/Vectors__matrices__linear_algebra_and_sets.ht ml -rw-r--r-- root/root 60202 2021-03-02 08:52 ./usr/share/giac/doc/pari/_L_minusfunctions.html -rw-r--r-- root/root 10136 2021-03-02 08:52 ./usr/share/giac/doc/pari/cont_A.html -rw-r--r-- root/root 10611 2021-03-02 08:52 ./usr/share/giac/doc/pari/cont_Arithmetic_functions.html -rw-r--r-- root/root 8119 2021-03-02 08:52 ./usr/share/giac/doc/pari/cont_Associative_and_central_simple_algebras. html -rw-r--r-- root/root 6673 2021-03-02 08:52 ./usr/share/giac/doc/pari/cont_B.html -rw-r--r-- root/root 4179 2021-03-02 08:52 ./usr/share/giac/doc/pari/cont_C.html -rw-r--r-- root/root 1403 2021-03-02 08:52 ./usr/share/giac/doc/pari/cont_Combinatorics.html -rw-r--r-- root/root 7794 2021-03-02 08:52 ./usr/share/giac/doc/pari/cont_Conversions_and_similar_elementary_funct ions_or_commands.html -rw-r--r-- root/root 2773 2021-03-02 08:52 ./usr/share/giac/doc/pari/cont_D.html -rw-r--r-- root/root 9432 2021-03-02 08:52 ./usr/share/giac/doc/pari/cont_E.html -rw-r--r-- root/root 7633 2021-03-02 08:52 ./usr/share/giac/doc/pari/cont_Elliptic_curves.html -rw-r--r-- root/root 6293 2021-03-02 08:52 ./usr/share/giac/doc/pari/cont_F.html -rw-r--r-- root/root 4339 2021-03-02 08:52 ./usr/share/giac/doc/pari/cont_G.html -rw-r--r-- root/root 3959 2021-03-02 08:52 ./usr/share/giac/doc/pari/cont_GP_defaults.html -rw-r--r-- root/root 17065 2021-03-02 08:52 ./usr/share/giac/doc/pari/cont_General_number_fields.html -rw-r--r-- root/root 1429 2021-03-02 08:52 ./usr/share/giac/doc/pari/cont_H.html -rw-r--r-- root/root 6413 2021-03-02 08:52 ./usr/share/giac/doc/pari/cont_I.html -rw
Bug#1001557: Ship html documentation
On Sun, Dec 12, 2021 at 12:32:35PM +0100, Julien Puydt wrote: > Le dimanche 12 décembre 2021 à 12:15 +0100, Bill Allombert a écrit : > > On Sun, Dec 12, 2021 at 11:39:19AM +0100, Julien Puydt wrote: > > > Package: pari-doc > > > Version: 2.13.3-1 > > > Severity: wishlist > > > > > > The pari-doc package only ships documentation in tex, dvi and pdf. > > > > > > For the giac package, I would need some html documentation too, > > > like > > > what can be found in: > > > https://pari.math.u-bordeaux.fr/dochtml/html-stable/ > > > > Hello Julien, > > > > The script used to generate them is not provided by the source > > tarball and is > > not particularly robust nor up-to-date with current web standard (it > > use > > html frames). > > > > Could you elaborate why you need them ? > > The upstream src:giac package ships a doc/pari with that documentation, > and clicking in xcas' help menu for "PARI/GP documentation" opens it in > a browser. So fonctionaly, you only need a single URL, not the whole set of URL provided by https://pari.math.u-bordeaux.fr/dochtml/html-stable/ ? This is important, because it is possible to convert PARI documentation to HTML instead of PDF (with pod2html) but it will not look like https://pari.math.u-bordeaux.fr/dochtml/html-stable/ at all... In particular it is missing an index.html page. > I noticed that Debian's src:giac does not ship it (because it's an > embedding), hence the link is dead. > > My plan is to depend on pari-doc and link to what's there. In the mean > time, I'm linking to pari's homepage (a privacy breach, but better than > a broken link). I suggest you write a simple HTML document which lists the links to the PDF files in file:///usr/share/doc/pari-doc and then patches giac to open this URL. (or use doc-base to do it for you, after all, all the pari documents are registered with doc-base). If you feel this to be inadequate for, then I can consider shipping the pod2html-generated fils in the packages. Cheers, -- Bill. Imagine a large red swirl here.
Bug#1001557: Ship html documentation
Le dimanche 12 décembre 2021 à 12:15 +0100, Bill Allombert a écrit : > On Sun, Dec 12, 2021 at 11:39:19AM +0100, Julien Puydt wrote: > > Package: pari-doc > > Version: 2.13.3-1 > > Severity: wishlist > > > > The pari-doc package only ships documentation in tex, dvi and pdf. > > > > For the giac package, I would need some html documentation too, > > like > > what can be found in: > > https://pari.math.u-bordeaux.fr/dochtml/html-stable/ > > Hello Julien, > > The script used to generate them is not provided by the source > tarball and is > not particularly robust nor up-to-date with current web standard (it > use > html frames). > > Could you elaborate why you need them ? The upstream src:giac package ships a doc/pari with that documentation, and clicking in xcas' help menu for "PARI/GP documentation" opens it in a browser. I noticed that Debian's src:giac does not ship it (because it's an embedding), hence the link is dead. My plan is to depend on pari-doc and link to what's there. In the mean time, I'm linking to pari's homepage (a privacy breach, but better than a broken link). Cheers, J.Puydt
Bug#1001557: Ship html documentation
On Sun, Dec 12, 2021 at 11:39:19AM +0100, Julien Puydt wrote: > Package: pari-doc > Version: 2.13.3-1 > Severity: wishlist > > The pari-doc package only ships documentation in tex, dvi and pdf. > > For the giac package, I would need some html documentation too, like > what can be found in: > https://pari.math.u-bordeaux.fr/dochtml/html-stable/ Hello Julien, The script used to generate them is not provided by the source tarball and is not particularly robust nor up-to-date with current web standard (it use html frames). Could you elaborate why you need them ? Cheers, -- Bill. Imagine a large red swirl here.
Bug#1001557: Ship html documentation
Package: pari-doc Version: 2.13.3-1 Severity: wishlist The pari-doc package only ships documentation in tex, dvi and pdf. For the giac package, I would need some html documentation too, like what can be found in: https://pari.math.u-bordeaux.fr/dochtml/html-stable/ Thanks, J.Puydt