user/dev discussion of public-inbox itself
 help / color / Atom feed
From: Eric Wong <e@yhbt.net>
To: meta@public-inbox.org
Subject: [PATCH 3/4] doc: txt2pre: auto-linkify manpage references
Date: Wed,  5 Feb 2020 22:03:48 -0600
Message-ID: <20200206040349.11587-4-e@yhbt.net> (raw)
In-Reply-To: <20200206040349.11587-1-e@yhbt.net>

This can be more convenient for people browsing HTML docs
remotely or locally.
---
 Documentation/public-inbox-compact.pod |  3 +-
 Documentation/public-inbox-edit.pod    |  2 +-
 Documentation/public-inbox-xcpdb.pod   |  4 +-
 Documentation/txt2pre                  | 86 +++++++++++++++++++++++++-
 4 files changed, 88 insertions(+), 7 deletions(-)

diff --git a/Documentation/public-inbox-compact.pod b/Documentation/public-inbox-compact.pod
index 6b0c7376..956069fd 100644
--- a/Documentation/public-inbox-compact.pod
+++ b/Documentation/public-inbox-compact.pod
@@ -61,5 +61,4 @@ License: AGPL-3.0+ L<https://www.gnu.org/licenses/agpl-3.0.txt>
 
 =head1 SEE ALSO
 
-L<xapian-compact(1)|https://public-inbox.org/.xapian-compact.1.html>,
-L<public-inbox-index(1)|https://public-inbox.org/public-inbox-index.html>
+L<xapian-compact(1)>, L<public-inbox-index(1)>
diff --git a/Documentation/public-inbox-edit.pod b/Documentation/public-inbox-edit.pod
index 120f3c3b..46179778 100644
--- a/Documentation/public-inbox-edit.pod
+++ b/Documentation/public-inbox-edit.pod
@@ -106,4 +106,4 @@ License: AGPL-3.0+ L<https://www.gnu.org/licenses/agpl-3.0.txt>
 
 =head1 SEE ALSO
 
-L<public-inbox-purge(1)|https://public-inbox.org/public-inbox-purge.html>
+L<public-inbox-purge(1)>
diff --git a/Documentation/public-inbox-xcpdb.pod b/Documentation/public-inbox-xcpdb.pod
index a13c4efa..b19470cc 100644
--- a/Documentation/public-inbox-xcpdb.pod
+++ b/Documentation/public-inbox-xcpdb.pod
@@ -89,6 +89,4 @@ License: AGPL-3.0+ L<https://www.gnu.org/licenses/agpl-3.0.txt>
 
 =head1 SEE ALSO
 
-L<copydatabase(1)|https://public-inbox.org/.copydatabase.1.html>,
-L<xapian-compact(1)|https://public-inbox.org/.xapian-compact.1.html>,
-L<public-inbox-index(1)|https://public-inbox.org/public-inbox-index.html>
+L<copydatabase(1)>, L<xapian-compact(1)>, L<public-inbox-index(1)>
diff --git a/Documentation/txt2pre b/Documentation/txt2pre
index cb6a7613..01b49379 100755
--- a/Documentation/txt2pre
+++ b/Documentation/txt2pre
@@ -9,13 +9,97 @@ use strict;
 use warnings;
 use PublicInbox::Linkify;
 use PublicInbox::Hval qw(ascii_html);
+my %xurls;
+for (qw[public-inbox.cgi(1)
+	public-inbox-compact(1)
+	public-inbox-config(5)
+	public-inbox-convert(1)
+	public-inbox-daemon(8)
+	public-inbox-edit(1)
+	public-inbox-httpd(1)
+	public-inbox-index(1)
+	public-inbox-init(1)
+	public-inbox-learn(1)
+	public-inbox-mda(1)
+	public-inbox-nntpd(1)
+	public-inbox-overview(7)
+	public-inbox-purge(1)
+	public-inbox-v1-format(5)
+	public-inbox-v2-format(5)
+	public-inbox-watch(1)
+	public-inbox-xcpdb(1)
+]) {
+	my ($n) = (/([\w\-\.]+)/);
+	$xurls{$_} = "$n.html";
+	$xurls{$n} = "$n.html";
+}
+
+for (qw[copydatabase(1) xapian-compact(1)]) {
+	my ($n) = (/([\w\-\.]+)/);
+	$xurls{$_} = ".$n.1.html"
+}
+
+for (qw[flock(2) setrlimit(2) vfork(2)]) {
+	my ($n, $s) = (/([\w\-]+)\((\d)\)/);
+	$xurls{$_} = "http://www.man7.org/linux/man-pages/man2/$n.$s.html";
+}
+
+for (qw[git(1)
+	git-am(1)
+	git-config(1)
+	git-daemon(1)
+	git-fetch(1)
+	git-filter-branch(1)
+	git-format-patch(1)
+	git-gc(1)
+	git-http-backend(1)
+	git-imap-send(1)
+	git-init(1)
+	git-send-email(1)
+	gitrepository-layout(5)
+]) {
+	my ($n) = (/([\w\-\.]+)/);
+	$xurls{$_} = "https://kernel.org/pub/software/scm/git/docs/$n.html"
+}
 
