Changes between Version 7 and Version 8 of SearchAllPlugin

Timestamp:

Oct 4, 2017, 1:37:39 PM (7 years ago)

Author:

figaro

Comment:

Moved example to description

SearchAllPlugin

@@ -1 +1 @@
 [[PageOutline(2-5,Contents,pullout)]]
 
-= Trac Search All Projects Plugin
+= Search in all Trac projects
 
 == Description
 
-This plugin provides a new search option to search in all the projects in the current multi-project environment.
+This plugin provides functionality to search within all the projects in a multi-project environment setup.
+
+This plugin will work in a multi-project environment, as it will search all projects in the environment folder. For example, you can use it by having a multi-project environment, where one project is the ''master'' project, and has SearchAllPlugin enabled.
+
+By default, the search will be performed within all projects.
+
+You can also limit the search to certain projects, by adding the projects to your `trac.ini` file:
+
+{{{#!ini
+[searchall]
+include_projects = project1, project2, project3
+}}}
+
+This will search only in projects ''project1'', ''project2'' and ''project3''.
+
+Or you can exclude projects from the search as follows:
+
+{{{#!ini
+[searchall]
+exclude_projects = project1, project2
+}}}
+
+This will search in all projects '''except''' ''project1'' and ''project2''.
 
 == Bugs/Feature Requests
@@ -27 +49 @@
 == Installation
 
+General instructions on installing Trac plugins can be found on the [TracPlugins#InstallingaTracplugin TracPlugins] page.
+
 To enable the plugin, add the following line to the ''components'' section in your `trac.ini` file:
 {{{#!ini
@@ -37 +61 @@
 A new checkbox '''Search All Projects''' will appear in the Search page.
 
-== Example
-
-This plugin will work in a multi-project environment, as it will search all projects in the environment folder. For example, you can use it by having a multi-project environment, where one project is the ''master'' project, and has SearchAllPlugin enabled.
-
-You can also limit search to a list of projects, adding to `trac.ini`:
-
-{{{#!ini
-[searchall]
-include_projects=project1, project2, project3
-}}}
-
-This will search only in projects ''project1'', ''project2'' and ''project3''. If this option is not set, it will default to search in all projects.
-
-Or you can exclude projects from the search with:
-
-{{{#!ini
-[searchall]
-exclude_projects=project1, project2
-}}}
-
-This will search in all projects '''except''' ''project1'' and ''project2''.
-
 == Recent Changes