m (→Further help and feedback: Removing interlanguage link) |
m (Sophiedp moved page Help:Inputbox to Help:InputBox) |
||
(9 intermediate revisions by 8 users not shown) | |||
Line 1: | Line 1: | ||
{{tocright}} |
{{tocright}} |
||
− | |||
An '''inputbox''' allows you to put a box on any page, which has a text field for users to fill and a customizable button for launching the action. |
An '''inputbox''' allows you to put a box on any page, which has a text field for users to fill and a customizable button for launching the action. |
||
There are three types: the '''article creation box''', the '''search box''', and the '''comment box'''. The default width for all boxes is 50 characters. |
There are three types: the '''article creation box''', the '''search box''', and the '''comment box'''. The default width for all boxes is 50 characters. |
||
+ | == Box types == |
||
− | == How do I add an article creation box to a page? == |
||
+ | === Article creation box === |
||
− | An article creation box places a box on the page that lets the user create a new page by entering the page title. A new page will be opened at the title the user types in. Page creation is handled by the InputBox extension, or by the CreateBox extension. CreateBox takes mostly the same arguments as InputBox when used with <code>type=create</code>. Both check if a page already exists and display an error message if it does. |
+ | An article creation box places a box on the page that lets the user create a new page by entering the page title. A new page will be opened at the title the user types in. Page creation is handled by the InputBox [[Help:Extensions|extension]], or by the CreateBox extension. CreateBox takes mostly the same arguments as InputBox when used with <code>type=create</code>. Both check if a page already exists and display an error message if it does. It is also possible to [[#Using preloaded templates with an article creation box|use preloaded templates with the box]] to simplify the article creation process for editors. |
{| class="article-table" |
{| class="article-table" |
||
Line 13: | Line 13: | ||
!To make this: |
!To make this: |
||
|- style="vertical-align:top;" |
|- style="vertical-align:top;" |
||
⚫ | |||
− | | |
||
⚫ | |||
<inputbox> |
<inputbox> |
||
type=create |
type=create |
||
</inputbox> |
</inputbox> |
||
</pre> |
</pre> |
||
⚫ | |||
− | | |
||
⚫ | |||
type=create |
type=create |
||
</inputbox> |
</inputbox> |
||
|} |
|} |
||
− | == |
+ | === Search box === |
A search box provides an extra box for users to search your community, in addition to the one in the global navigation bar. |
A search box provides an extra box for users to search your community, in addition to the one in the global navigation bar. |
||
Line 33: | Line 31: | ||
!To make this: |
!To make this: |
||
|- style="vertical-align:top;" |
|- style="vertical-align:top;" |
||
⚫ | |||
− | | |
||
⚫ | |||
<inputbox> |
<inputbox> |
||
type=search |
type=search |
||
</inputbox> |
</inputbox> |
||
</pre> |
</pre> |
||
⚫ | |||
− | | |
||
⚫ | |||
type=search |
type=search |
||
</inputbox> |
</inputbox> |
||
|} |
|} |
||
− | == |
+ | === Comment box === |
− | This box adds a section to an existing page |
+ | This box adds a section to an existing page, which can be helpful in adding a new discussion to a talk page, or new items to a news page. |
The text typed in the box is the page where to start a new section header. If you use as type ''commenttitle'' instead of ''comment'', the text typed in the box becomes the new section header, and is also used as the [[Help:Edit summary|edit summary]] for the addition. In this case, you additionally need to define a pagename with the ''page'' parameter. |
The text typed in the box is the page where to start a new section header. If you use as type ''commenttitle'' instead of ''comment'', the text typed in the box becomes the new section header, and is also used as the [[Help:Edit summary|edit summary]] for the addition. In this case, you additionally need to define a pagename with the ''page'' parameter. |
||
Line 55: | Line 51: | ||
! To make this: |
! To make this: |
||
|- style="vertical-align:top;" |
|- style="vertical-align:top;" |
||
⚫ | |||
− | | |
||
⚫ | |||
<inputbox> |
<inputbox> |
||
type = comment |
type = comment |
||
⚫ | |||
</inputbox> |
</inputbox> |
||
</pre> |
</pre> |
||
⚫ | |||
− | | |
||
⚫ | |||
type = comment |
type = comment |
||
+ | buttonlabel=Post a comment |
||
</inputbox> |
</inputbox> |
||
|- |
|- |
||
Line 70: | Line 66: | ||
type = commenttitle |
type = commenttitle |
||
page = Help talk:Inputbox |
page = Help talk:Inputbox |
||
+ | buttonlabel=Post a comment |
||
</inputbox> |
</inputbox> |
||
</pre> |
</pre> |
||
⚫ | |||
− | | |
||
⚫ | |||
type = commenttitle |
type = commenttitle |
||
page = Help talk:Inputbox |
page = Help talk:Inputbox |
||
+ | buttonlabel=Post a comment |
||
</inputbox> |
</inputbox> |
||
|} |
|} |
||
− | == |
+ | == Customizing inputboxes == |
There are several parameters you can use to customize the display of the inputboxes. |
There are several parameters you can use to customize the display of the inputboxes. |
||
− | ; Background color |
+ | ; Background color |
+ | : |
||
− | :< |
+ | :<code>bgcolor=#FFFFFF</code> |
− | :Sets the background color using [[Help:Color|HTML color values]]. |
+ | :Sets the background color using [[Help:Color|HTML color values]]. Enter the color value without using quotes. In some cases, giving this the same color as the page color can make the background invisible. |
− | ; Width |
+ | ; Width |
+ | : |
||
− | :< |
+ | :<code>width=##</code> |
:Sets width of input field, where ## is a number of characters. (The default is 50.) |
:Sets width of input field, where ## is a number of characters. (The default is 50.) |
||
− | ; Default text |
+ | ; Default text |
+ | : |
||
− | :< |
+ | :<code>default=any text</code> |
− | :Default text to put in the inputbox, such as "enter page title here" |
+ | :Default text to put in the inputbox before it is changed, such as "enter page title here". |
− | ; Button label |
+ | ; Button label |
+ | : |
||
⚫ | |||
⚫ | |||
− | :This label will be used for the main button of the form. |
+ | :This label will be used for the text in the main submit button of the form. |
− | ; Search button label |
+ | ; Search button label |
+ | : |
||
− | :< |
+ | :<code>searchbuttonlabel=any text</code> |
− | : |
+ | :For search forms, this label will be used for the "Search full text" button. |
− | ; Line break |
+ | ; Line break |
+ | : |
||
− | :< |
+ | :<code>break=no</code> |
:Removes the default line break between the input box and the button(s), displaying them side by side. |
:Removes the default line break between the input box and the button(s), displaying them side by side. |
||
− | ; Placeholder |
+ | ; Placeholder |
+ | : |
||
⚫ | |||
+ | :<code>placeholder=any text</code> |
||
:Define placeholder text that will display in the input box when it is empty. |
:Define placeholder text that will display in the input box when it is empty. |
||
− | ; Hide Box |
+ | ; Hide Box |
+ | : |
||
− | :< |
+ | :<code>hidden=yes</code> |
:Removes the box and automatically goes to the page specified by <code>default=</code>. |
:Removes the box and automatically goes to the page specified by <code>default=</code>. |
||
Line 119: | Line 124: | ||
!To make this: |
!To make this: |
||
|- |
|- |
||
⚫ | |||
− | | |
||
⚫ | |||
<inputbox> |
<inputbox> |
||
type=create |
type=create |
||
Line 129: | Line 133: | ||
</inputbox> |
</inputbox> |
||
</pre> |
</pre> |
||
⚫ | |||
− | | |
||
⚫ | |||
type=create |
type=create |
||
width=15 |
width=15 |
||
Line 144: | Line 147: | ||
!To make this: |
!To make this: |
||
|- |
|- |
||
⚫ | |||
− | | |
||
⚫ | |||
<inputbox> |
<inputbox> |
||
type=create |
type=create |
||
Line 155: | Line 157: | ||
</inputbox> |
</inputbox> |
||
</pre> |
</pre> |
||
⚫ | |||
− | | |
||
⚫ | |||
type=create |
type=create |
||
width=15 |
width=15 |
||
Line 169: | Line 170: | ||
: ''See [[Help:Preloaded templates]] for more detail'' |
: ''See [[Help:Preloaded templates]] for more detail'' |
||
− | If you want to use a standard article template, you can specify this in the form. |
+ | If you want to use a standard article template, you can specify this in the form. Doing so will pre-load an article with a basic layout in terms of templates and structure, making the process standard for editors. |
;Preloaded text |
;Preloaded text |
||
− | :< |
+ | :<code>preload=pagename</code> |
:For comment and create boxes, the text of the page under pagename will be preloaded (see below) into the blank editbox when a new page is created. |
:For comment and create boxes, the text of the page under pagename will be preloaded (see below) into the blank editbox when a new page is created. |
||
:Example: By specifying "preload=Template:New_page", the content of "Template:New page" will be loaded into the edit box for the new article. |
:Example: By specifying "preload=Template:New_page", the content of "Template:New page" will be loaded into the edit box for the new article. |
||
;Edit introduction |
;Edit introduction |
||
− | :< |
+ | :<code>editintro=pagename</code> |
− | :For comment and create boxes, the text of the page under pagename will be added, as instructions, before the submission form for new pages. It is displayed instead of the text of [[MediaWiki:Newarticletext]] |
+ | :For comment and create boxes, the text of the page under pagename will be added, as instructions, before the submission form for new pages. It is displayed instead of the text of [[MediaWiki:Newarticletext]]. |
:Example: By specifying "editintro=Template:Welcome", the content of Template:Welcome will be shown above the article. |
:Example: By specifying "editintro=Template:Welcome", the content of Template:Welcome will be shown above the article. |
||
Line 186: | Line 187: | ||
!To make this: |
!To make this: |
||
|- |
|- |
||
⚫ | |||
− | | |
||
⚫ | |||
<createbox> |
<createbox> |
||
preload=Template:New_page |
preload=Template:New_page |
||
Line 194: | Line 194: | ||
</createbox> |
</createbox> |
||
</pre> |
</pre> |
||
⚫ | |||
− | | |
||
⚫ | |||
preload=Template:New_page |
preload=Template:New_page |
||
editintro=Template:Welcome |
editintro=Template:Welcome |
||
Line 204: | Line 203: | ||
== See also == |
== See also == |
||
* [[mw:Extension:Inputbox|Inputbox extension documentation on MediaWiki.org]] |
* [[mw:Extension:Inputbox|Inputbox extension documentation on MediaWiki.org]] |
||
− | * [[mw:Extension:CreateBox|CreateBox extension documentation on MediaWiki.org]] |
||
== Further help and feedback == |
== Further help and feedback == |
||
{{Help and feedback section}} |
{{Help and feedback section}} |
||
+ | [[be:Даведка:Inputbox]] |
||
− | |||
[[de:Hilfe:Inputbox]] |
[[de:Hilfe:Inputbox]] |
||
[[es:Ayuda:Inputbox]] |
[[es:Ayuda:Inputbox]] |
||
Line 218: | Line 216: | ||
[[pt:Ajuda:Inputbox]] |
[[pt:Ajuda:Inputbox]] |
||
[[ru:Справка:Inputbox]] |
[[ru:Справка:Inputbox]] |
||
+ | [[tr:Yardım:Giriş kutusu]] |
||
[[uk:Довідка:Inputbox]] |
[[uk:Довідка:Inputbox]] |
||
[[zh:Help:輸入框]] |
[[zh:Help:輸入框]] |
||
− | |||
[[Category:Help]] |
[[Category:Help]] |
Revision as of 19:42, 23 April 2020
An inputbox allows you to put a box on any page, which has a text field for users to fill and a customizable button for launching the action.
There are three types: the article creation box, the search box, and the comment box. The default width for all boxes is 50 characters.
Box types
Article creation box
An article creation box places a box on the page that lets the user create a new page by entering the page title. A new page will be opened at the title the user types in. Page creation is handled by the InputBox extension, or by the CreateBox extension. CreateBox takes mostly the same arguments as InputBox when used with type=create
. Both check if a page already exists and display an error message if it does. It is also possible to use preloaded templates with the box to simplify the article creation process for editors.
Type this: | To make this: |
---|---|
<inputbox> type=create </inputbox> |
Search box
A search box provides an extra box for users to search your community, in addition to the one in the global navigation bar.
Type this: | To make this: |
---|---|
<inputbox> type=search </inputbox> |
Comment box
This box adds a section to an existing page, which can be helpful in adding a new discussion to a talk page, or new items to a news page.
The text typed in the box is the page where to start a new section header. If you use as type commenttitle instead of comment, the text typed in the box becomes the new section header, and is also used as the edit summary for the addition. In this case, you additionally need to define a pagename with the page parameter.
Type this: | To make this: |
---|---|
<inputbox> type = comment buttonlabel=Post a comment </inputbox> |
|
<inputbox> type = commenttitle page = Help talk:Inputbox buttonlabel=Post a comment </inputbox> |
Customizing inputboxes
There are several parameters you can use to customize the display of the inputboxes.
- Background color
bgcolor=#FFFFFF
- Sets the background color using HTML color values. Enter the color value without using quotes. In some cases, giving this the same color as the page color can make the background invisible.
- Width
width=##
- Sets width of input field, where ## is a number of characters. (The default is 50.)
- Default text
default=any text
- Default text to put in the inputbox before it is changed, such as "enter page title here".
- Button label
buttonlabel=any text
- This label will be used for the text in the main submit button of the form.
- Search button label
searchbuttonlabel=any text
- For search forms, this label will be used for the "Search full text" button.
- Line break
break=no
- Removes the default line break between the input box and the button(s), displaying them side by side.
- Placeholder
placeholder=any text
- Define placeholder text that will display in the input box when it is empty.
- Hide Box
hidden=yes
- Removes the box and automatically goes to the page specified by
default=
.
Type this: | To make this: |
---|---|
<inputbox> type=create width=15 placeholder=Type here! buttonlabel=Click here! break=no </inputbox> |
Type this: | To make this: |
---|---|
<inputbox> type=create width=15 default=Type here! hidden=yes buttonlabel=Click here! break=no </inputbox> |
Using preloaded templates with an article creation box
- See Help:Preloaded templates for more detail
If you want to use a standard article template, you can specify this in the form. Doing so will pre-load an article with a basic layout in terms of templates and structure, making the process standard for editors.
- Preloaded text
preload=pagename
- For comment and create boxes, the text of the page under pagename will be preloaded (see below) into the blank editbox when a new page is created.
- Example: By specifying "preload=Template:New_page", the content of "Template:New page" will be loaded into the edit box for the new article.
- Edit introduction
editintro=pagename
- For comment and create boxes, the text of the page under pagename will be added, as instructions, before the submission form for new pages. It is displayed instead of the text of MediaWiki:Newarticletext.
- Example: By specifying "editintro=Template:Welcome", the content of Template:Welcome will be shown above the article.
Type this: | To make this: |
---|---|
<createbox> preload=Template:New_page editintro=Template:Welcome width=25 </createbox> |
<createbox>
preload=Template:New_page editintro=Template:Welcome width=25 </createbox> |
See also
Further help and feedback
- Browse and search other help pages at Help:Contents
- Check Fandom Community Central for sources of further help and support
- Check Contacting Fandom for how to report any errors or unclear steps in this article