Difference between revisions of "Manual:Extension/BlueSpiceTagSearch"

m
(Tag: 2017 source edit)
 

What is BlueSpiceTagSearch?[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.

Inserting TagSearch tag[edit | edit source]

Tag
<bs:tagsearch />
can be inserted to the page directly in wikitext or using "Insert magic" menu of VisualEditor. For more information on how to insert magic words, see BlueSpiceInsertMagic.

Once the tag is inserted on the page, if using VisualEditor, a configuration dialog (inspector) will be displayed. Here, all aspects of TagSearch can be configured.

Configuration[edit | edit source]

Configuration of TagSearch tag
Parameter Display name Description
ns Namespace(s) List of namespaces in which to search. Namespaces can be entered by using their IDs or names, separated by pipe (|). IDs and names cannot be mixed. Correct entries are: "1|6|8", "Help|QM", while invalid is "1|QM"
cat Category(-ies) List of categories in which to search. Mutltiple categories must be separated by pipe (|) - "Cat1|Cat2"
placeholder Placeholder Text to be shown in the search field when nothing is typed in
operator Search operator Applies only to categories. Operator "AND" will only find results that are in all of the given categories, while operator "OR" will show results in any of the given categories
type Type List of types of search entities to search. By default search entities availble are: wikipage, specialpages, repofile (internal files), externalfile (external files). Multiple values can be entered separated by pipe (|) - "wikipage|repofile"


Multiple tags can be added to single page, with same or different configurations.

Usage[edit | edit source]

Using TagSearch tag
Once the page with
<bs:tagsearch />
is saved, search field will be shown at the place in text where the text was inserted.

Typing in the field will show autocomplete list of results.

Clicking on search icon in the field or hitting Return will lead to full-text search in <code>Special:Search-Center</code>

See also[edit | edit source]

Eeference page for this extension.

<bs:bookshelf src="Book:User manual" />
        

        __TOC__
        

        ==What is BlueSpiceTagSearch?==
        

        '''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]].
        

        ==Inserting TagSearch tag==
        
        Tag <pre><bs:tagsearch /></pre> can be inserted to the page directly in wikitext or using "Insert magic" menu of [[Manual:Extension/VisualEditor|VisualEditor]]. For more information on how to insert magic words, see [[Manual:Extension/BlueSpiceInsertMagic|BlueSpiceInsertMagic]].
        

        Once the tag is inserted on the page, if using VisualEditor, a configuration dialog (inspector) will be displayed. Here, all aspects of TagSearch can be configured.
        

        ===Configuration===
        
        [[File:TagSearch2a.png|thumb|Configuration of TagSearch tag]]
        
        {| class="wikitable"
        
        |+
        
        !Parameter!!Display name
        
        !Description
        
        |-
        
        |ns||Namespace(s)
        
        |<nowiki>List of namespaces in which to search. Namespaces can be entered by using their IDs or names, separated by pipe (|). IDs and names cannot be mixed. Correct entries are: "1|6|8", "Help|QM", while invalid is "1|QM"</nowiki>
        

        *
        
        |-
        
        |cat
        
        |Category(-ies)
        
        |<nowiki>List of categories in which to search. Mutltiple categories must be separated by pipe (|) - "Cat1|Cat2"</nowiki>
        
        |-
        
        |placeholder
        
        |Placeholder
        
        |Text to be shown in the search field when nothing is typed in
        
        |-
        
        |operator
        
        |Search operator
        
        |Applies only to categories. Operator "AND" will only find results that are in all of the given categories, while operator "OR" will show results in any of the given categories
        
        |-
        
        |type
        
        |Type
        
        |<nowiki>List of types of search entities to search. By default search entities availble are: wikipage, specialpages, repofile (internal files), externalfile (external files). Multiple values can be entered separated by pipe (|) - "wikipage|repofile"</nowiki>
        
        |}
        

        Multiple tags can be added to single page, with same or different configurations.
        

        == Usage ==
        
        [[File:TagSearch3a.png|thumb|Using TagSearch tag]]
        
        Once the page with <pre>
        <bs:tagsearch />
        </pre>is saved, search field will be shown at the place in text where the text was inserted.
        

        Typing in the field will show autocomplete list of results.
        

        Clicking on search icon in the field or hitting Return will lead to full-text search in <nowiki><code>Special:Search-Center</code></nowiki>
        

        ==See also==
        

        [[Reference:TagSearch|Eeference page]] for this extension.
            

            {{Translation}}
Line 57: Line 57:
  
 
[[Reference:TagSearch|Eeference page]] for this extension.
 
[[Reference:TagSearch|Eeference page]] for this extension.
 +
 +
{{Translation}}

Attachments

Discussions