From: Joey Hess <joey@kodama.kitenet.net>
Date: Wed, 4 Jun 2008 18:13:21 +0000 (-0400)
Subject: The search interface now allows searching for a page by title ("title:foo"), as well... 
X-Git-Url: https://sipb.mit.edu/gitweb.cgi/ikiwiki.git/commitdiff_plain/e4119f048c9ddd8795df378ff1ad676dca28de82

The search interface now allows searching for a page by title ("title:foo"), as well as for pages that contain a given link ("link:bar").
---

diff --git a/IkiWiki/Plugin/search.pm b/IkiWiki/Plugin/search.pm
index 29d31dfdc..249f267b9 100644
--- a/IkiWiki/Plugin/search.pm
+++ b/IkiWiki/Plugin/search.pm
@@ -62,7 +62,15 @@ sub index (@) { #{{{
 	
 	my $db=xapiandb();
 	my $doc=Search::Xapian::Document->new();
-	my $title=IkiWiki::pagetitle($params{page});
+	my $caption=IkiWiki::pagetitle($params{page});
+	my $title;
+	if (exists $pagestate{$params{page}}{meta} &&
+		exists $pagestate{$params{page}}{meta}{title}) {
+		$title=$pagestate{$params{page}}{meta}{title};
+	}
+	else {
+		$title=$caption;
+	}
 
 	# Remove html from text to be indexed.
 	if (! defined $scrubber) {
@@ -93,11 +101,12 @@ sub index (@) { #{{{
 	$doc->set_data(
 		"url=".urlto($params{page}, "")."\n".
 		"sample=".decode_entities($sample)."\n".
-		"caption=".decode_entities($title)."\n".
+		"caption=".decode_entities($caption)."\n".
 		"modtime=$IkiWiki::pagemtime{$params{page}}\n".
 		"size=".length($params{content})."\n"
 	);
 
+	# Index document and add terms for other metadata.
 	my $tg = Search::Xapian::TermGenerator->new();
 	if (! $stemmer) {
 		my $langcode=$ENV{LANG} || "en";
@@ -110,9 +119,15 @@ sub index (@) { #{{{
 	$tg->set_stemmer($stemmer);
 	$tg->set_document($doc);
 	$tg->index_text($params{page}, 2);
-	$tg->index_text($title, 2);
+	$tg->index_text($caption, 2);
+	$tg->index_text($title, 2) if $title ne $caption;
 	$tg->index_text($toindex);
+	$tg->index_text(lc($title), 1, "ZS"); # for title:foo
+	foreach my $link (@{$links{$params{page}}}) {
+		$tg->index_text(lc($link), 1, "ZLINK"); # for link:bar
+	}
 
+	# A unique pageterm is used to identify the document for a page.
 	my $pageterm=pageterm($params{page});
 	$doc->add_term($pageterm);
 	$db->replace_document_by_term($pageterm, $doc);
diff --git a/debian/changelog b/debian/changelog
index 34112ab26..6ce6bd067 100644
--- a/debian/changelog
+++ b/debian/changelog
@@ -9,6 +9,9 @@ ikiwiki (2.49) UNRELEASED; urgency=low
     prevent wikilinks added by filters from being scanned properly. But
     no known filter hook does that, so let's not waste time on it.
   * Pass a destpage parameter to the sanitize hook.
+  * The search interface now allows searching for a page by title
+    ("title:foo"), as well as for pages that contain a given link
+    ("link:bar").
 
  -- Joey Hess <joeyh@debian.org>  Fri, 30 May 2008 19:08:54 -0400
 
diff --git a/doc/ikiwiki/searching.mdwn b/doc/ikiwiki/searching.mdwn
new file mode 100644
index 000000000..0eeb5a6b9
--- /dev/null
+++ b/doc/ikiwiki/searching.mdwn
@@ -0,0 +1,20 @@
+[[!meta robots="noindex, follow"]]
+
+[[!if test="enabled(search)"
+then="This wiki has searching **enabled**."
+else="This wiki has searching **disabled**."]]
+
+If searching is enabled, you can enter search terms in the search field,
+like you'd expect. There are a few special things you can do to constuct
+more powerful searches.
+
+* To match a phrase, enclose it in double quotes.
+* `AND` can be used to search for documents containing two expressions.
+* `OR` can be used to search for documents containing either one of
+  two expressions.
+* Parentheses can be used to build up complicated search expressions. For
+  example, "(foo AND bar) OR (me AND you)"
+* Prefix a search term with "-" to avoid it from appearing in the results.
+  For example, "-discussion" will omit "discussion".
+* To search for a page with a given title, use "title:foo".
+* To search for pages that contain a "bar" link, use "link:bar".
diff --git a/doc/todo/search_terms.mdwn b/doc/todo/search_terms.mdwn
index 4e3f3aa6b..0e5edb520 100644
--- a/doc/todo/search_terms.mdwn
+++ b/doc/todo/search_terms.mdwn
@@ -3,3 +3,5 @@ searches. For example, "title:foo", or "link:somepage", or "author:foo", or
 "copyright:GPL".
 
 Reference: <http://xapian.org/docs/omega/termprefixes.html>
+
+[[done]] for title and link, which seem like the really useful ones.
diff --git a/templates/searchquery.tmpl b/templates/searchquery.tmpl
index 33a7cb6fa..bf36f3330 100644
--- a/templates/searchquery.tmpl
+++ b/templates/searchquery.tmpl
@@ -1,3 +1,5 @@
+$setmap{prefix,title,S}
+$setmap{prefix,link,LINK}
 $set{thousand,$.}$set{decimal,.}$setmap{BN,,Any Country,uk,England,fr,France}
 ${
 $def{PREV,
diff --git a/underlays/basewiki/ikiwiki/searching.mdwn b/underlays/basewiki/ikiwiki/searching.mdwn
new file mode 120000
index 000000000..d94120e36
--- /dev/null
+++ b/underlays/basewiki/ikiwiki/searching.mdwn
@@ -0,0 +1 @@
+../../../doc/ikiwiki/searching.mdwn
\ No newline at end of file