Difference between revisions of "Reference:BlueSpiceTagSearch"

m
(Tag: 2017 source edit)
 
BlueSpiceTagSearch
allows the integration of a configurable search field in articles.
Status: stable
Developer: HalloWelt
Extension type: BlueSpice
Edition: BlueSpice pro
Dependencies: BlueSpice
License: GPL v3 only
Activated: Yes
Category: Rich Articles
Documentation on MediaWiki.org

Description[edit | edit source]

BlueSpiceTagSearch allows the integration of a configurable search field in articles, by providing tag that can be inserted on page. This search field relies on BlueSpiceExtendedSearch.

Usage / Features[edit | edit source]

A tag will be made available, with which a configurable search field can be integrated into a page.

This tag can be configured in the following ways:

  • Namespaces: Sets the namespaces, which should be browsed. You can indicate it by ID or by name of the namespace. With administration rights you have access to the NamespaceManager in which you can find all namespaces including the related IDs. A multiple entry is possible, separated by a pipe symbol (|). Default: Like set in the ExtendedSearch.
  • Categories: Sets the categories, which should be browsed. A multiple entry is possible, separated by pipe symbol (|). Default: No category is defined.
  • Operator: Sets the type of search, affecting the search result output, when you insert multiple search terms. It is possible to use "AND- and "OR"-operators. Default: AND

Overview

Variable Significance Configuration Standard
cat="Name_of_Category" Set the categories, which should be browsed. You can set multiple categories here, separated by a pipe symbol (|) No category is set, all categories will be browsed.
ns="Title_or_ID_of_Namespace" Set the namespace(s), which should be browsed. Set title or ID of the namespace(s). You can set multiple namespaces here, separated by a pipe symbol (|). The same configuration is used, which is determined for ExtendedSearch.
operator="AND/OR" Set an operator Operator to be be applied to category filter (not applicable to namespaces as one result cannot have multiple namespaces). "AND"

With the supplied tag it is possible to integrate a configurable search field into a site. This function depends on the ExtendedSearch.
Tag: <bs:tagsearch></bs:tagsearch>

Technical information[edit | edit source]

Configuration[edit | edit source]

This extension offers no configurations.

Rights (permissions)[edit | edit source]

This extension does not require any special rights.

Requirements[edit | edit source]

TagSearch requires BlueSpiceFoundation.

User manual[edit | edit source]

For detailed description and usage please visit our user manual.

Icon-note.png
Note

TagSearch is included in the BlueSpice package ServiceCenter, which is an extension requiring payment. Click here for further information.

Try free our BlueSpice[edit | edit source]

BlueSpiceDemo.

Icon-note.png
Note

Organize your categories with care, because this is a prerequisite for helpful search results. This means on the one hand, that categories need to be set up in the system already, on the other hand that articles are already related to those categories. Also pay attention on the appropriate configuration of the "tagsearch" and the "toplist". The search box and the related Toplist need to be configured with the same categories and namespaces.

{{BSExtensionInfobox
        
        |desc=allows the integration of a configurable search field in articles.
        
        |status=stable
        
        |developer=HalloWelt
        
        |type=BlueSpice
        
        |edition=BlueSpice pro
        
        |active=Yes
        
        |compatible=BlueSpice
        
        |category=Rich Articles
        
        |license=GPL v3 only
        
        |docu=https://www.mediawiki.org/wiki/Extension:TagSearch
        
        |package=ServiceCenter
        
        }}
        
        __TOC__
        

        ==Description==
        
        '''BlueSpiceTagSearch''' allows the integration of a configurable search field in articles, by providing tag that can be inserted on page. This search field relies on [[Manual:Extension/BlueSpiceExtendedSearch|BlueSpiceExtendedSearch]].
        

        ==Usage / Features==
        
        A tag will be made available, with which a configurable search field can be integrated into a page.
        

        This tag can be configured in the following ways:
        

        *Namespaces: Sets the namespaces, which should be browsed. You can indicate it by ID or by name of the namespace. With administration rights you have access to the [[Reference:NamespaceManager|NamespaceManager]] in which you can find all namespaces including the related IDs. A multiple entry is possible, separated by a pipe symbol (|). 
            '''Default''': Like set in the [[Reference:ExtendedSearch|ExtendedSearch]].
        

        *Categories: Sets the categories, which should be browsed. A multiple entry is possible, separated by pipe symbol (|). 
            '''Default''': No category is defined.
        

        *'''Operator''': Sets the type of search, affecting the search result output, when you insert multiple search terms. It is possible to use "AND- and "OR"-operators. 
            '''Default''': AND
            
