Brontekst bekijken van Extension:InputBox

<languages />
{{bundled|1.21}}
{{Extension
|name          = InputBox
|status        = stable
|type1         = tag
|type2         = page action
|type3         = search
|hook1         = ParserFirstCallInit
|hook2         = MediaWikiPerformAction
|hook3         = SpecialPageBeforeExecute
|username      = 
|author        = * Erik Möller
* Leonardo Pimenta
* Rob Church
* Trevor Parscal
* Daniel Schuba
|description   = <translate><!--T:1--> Allows users to add predefined HTML forms to wiki pages</translate>
|image         = Simple_Input_Form.png
|imagesize     = border{{!}}325
|version       = Continuous updates
|update        = 
|mediawiki     = 1.30+
|license       = MIT
|download      = {{WikimediaDownload}}
|needs-updatephp = No
|readme        =
|changelog     = 
|parameters    =
|tags          = * &lt;inputbox>
|rights        =
|example       =
|compatibility =
|phabricator   = MediaWiki-extensions-InputBox
|pagedrive1    = true
}}

<translate>
<!--T:2-->
The '''InputBox''' extension adds already created [[w:HTML form|HTML forms]] to wiki pages.</translate>
<translate>
<!--T:3-->
Users can "complete" a form (entering text, selecting menu items, etc.) by entering text into the box.

<!--T:4-->
InputBox was originally created by <tvar|user>[[User:Eloquence|Erik Möller]]</> for the purpose of adding a <tvar|create-article>''{{int|Articleplaceholder-abouttopic-create-article-button}}''</> box to [[m:Wikinews|Wikinews]].

== Installation == <!--T:5-->
</translate>
{{ExtensionInstall
|repo-name=InputBox
|registration=yes
}}

<translate>
== Example == <!--T:6-->

<!--T:7-->
Box for starting a new article.

===Wiki code=== <!--T:8-->
</translate>

<pre><inputbox>
type=create
break=no
</inputbox>
</pre>

<translate>
===Result=== <!--T:9-->
</translate>
<div style="float:{{dir|{{pagelang}}|right|left}};">
<inputbox>
type=create
break=no
</inputbox>
</div>
{{clr}}

<translate>
== General syntax == <!--T:10-->

<!--T:11-->
Input boxes are constructed like this:
</translate>

{| cellspacing="5" bgcolor="#ffffff" rules="all" cellpadding="5" border="0"
|<source lang="html"><inputbox>
type=
bgcolor=
width=
page=
default=
preload=
editintro=
buttonlabel=
hidden=
searchbuttonlabel=
break=
namespaces=
prefix=
placeholder=
preloadparams[]=
</inputbox>
</source>
|}

<translate>
<!--T:12-->
The <tvar|type>''type''</> parameter is mandatory.</translate>
<translate>
<!--T:13-->
All other parameters are optional.</translate>
<translate>
<!--T:14-->
<tvar|preloadparams>''preloadparams[]''</> can appear more than once.

== Box types == <!--T:15-->

<!--T:16-->
The default location of the “<tvar|submit>{{int|Htmlform-submit}}</>” button(s) is below the input box.


<!--T:17-->
The “<tvar|submit>{{int|Htmlform-submit}}</>” button can be moved to the right by using the line break parameter to eliminate the line break between the box and the button: <tvar|break><code>break=no</code></>.

<!--T:18-->
Having the “<tvar|submit>{{int|Htmlform-submit}}</>” button to the right is useful for search boxes when search suggestions would otherwise cover up a search button below the search box.
</translate> 

