Jump to content

Extension:VEForAll

課題管理システム: #mediawiki-extensions-veforall
From mediawiki.org
This page is a translated version of the page Extension:VEForAll and the translation is 100% complete.
Languages:
MediaWiki 拡張機能マニュアル
VEForAll
リリースの状態: 安定
説明 他の拡張機能でビジュアルエディターをフォームのテキストエリアに組み込むための JavaScript 機能を定義する
作者 Pierre Boutet, Clément Flipo, Ike Hecht, Yaron Koren ならびに Cindy Cicalese
最新バージョン 0.7 (2025年11月)
互換性の方針 master は後方互換性を維持しています。
MediaWiki 1.40+
データベースの変更 いいえ
ライセンス GNU 一般公衆利用許諾書 2.0 以降
ダウンロード
拡張機能をダウンロード
Git [?]:
使用するフック
提供するフック
translatewiki.net で翻訳を利用できる場合は、VEForAll 拡張機能の翻訳にご協力ください
問題点 未解決のタスク · バグを報告

VEForAll拡張機能（「全てに通用するビジュアルエディタ」）は他の拡張機能の文字入力領域に VisualEditor インタフェースを組み込み、利用者が編集に使えるようにします。

この拡張機能はユーザインタフェースに直接、波及効果を与えません。 むしろ JavaScript 関数（呼称は"applyVisualEditor()"）を定義し、他の拡張機能の文字入力領域から呼び出されます。 現状として、以下の拡張機能が VEForAll を採用します。

当然のことですが、この拡張機能を動作させるためには、VisualEditor 拡張機能をインストールする必要があります。

ダウンロード

コードは .zip形式で、ここからダウンロードできます。

また、MediaWiki のソース コード リポジトリから Git 経由で直接ダウンロードすることもできます。 コマンドラインから、以下のように呼び出せます: 

git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/VEForAll

コードをオンラインで読むには こちら。

インストール

この拡張機能をインストールするには、'1' ディレクトリを作成し（圧縮ファイルを展開するか Git 経由でダウンロードします）、このディレクトリをメインの MediaWiki '$2' ディレクトリ内に配置します。 そして、ファイル 'LocalSettings.php' に、次の行を追加します。 

wfLoadExtension( 'VEForAll' );

VEForAll を他の拡張機能と連携

VEForAll は現在、次の拡張子と連携します。 CommentStreams , Page Forms , FlexForm , VisualData

  • CommentStreams について、インストールは VEForAll（ならびに VisualEditor）のみインストールすると、コメントを書き込む文字入力領域には、自動で VisualEditor インタフェースが付与されます。
  • Page Forms では書式の定義において、どの文字入力領域の入力でもタグに |editor=visualeditor を追加 （"free text" 入力も含む）、また、その書式を表示すると VisualEditor インタフェース を表示する設定です。
  • FlexForm には、たとえば <textarea name="whatever" editor="ve"></textarea> の場合、文字入力領域の定義には editor="ve" を使用。 特定のページには必要に応じて VE エディタを複数利用でき、また VE エディタを入れ子で呼び出せるように、特定の VE エディタにメニューまたはボタンを追加することも可能です。
  • For VisualData, VEForAll is enabled by default in the form for creating a new article, and can be enabled through the Schema Builder in any input with type string and format textarea.


設定

既定では、ツールバーはテキストエリアの下部に表示されます。 ページの書式でページ上部に表示させるには、書式定義の文字入力領域のタグに |class=toolbarOnTop を追加してください。

ツールバーの表示をカスタマイズするには、フックの "VEForAllToolbarConfigNormal" と "VEForAllToolbarConfigWide" を使ってください。 1件以上のフックを呼び出すには、"toolbarOnTop" の設定に依存します。設定していないと "Normal" が、してあると "Wide" が呼応します。

たとえば通常（ツールバーの位置が下部の場合）、「挿入 > Math 方程式」、「挿入 > 画像とメディア」へのボタンの追加、さらに「出典」の加筆には LocalSettings.php に以下の要素を追加し、位置は VEForAll を追加した下にします。 

