Difference between revisions of "Reference:InputBox"

(Changed categories.)

Extension: InputBox


Overview
Description:
State: stable Dependency: MediaWiki, BlueSpice
Developer: Erik Möller, Leonardo Pimenta, Rob Church, Trevor Parscal, Daniel Schuba License: -
Type: MediaWiki Category: -
Edition: BlueSpiceFree"BlueSpiceFree" is not in the list (BlueSpice pro, BlueSpice free, BlueSpice Farm, BlueSpice Cloud, BlueSpice free (deactivated), BlueSpice pro (deactivated), BlueSpice Farm (deactivated), BlueSpice Cloud (deactivated)) of allowed values for the "BSExtensionInfoEdition" property., BlueSpicePro"BlueSpicePro" is not in the list (BlueSpice pro, BlueSpice free, BlueSpice Farm, BlueSpice Cloud, BlueSpice free (deactivated), BlueSpice pro (deactivated), BlueSpice Farm (deactivated), BlueSpice Cloud (deactivated)) of allowed values for the "BSExtensionInfoEdition" property.
For more info, visit Mediawiki.

Features[edit source]

With InputBox you can integrate HTML forms into wiki pages.  

Contents

1

What is an InputBox?

  • 2 What kind of InputBoxes can be created?
  • 3 Sample Code as Template
  • 4 Configuration Possibilities for InputBox
  • 5 Related Links
  • What is an InputBox?[edit | edit source]

    The InputBox is an input field that is provided with a button that calls a certain predefined action. You can, for example, create new pages automatically in a specific namespace and with a certain template just by entering an article title and click on the button. Or you define a search that is restricted to specific namespaces and categories to make the search results more precise.

    What kind of InputBoxes can be created?[edit | edit source]

    Type Result Description
    type=search

    Creates a search box, which has a default width of 50 characters. Information added in the text box is searched for.
    type=search2
     

    For type=search2 the default location for the search button is to the right. Currently, it does not seem to be possible to add other parameters to this type of input box. This search box searches the entire wiki that it is placed on.

    type=create

    Creates a new page. Information added in the text box is the name of the page which is edited.
    type=comment

    Adds a new section to the bottom of the page specified in the text box.
    type=commenttitle

    Adds a new section with the section header typed into the text box. The title can be specified with default= parameter. The page has to be specified with page= parameter. 
    type=fulltext
    Search only with the fulltext search button, without the 'Go' button.
    type=move

    Move (rename) a page to a different name.

    Sample Code as Template[edit | edit source]

    For using the InputBox, please insert the following code into the content field of the wiki article: 

    <inputbox>
    type=
    placeholder= 
    bgcolor=
    width=
    preload= 
    editintro=
    buttonlabel= 
    hidden=
    searchbuttonlabel=
    break=
    namespaces= 
    prefix=
    </inputbox>
    

    Configuration Possibilities for InputBox[edit | edit source]

    Parameter

    Type

    Description

    bgcolor=

    All types

    Sets the table background color (HTML color values, e.g. #eeeeff)

    width=

    All types

    Sets the width of the InputBox in characters.

    default=

    All types

    Default text to put in the InputBox (displayed in grey

    preload=

    create, comment, commentitle

    The page under this title will be preloaded into the blank editbox when a new page is created.

    editintro=

    create, comment

    The page which is given under this parameter will be shown, as instructions, above the editing window.

    buttonlabel=

    All types

    This label will be used for the main button of the form.

    hidden=

    create, comment

    This specifies that there is no InputBox.

    It is used with parameter "default", now not being a default, but the fixed value of the name of the page.

    searchbuttonlabel=

    search, fulltext

    This label will be used for the "Search full text" button of the search form.

    fulltextbutton=

    search2

    Show the full text search button on search2 form

    break=

    All types

    Whether or not to insert a line break between the input box and the button(s). Defaults to yes (use a line break).

    labeltext=

    search2

    Text to print beside the button

    namespaces=

    search, fulltext

    Support for namespace checkboxes in fulltext search.

    With "Main**", main article namespace is checked by default.

    prefix=

    search, fulltext, create

    • Narrow down search to pages beginning with certain prefix. Note this only works with certain search back-ends, currently only latest Extension:lucene-search. Defaults to empty string (search all pages).
    • Create new page beginning with a certain prefix.
    • In type=move, the prefix is prepended to the default parameter.

    Remark: underscores aren't recognized as spaces.

    placeholder=

    All types

    Define placeholder text that will display in the input box when it is empty.

    page=

    comment, move

    Page to posts comment to, or page to move

    minor=

    comment, move

    Minor edit.

    nosummary=

    comment

    Edit summary (headline) not required for new comment.

    summary=

    comment, move, create

    Edit summary or move reason.

    id=

    All types id attribute for<form></form>.

    inline=

    search2

    Make the InputBox be an inline element (no line break at beginning).

    dir=

    All types

    Right to left (rtl) or left to right (ltr). Defaults to directionality of the page's language.

    preloadparams[]=

    create, comment, commentitle

    Specify parameters to the preload text.

    Related Links[edit | edit source]


    Attachments

    Discussions