Inputbox help
محتويات
Example[عدل]
Box for starting a new article.
Wiki code[عدل]<inputbox> type=create break=no </inputbox> |
Result[عدل]<inputbox> type=create break=no </inputbox> |
General syntax[عدل]
InputBoxes are constructed like this:
<inputbox> type= bgcolor= width= default= preload= editintro= buttonlabel= hidden= searchbuttonlabel= break= namespaces= prefix= placeholder= preloadparams[]= </inputbox> |
The type parameter is mandatory. All other parameters are optional. preloadparams[] can appear more than once.
Box types[عدل]
The default location of the submit button(s) is below the input box. The submit button can be moved to the right by using the line break parameter to eliminate the line break between the input box and the submit button: break=no
Having the submit button to the right is useful for search boxes when search suggestions would otherwise cover up a search button below the search box.
| Type | Example | Description |
|---|---|---|
| type=search |
<inputbox> type=search </inputbox> |
Creates a search box which has a default width of 50 characters. Information added in the text box is searched for. |
| type=create |
<inputbox> type=create </inputbox> |
Creates a new page. Information added in the text box is the name of the page which is edited. |
| type=comment |
<inputbox> type=comment </inputbox> |
Adds a new section to the bottom of the page specified in the text box. |
| type=commenttitle |
<inputbox> type=commenttitle page=نقاش:Inputbox help </inputbox> |
Adds a new section with the section header typed into the text box. The page has to be specified with page= parameter. Added in rev:42703.
|
| type=fulltext |
<inputbox> type=fulltext </inputbox> |
Search only with the fulltext search button, without the 'Go' button. Added in rev:45269. |
| type=move |
<inputbox> type=move page=Inputbox help </inputbox> |
Move a page to a different name. Added in gerrit:97559. |
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 | Example |
|---|---|
| type=search2 |
<inputbox> type=search2 </inputbox> |
Parameters[عدل]
| Parameter | Description | Scope | Compatibility | Example | Result |
|---|---|---|---|---|---|
| bgcolor= | Sets the table background color (HTML color values). Do not use quotes. | All types | ? | <inputbox> type=search bgcolor=#eeeeff </inputbox> |
<inputbox>
type=search bgcolor=#eeeeff </inputbox> |
| width= | Sets the width of the InputBox in characters. | All types | ? | <inputbox> type=create width=24 </inputbox> |
<inputbox>
type=create width=24 </inputbox> |
| default= | Default text to put in the InputBox. | All types | ? | <inputbox> type=comment default=User talk:Eloquence </inputbox> |
<inputbox>
type=comment default=User talk:Eloquence </inputbox> |
| preload= | The page under this title will be preloaded (see Manual:Creating pages with preloaded text) into the blank editbox when a new page is created. | create, comment, commentitle | ? | <inputbox> type=create preload=Log </inputbox> |
<inputbox>
type=create preload=Log </inputbox> |
| Enter the title of a non-existent page in the example InputBox above or below, and click "⧼inputbox-createarticle⧽" or "⧼inputbox-postcomment⧽" respectively to test this effect. | |||||
| editintro= | The page which is given under this parameter will be shown, as instructions, above the editing window. | create, comment | ? | <inputbox> type=comment editintro=MediaWiki:Missingcommenttext </inputbox> |
<inputbox>
type=comment editintro=Mediawiki:Missingcommenttext </inputbox> |
| buttonlabel= | This label will be used for the main button of the form. | All types | ? | <inputbox> type=comment buttonlabel=Add new rumor </inputbox> |
<inputbox>
type=comment buttonlabel=Add new rumor </inputbox> |
| hidden= | 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. |
create, comment | ? | <inputbox> type=comment editintro=Extension:InputBox/editintro comment preload=Extension:InputBox/preload hidden=yes default=Extension talk:Inputbox buttonlabel=Post a comment on the talk page </inputbox> |
<inputbox>
type=comment editintro=Extension:InputBox/editintro comment preload=Extension:InputBox/preload hidden=yes default=Extension talk:InputBox buttonlabel=Post a comment on the talk page </inputbox> |
| searchbuttonlabel= | This label will be used for the "Search full text" button of the search form. | search, fulltext | ? | <inputbox> type=search searchbuttonlabel=Dig deeper </inputbox> |
<inputbox>
type=search searchbuttonlabel=Dig deeper </inputbox> |
| fulltextbutton= | Show the full text search button on search2 form | search2 | ? | <inputbox> type=search2 searchbuttonlabel=Dig deeper fulltextbutton=true </inputbox> |
<inputbox>
type=search searchbuttonlabel=Dig deeper fulltextbutton=true </inputbox> |
| labeltext= | Text to print beside the button | search2 | ? | <inputbox> type=search2 searchbuttonlabel=Dig deeper labeltext=Look for: </inputbox> |
<inputbox>
type=search2 searchbuttonlabel=Dig deeper labeltext=Look for: </inputbox> |
| break= | Whether or not to insert a line break between the input box and the button(s). Defaults to yes (use a line break). | All types | ? | <inputbox> type=create width=24 break=no </inputbox> |
<inputbox>
type=create width=24 break=no </inputbox> |
| namespaces= | Support for namespace checkboxes in fulltext search. With "Namespace**" it is checked by default. |
search, fulltext | ? | <inputbox> type=search namespaces=Main**,Help </inputbox> |
<inputbox>
type=search namespaces=Main**,Help </inputbox> |
| prefix= |
Remark: underscores aren't recognised as spaces. |
search, fulltext, create | ? | <inputbox>
type=search
prefix={{FULLPAGENAME}}/Archive
</inputbox>
|
<inputbox>
type=search prefix=Inputbox help/Archive </inputbox> The button below prefixes the name with Special:Mypage/. <InputBox> type=create preload=Template:Article wizard/userpageskeleton default=new article name here prefix=Special:Mypage/ editintro=Wikipedia:Article wizard/Wizard-New edit instructions userdraft buttonlabel=Create a userspace draft width=50 </InputBox> |
| placeholder= | Define placeholder text that will display in the input box when it is empty. | All types | 1.19+ | <inputbox> type=search placeholder=Search this Wiki </inputbox> |
<inputbox>
type=search placeholder=Search this Wiki </inputbox> |
| page= | Page to posts comment to, or page to move | comment, move | <inputbox> type=comment page=Project:Sandbox </inputbox> |
<inputbox>
type=comment page=Project:Sandbox </inputbox> | |
| minor= | Minor edit | comment, create | <inputbox> type=comment page=Project:Sandbox minor=true </inputbox> |
<inputbox>
type=comment page=Project:Sandbox minor=true </inputbox> | |
| nosummary= | Edit summary (headline) not required for new comment | comment | <inputbox> type=comment page=Project:Sandbox nosummary=true </inputbox> |
<inputbox>
type=comment page=Project:Sandbox nosummary=true </inputbox> | |
| summary= | Edit summary or move reason | comment, move, create | <inputbox> type=comment page=Project:Sandbox summary=Foo </inputbox> |
<inputbox>
type=comment page=Project:Sandbox summary=Foo </inputbox> | |
| id= | id attribute for <form> | all | 1.23 for some types | <inputbox> type=comment page=Project:Sandbox summary=Foo id=bar </inputbox> |
<inputbox>
type=comment page=Project:Sandbox summary=Foo id=bar </inputbox> |
| inline= | Make the inputbox be an inline element (no line break at beginning) | search2 | Text here: <inputbox> type=search2 inline=true width=10 </inputbox> |
Text here: <inputbox>
type=search2 inline=true width=10 </inputbox> | |
| dir= | Right to left (rtl) or left to right (ltr). Defaults to directionality of the page's language. | all | <inputbox> dir=rtl type=comment page=Project:Sandbox summary=Foo </inputbox> |
<inputbox>
dir=rtl type=comment page=Project:Sandbox summary=Foo </inputbox> | |
| preloadparams[]= | Specify parameters to the preload text. See Manual:Creating pages with preloaded text#Using parameters. | create, comment, commentitle | 1.25+ | <inputbox> type=create preload=Log preloadparams[]=param1 preloadparams[]=param2 </inputbox> |
<inputbox>
type=create preload=Log preloadparams[]=param1 preloadparams[]=param2 </inputbox> |
Applying create to an existing page simply gives the edit page. In that case preload is ignored. Applying comment for a new page works.
The texts taken from the MediaWiki: namespace are of course only examples, any existing page can be used for editintro or preload. Unfortunately preload does not yet work for the Special:Upload summary.
Alignment[عدل]
If you want to create an infobox on the right side of the page, do something like:
<div style="float:right;width:42em"> <inputbox> type=create </inputbox> </div>
<inputbox> type=create </inputbox>
Parser function[عدل]
Using InputBox in a template
In order to create many similar input boxes, InputBox can be used in a template. However, passing template parameters to InputBox parameters only works if the <inputbox>...</inputbox> tag is written as {{#tag:inputbox | ...}} inside the template.
The following example is a template to create a new wiki page from a named template:
{{#tag:inputbox |
type=create
buttonlabel=Create new {{{1|article}}}
preload={{{2|Template:Article}}} }}
When instantiating the template, the first parameter gives the item that is created (default: article) as spelled out in the button, the second parameter gives the name of the template used to create the item (default: Template:Article).
E.g., the code for an input box to create a new project from a project template might look like this:
{{Template:CreateNew|project|Template:Project}}
