discussion and development of piem
 help / color / mirror / code / Atom feed
From: Kyle Meyer <kyle@kyleam.com>
To: piem@inbox.kyleam.com
Cc: Xinglu Chen <public@yoctocell.xyz>
Subject: [PATCH 5/5] manual: Add section on "copy public-inbox link" functionality
Date: Sun,  7 Feb 2021 02:57:38 -0500
Message-ID: <20210207075738.8752-6-kyle@kyleam.com> (raw)
In-Reply-To: <20210207075738.8752-1-kyle@kyleam.com>

Cc: Xinglu Chen <public@yoctocell.xyz>
---
 piem.texi | 35 +++++++++++++++++++++++++++++++++--
 1 file changed, 33 insertions(+), 2 deletions(-)

diff --git a/piem.texi b/piem.texi
index 070adf4..e3019c7 100644
--- a/piem.texi
+++ b/piem.texi
@@ -48,7 +48,7 @@ Top
 * Overview::
 * Getting started::
 * Applying patches::
-* Injecting messages into a Maildir directory::
+* Miscellaneous functionality::
 * Contributing::
 
 Appendices
@@ -383,8 +383,11 @@ Applying patches without a public-inbox archive
 b4-inspired patch extraction.
 
 \f
+@node Miscellaneous functionality
+@chapter Miscellaneous functionality
+
 @node Injecting messages into a Maildir directory
-@chapter Injecting messages into a Maildir directory
+@section Injecting messages into a Maildir directory
 @cindex Maildir
 
 public-inbox allows you to follow lists through several mechanisms
@@ -441,6 +444,34 @@ Injecting messages into a Maildir directory
       #'piem-notmuch-known-mid-p)
 @end lisp
 
+@node Copying public-inbox URLs
+@section Copying public-inbox URLs
+
+@findex piem-copy-mid-url
+When referring to a message from a public-inbox archive, a common format
+to use is a URL that points to a specific archive and ends with
+@code{/$INBOX/$MESSAGE_ID}, e.g.,
+@url{https://public-inbox.org/meta/20190108015420.GA28903@@dcvr}.
+Calling @code{piem-copy-mid-url} (available in the @code{piem-dispatch}
+transient) constructs such a URL, using the message ID and inbox
+asscociated with the current buffer, and then copies the URL to the kill
+ring.  When a prefix agument is given, @code{browse-url} is called after
+copying the URL.
+
+@vindex piem-browse-url-browser-function
+Note that EWW works nicely with public-inbox's HTTP interface.  If you'd
+prefer it to be invoked even though it's not your default browser (as
+configured by @code{browse-url-browser-function}), you can set
+@code{piem-browse-url-browser-function} to @code{eww-browse-url}.
+
+@findex piem-notmuch-mode
+@findex piem-notmuch-show-get-public-inbox-link
+For notmuch.el users, there's an additional entry point for copying
+public-inbox URLs: enabling @code{piem-notmuch-mode} adds a ``piem''
+candidate to archives offered by
+@code{notmuch-show-stash-mlarchive-link} and
+@code{notmuch-show-stash-mlarchive-link-and-go}.
+
 \f
 @node Contributing
 @chapter Contributing
-- 
2.30.0


  parent reply	other threads:[~2021-02-07  7:57 UTC|newest]

Thread overview: 10+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-02-07  7:57 [PATCH 0/5] New command for copying public-inbox URLs Kyle Meyer
2021-02-07  7:57 ` [PATCH 1/5] piem: Add helper to construct message ID link Kyle Meyer
2021-02-07  7:57 ` [PATCH 2/5] piem-dispatch: Add command for copying public-inbox URLs Kyle Meyer
2021-02-07  7:57 ` [PATCH 3/5] piem-copy-mid-url: Add support for browsing url Kyle Meyer
2021-02-07  7:57 ` [PATCH 4/5] piem-copy-mid-url: Allow overriding browse-url-browser-function Kyle Meyer
2021-02-07  7:57 ` Kyle Meyer [this message]
2021-02-07 12:38 ` [PATCH 0/5] New command for copying public-inbox URLs Xinglu Chen
2021-02-07 16:57   ` Kyle Meyer
2021-02-07 17:35     ` Kyle Meyer
2021-02-07 20:25       ` Xinglu Chen

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: https://git.kyleam.com/

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

  git send-email \
    --in-reply-to=20210207075738.8752-6-kyle@kyleam.com \
    --to=kyle@kyleam.com \
    --cc=piem@inbox.kyleam.com \
    --cc=public@yoctocell.xyz \
    --subject='Re: [PATCH 5/5] manual: Add section on "copy public-inbox link" functionality' \
    /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

discussion and development of piem

This inbox may be cloned and mirrored by anyone:

	git clone --mirror https://inbox.kyleam.com/piem/0 piem/git/0.git

	# If you have public-inbox 1.1+ installed, you may
	# initialize and index your mirror using the following commands:
	public-inbox-init -V2 piem piem/ https://inbox.kyleam.com/piem \
		piem@inbox.kyleam.com
	public-inbox-index piem

Example config snippet for mirrors.
Newsgroup available over NNTP:
	nntp://news.yhetil.org/yhetil.emacs.piem


code repositories for project(s) associated with this inbox:

	https://git.kyleam.com/piem/

AGPL code for this site: git clone http://ou63pmih66umazou.onion/public-inbox.git