Bug 266107 - FreeBSD Handbook and other books: PDF: broken links – crossref
Summary: FreeBSD Handbook and other books: PDF: broken links – crossref
Status: Closed FIXED
Alias: None
Product: Documentation
Classification: Unclassified
Component: Books & Articles (show other bugs)
Version: Latest
Hardware: Any Any
: --- Affects Many People
Assignee: Fernando Apesteguía
URL: https://github.com/freebsd/freebsd-do...
Keywords:
Depends on:
Blocks:
 
Reported: 2022-08-30 03:48 UTC by Graham Perrin
Modified: 2024-11-18 16:20 UTC (History)
3 users (show)

See Also:


Attachments
Screenshot: a non-working link (43.75 KB, image/png)
2022-10-09 18:00 UTC, Graham Perrin
no flags Details

Note You need to log in before you can comment on or make changes to this bug.
Description Graham Perrin freebsd_committer freebsd_triage 2022-08-30 03:48:54 UTC
Under <https://docs.freebsd.org/en/books/handbook/cutting-edge/#freebsdupdate-security-patches> there's a link (not bugged) to a different page within the handbook: 

    <https://docs.freebsd.org/en/books/handbook/security/index.html#security-advisories>

In the FreeBSD-packaged PDF (bugged): 

    ../security/index.html#security-advisories

– and so, for example, in Okular: 

> Unable to run the command specified. The file or folder 
> /usr/local/share/doc/freebsd/en/books/security/index.html does not exist.

----

<https://github.com/freebsd/freebsd-doc/blob/main/documentation/content/en/books/handbook/cutting-edge/_index.adoc#22-applying-security-patches> I see: 

> crossref:security[security-advisories,"FreeBSD Security Advisories"]

----

Keyword, maybe    crossref

* the first page after the table of contents is bugged 
  (the link to the bibliography is broken)

* … and so on. 

I wondered whether this is a misc/freebsd-doc-en bug, probably not; links are similarly broken in the PDF that's produced by clicking 'Download PDF' within the online version of the Handbook. 

Also broken: 

* fdp-primer_en.pdf (the first link under 1.2.2.)

* faq_en.pdf (under 6.2)

* …
Comment 1 Pau Amma 2022-08-31 00:07:16 UTC
Why accessibility? Not clear to me how "Issues related to ensuring that the FreeBSD community and its work is accessible to people with a diverse range of hearing, movement, sight, and cognitive ability" applies. Am I missing something?
Comment 2 Graham Perrin freebsd_committer freebsd_triage 2022-09-02 01:03:58 UTC
(In reply to Pau Amma from comment #1)

Thanks. I was unsure about applicability of the keyword in this case. 

I probably applied it through frustration at … (I should write to the list, but can't do so right now).
Comment 3 commit-hook freebsd_committer freebsd_triage 2022-09-04 10:30:59 UTC
A commit in branch main references this bug:

URL: https://cgit.FreeBSD.org/doc/commit/?id=d46632e1af2002089721a751d7655401f513fe43

commit d46632e1af2002089721a751d7655401f513fe43
Author:     Sergio Carlavilla Delgado <carlavilla@FreeBSD.org>
AuthorDate: 2022-09-04 10:29:12 +0000
Commit:     Sergio Carlavilla Delgado <carlavilla@FreeBSD.org>
CommitDate: 2022-09-04 10:30:29 +0000

    Fix links to the handbook in FAQ

    PR:             259342, 266107
    Submitted by:   grahamperrin@, mhorne@

 documentation/content/en/books/faq/_index.adoc | 76 +++++++++++++-------------
 1 file changed, 38 insertions(+), 38 deletions(-)
Comment 5 Fernando Apesteguía freebsd_committer freebsd_triage 2022-10-09 15:59:18 UTC
^Triage: assign to committer who resolved the issue

Closing.
Comment 6 Graham Perrin freebsd_committer freebsd_triage 2022-10-09 18:00:58 UTC
Created attachment 237168 [details]
Screenshot: a non-working link

Not fixed. 

Please see comment 0, and here's a screenshot of the PDF that is currently produced by clicking 'Download PDF'; the linked page is 404, not found. 

I'm not sure how to fix this type of thing, for links within PDF to work as required.
Comment 7 Graham Perrin freebsd_committer freebsd_triage 2022-12-10 14:12:29 UTC
(In reply to Graham Perrin from comment #6)

What was in the screenshot – Applying Security Patches – has moved from 24.2.2 to 25.2.2. 

To reproduce the bug, please click the first link in this section.
Comment 8 Alexander Ziaee freebsd_triage 2024-08-09 22:45:19 UTC
Confirmed. Here is the first round of fixes, going alphabetically:

https://reviews.freebsd.org/D46258
Comment 9 Alexander Ziaee freebsd_triage 2024-08-10 00:26:05 UTC
(previous revision was advanced networking)
basics - https://reviews.freebsd.org/D46260
audit - https://reviews.freebsd.org/D46261
Comment 10 Fernando Apesteguía freebsd_committer freebsd_triage 2024-08-13 15:11:01 UTC
See https://reviews.freebsd.org/D46266#inline-277823
Comment 11 Fernando Apesteguía freebsd_committer freebsd_triage 2024-08-29 17:28:34 UTC
https://reviews.freebsd.org/D46480
Comment 12 commit-hook freebsd_committer freebsd_triage 2024-09-07 18:04:44 UTC
A commit in branch main references this bug:

URL: https://cgit.FreeBSD.org/doc/commit/?id=557464e66e059e785c3d83036ed2168df224198f

commit 557464e66e059e785c3d83036ed2168df224198f
Author:     Fernando Apesteguía <fernape@FreeBSD.org>
AuthorDate: 2024-08-11 16:52:22 +0000
Commit:     Fernando Apesteguía <fernape@FreeBSD.org>
CommitDate: 2024-09-07 18:02:30 +0000

    [documentation]: Fix links in all output formats

    Use the crossref: macro for intra-file and intra-book links.
    This will produce the correct link in Single HTML, Splitted HTML and PDF.

    Rework the macro to include the PDF special render.

    While here, briefly document macros.

    PR:                     266107
    Reviewed by:            bcr@, dbaio@, concussious.bugzilla_runbox.com
    Differential Revision:  https://reviews.freebsd.org/D46480

 .../en/articles/building-products/_index.adoc      |  58 ++--
 .../en/articles/committers-guide/_index.adoc       |  67 +++--
 .../content/en/articles/contributing/_index.adoc   |  15 +-
 .../content/en/articles/contributors/_index.adoc   |   3 +-
 .../content/en/articles/freebsd-releng/_index.adoc |  21 +-
 .../en/articles/gjournal-desktop/_index.adoc       |   2 +-
 documentation/content/en/articles/hubs/_index.adoc |  16 +-
 .../content/en/articles/ipsec-must/_index.adoc     |  13 +-
 .../content/en/articles/ldap-auth/_index.adoc      |   9 +-
 .../content/en/articles/license-guide/_index.adoc  |   4 +-
 documentation/content/en/articles/pam/_index.adoc  |  10 +-
 .../content/en/articles/pr-guidelines/_index.adoc  |  10 +-
 .../content/en/articles/rc-scripting/_index.adoc   |  11 +-
 .../content/en/articles/releng/_index.adoc         |  10 +-
 .../content/en/articles/remote-install/_index.adoc |   2 +-
 .../content/en/articles/solid-state/_index.adoc    |  11 +-
 .../content/en/articles/vinum/_index.adoc          |  17 +-
 .../content/en/books/arch-handbook/mac/_index.adoc |   4 +-
 .../content/en/books/arch-handbook/smp/_index.adoc |   6 +-
 .../en/books/arch-handbook/sound/_index.adoc       |  17 +-
 .../content/en/books/design-44bsd/_index.adoc      |  40 ++-
 .../content/en/books/dev-model/_index.adoc         | 164 +++++++----
 .../en/books/developers-handbook/ipv6/_index.adoc  |  23 +-
 .../en/books/developers-handbook/tools/_index.adoc |   6 +-
 .../en/books/developers-handbook/x86/_index.adoc   |   4 +-
 .../en/books/fdp-primer/editor-config/_index.adoc  |   2 +-
 .../books/handbook/advanced-networking/_index.adoc |  12 +-
 .../content/en/books/handbook/audit/_index.adoc    |   8 +-
 .../content/en/books/handbook/basics/_index.adoc   |  28 +-
 .../content/en/books/handbook/boot/_index.adoc     |   7 +-
 .../en/books/handbook/bsdinstall/_index.adoc       |  83 ++++--
 .../content/en/books/handbook/config/_index.adoc   |  10 +-
 .../en/books/handbook/cutting-edge/_index.adoc     |  24 +-
 .../content/en/books/handbook/desktop/_index.adoc  |   2 +-
 .../content/en/books/handbook/disks/_index.adoc    |  25 +-
 .../en/books/handbook/firewalls/_index.adoc        |   5 +-
 .../content/en/books/handbook/geom/_index.adoc     |   7 +-
 .../content/en/books/handbook/glossary.adoc        | 268 ++++++++---------
 .../content/en/books/handbook/jails/_index.adoc    |  11 +-
 .../en/books/handbook/kernelconfig/_index.adoc     |   3 +-
 .../content/en/books/handbook/l10n/_index.adoc     |  14 +-
 .../content/en/books/handbook/mac/_index.adoc      |   2 +-
 .../content/en/books/handbook/mail/_index.adoc     |  10 +-
 .../content/en/books/handbook/mirrors/_index.adoc  |   3 +-
 .../en/books/handbook/network-servers/_index.adoc  |   2 +-
 .../content/en/books/handbook/network/_index.adoc  |   3 +-
 .../content/en/books/handbook/ports/_index.adoc    |   7 +-
 .../content/en/books/handbook/printing/_index.adoc |   5 +-
 .../content/en/books/handbook/security/_index.adoc |   5 +-
 .../en/books/handbook/serialcomms/_index.adoc      |  19 +-
 .../content/en/books/handbook/wine/_index.adoc     |  15 +-
 .../content/en/books/handbook/x11/_index.adoc      |   7 +-
 .../content/en/books/handbook/zfs/_index.adoc      | 316 ++++++++++++++++-----
 .../en/books/porters-handbook/flavors/_index.adoc  |   7 +-
 .../books/porters-handbook/makefiles/_index.adoc   | 208 +++++++++-----
 .../en/books/porters-handbook/new-port/_index.adoc |   2 +-
 .../en/books/porters-handbook/order/_index.adoc    |  20 +-
 .../books/porters-handbook/pkg-files/_index.adoc   |   2 +-
 .../en/books/porters-handbook/plist/_index.adoc    |  14 +-
 .../en/books/porters-handbook/special/_index.adoc  |  35 ++-
 .../en/books/porters-handbook/testing/_index.adoc  |  11 +-
 .../books/porters-handbook/upgrading/_index.adoc   |   2 +-
 .../en/books/porters-handbook/uses/_index.adoc     |  24 +-
 .../lib/CrossDocumentReferencesMacro/extension.rb  |   1 +
 .../lib/InterDocumentReferencesMacro/extension.rb  |  32 ++-
 65 files changed, 1137 insertions(+), 667 deletions(-)
Comment 13 Fernando Apesteguía freebsd_committer freebsd_triage 2024-09-07 18:05:15 UTC
Fixed.
Comment 14 Graham Perrin 2024-11-17 14:26:09 UTC
Tested with 'FreeBSD Security Advisories' on page 638 (639), goes to page 366 (367), which has the subheading. 

Thanks!
Comment 15 Fernando Apesteguía freebsd_committer freebsd_triage 2024-11-18 16:20:40 UTC
(In reply to Graham Perrin from comment #14)
On which format? On which document? Is this a bug?