This package implements all modules for keyword search, search management and scheduling.
Site search keywords are extracted from all pages (accessible by anonymous and logged in users) by the Scheduler at regular intervals. Only pages with the Anonymous or User role (see Roles) are included when extracting search keywords. Other roles are not accessible.
The YetaWF.Search package requires a SQL database to store search keywords.
In order to enable use of a PostgreSQL or SQL DB by the Visitors Package, a connection string has to be defined in your AppSettings.json file:
"P": { . . . "YetaWF_Search_Data": { . . . "IOMode": "Sql", "SQLDbo": "dbo", "SQLConnect": "Data Source=....;Initial Catalog=....;User ID=....;Password=...." }, "YetaWF_Search_Urls": { . . . "IOMode": "Sql", "SQLDbo": "dbo", "SQLConnect": "Data Source=....;Initial Catalog=....;User ID=....;Password=...." },
Uses the YetaWF_Search Site component to create all pages necessary for your search results page, administrator and configuration pages.
The Search Module can be added to any page, even as a skin module so site visitors can enter search terms to search your pages. The Search Results Module is used to display search results. The Search Results Module is located on the /SearchResults page (when using the YetaWF_Search Site Component).
Your search terms will not be available immediately. The scheduler is set up to extract them at regular intervals. Use the Search Keywords Module to immediately extract search terms using its Collect Keywords action. This task may run for a long time.
The Scheduler Module, see Admin > Panel > Scheduler (standard YetaWF site), can be used to define when search keywords are extracted. The Scheduler Item "Extract Search Keywords From Pages" defines the frequency.
Module Name | Description |
---|---|
Edit Search Item Module | Used to edit an existing search term. This is used by the Search Keywords Module to edit a search term. |
Search Input Module | Allow search term input. |
Search Keywords Module | Displays and manages search keywords that were found in the site's pages. It is accessible using Admin > Panel > Search Keywords (standard YetaWF site). This module offers a Collect Keywords action, which can be used to extract all page keywords immediately (instead of by the Scheduler at regular intervals). This task may run for a long time. Editing and removing a search keyword is available in the Search Keywords grid shown by the Search Keywords Module. |
Search Results Module | Displays search results. The Search Input Module uses the Search Results Module. |
Search Results Highlighter (Skin) Module | Highlights any search terms found on the current page displayed. It can be included as a skin module or referenced by a site, page or module (see References tab in Page, Module or Site Settings). See Skin Modules for more information. |
Search Settings Module | Main configuration module for search settings. It is accessible using Admin > Settings > Search Settings (standard YetaWF site). |
The YetaWF.Search package is part of YetaWF, an open source product licensed under the GNU General Public License, version 3 (GPL-3.0) - Copyright - Softel vdm, Inc.
Last Updated 04/24/2022 - (email)
© 2023 - Softel vdm, Inc. - YetaWF.com