Extension:InputBox

From MediaWiki.org
Jump to: navigation, search
This page is a translated version of the page Extension:InputBox and the translation is 42% complete.

Other languages:
English • ‎français • ‎日本語 • ‎한국어 • ‎polski • ‎português do Brasil • ‎русский • ‎中文
この拡張機能は MediaWiki 1.21 以降に同梱されています。 そのため再度ダウンロードする必要はありません。 しかし、提供されているその他の手順に従う必要はあります。
MediaWiki 拡張機能マニュアルManual:Extensions
Crystal Clear action run.png
InputBox

リリースの状態:Extension status 安定

Simple Input Form.png
実装Template:Extension#type Tag, Page action, Search
説明Template:Extension#description あらかじめ定義された HTML フォームを利用者がウィキページに追加できるようにする
作者Template:Extension#username Erik Möller, Leonardo Pimenta, Rob Church, Trevor Parscal, Daniel Schuba (Eloquencetalk)
最新バージョンTemplate:Extension#version Continuous updates
MediaWikiTemplate:Extension#mediawiki 1.23+
データベースの変更Template:Extension#needs-updatephp いいえ
ライセンスTemplate:Extension#license MIT License
ダウンロード
タグTemplate:Extension#tags
* <inputbox>
使用するフックTemplate:Extension#hook
ParserFirstCallInitManual:Hooks/ParserFirstCallInit
MediaWikiPerformActionManual:Hooks/MediaWikiPerformAction
SpecialPageBeforeExecuteManual:Hooks/SpecialPageBeforeExecute

translatewiki.net で翻訳を利用できる場合は、InputBox 拡張機能の翻訳にご協力ください

使用状況とバージョン マトリクスを確認してください。

問題点Phabricator

未解決のタスク · バグを報告

InputBox 拡張機能はあらかじめ作られた HTML フォームをウィキページに追加します。 利用者はボックスにテキストを入力することによってフォームを「埋める」(テキストを入力する、メニュー項目を選択する、等)ことができます。

InputBoxは、当初は Erik Möller によって Wikinews の「記事を作成する」欄を追加するために作成されました。

インストール

  • ダウンロードして、ファイルを extensions/ フォルダー内の InputBox という名前のディレクトリ内に配置します。
  • 以下のコードを LocalSettings.php の末尾に追加します:
    wfLoadExtension( 'InputBox' );
    
  • YesY 完了 - ウィキの「Special:Version」に移動して、拡張機能が正しくインストールされたことを確認します。

MediaWiki 1.24 以前を稼働させている利用者へ:

上記の手順では、wfLoadExtension() を使用してこの拡張機能をインストールする新しい方法を記載しています。 この拡張機能をこれらの過去のバージョン (MediaWiki 1.24 以前) にインストールする必要がある場合は、wfLoadExtension( 'InputBox' ); の代わりに以下を使用する必要があります:

require_once "$IP/extensions/InputBox/InputBox.php";

新しい記事を開始するためのボックス。

ウィキコード

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

結果

一般的な構文

入力ボックスは以下のように構築されます:

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

type パラメーターは必須です。 その他のパラメーターはすべて省略可能です。 preloadparams[]は複数回現れます。

ボックスの種類

既定では、送信ボタンは入力ボックスの下に配置されます。 送信ボタンは、break=noというパラメータを指定することで入力ボックスの右に配置させることも可能です。このパラメータは、入力ボックスと送信ボタンの間にある改行を取り除くものです。

送信ボタンを下に配置すると入力の自動補完機能によってボタンが隠れてしまうといった場合には右に配置するのが有用です。

種類 説明
type=search
既定の幅が50文字の検索ボックスを作成します。 テキストボックスに追加された情報が検索されます。
type=create

新しいページを作成します。 テキストボックスに追加される情報は、編集されたページの名前です。
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. rev:42703 で追加されました。
type=fulltext
Search only with the fulltext search button, without the “Go” button. rev:45269 で追加されました。
type=move

ページ名を別の名前に移動する 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=search2
 


パラメーター

パラメーター 説明 通用範囲 互換性 結果
bgcolor= Sets the table background color (HTML color values). 引用符の使用は不可 すべての種類 ?
<inputbox>
type=search
bgcolor=#eeeeff
</inputbox>
width= Sets the width of the InputBox in characters. すべての種類 ?
<inputbox>
type=create
width=24
</inputbox>

default= Default text to put in the InputBox. すべての種類 ?
<inputbox>
type=comment
default=User talk:Eloquence
</inputbox>

preload= The page under this title will be preloaded (see Manual:Creating pages with preloaded textManual:Creating pages with preloaded text) into the blank editbox when a new page is created. create, comment, commentitle ?
<inputbox>
type=create
preload=Log
</inputbox>

Enter the title of a non-existent page in the example InputBox above or below, and click "項目を作成" or "新しい節" 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>

buttonlabel= This label will be used for the main button of the form. すべての種類 ?
<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>

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>
fulltextbutton= Show the full text search button on search2 form search2 ?
<inputbox>
type=search2
searchbuttonlabel=Dig deeper
fulltextbutton=true
</inputbox>
labeltext= Text to print beside the button search2 ?
<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). すべての種類 ?
<inputbox>
type=create
width=24
break=no
</inputbox>
namespaces= Support for namespace checkboxes in fulltext search.

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

search, fulltext ?
<inputbox>
type=search
namespaces=Main**,Help
</inputbox>
prefix=
  • Narrow down search to pages beginning with certain prefix. Note this only works with certain search back-ends, currently only latest Extension:lucene-searchExtension: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.

search, fulltext, create ?
<inputbox>
type=search
prefix={{FULLPAGENAME}}/Archive
</inputbox>

The button below prefixes the name with Special:Mypage/.


placeholder= Define placeholder text that will display in the input box when it is empty. すべての種類 1.19+
<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>

minor= 細部の編集。 comment, create
<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>

summary= Edit summary or move reason. create, move
<inputbox>
type=create
default=Special:Mypage/inputbox test
summary=Foo
</inputbox>

id= id attribute for <form>. すべての種類 1.23 for some types
<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:
 
dir= Right to left (rtl) or left to right (ltr). Defaults to directionality of the page's language. すべての種類
<inputbox>
dir=rtl
type=comment
page=Project:Sandbox
summary=Foo
</inputbox>

preloadparams[]= Specify parameters to the preload text. See Creating pages with preloaded text. create, comment, commentitle 1.25+
<inputbox>
type=create
preload=Log
preloadparams[]=param1
preloadparams[]=param2
</inputbox>

searchfilter= Specify parameters to append to the search search 1.30+
<inputbox>
type=search
searchfilter=insource:foo
</inputbox>
useve= 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. Bug remains to be fixed to be able to include the prefix parameter in the string of the page to be created. If the whole path of the page is typed, VE creates it correctly in all spaces. create, comment
<inputbox>
type=create
break=no
useve=true
</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 Upload summary.

配置

If you want to create an inputbox on the right side of the page, do something like:

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


パーサー関数

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}}

関連項目