user/dev discussion of public-inbox itself
 help / color / mirror / code / Atom feed
Search results ordered by [date|relevance]  view[summary|nested|Atom feed]
thread overview below | download mbox.gz: |
* Re: [PATCH 0/2] begin online help for each public-inbox
  2016-08-18  9:51  5% [PATCH 0/2] begin online help for each public-inbox Eric Wong
  2016-08-18  9:51  7% ` [PATCH 2/2] searchview: link to internal help text Eric Wong
@ 2016-08-18 19:29  0% ` Philip Oakley
  1 sibling, 0 replies; 3+ results
From: Philip Oakley @ 2016-08-18 19:29 UTC (permalink / raw)
  To: Eric Wong, meta

From: "Eric Wong" <e@80x24.org>
To: <meta@public-inbox.org>
Cc: "Philip Oakley" <philipoakley@iee.org>
Sent: Thursday, August 18, 2016 10:51 AM
Subject: [PATCH 0/2] begin online help for each public-inbox


>I expect this will be tweaked and edited heavily in coming
> weeks, but this at least a start.

Eric, was this also meant to go to the list?

>
> I'll be keeping everything within the constraints of a
> plain-text email, so no cheating with styling or #fragment
> tags, and definitely no deceptive hiding of URLs to external
> resources.
>
> Fortunately, deploying changes are cheap and relatively
> risk-free with zero user-visible downtime
> (which also needs to be documented :x)
>
> Thanks to Philip Oakley at the git list for reminding me the
> design_www document is actually helpful to users, not just
> hackers :)
>
> 
> https://public-inbox.org/git/D5A2E231FFE74D1C891A1653E1C2D797@PhilipOakley/
>
> Eric Wong (2):
>  www: implement generic help text
>  searchview: link to internal help text
>
> MANIFEST                      |   2 +
> lib/PublicInbox/Search.pm     |  38 ++++++++
> lib/PublicInbox/SearchView.pm |   5 +-
> lib/PublicInbox/WWW.pm        |  14 +++
> lib/PublicInbox/WwwStream.pm  |   4 +-
> lib/PublicInbox/WwwText.pm    | 201 
> ++++++++++++++++++++++++++++++++++++++++++
> t/psgi_text.t                 |  39 ++++++++
> 7 files changed, 299 insertions(+), 4 deletions(-)
> create mode 100644 lib/PublicInbox/WwwText.pm
> create mode 100644 t/psgi_text.t
>
> -- 
> EW
> 


^ permalink raw reply	[relevance 0%]

* [PATCH 2/2] searchview: link to internal help text
  2016-08-18  9:51  5% [PATCH 0/2] begin online help for each public-inbox Eric Wong
@ 2016-08-18  9:51  7% ` Eric Wong
  2016-08-18 19:29  0% ` [PATCH 0/2] begin online help for each public-inbox Philip Oakley
  1 sibling, 0 replies; 3+ results
From: Eric Wong @ 2016-08-18  9:51 UTC (permalink / raw)
  To: meta; +Cc: Philip Oakley

The internal help text links to the Xapian query parser
documentation anyways, but also provides information
on which prefixes exist.
---
 lib/PublicInbox/SearchView.pm | 5 ++---
 1 file changed, 2 insertions(+), 3 deletions(-)

diff --git a/lib/PublicInbox/SearchView.pm b/lib/PublicInbox/SearchView.pm
index 3623a78..4f0811a 100644
--- a/lib/PublicInbox/SearchView.pm
+++ b/lib/PublicInbox/SearchView.pm
@@ -85,12 +85,11 @@ sub mset_summary {
 
 sub err_txt {
 	my ($ctx, $err) = @_;
-	my $u = '//xapian.org/docs/queryparser.html';
-	$u = PublicInbox::Hval::prurl($ctx->{env}, $u);
+	my $u = $ctx->{-inbox}->base_url($ctx->{env}) . '_/text/help/';
 	$err =~ s/^\s*Exception:\s*//; # bad word to show users :P
 	$err = ascii_html($err);
 	"\nBad query: <b>$err</b>\n" .
-		qq{See <a\nhref="$u">$u</a> for Xapian query syntax};
+		qq{See <a\nhref="$u">$u</a> for help on using search};
 }
 
 sub search_nav_top {
-- 
EW


^ permalink raw reply related	[relevance 7%]

* [PATCH 0/2] begin online help for each public-inbox
@ 2016-08-18  9:51  5% Eric Wong
  2016-08-18  9:51  7% ` [PATCH 2/2] searchview: link to internal help text Eric Wong
  2016-08-18 19:29  0% ` [PATCH 0/2] begin online help for each public-inbox Philip Oakley
  0 siblings, 2 replies; 3+ results
From: Eric Wong @ 2016-08-18  9:51 UTC (permalink / raw)
  To: meta; +Cc: Philip Oakley

I expect this will be tweaked and edited heavily in coming
weeks, but this at least a start.

I'll be keeping everything within the constraints of a
plain-text email, so no cheating with styling or #fragment
tags, and definitely no deceptive hiding of URLs to external
resources.

Fortunately, deploying changes are cheap and relatively
risk-free with zero user-visible downtime
(which also needs to be documented :x)

Thanks to Philip Oakley at the git list for reminding me the
design_www document is actually helpful to users, not just
hackers :)

  https://public-inbox.org/git/D5A2E231FFE74D1C891A1653E1C2D797@PhilipOakley/

Eric Wong (2):
  www: implement generic help text
  searchview: link to internal help text

 MANIFEST                      |   2 +
 lib/PublicInbox/Search.pm     |  38 ++++++++
 lib/PublicInbox/SearchView.pm |   5 +-
 lib/PublicInbox/WWW.pm        |  14 +++
 lib/PublicInbox/WwwStream.pm  |   4 +-
 lib/PublicInbox/WwwText.pm    | 201 ++++++++++++++++++++++++++++++++++++++++++
 t/psgi_text.t                 |  39 ++++++++
 7 files changed, 299 insertions(+), 4 deletions(-)
 create mode 100644 lib/PublicInbox/WwwText.pm
 create mode 100644 t/psgi_text.t

-- 
EW

^ permalink raw reply	[relevance 5%]

Results 1-3 of 3 | reverse | options above
-- pct% links below jump to the message on this page, permalinks otherwise --
2016-08-18  9:51  5% [PATCH 0/2] begin online help for each public-inbox Eric Wong
2016-08-18  9:51  7% ` [PATCH 2/2] searchview: link to internal help text Eric Wong
2016-08-18 19:29  0% ` [PATCH 0/2] begin online help for each public-inbox Philip Oakley

Code repositories for project(s) associated with this public inbox

	https://80x24.org/public-inbox.git

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).