Extension:SearchParserFunction
リリースの状態: 安定 |
|
|---|---|
| 実装 | パーサー関数 , 検索 |
| 説明 | Adds a parser function to search, format and display search results in wiki pages. |
| 作者 | Sophivorus トーク |
| 最新バージョン | 2.1 |
| MediaWiki | >= 1.40.0 |
| データベースの変更 | いいえ |
| ライセンス | GNU 一般公衆利用許諾書 3.0 以降 |
| ダウンロード | |
| 例 | Appropedia |
| translatewiki.net で翻訳を利用できる場合は、SearchParserFunction 拡張機能の翻訳にご協力ください | |
The SearchParserFunction extension adds a parser function to search, format and display search results in wiki pages.
Installation
- ダウンロードして、ファイルを
extensions/フォルダー内のSearchParserFunctionという名前のディレクトリ内に配置します。
開発者とコード寄稿者は、上記の代わりに以下を使用してGitからインストールします:cdextensions/ gitclonehttps://gerrit.wikimedia.org/r/mediawiki/extensions/SearchParserFunction - 以下のコードを LocalSettings.php ファイルの末尾に追加します:
wfLoadExtension( 'SearchParserFunction' );
- Yes 完了 – ウィキの「
Special:Version」に移動して、拡張機能が正しくインストールされたことを確認します。
Usage
Basic usage
{{#search:foo}}
This will search for pages that contain foo and return the results as a list of links, like so:
You can use all available search operators. For example, if you're using CirrusSearch :
{{#search:foo incategory:"Bar" linksto:"Baz"}}
See Help:CirrusSearch for all available search operators (or API:検索 if you're not using CirrusSearch).
Parameters
| Name | Default | Description |
|---|---|---|
namespace |
0 | Namespace to search. Separate multiple values with commas. (See namespace constants .) |
limit |
10 | Max number of results, should be either an integer or 'max'. |
offset |
0 | Number of results to skip, useful to access results beyond the 'max' limit. |
profile |
Ranking algorithm to use, defaults to let the engine decide. | |
what |
'text'
|
Type of search to perform, either 'text', 'title' or 'nearmatch'.
'title' doesn't work when CirrusSearch is enabled (use intitle instead).
|
interwiki |
Include interwiki results in the search, if available. | |
rewrites |
Enable internal query rewriting, for example to correct spelling mistakes. | |
sort |
'relevance' |
Sorting criteria. |
format |
'list' |
Format of the search results. (See below for more.) |
For example, to get the name of the latest file that has foo in the title:
{{#search: foo | namespace = 6 | limit = 1 | what = title | sort = create_timestamp_asc | format = plain }}
Formats
List
Returns an unordered list (<ul>) of search results, linked to their pages.
For example:
Count
Returns the total number of search results as a plain number.
Plain
Returns a comma-separated list of plain titles. For example:
Foo, Bar, Baz
This format is designed for further processing. For example, using the #arraymap function of Extension:PageForms :
{{#arraymap: {{#search:foo}} | , | @ | [[@]] | <br> }}
This would output the search results one below the other and linked to their pages, like so:
If some of the titles contain commas, you can change the separator like so:
{{#search:foo|separator=;}}
JSON
Returns a JSON object for further processing, for example in a Lua module .
Note that this format returns the entire output from the Search API, not just the search results.
Template
Returns the search results wrapped in a template. The search result title is passed to the template as an unnamed parameter {{{1}}} and may be used or ignored.
For example, if a template named "Search result" contained the following:
<divstyle="border: 1px solid #aaa; border-radius: 10px; margin: 1em 0; padding: 1em; max-width: 600px;"> <spanstyle="font-size:120%">[[{{{1}}}]]</span> <p>{{fullurl:{{{1}}}}}</p> </div>
then a query such as:
{{#search: foo | format = template | template = Search result }}
would output something like this:
Hooks
SearchParserFunctionQuery
Use this hook to customize the query to the Search API.
SearchParserFunctionOutput
Use this hook to add or modify search result formats.
See also
- Extension:SemanticMediaWiki - Much more sophisticated and powerful, but also much more complicated and difficult to maintain. #ask queries can do much than #search can't, but #search can also do some things that #ask can't, such as simple full-text search.
- Extension:DynamicPageList - List pages by category and other criteria.
- Appropedia:Template:Search results - Real use case of this extension.