help text in sidebar

5 files changed, 53 insertions, 0 deletions

diff --git a/data/config.php.dist b/data/config.php.dist
index 5c3eba8..9bd10e4 100644
--- a/data/config.php.dist
+++ b/data/config.php.dist
@@ -30,6 +30,8 @@ $GLOBALS['phinde'] = array(
     'showFullContent' => false,
     //search result "hit" template file
     'hitTemplate' => 'hit.htm',
+    //sidebar help text. empty to disable
+    'sidebarinclude' => 'search/sidebar-searchtips.htm',
     //default sort order: "score" or "date"
     'defaultSort' => 'score',
     //database for PuSH subscriptions
diff --git a/data/templates/search/sidebar-searchtips-chat.htm b/data/templates/search/sidebar-searchtips-chat.htm
new file mode 100644
index 0000000..2cce73a
--- /dev/null
+++ b/data/templates/search/sidebar-searchtips-chat.htm
@@ -0,0 +1,23 @@
+<hr/>
+<h4>Search tips</h4>
+<dl>
+ <dt>Exclusion</dt>
+ <dd><tt>+foo -bar</tt></dd>
+
+ <dt>Logical OR</dt>
+ <dd><tt>foo OR bar</tt></dd>
+
+ <dt>Exact phrase</dt>
+ <dd><tt>"foo bar"</tt></dd>
+
+  <dt>Partial words</dt>
+  <dd><tt>foo*</tt></dd>
+
+  <dt>Particular fields only</dt>
+  <dd><tt>title:foo</tt></dd>
+  <dd><tt>domain:example.org</tt></dd>
+  <dd><tt>nick:somebody</tt></dd>
+  <dd><tt>after:2016-11-23</tt></dd>
+  <dd><tt>before:2016-11-23</tt></dd>
+  <dd><tt>date:2016-11-23</tt></dd>
+</dl>
diff --git a/data/templates/search/sidebar-searchtips.htm b/data/templates/search/sidebar-searchtips.htm
new file mode 100644
index 0000000..f703d44
--- /dev/null
+++ b/data/templates/search/sidebar-searchtips.htm
@@ -0,0 +1,23 @@
+<hr/>
+<h4>Search tips</h4>
+<dl>
+ <dt>Exclusion</dt>
+ <dd><tt>+foo -bar</tt></dd>
+
+ <dt>Logical OR</dt>
+ <dd><tt>foo OR bar</tt></dd>
+
+ <dt>Exact phrase</dt>
+ <dd><tt>"foo bar"</tt></dd>
+
+  <dt>Partial words</dt>
+  <dd><tt>foo*</tt></dd>
+
+  <dt>Particular fields only</dt>
+  <dd><tt>title:foo</tt></dd>
+  <dd><tt>domain:example.org</tt></dd>
+  <dd><tt>author.name:Snowden</tt></dd>
+  <dd><tt>after:2016-11-23</tt></dd>
+  <dd><tt>before:2016-11-23</tt></dd>
+  <dd><tt>date:2016-11-23</tt></dd>
+</dl>
diff --git a/data/templates/search/sidebar.htm b/data/templates/search/sidebar.htm
index 0c663ee..9247f36 100644
--- a/data/templates/search/sidebar.htm
+++ b/data/templates/search/sidebar.htm
@@ -23,3 +23,7 @@
 <p class="muted">
  Query took {{queryTime}}.
 </p>
+
+{% if sidebarinclude %}
+  {% include sidebarinclude %}
+{% endif %}
diff --git a/www/index.php b/www/index.php
index 8bd900c..33adfb0 100644
--- a/www/index.php
+++ b/www/index.php
@@ -175,6 +175,7 @@ render(
         'sort' => $sort,
         'urlSorts' => $urlSorts,
         'hitTemplate' => 'search/' . $GLOBALS['phinde']['hitTemplate'],
+        'sidebarinclude' => $GLOBALS['phinde']['sidebarinclude'],
     )
 );
 ?>