{| class="wikitable"
! <translate><!--T:19--> Type</translate> 
! <translate><!--T:20--> Example</translate> 
! <translate><!--T:21--> Description</translate>
|-
| type=search
|
<inputbox>
type=search
</inputbox>
| <translate><!--T:22--> Creates a search box which has a default width of 50 characters.</translate> <translate><!--T:23--> Information added in the text box is searched for.</translate> 
|-
| type=create
|
<inputbox>
type=create
</inputbox>
| <translate><!--T:24--> Creates a new page.</translate> <translate><!--T:25--> Information added in the text box is the name of the page which is edited.</translate>  
|-
| type=comment
|
<inputbox>
type=comment
</inputbox>
| <translate><!--T:26--> Adds a new section to the bottom of the page specified in the text box.</translate> 
|-
| type=commenttitle
|
<inputbox>
type=commenttitle
page={{TALKPAGENAME}}
</inputbox>
| <translate><!--T:27--> Adds a new section with the section header typed into the text box.</translate> <translate><!--T:28--> The title can be specified with <tvar|default><code>default=</code></> parameter. The page has to be specified with <tvar|page><code>page=</code></> parameter.</translate> {{introduced-inline|[[rev:47203]]}}
|-
| type=fulltext
|
<inputbox>
type=fulltext
</inputbox>
| <translate><!--T:30--> Search only with the fulltext search button, without the “<tvar|go>{{int|Go}}</>” button.</translate> {{introduced-inline|[[rev:45269]]}}
|-
| type=move
|
<inputbox>
type=move
page={{PAGENAME}}
</inputbox>
| <translate><!--T:32--> Move a page to a different name.</translate> {{introduced-inline|[[gerrit:97559]]}}
|}

<translate>
<!--T:34-->
For <tvar|search2><code>type=search2</code></>, the default location for the search button is to the right.</translate>
<translate>
<!--T:35-->
Currently, it does not seem to be possible to add other parameters to this type of input box.</translate>
<translate>
<!--T:36-->
This search box searches the entire wiki that it is placed on.
</translate> 

{| class="wikitable"
! <translate><!--T:37--> Type</translate> 
! <translate><!--T:38--> Example</translate>
|-
| type=search2
| 
<inputbox>
type=search2
</inputbox>
|}
<div style="clear:both;"></div>

<translate>
== Parameters == <!--T:39-->
</translate>