-my $str = eval { local $/; <> };
+for (qw[
+	sd_listen_fds(3)
+	systemd(1)
+	systemd.unit(5)
+	systemd.socket(5)
+]) {
+	my ($n) = (/([\w\-\.]+)/);
+	$xurls{$_} = "https://www.freedesktop.org/software/systemd/man/$n.html";
+}
+
+$xurls{'spamc(1)'} =
+	'https://spamassassin.apache.org/full/3.4.x/doc/spamc.html';
+$xurls{'grok-pull'} =
+	'https://git.kernel.org/pub/scm/utils/grokmirror/grokmirror.git' .
+	'/tree/man/grok-pull.1.rst';
+$xurls{'ssoma(1)'} = 'https://ssoma.public-inbox.org/ssoma.txt';
+$xurls{'cgitrc(5)'} = 'https://git.zx2c4.com/cgit/tree/cgitrc.5.txt';
+
+my $str = do { local $/; <STDIN> };
 my ($title) = ($str =~ /\A([^\n]+)/);
+if ($str =~ /^NAME\n\s+([^\n]+)/sm) {
+	# don't link to ourselves
+	$title = $1;
+	if ($title =~ /([\w\.\-]+)/) {
+		delete $xurls{$1};
+	}
+}
 $title = ascii_html($title);
 my $l = PublicInbox::Linkify->new;
 $str = $l->linkify_1($str);
 $str = ascii_html($str);
+
+# longest matches, first
+my @keys = sort { length($b) <=> length($a) } keys %xurls;
+my $xkeys = join('|', map { quotemeta } @keys);
+$str =~ s,(?<![>\w_])($xkeys)(?!(?:[\w<\-]|\.html)),
+	qq(<a\nhref=").$xurls{$1}.qq(">$1).($2//'').'</a>',sge;
+
 $str = $l->linkify_2($str);
 
 print '<html><head>',

  parent reply index

Thread overview: 5+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-02-06  4:03 [PATCH 0/4] doc: data flow graph and doc linkification Eric Wong
2020-02-06  4:03 ` [PATCH 1/4] doc: add data flow diagram using Graph::Easy Eric Wong
2020-02-06  4:03 ` [PATCH 2/4] doc: remove .x/ subdirectory for Xapian manpages Eric Wong
2020-02-06  4:03 ` Eric Wong [this message]
2020-02-06  4:03 ` [PATCH 4/4] doc: v1: add a reference to git-filter-repo(1), too Eric Wong

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

  List information: http://public-inbox.org/README

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20200206040349.11587-4-e@yhbt.net \
    --to=e@yhbt.net \
    --cc=meta@public-inbox.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link

user/dev discussion of public-inbox itself

Archives are clonable:
	git clone --mirror http://public-inbox.org/meta
	git clone --mirror http://czquwvybam4bgbro.onion/meta
	git clone --mirror http://hjrcffqmbrq6wope.onion/meta
	git clone --mirror http://ou63pmih66umazou.onion/meta

Example config snippet for mirrors

Newsgroups are available over NNTP:
	nntp://news.public-inbox.org/inbox.comp.mail.public-inbox.meta
	nntp://ou63pmih66umazou.onion/inbox.comp.mail.public-inbox.meta
	nntp://czquwvybam4bgbro.onion/inbox.comp.mail.public-inbox.meta
	nntp://hjrcffqmbrq6wope.onion/inbox.comp.mail.public-inbox.meta
	nntp://news.gmane.io/gmane.mail.public-inbox.general

 note: .onion URLs require Tor: https://www.torproject.org/

AGPL code for this site: git clone https://public-inbox.org/public-inbox.git