Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[doc] Fix HTTP and Books links #22186

Closed
wants to merge 1 commit into from
Closed

[doc] Fix HTTP and Books links #22186

wants to merge 1 commit into from

Conversation

rwp0
Copy link
Contributor

@rwp0 rwp0 commented Apr 29, 2024

Update some obsolete Perl book URL's

Convert some HTTP links to HTTPS

pod/perlreref.pod Outdated Show resolved Hide resolved
@rwp0
Copy link
Contributor Author

rwp0 commented Apr 30, 2024

Fixed some more Oreilly book URL's converting from catalog (which doesn't function anymore) to a shorter version of library/view.

@rwp0
Copy link
Contributor Author

rwp0 commented Apr 30, 2024

That's the only one remaining (untouched by the PR):

Because the replacement for it is (looks like moved from Oreilly proper):

whose URL is too long (crossing the 78 character limit) for POD checking tests.

pod/perlbook.pod Show resolved Hide resolved
pod/perlbook.pod Show resolved Hide resolved
@rwp0
Copy link
Contributor Author

rwp0 commented May 2, 2024

Since about minor doc changes, can this be merged before the 5.40 release?

@rwp0
Copy link
Contributor Author

rwp0 commented May 11, 2024

@jkeenan can you please review this again? I corrected all book references to their new and working URL's.

pod/perlbook.pod Show resolved Hide resolved
pod/perlbook.pod Show resolved Hide resolved
pod/perlbook.pod Show resolved Hide resolved
@rwp0
Copy link
Contributor Author

rwp0 commented May 12, 2024

@jkeenan I wrapped all URL's in L<>. Please approve if all good now.

@jkeenan
Copy link
Contributor

jkeenan commented May 15, 2024

Unfortunately, those newly added L<> links didn't have the effect I was hoping for. Many of them are already in indented blocks, which means that perldoc treats them as code (C<>) and presents them like this:

    *Programming Perl* (the "Camel Book"):
         by Tom Christiansen, brian d foy, Larry Wall with Jon Orwant
         ISBN 978-0-596-00492-7 [4th edition February 2012]
         ISBN 978-1-4493-9890-3 [ebook]
         L<https://www.oreilly.com/library/view/-/9781449321451/>

So there are about 30 instances of L<> in indented blocks which need to be removed. This regex should clean up most of them:

$ perl -pi -e 's/^(\s+)L<(.*)>/$1$2/' pod/perlbook.pod

There will be one in the entry for Higher-Order Perl that you'll have to manually clean up. When you're done, you can get a rough idea of how this will look in HTML by calling:

$ pod2html --infile=pod/perlbook.pod --outfile=/tmp/perlbook.html --no-index

I'm sorry that my suggestion didn't work out.

@rwp0
Copy link
Contributor Author

rwp0 commented May 15, 2024

Unfortunately, those newly added L<> links didn't have the effect I was hoping for. Many of them are already in indented blocks, which means that perldoc treats them as code (C<>) and presents them like this:

    *Programming Perl* (the "Camel Book"):
         by Tom Christiansen, brian d foy, Larry Wall with Jon Orwant
         ISBN 978-0-596-00492-7 [4th edition February 2012]
         ISBN 978-1-4493-9890-3 [ebook]
         L<https://www.oreilly.com/library/view/-/9781449321451/>

So there are about 30 instances of L<> in indented blocks which need to be removed. This regex should clean up most of them:

$ perl -pi -e 's/^(\s+)L<(.*)>/$1$2/' pod/perlbook.pod

There will be one in the entry for Higher-Order Perl that you'll have to manually clean up. When you're done, you can get a rough idea of how this will look in HTML by calling:

$ pod2html --infile=pod/perlbook.pod --outfile=/tmp/perlbook.html --no-index

I'm sorry that my suggestion didn't work out.

Thanks, I will.

At least we realize now why those URL's weren't "linkified" originally 🙂

Update some obsolete Perl book URL's

Convert some HTTP links to HTTPS

Wrap links in `L<>`.
@rwp0
Copy link
Contributor Author

rwp0 commented May 15, 2024

@jkeenan I removed all L<>'s from book references.
Hope everything is okay now and we can merge this PR already 🙂

are available in the POSIX locale system. At the time of this writing,
there was no CPAN module that provides access to this XML-encoded data.
However, it is possible to compute the POSIX locale data from them, and
earlier CLDR versions had these already extracted for you as UTF-8 locales
L<http://unicode.org/Public/cldr/2.0.1/>.)
L<https://unicode.org/Public/cldr/2.0.1/>.)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why do we link to this ancient version?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What version to link to among those since there's no latest symlink available?
https://unicode.org/Public/cldr/

Copy link
Contributor Author

@rwp0 rwp0 May 15, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There are actually three references to that URL in the file probably because it contains posix.zip.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Probably just https://cldr.unicode.org/, it makes most sense to like to something human readable.

jkeenan pushed a commit that referenced this pull request May 16, 2024
Update some obsolete Perl book URLs.  Convert some HTTP links to HTTPS.
Wrap links in `L<>`.

Committer: Resolve merge conflicts in pod/perllocale.pod.

For: #22186
@jkeenan
Copy link
Contributor

jkeenan commented May 16, 2024

@rwp0, pod/perllocale.pod had evolved since you worked on it, so there were merge conflicts. I fetched your pull request, rebased on blead, resolved merge conflicts, merged the result into blead and pushed to origin in e3f226d. Please check that I got all your changes correct. @khwilliamson, please check that I resolved merge conflicts in perllocale satisfactorily. Taking this ticket for the purpose of closing it once we know those conflicts were correctly resolved. Request that any further documentation issues be discussed in a new ticket/pull request. Thanks.

@jkeenan jkeenan self-assigned this May 16, 2024
@rwp0 rwp0 closed this May 16, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants