diff --git a/code/DocumentationSearch.php b/code/DocumentationSearch.php index 993d6ba..e708e4f 100755 --- a/code/DocumentationSearch.php +++ b/code/DocumentationSearch.php @@ -30,6 +30,11 @@ class DocumentationSearch { * @var bool - Is search enabled */ private static $enabled = false; + + /** + * @var bool - Is advanced search enabled + */ + private static $advanced_search_enabled = true; /** * @var string - OpenSearch metadata. Please use {@link DocumentationSearch::set_meta_data()} @@ -171,6 +176,20 @@ class DocumentationSearch { return self::$enabled; } + /** + * Enable advanced documentation search + */ + public static function enable_advanced_search($enabled = true) { + self::$advanced_search_enabled = ($enabled)? true: false; + } + + /** + * @return bool + */ + public static function advanced_search_enabled() { + return self::$advanced_search_enabled; + } + /** * @param string */ diff --git a/code/controllers/DocumentationViewer.php b/code/controllers/DocumentationViewer.php index 1a7bcb6..af75196 100755 --- a/code/controllers/DocumentationViewer.php +++ b/code/controllers/DocumentationViewer.php @@ -973,6 +973,17 @@ class DocumentationViewer extends Controller { return $form; } + + /** + * check if the Advanced SearchForm can be displayed + * enabled by default, to disable use: + * DocumentationSearch::enable_advanced_search(false); + * + * @return bool + */ + public function getAdvancedSearchEnabled() { + return DocumentationSearch::advanced_search_enabled(); + } /** * Check to see if the currently accessed version is out of date or diff --git a/docs/en/index.md b/docs/en/index.md index 572cf89..f2e29c4 100755 --- a/docs/en/index.md +++ b/docs/en/index.md @@ -65,6 +65,13 @@ documentation search needs to be updated on the fly sake dev/tasks/RebuildLuceneDocsIndex flush=1 +## Advanced Search + +Advanced Search is enabled by default on the searchresults page, allowing you to +extend your search over multiple modules and/or versions. Advanced search can +be disabled from your _config.php like this: + + DocumentationSearch::enable_advanced_search(false); ## Using a URL other than /dev/docs/ diff --git a/templates/Layout/DocumentationViewer_results.ss b/templates/Layout/DocumentationViewer_results.ss index b91647a..06a2b0f 100755 --- a/templates/Layout/DocumentationViewer_results.ss +++ b/templates/Layout/DocumentationViewer_results.ss @@ -43,10 +43,13 @@ <% end_if %> - \ No newline at end of file