'''Overview'''
        

        {| class="contenttable" style="width: 700px;" border="0"
        
        |-
        
        !|'''Variable'''
        
        !|'''Significance'''
        
        !|'''Configuration'''
        
        !|'''Standard'''
        
        |-
        
        ||cat="Name_of_Category"
        
        ||Set the categories, which should be browsed.
        
        ||<nowiki>You can set multiple categories here, separated by a pipe symbol (|)</nowiki>
        
        ||No category is set, all categories will be browsed.
        
        |-
        
        ||ns="Title_or_ID_of_Namespace"
        
        ||Set the namespace(s), which should be browsed.
        
        ||<nowiki>Set title or ID of the namespace(s). You can set multiple namespaces here, separated by a pipe symbol (|).</nowiki>
        
        ||The same configuration is used, which is determined for [[Reference:ExtendedSearch|ExtendedSearch]].
        
        |-
        
        ||operator="AND/OR"
        
        ||Set an operator
        
        ||Operator to be be applied to category filter (not applicable to namespaces as one result cannot have multiple namespaces).
        
        ||"AND"
        
        |}
        

        With the supplied tag it is possible to integrate a configurable search field into a site. This function depends on the [[Reference:ExtendedSearch|ExtendedSearch]].<br />'''Tag''': <code><nowiki><bs:tagsearch></bs:tagsearch></nowiki></code>
        

        ==Technical information==
        
        ===Configuration===
        
        This extension offers no configurations.
        

        ===Rights (permissions)===
        
        This extension does not require any special rights.
        

        ===Requirements===
        
        TagSearch requires [[Reference:BlueSpiceFoundation|BlueSpiceFoundation]].
        

        ==User manual==
        
        For detailed description and usage please visit our [[Manual:Extension/TagSearch|user manual.]]
        

            
            {{Box_Note|Note text = TagSearch is included in the BlueSpice package '''ServiceCenter''',  which is an extension requiring payment. Click [[ServiceCenter|here]] for further information.}}
            

            ====Try free our BlueSpice==
        
        [https://en.demo.bluespice.com/wiki/Main_Page BlueSpiceDemo.]
        
            
{{Box_Note|Note text = Organize your categories with care, because this is a prerequisite for helpful search results. This means on the one hand, that categories need to be set up in the system already, on the other hand that articles are already related to those categories. Also pay attention on the appropriate configuration of the "tagsearch" and the "toplist". The search box and the related Toplist need to be configured with the same categories and namespaces.
        
        }}
        

            
            [[de:Referenz:{{PAGENAME}}]]
            
            [[en:Reference:{{PAGENAME}}]]
            
{{Translation}}
            
[[Category:BlueSpice_pro]]
        
        [[Category:Extension]]
Line 22: Line 22:
 
This tag can be configured in the following ways:
 
This tag can be configured in the following ways:
  
*Namespaces: Sets the namespaces, which should be browsed. You can indicate it by ID or by name of the namespace. With administration rights you have access to the [[Reference:NamespaceManager|NamespaceManager]] in which you can find all namespaces including the related IDs. A multiple entry is possible, separated by a pipe symbol (|).
+
*Namespaces: Sets the namespaces, which should be browsed. You can indicate it by ID or by name of the namespace. With administration rights you have access to the [[Reference:NamespaceManager|NamespaceManager]] in which you can find all namespaces including the related IDs. A multiple entry is possible, separated by a pipe symbol (|). '''Default''': Like set in the [[Reference:ExtendedSearch|ExtendedSearch]].
  
'''Default''': Like set in the [[Reference:ExtendedSearch|ExtendedSearch]].
+
*Categories: Sets the categories, which should be browsed. A multiple entry is possible, separated by pipe symbol (|). '''Default''': No category is defined.
  
*Categories: Sets the categories, which should be browsed. A multiple entry is possible, separated by pipe symbol (|).
+
*'''Operator''': Sets the type of search, affecting the search result output, when you insert multiple search terms. It is possible to use "AND- and "OR"-operators. '''Default''': AND
 
 
'''Default''': No category is defined.
 
 
 
*'''Operator''': Sets the type of search, affecting the search result output, when you insert multiple search terms. It is possible to use "AND- and "OR"-operators.
 
  
 
'''Overview'''
 
'''Overview'''
Line 71: Line 67:
 
==User manual==
 
==User manual==
 
For detailed description and usage please visit our [[Manual:Extension/TagSearch|user manual.]]
 
For detailed description and usage please visit our [[Manual:Extension/TagSearch|user manual.]]
 
 
{{Box_Note|Note text = TagSearch is included in the BlueSpice package '''ServiceCenter''',  which is an extension requiring payment. Click [[ServiceCenter|here]] for further information.}}
 
  
 
==Try free our BlueSpice==
 
==Try free our BlueSpice==
 
[https://en.demo.bluespice.com/wiki/Main_Page BlueSpiceDemo.]
 
[https://en.demo.bluespice.com/wiki/Main_Page BlueSpiceDemo.]
 
 
 
{{Box_Note|Note text = Organize your categories with care, because this is a prerequisite for helpful search results. This means on the one hand, that categories need to be set up in the system already, on the other hand that articles are already related to those categories. Also pay attention on the appropriate configuration of the "tagsearch" and the "toplist". The search box and the related Toplist need to be configured with the same categories and namespaces.
 
{{Box_Note|Note text = Organize your categories with care, because this is a prerequisite for helpful search results. This means on the one hand, that categories need to be set up in the system already, on the other hand that articles are already related to those categories. Also pay attention on the appropriate configuration of the "tagsearch" and the "toplist". The search box and the related Toplist need to be configured with the same categories and namespaces.
 
}}
 
}}
  
 
+
{{Translation}}
[[de:Referenz:{{PAGENAME}}]]
 
[[en:Reference:{{PAGENAME}}]]
 
  
 
[[Category:BlueSpice_pro]]
 
[[Category:BlueSpice_pro]]
 
[[Category:Extension]]
 
[[Category:Extension]]

Attachments

Discussions