$wgHooks['VEForAllToolbarConfigNormal'][] = function( &$defaultConfig ) {
        $defaultConfig[4]['include'][] = 'math';
        $defaultConfig[4]['include'][] = 'media';
	    $defaultConfig[4]['include'][] = 'transclusion';
        $defaultConfig[] = [ 'name' => 'reference' ];
};

$wgHooks['VEForAllToolbarConfigWide'][] = function( &$defaultConfig ) {
        $defaultConfig[4]['include'][] = 'math';
        $defaultConfig[4]['include'][] = 'media';
	    $defaultConfig[4]['include'][] = 'transclusion';
        $defaultConfig[] = [ 'name' => 'reference' ];
};

(the same for toolbar on top)

第1行と第3行を有効にするには、拡張機能の Math と Cite それぞれのインストールが必須です。

List of potential button names

This list of potential button names was derived from the VisualEditor source code:

  • alienExtension
  • big
  • blockquote
  • bold
  • bullet
  • cancel
  • changeDirectionality
  • checkList
  • clear
  • code
  • comment
  • commentAnnotation
  • commandHelp
  • editCheckDialog
  • findAndReplace
  • gallery
  • heading1
  • heading2
  • heading3
  • heading4
  • heading5
  • heading6
  • indent
  • insertTable
  • italic
  • language
  • link
  • media
  • mergeCells
  • meta
  • meta/advanced
  • meta/categories
  • meta/languages
  • meta/settings
  • meta/templatesUsed
  • mwExportWikitext
  • mwLanguageVariant
  • mwPre
  • mwSignature
  • number
  • openHelpCompletionsTrigger
  • outdent
  • paragraph
  • preformatted
  • redo
  • showSave
  • small
  • specialCharacter
  • strikethrough
  • subscript
  • superscript
  • table
  • tableCellData
  • tableCellHeader
  • transclusion
  • underline
  • undo


既知の問題点

一部の外装では、ドロップダウンがかなり圧縮されて表示される場合があります。 CSS を少し修正することで、これを解決できます: 

table.formtable,
table.multipleTemplateInstanceTable {
  border-collapse: inherit;
}

作者とクレジット情報

VEForAll は Pierre Boutet さんと Clément Flipo さんが開発した VEForPageForm 拡張機能（すでに非推奨）に大きく依存しています。 コードの汎用性を高める作業の一部は Ike Hecht さん、Yaron Koren さんと Cindy Cicalese さんが担当。 コード貢献者はほかにも Anysite さんと Mark Hershberger さん。 VEForAll には、構造化議論拡張機能のコードを含みます。

バージョン履歴

  • 0.1 - - 最初のバージョン
  • 0.2 - - ツールバーを設定可能に、Math 拡張機能の依存性を廃止、「フォーカスした」文字入力領域の入力値の制限を解除、VE の表記方向を指定を修正 (RTL/LTR) 、"veForAll.targetCreated" フックの追加、その他の修正多数
  • 0.3 - - MW 1.35以降のサポートを改善、サポート廃止 MW < 1.29以前、Page Forms "max height" パラメータ（高さ上限）の処理を追加、wikitext 形式の表の Page Forms テンプレートの入力欄にパイプの迂回を追加、バグ修正
  • 0.4 - - MW 1.34以降のサポートを改善、サポート廃止MW < 1.32、パイプ記号の迂回を修正
  • 0.4.1 - - MW 1.39 以降にサポートの修正あり、その他の修正
  • 0.5 - - MW 1.39以降にサポートの修正あり、サポート廃止、MW < 1.35
  • 0.5.1 - - Parsoid 処理の修正済み、MW 1.40 以降。"rowspan" と "colspan"の処理を修正。フックの処理を更新
  • 0.5.2 - - Improved support for MW 1.41+; fix for rapid conversion between wikitext and HTML
  • 0.6 - - Removed support for MW < 1.39; removed requirement for "visualeditor-enable" preference; fix for "toolbar on top" positioning
  • 0.7 - - Removed support for MW 1.39; improved support for MW 1.44+; code improvements
Retrieved from "https://www.mediawiki.org/w/index.php?title=Extension:VEForAll/ja&oldid=8026019"