{| class="wikitable"
! <translate><!--T:40--> Parameter</translate> 
! <translate><!--T:41--> Description</translate> 
! <translate><!--T:42--> Scope</translate> 
! <translate><!--T:43--> Compatibility</translate> 
! <translate><!--T:44--> Example</translate> 
! <translate><!--T:45--> Result</translate>
|-
|'''bgcolor='''
| <translate><!--T:46--> Sets the table background color (HTML color values).</translate> <translate><!--T:47--> Do not use quotes.</translate>
| <translate><!--T:48--> All types</translate>
|''?''
|<pre><inputbox>
type=search
bgcolor=#eeeeff
</inputbox></pre>
|<inputbox>
type=search
bgcolor=#eeeeff
</inputbox>
|-
|'''width='''
| <translate><!--T:49--> Sets the width of the InputBox in characters.</translate>
| <translate><!--T:50--> All types</translate>
|''?''
|<pre><inputbox>
type=create
width=24
</inputbox></pre>
|<inputbox>
type=create
width=24
</inputbox>
|-
|'''default='''
| <translate><!--T:51--> Default text to put in the InputBox.</translate>
| <translate><!--T:52--> All types</translate>
|''?''
|<pre><inputbox>
type=comment
default=User talk:Eloquence
</inputbox></pre>
|<inputbox>
type=comment
default=User talk:Eloquence
</inputbox>
|-
|'''preload='''
| <translate><!--T:53--> The page under this title will be preloaded (see <tvar|1>{{ll|Manual:Creating pages with preloaded text}}</>) into the blank editbox when a new page is created.</translate>
| create, comment, commenttitle
|''?''
|<pre><inputbox>
type=create
preload=Log
</inputbox></pre>
|<inputbox>
type=create
preload=Log
</inputbox>
|-
| colspan="6" | <translate><!--T:54--> Enter the title of a non-existent page in the example InputBox above or below, and click "<tvar|create>{{int|inputbox-createarticle}}</>" or "<tvar|new>{{int|inputbox-postcomment}}</>" respectively to test this effect.</translate>
|-
|'''editintro='''
| <translate><!--T:55--> The page which is given under this parameter will be shown, as instructions, ''above'' the editing window.</translate>
| create, comment
|''?''
|<pre><inputbox>
type=comment
editintro=MediaWiki:Missingcommenttext
</inputbox></pre>
|<inputbox>
type=comment
editintro=Mediawiki:Missingcommenttext
</inputbox>
|-
|'''buttonlabel='''
| <translate><!--T:56--> This label will be used for the main button of the form.</translate>
| <translate><!--T:57--> All types</translate>
|''?''
|<pre><inputbox>
type=comment
buttonlabel=Add new rumor
</inputbox></pre>
|<inputbox>
type=comment
buttonlabel=Add new rumor
</inputbox>
|-
|'''hidden='''
| <translate><!--T:58-->
This specifies that there is no InputBox.

<!--T:59-->
It is used with parameter "<tvar|default>default</>", now not being a default, but the fixed value of the name of the page.</translate>
|create, comment
|''?''
|<pre><inputbox>
type=comment
editintro=Extension:InputBox/editintro comment
preload=Extension:InputBox/preload
hidden=yes
default=Extension talk:InputBox
buttonlabel=<translate><!--T:60--> Post a comment on the talk page</translate>
</inputbox></pre>
|<inputbox>
type=comment
editintro=Extension:InputBox/editintro comment
preload=Extension:InputBox/preload
hidden=yes
default=Extension talk:InputBox
buttonlabel=<translate><!--T:61--> Post a comment on the talk page</translate>
</inputbox>
|-
|'''searchbuttonlabel='''
| <translate><!--T:62--> This label will be used for the "Search full text" button of the search form.</translate>
| search, fulltext
|''?''
|<pre><inputbox>
type=search
searchbuttonlabel=<translate><!--T:63--> Dig deeper</translate>
</inputbox></pre>
|<inputbox>
type=search
searchbuttonlabel=<translate><!--T:64--> Dig deeper</translate>
</inputbox>
|-
|'''fulltextbutton='''
| <translate><!--T:65--> Show the full text search button on search2 form</translate>
|search2
|''?''
|<pre><inputbox>
type=search2
searchbuttonlabel=<translate><!--T:66--> Dig deeper</translate>
fulltextbutton=true
</inputbox></pre>
|<inputbox>
type=search
searchbuttonlabel=<translate><!--T:67--> Dig deeper</translate>
fulltextbutton=true
</inputbox>
|-
|'''labeltext='''
| <translate><!--T:68--> Text to print beside the button</translate>
|search2
|''?''
|<pre><inputbox>
type=search2
searchbuttonlabel=<translate><!--T:69--> Dig deeper</translate>
labeltext=<translate><!--T:70--> Look for:</translate> 
</inputbox></pre>
|<inputbox>
type=search2
searchbuttonlabel=<translate><!--T:71--> Dig deeper</translate>
labeltext=<translate><!--T:72--> Look for:</translate> 
</inputbox>
|-
|'''break='''
| <translate><!--T:73--> Whether or not to insert a line break between the input box and the button(s).</translate> <translate><!--T:74--> Defaults to <tvar|yes>'''yes'''</> (use a line break).</translate>
| <translate><!--T:75--> All types</translate>
|''?''
|<pre><inputbox>
type=create
width=24
break=no
</inputbox></pre>
|<inputbox>
type=create
width=24
break=no
</inputbox>
|-
|'''namespaces='''
| <translate><!--T:76-->
Support for namespace checkboxes in fulltext search.

<!--T:77-->
With "<tvar|main><code>Main'''**'''</code></>", main article namespace is checked by default.</translate>
| search, fulltext
|''?''
|<pre><inputbox>
type=search
namespaces=Main**,Help
</inputbox></pre>
|<inputbox>
type=search
namespaces=Main**,Help
</inputbox>
|-
|'''prefix='''
|
<translate>
<!--T:78-->
* Narrow down search to pages beginning with certain prefix.</translate> <translate><!--T:79--> Note this only works with certain search back-ends, currently only <tvar|ext>{{ll|Extension:CirrusSearch}}</>.</translate> <translate><!--T:80--> Defaults to empty string (search all pages).</translate>
<translate>
<!--T:81-->
* Create new page beginning with a certain prefix.</translate>
<translate>
<!--T:82-->
* In <tvar|tmove>type=move</>, the prefix is prepended to the default parameter.

<!--T:83-->
Remark: underscores aren't recognized as spaces.
</translate>
|search, fulltext, create
|''?''
|<pre><inputbox>
type=search
prefix={{FULLPAGENAME}}/Archive
</inputbox></pre>
|<inputbox>
type=search
prefix={{FULLPAGENAME}}/Archive
</inputbox>

<translate><!--T:84--> The button below prefixes the name with <tvar|mypage>''<code>Special:Mypage/</code>''</>.</translate>
<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=<translate><!--T:85--> Create a userspace draft</translate>
width=50
</inputbox>
|-
|'''placeholder='''
| <translate><!--T:86--> Define placeholder text that will display in the input box when it is empty.</translate>
| <translate><!--T:87--> All types</translate>
|1.19+
|<pre><inputbox>
type=search
placeholder=<translate><!--T:88--> Search this Wiki</translate>
</inputbox></pre>
|<inputbox>
type=search
placeholder=<translate><!--T:89--> Search this Wiki</translate>
</inputbox>
|-
|'''page='''
| <translate><!--T:90--> Page to posts comment to, or page to move.</translate>
| comment, move
|
|<pre><inputbox>
type=comment
page=Project:Sandbox
</inputbox></pre>
|<inputbox>
type=comment
page=Project:Sandbox
</inputbox>
|-
|'''minor='''
| <translate><!--T:91--> Minor edit.</translate>
| comment, create
|
|<pre><inputbox>
type=comment
page=Project:Sandbox
minor=true
</inputbox></pre>
|<inputbox>
type=comment
page=Project:Sandbox
minor=true
</inputbox>
|-
|'''nosummary='''
| <translate><!--T:92--> Edit summary (headline) not required for new comment.</translate>
|comment
|
|<pre><inputbox>
type=comment
page=Project:Sandbox
nosummary=true
</inputbox></pre>
|<inputbox>
type=create
page=Project:Sandbox
nosummary=true
</inputbox>
|-
|'''summary='''
| <translate><!--T:93--> Edit summary or move reason.</translate>
| create, move
|
|<pre><inputbox>
type=create
default=Special:Mypage/inputbox test
summary=Foo
</inputbox></pre>
|<inputbox>
type=create
default=Special:Mypage/inputbox test
summary=Foo
</inputbox>
|-
|'''id='''
| <translate><!--T:94--> id attribute for <tvar|form>&lt;form&gt;</>.</translate>
| <translate><!--T:95--> All types</translate>
| <translate><!--T:96--> 1.23 for some types</translate>
|<pre><inputbox>
type=comment
page=Project:Sandbox
summary=Foo
id=bar
</inputbox></pre>
|<inputbox>
type=comment
page=Project:Sandbox
summary=Foo
id=bar
</inputbox>
|-
|'''inline='''
| <translate><!--T:97--> Make the InputBox be an inline element (no line break at beginning).</translate>
| search2
|
|<pre><translate><!--T:98--> Text here:</translate> <inputbox>
type=search2
inline=true
width=10
</inputbox></pre>
| <translate><!--T:99--> Text here:</translate> <inputbox>
type=search2
inline=true
width=10
</inputbox>
|-
|'''dir='''
| <translate><!--T:100--> Right to left (rtl) or left to right (ltr).</translate> <translate><!--T:101--> Defaults to directionality of the page's language.</translate>
| <translate><!--T:102--> All types</translate>
|
|<pre><inputbox>
dir=rtl
type=comment
page=Project:Sandbox
summary=Foo
</inputbox></pre>
|<inputbox>
dir=rtl
type=comment
page=Project:Sandbox
summary=Foo
</inputbox>
|-
| id="preloadparams" |'''preloadparams[]='''
| <translate><!--T:103--> Specify parameters to the preload text.</translate> <translate><!--T:104--> See [[<tvar|man>Manual:Creating pages with preloaded text#Using parameters</>|Creating pages with preloaded text]].</translate>
| create, comment, commenttitle
|1.25+
|<pre><inputbox>
type=create
preload=Log
preloadparams[]=param1
preloadparams[]=param2
</inputbox></pre>
|<inputbox>
type=create
preload=Log
preloadparams[]=param1
preloadparams[]=param2
</inputbox>
|-
|'''searchfilter='''
|<translate><!--T:123--> Specify parameters to append to the search</translate>
|search
|1.30+
|<pre><inputbox>
type=search
searchfilter=insource:foo
</inputbox></pre>
|<inputbox>
type=search
searchfilter=insource:foo
</inputbox>
|-
|'''useve='''
|  <translate><!--T:124--> When creating a page the input box will use the new visual editor, if the extension is installed, and this parameter is set to true.</translate>
| create, comment
|
|<pre><inputbox>
type=create
break=no
useve=true
</inputbox></pre>
|<inputbox>
type=create
break=no
useve=true
</inputbox>
|}

<translate>
<!--T:107-->
Applying <tvar|create>''create''</> to an existing page simply gives the edit page.</translate>
<translate>
<!--T:108-->
In that case <tvar|preload><code>preload</code></> is ignored.</translate>
<translate>
<!--T:109-->
Applying <tvar|comment>''comment''</> for a new page works.

<!--T:110-->
The texts taken from the <tvar|mediawiki><code>MediaWiki:</code></> namespace are of course only examples, any existing page can be used for <tvar|editintro><code>editintro</code></> or <tvar|preload><code>preload</code></>.</translate>
<translate>
<!--T:111-->
Unfortunately <tvar|preload><code>preload</code></> does not yet work for the [[<tvar|special>Special:Upload</>|Upload]] summary.

== Alignment == <!--T:112-->

<!--T:113-->
If you want to create an inputbox on the right side of the page, do something like:
</translate>

<syntaxhighlight lang="html">
<div style="float:{{dir|{{pagelang}}|left|right}}; width:42em">
<inputbox>
type=create
</inputbox>
</div>
</syntaxhighlight>

<div style="float:{{dir|{{pagelang}}|left|right}}; width:42em">
<inputbox>
type=create
</inputbox>
</div>
{{clear}}

<translate>
== Parser function == <!--T:114-->

<!--T:115-->
Using InputBox in a template

<!--T:116-->
In order to create many similar input boxes, InputBox can be used in a template.</translate>
<translate>
<!--T:117-->
However, passing template parameters to InputBox parameters only works if the <tvar|inputbox><code><nowiki><inputbox>...</inputbox></nowiki></code></> tag is written as <tvar|inputbox2><code><nowiki>{{#tag:inputbox | ...}}</nowiki></code></> inside the template.

<!--T:118-->
The following example is a template to create a new wiki page from a named template:
</translate>

<source lang=moin>
{{#tag:inputbox |
type=create
buttonlabel=<translate><!--T:119--> Create new {{{1|article}}}</translate>
preload={{{2|Template:Article}}} }}
</source>

<translate>
<!--T:120-->
When instantiating the template, the first parameter gives the item that is created (default: <tvar|article><code>article</code></>) as spelled out in the button, the second parameter gives the name of the template used to create the item (default: <tvar|template><code>Template:Article</code></>).

<!--T:121-->
E.g., the code for an input box to create a new project from a project template might look like this:
</translate>

<source lang=moin>
{{Template:CreateNew|project|Template:Project}}
</source>

<translate>
== See also == <!--T:122-->
</translate>
*{{ll|Extension:Create Page}}

{{OnWikimedia}}

[[Category:Form extensions{{#translation:}}]]
[[Category:Page creation extensions{{#translation:}}]]
[[Category:Search widget extensions{{#translation:}}]]
[[Category:Edit box extensions{{#translation:}}]]