Difference between revisions of "Search"

From Online Manual

Jump to: navigation, search
(TOC doesn't show when using h2 I guess.)
(Undo revision 24847 by Chainy (talk))
 
(48 intermediate revisions by 7 users not shown)
Line 1: Line 1:
 +
{{Other languages}}
 
{{TOCright}}
 
{{TOCright}}
== Weights ==
 
On the '''Weights''' page you can control some weights for searching to help you control what type of search results you get.
 
  
* ''' Relative search weight for number of matching messages within a topic''' - Weight factors are used to determine the relevancy of a search result. Change these weight factors to match the things that are specifically important for your forum. For instance, a forum of a news site, might want a relatively high value for 'age of last matching message'. All values are relative in relation to each other and should be positive integers. This factor counts the amount of matching messages and divides them by the total number of messages within a topic.
+
<small><translate><!--T:1-->
* '''Relative search weight for age of last matching message''' - Similar to the above. This factor rates the age of the last matching message within a topic. The more recent this message is, the higher the score.
+
If you are looking for the search settings, see {{llink|Search (admin)|text=Search (admin)}}</translate></small>
* '''Relative search weight for topic length''' - Similar to the above. This factor is based on the topic size. The more messages are within the topic, the higher the score.
 
* '''Relative search weight for a matching subject''' - Similar to the above. This factor looks whether a search term can be found within the subject of a topic.
 
* '''Relative search weight for a first message match''' - Similar to the above. This factor looks whether a match can be found in the first message of a topic.
 
* '''Relative search weight for a sticky topic''' - This factor looks whether a topic is sticky and increases the relevancy score if it is.
 
  
== Search Method ==
+
<translate><!--T:2-->
On the '''Search method''' page you can select the method of searching that you would like to use that impacts the results from searching. The following methods of searching are available:
+
The SMF default theme and its derivatives have a simple search field in the collapsible header as well as a search link in the main menu. Using the link in the main menu, users can also access the advanced search screen. Administrators can choose to disable search or regulate the search permissions for users.
  
*'''No Index''' - Check this if you want no search index to be created when searching your forum.
+
== Simple Search == <!--T:3-->
*'''Fulltext index''' - Check this if you want to use a fulltext index when searching your forum. You will need to click on the link below: [create fulltext index] first before you can select this option.
 
*'''Custom index''' - Check this if you want to use a custom index when searching your forum. You will need to click on the link below: [create fulltext index] first before you can select this option.
 
*'''Force the use of a search index:''' Checking this will force the use of a search index.
 
*'''Match whole words only:''' - Using this will match only full words when searching. An example can be if a post has the word 'strictly' in it. When searching for 'strict' with this option checked, you will not get any results back, but with the option unchecked, you will get results.
 
  
==Settings==
+
<!--T:4-->
* '''Enable simple search''' - This will show a simple search form and a link to a more advanced form.
+
The simple search field located at the top of the default SMF theme will, when viewing topics, filter search results to just that topic. The same applies to boards as well - when viewing a board the simple search field will filter the search to just results in that particular board.
* '''Only search for complete word matches''' - This option limit search results to full words that match a users query. For example, if this option is disabled, a search term like 'here' would match 'here', 'there', and 'hereafter'. Enabling this option would limit search results to only match 'here. Please notice that enabling this option might slow down the search function, especially if the amount of messages is large.
 
* '''Disable temporary tables''' - This option prevents the usage of temporary tables. Since this option makes search queries slower, it's advisable to only use it if you don't have permissions to create temporary tables.
 
* '''Number of search results per page''' - The amount of results per page that will be shown after searching for a string.
 
* '''Maximum cached searches''' - Search caching is used to limit the amount of extensive database queries. Once the user has entered a search query, the results are cached in the database. This way, the next pages of the search results are already available without need for extensive search. Use this setting to limit the amount of cached results. Increasing this value requires a larger database (about 20kb for each cached result).
 
* '''Relative search weight for number of matching messages within a topic''' - Weight factors are used to determine the relevancy of a search result. Change these weight factors to match the things that are specifically important for your forum. For instance, a forum of a news site, might want a relatively high value for 'age of last matching message'. All values are relative in relation to each other and should be positive integers. This factor counts the amount of matching messages and divides them by the total number of messages within a topic.
 
* '''Relative search weight for age of last matching message''' - Similar to the above. This factor rates the age of the last matching message within a topic. The more recent this message is, the higher the score.
 
* '''Relative search weight for topic length''' - Similar to the above. This factor is based on the topic size. The more messages are within the topic, the higher the score.
 
* '''Relative search weight for a matching subject''' - Similar to the above. This factor looks whether a search term can be found within the subject of a topic.
 
* '''Relative search weight for a first message match''' - Similar to the above. This factor looks whether a match can be found in the first message of a topic.
 
  
 +
<!--T:5-->
 +
While you can just type and search for any combination of characters, you should consider using {{llink|anchor=Modifiers|text=modifiers}} to make the search really work for you.
  
[[Category:Searching]]
+
<!--T:6-->
{{As an administrator}}
+
The search tool searches the entire {{llink|forum|text=forum}} for any or all of what you specify that has been posted during the last 9999 days (which is more than 27 years)! To take more control of your search, you should use the advanced search feature.
 +
 
 +
== Advanced Search == <!--T:7-->
 +
 
 +
<!--T:8-->
 +
Although the advanced search screen might initially seem a little intimidating if a forum has many boards and child boards, it is surprisingly straightforward when reduced to its basic components.</translate>
 +
<translate>
 +
<!--T:8.1-->
 +
*Despite initial appearances, there are really three options for how to search, with ''Match all words'' and ''Match any words'' being available from the drop-down menu, and ''Match as phrase'' also an option.</translate>
 +
<translate>
 +
<!--T:8.2-->
 +
*The default * in the ''By user'' field is essentially a wildcard matching any poster. Please note that, while you can replace this with any single username for a more specific search, it is not possible to search for posts by multiple users.</translate>
 +
<translate>
 +
<!--T:8.3-->
 +
*''Show results as messages'' returns the full message containing the search string (with a reply option) instead of the usual linked excerpt, but will naturally result in much larger results pages which might be significant if you are searching for a popular word or phrase.
 +
*''Message age'' sets the minimum and maximum ages of posts to search.</translate>
 +
<translate>
 +
<!--T:8.4-->
 +
*''Choose a {{llink|board|text=board}} to search in'' provides you with another tool to narrow the scope of the search, with the default being 'all' (the whole forum or, more properly, all the boards to which you have read access). To search by board you need to expand the list of boards by clicking on ''Choose a board to search in, or search all'' and select which boards to search in and check the correct box.</translate>
 +
<translate>
 +
<!--T:8.5-->
 +
*The ''Search'' button not surprisingly sets the whole thing in motion, but pressing 'Enter' direct from any of the search fields is sometimes more convenient.</translate>
 +
<translate>
 +
 
 +
== Modifiers == <!--T:9-->
 +
 
 +
<!--T:10-->
 +
Using the simple or advanced search methods, you can still use search modifiers. These are powerful special characters which modify the way in which SMF handles your search string.</translate>
 +
<translate>
 +
<!--T:10.1-->
 +
*'''Phrase search''' - use double quotes (") around your term ("search term") to search for the search term as a phrase instead of individual words.</translate>
 +
<translate>
 +
<!--T:10.2-->
 +
*'''Excluding terms''' - use a minus sign in front of terms you would like to exclude from the search result. For instance, "search -term" will search for "search" but not "term". The minus sign must have a space prior to it.
 +
More search modifiers may be found at [http://www.google.com/support/websearch/bin/answer.py?hl=en&answer=136861 Google's help page]. Not all of them may be useful in SMF at the present time.</translate>
 +
<translate>
 +
 
 +
== Search Options == <!--T:11-->
 +
 
 +
<!--T:12-->
 +
See {{llink|Search (admin)|text=Search (admin)}} for options for the administrator to configure searching.
 +
</translate>
 +
{{ {{Localized|As a regular user}}}}

Latest revision as of 09:17, 10 May 2014

If you are looking for the search settings, see Search (admin)

The SMF default theme and its derivatives have a simple search field in the collapsible header as well as a search link in the main menu. Using the link in the main menu, users can also access the advanced search screen. Administrators can choose to disable search or regulate the search permissions for users.

Simple Search

The simple search field located at the top of the default SMF theme will, when viewing topics, filter search results to just that topic. The same applies to boards as well - when viewing a board the simple search field will filter the search to just results in that particular board.

While you can just type and search for any combination of characters, you should consider using modifiers to make the search really work for you.

The search tool searches the entire forum for any or all of what you specify that has been posted during the last 9999 days (which is more than 27 years)! To take more control of your search, you should use the advanced search feature.

Advanced Search

Although the advanced search screen might initially seem a little intimidating if a forum has many boards and child boards, it is surprisingly straightforward when reduced to its basic components.

  • Despite initial appearances, there are really three options for how to search, with Match all words and Match any words being available from the drop-down menu, and Match as phrase also an option.
  • The default * in the By user field is essentially a wildcard matching any poster. Please note that, while you can replace this with any single username for a more specific search, it is not possible to search for posts by multiple users.
  • Show results as messages returns the full message containing the search string (with a reply option) instead of the usual linked excerpt, but will naturally result in much larger results pages which might be significant if you are searching for a popular word or phrase.
  • Message age sets the minimum and maximum ages of posts to search.
  • Choose a board to search in provides you with another tool to narrow the scope of the search, with the default being 'all' (the whole forum or, more properly, all the boards to which you have read access). To search by board you need to expand the list of boards by clicking on Choose a board to search in, or search all and select which boards to search in and check the correct box.
  • The Search button not surprisingly sets the whole thing in motion, but pressing 'Enter' direct from any of the search fields is sometimes more convenient.

Modifiers

Using the simple or advanced search methods, you can still use search modifiers. These are powerful special characters which modify the way in which SMF handles your search string.

  • Phrase search - use double quotes (") around your term ("search term") to search for the search term as a phrase instead of individual words.
  • Excluding terms - use a minus sign in front of terms you would like to exclude from the search result. For instance, "search -term" will search for "search" but not "term". The minus sign must have a space prior to it.

More search modifiers may be found at Google's help page. Not all of them may be useful in SMF at the present time.

Search Options

See Search (admin) for options for the administrator to configure searching.