====== SearchResultsWithPath Plugin ======

---- plugin ----
description: Displays Pages in Search Results with their containing Namespace when use_heading is on
author     : Sam B
email      : sam@s-blu.de
type       : Action
lastupdate : 2016-02-20
compatible : Elenor Of Tsort, Detritus, Greebo
depends    : 
conflicts  : 
similar    : 
tags       : Searchresult, search

downloadurl: https://github.com/s-blu/searchresultswithpath/zipball/master
bugtracker : https://github.com/s-blu/searchresultswithpath/issues
sourcerepo : https://github.com/s-blu/searchresultswithpath

screenshot_img : https://raw.githubusercontent.com/s-blu/searchresultswithpath/master/screenshot.jpg
----

===== Installation =====

Search and install the plugin using the [[plugin:extension|Extension Manager]]. 

Refer to [[:Plugins]] on how to install plugins manually. If you install this plugin manually, make sure it is installed in ''lib/plugins/searchresultswithpath/'' - if the folder is called different it
will not work!

===== Examples/Usage =====

See the plugin in action [[http://stardew-valley.de|here]]. 

This Plugin lets you display the path of a Page when you have "use_headings" set to "navigation" or "both" to use the first Heading of a Page for its Name. //It does nothing if you have navigation set to "content" or "none".//

Lets say you have the following pagestructure:

  * meta_animal (//A Meta-Animal //)
  * creatures (//Creatures//)
    * animal1 (//First Animal //)
    * oceanic
      * animal2 (//Second Animal //)
    * terran 
      * start (// Terran Animals //)
      * animal3 (//Third Animal //)

Searching for animal will get you a search result that looks like this:

With default settings: 

  * A Meta-Animal
  * First Animal [Creatures]
  * Second Animal [creatures:oceanic]
  * Third Animal [Terran Animals]

When use_ns_heading is turned off:

  * A Meta-Animal
  * First Animal [creatures]
  * Second Animal [creatures:oceanic]
  * Third Animal [creatures:terran]

===== Configuration and Settings =====

There are two Settings you can set via the Configuration GUI:

^ Key ^ Description ^ default ^
| use_ns_heading | Similar to use_headings: Use the first Heading of the namespace or namespace:start page as namespacename | on |
| show_path_only_as_heading | Only display the path if the first heading will be used as name - Omits displaying if a ID would be shown (this option gets ignored if use_ns_heading is turned off) | off |

=== Change Log ===

  * **2016-02-21**
    * Initial release

===== FAQ =====


===== Discussion =====

Feel free to report issues on the [[https://github.com/s-blu/searchresultswithpath/issues | Issue Tracker]] or discuss here.