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

Add glossary search to Pod::Perldoc #45

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

illandan
Copy link

@illandan illandan commented Oct 3, 2020

This one searches in the existing 'perlglossary.pod' file and spits out text/descriptions against matching =items

Examples:

$ perldoc -u -g BSD
=encoding utf8

=over 8

=item BSD

A X<BSD (Berkeley Standard Distribution)>X<Berkeley Standard Distribution
(BSD)>psychoactive drug, popular in the ’80s, probably developed at UC
Berkeley or thereabouts. Similar in many ways to the prescription-only
medication called “System V”, but infinitely more useful. (Or, at least,
more fun.) The full chemical name is “Berkeley Standard Distribution”.

=back
$ perldoc -u -g signal
=encoding utf8

=over 8

=item signal

A bolt X<signals and signal handling, about>out of the blue; that is, an
event triggered by the B<operating system>, probably when you’re least
expecting it.

=item signal handler

A B<subroutine> that, X<handlers, signal>instead of being content to be
called in the normal fashion, sits around waiting for a bolt out of the
blue before it will deign to B<execute>. Under Perl, bolts out of the blue
are called signals, and you send them with the C<kill> built-in. See the
C<%SIG> hash in Camel chapter 25, “Special Names” and the section “Signals”
in Camel chapter 15, “Interprocess Communication”.

=back

@briandfoy
Copy link
Owner

I've just taken over the maintenance of Pod::Perldoc, so I'll look into this. I know it's years old, and it might take me a bit to catch up.

@briandfoy briandfoy added Type: enhancement improve a feature that already exists Status: stalled something is blocking progress Priority: low get to this whenever labels Dec 5, 2023
@briandfoy
Copy link
Owner

I see this change and it's something I agree with and support. However, I want to land and test some of the backlog first. Once those things stabilize, I will look at merging this. The only hold-up is me being cautious.

@illandan
Copy link
Author

illandan commented Dec 7, 2023

Thanks @briandfoy - I can understand this module has some catching up to do with the backlog both on RT and here. I don't remember much of the things that I noticed were broken when I was writing this, except one.

If my memory serves right, there were some parts of perlglossary.pod that didn't agree with the renderers for spitting out unicode output. There was a PR or two that addressed this: you may want to look at merging those ahead of this one and see if formatting/rendering problems are fixed.

@briandfoy briandfoy added Type: feature request add a feature that does not exist Priority: backlog not working on this, unless someone else wants to and removed Type: enhancement improve a feature that already exists Status: stalled something is blocking progress Priority: low get to this whenever labels Dec 8, 2023
@briandfoy briandfoy added the Status: stalled something is blocking progress label Dec 22, 2023
This adds a glossary search in the 'perldoc' program that basically just spits out sections of text from `perldoc perlglossary`. Usage would be like:

```shell
$ perldoc -g GlossaryTerm
$ perldoc -g BSD
$ perldoc -g Unix
```
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Priority: backlog not working on this, unless someone else wants to Status: stalled something is blocking progress Type: feature request add a feature that does not exist
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants