ヘルプ:Inputbox

提供:ウィキボヤージュ
ナビゲーションに移動 検索に移動

ここでは、日本語版Wikivoyageにおけるinputboxの使用についてプリロード機能を含めて解説しています。拡張機能の説明はMediaWikiをご覧ください。

Wikivoyageには、Inputboxなる機能があります。この機能を使うことにより、簡単に記事・節を検索・作成・移動することができるようになります。百聞は一見に如かず、実物は以下のようなものです :

これは、inputboxの「検索」機能を使用したものです。このように、入力ボックスを生成して様々な機能を使うことができます。

作り方[編集]

ここでは、Inputboxの作り方を説明します。Inputboxは、<inputbox>タグで囲まれた中にパラメータで情報を指定して作ります。全パラメータを含む構文は以下のとおりです :

<inputbox>
type=
bgcolor=
width=
page=
default=
preload=
editintro=
buttonlabel=
hidden=
searchbuttonlabel=
fulltextbutton=
labeltext=
break=
namespaces=
prefix=
placeholder=
minor=
nosummary=
summary=
id=
inline=
dir=
preloadparams[]=
searchfilter=
useve=
arialabel=
</inputbox>
名前 説明 利用可能なタイプ
type Inputboxのタイプを指定します。「search」では検索・「create」ではページの作成・「comment」では新しいセクション・「fulltext」では全文検索を・「move」では移動をそれぞれ行えるようになります。
arialabel 生成されたHTMLのInputタグに与える、aria-label属性。既定では何も入っていません。主にスクリーンリーダーのアクセスを可能にする目的で使用されます。 全て
bgcolor 背景色です。CSSの色指定で書きます。rgb関数やrgba関数の使用も可能ですが、通常は16進法で書きましょう。 全て
width ボックスの横幅です。単位はpxで、数値だけを指定します。 全て
default 入力ボックスに既定で入力されている文字列です。 全て
preload ページ編集を伴うものに関して、編集ボックスに既定で入力されているものを指定できます。ここに文字列を書くのではなく、別のページに書いてある文字列を読み込むため、ページ名を指定してください。 create、comment
buttonlabel 入力ボックスの下にある、ボタンに表示されている文字を指定します。 全て
hidden yesかnoかで指定します。yesとした場合、入力ボックスが表示されなくなります。これをする場合、defaultパラメータを空にしないでください。 create、comment
searchbuttonlabel ボタンが2つ表示されている場合の2つ目のボタンに表示される文字列です。1つ目についてはbuttonlabelで指定します。 search、fulltext
labeltext ボックスの上に表示される文字列です。ボックスの簡単な説明など。 search2
break yesかnoかで指定します。noとすると、入力ボックスとボタンが横並びに表示されます。 全て
namespaces 全文検索をかける名前空間をチェックボックスで指定します。名前空間は「,」 (カンマ) で区切ってください。デフォルトでチェックボックスにレ印を入れたい場合、名前空間の後に「*」 (アスタリスク) を2つ入れてください。(例 : Wikivoyage名前空間とヘルプ名前空間で全文検索したい場合 - Wikivoyage,Help) search、fulltext
prefix 検索する範囲を指定します。ここにAと書かれた場合、Aのサブページのみが検索対象になります。 search、fulltext、create
placeholder 入力ボックスの背景に書かれている文字列です。 全て
page 移動・コメントアクションをするページを指定します。 comment、move
minor trueかfalseで指定します。trueの場合、編集が細部の編集としてマークされます。 comment、create
nosummary 編集の要約をなくします。 comment
summary 既定で入力されている編集の要約です。 ceate、move
id 生成されたHTMLのformタグに付けられるidです。 全て
inline
dir 入力ボックスにおいて文字の入力する方向を指定します。既定ではltr (left to right) です。右から左にしたい場合rtl (right to left) とします。この指定は言語・文字に依存します。 全て
preloadparams[] プリロードファイルのパラメータを指定します。MediaWiki参照。 create、comment
searchfilter 検索パラメータの指定。 search
useve trueまたはfalseで指定。trueの場合ビジュアルエディターが起動します。 create、comment

URLで指定する[編集]

実は、上記のように様々な指定をしてページを作成することは、Inputboxを使用せずとも可能です。特にページのプリロード(編集ボックスに既定で文字列を入れておく)機能は非常に便利であり、Inputboxを使用せずとも実現されるべきです。

上記様々な機能を実現するためには、URLを指定します。即ち、「https://ja.wikivoyage.org/w/index.php?title=メインページ&action=」の様になっているURLを編集して、URLパラメータを追加することでプリロードや既定の編集要約欄等を実装できるのです。以下がURLのパラメータの一覧です。

パラメータ 説明
title ページ名を指定します。
action ページに対するアクションを指定します。viewでは閲覧、historyでは履歴表示、editでは編集etc... 詳細はMediaWikiも参照。
section 編集するセクションを番号で指定します。新しいセクションの場合newと書きます。
preloadtitle プリロードするページを指定します。この機能は、指定された文字列ではなく指定されたページの内容を読み込みます。
summary 既定で入力されている編集の要約です。
minor 1と指定することで細部の編集ボックスに既定で印が付きます。
nosummary trueと指定することで題名の入力欄がなくなります。
editintro 編集ボックスの上に表示されるものを読み込みます。読込先はメッセージボックステンプレートで表示されるようにしてください。