2017年版ウィキテキストエディター

This page is a translated version of the page 2017 wikitext editor and the translation is 100% complete.

2017年版ウィキテキストエディター はVisualEditor拡張機能内のモードの1つであり、利用者がウィキテキストのソースコードを編集する際に、ビジュアルエディターのツールを使用できるようにします。ビジュアルエディター内のツールバーでウィキテキストに切り替えるボタンをクリックすることで、この機能にアクセスできます。

2017年版ウィキテキストエディターは、ウィキメディア財団がホストするウィキへ2023年にリリースされました。既定では、有効化されていません。ウィキメディアのウィキ群では、個人設定に遷移し、「ウィキテキストエディターの代わりに、ビジュアルエディターのウィキテキストモードを使用する」のチェックボックスにチェックを入れて「保存」をクリックすることで、この機能を有効にできます。

概要

「現在のコンテンツの作成と整理のインターフェイスを維持し、改善していく」という2016-2017年の年間計画の目標のひとつを支援するため、編集委員会は新しいウィキテキストエディターに取り組んでいます。

2つのモードの切り替えを改善するため、ビジュアルエディターに統合されています。ビジュアルエディターと似たデザインであり、citoid 機能をはじめビジュアルエディターの数多くの機能も備えています。新ウィキエディターはデスクトップ利用者が利用可能です。Phabricatorのメインタスクはタスク T104479です（「modern wikitext editor」や「new wiki text editor」、NWEとも呼んでいます）。

これは「新しい」エディターであって、既存のウィキテキストエディターへの修正ではありません。このエディターは標準テキスト領域ではなく、VEの外観に基づいているので、多くの編集ガジェットが動作しません（ウィキコードにアクセスするために非常に特殊なAPIを使用する必要があります）。編集フォームを開きテキスト領域を必要とするガジェットは、（action=editではなく）action=submitを使ってウィキコードをそのまま編集するエディターに切り替えることができます。

このプロジェクトの根拠は？

2010年、ウィキメディア財団はユーザビリティプロジェクトを完了（現状のベクター外装、とアップロードツールおよび2010 wikitext editor を提供）して、2010－2015年戦略計画でコミュニティによって選ばれた問題点の改善へ乗り出しました。この中には通知などの他の改善と共に、編集ツール、特にビジュアルエディターの改善が多く含まれていました。しかし、この戦略はウィキテキストに取って代わるものでは決してありません。どちらの編集システムも、長期的にコミュニティが現在のウィキメディアプロジェクト群を継続し成功させるために重要なものであると考えています。

2016年12月時点ではウィキメディアのほぼすべてのウィキ群で、3つの主要なエディタを提供しています。利用者にとっては外観、操作、性能、そしてヘルプやサポートに一貫性がありません。 1つめはウィキエディター (WikiEditor) と呼ばれる2010年代のデスクトップ向けのウィキテキストエディター、2つめはデスクトップ向け・携帯機器向けの形態がある視覚的なエディター、3つめは携帯機器向けの必要最低限の機能を備えたウィキテキストエディターです。

2010年以来、経験の長さに関わらず利用者が私たちのソフトをどう使っているか、編集用ソフトウェアで改善してほしいと考えている点は何か、実に多くを知ることができました。調査に基づくビジュアルエディターの設計により、ベテラン編集者が使い慣れたウィキエディターを離れ、初学者にも使い方が明確にわかる使いやすいデザインを目指したのです。完璧とはいかないまでも、デザインやワークフローのヒント等、ビジュアルエディターは全般に初学者から強く支持されたようです。技術面で新しい課題も多く、ページでの挙動 (例: ソースを編集を押した時) やツールとの相性 (例: フロー)、あるいはデスクトップ版と携帯機器版等、他の拡張機能との伸展性を考えて構築しました。

3つばらばらの編集システムがあるのは不都合です。編集初心者は、せっかく覚えたことが別の状況（議論ページの編集等）では使えないのです。ベテラン編集者は、初めたばかりの編集者の状況を把握し改善案を考える前に、いくつか質問に答えなければいけません。管理者はコミュニティの希望に合わせ、編集ソフトウェアごとの調整が必要だし—あるいはソフトウェアによっては、希望通りにできないと判明するだけに終わってしまいます。スクリプトやガジェットの開発者にとって、さまざまな状況への対応（もしくは無視）をさせられることは徒労になります。何か修正したり機能を追加したりするたび、3倍の手間がかかることを頭に置いて作業するのでは、開発者もたまりません。さらにウィキメディア財団の寄付者のご芳志が複数の並行作業に費やされるのでは非合理です。

上記のような経緯から、現在、新しいウィキテキストエディターである2017年版ウィキテキストエディターに取り組んでいます。これによりデスクトップとモバイル、ウィキテキストとビジュアルエディターの体験を統合し、一貫性をもたらします。複数のエディターに互換性があり、状況やコンテンツの種類が変わってもできるだけ使用体験が近いプラットフォームを目指しています。利用者の皆さんに使い心地の良さを提供し、現状の機能性と両立させようとしています。

利用を希望しない利用者は無効にできます。現状でウィキテキストエディターの運用は少なくとも今後2、3年は継続する予定です。最終的には廃止するかもしれませんが、希望する人が誰でも維持できます。

開発の目標と状況

初回のリリース (ベータ機能)

当初、このプロジェクトが目指したのは、既存のウィキテキストエディターつまりWikiEditorと同じツールバーをビジュアルエディターでも使い、ボタンの位置も変えないことで利用者に一貫性のある使用感を提供することでした。その実現には少なくともウィキテキストエディタのボタンをほぼすべて制御できるようにすることで、ごく少数の例外を次にあげます。

基本ツール（太字、斜体、署名、リンク、画像）;
高度なツール（見出し、箇条書きリスト、番号付きリスト、拡大、縮小、上付き文字、下付き文字、ギャラリー、表）;
特殊文字の挿入、そして
検索して置換です。

上記の項目はいずれも2016年8月までに完成しており、現行のウィキテキストエディタにはなかったさまざまなツール（取り消し線や下線、テンプレート挿入など）や、HTMLコードを貼り付けると自動的にウィキテキストに変換する機能も同様です。特筆すべきは利用者が URL や DOI コードに基づいて手早く出典を追加できるツールで、「サイトイド」（citoid）といいます。機能としては英語版ウィキペディアなど数件のウィキで個別に開発済みのガジェットに似ていて、さらに進化した上に誰でも使えるようになる予定です。

果たして拡張機能が期待通りに機能するかどうかQAテストを念入りに行い、デザインの評価や構造化した利用者テストをしました。設計どおりに機能することを確認でき、新人利用者にとって（少なくとも）使い心地の良さに差がないとわかった段階でベータ機能を導入し、技術レベルの異なるベテラン利用者を揃えてフィードバックをお願いしました。

完成版ベータのリリース (改訂版のリリース前の段階)

ベータ機能としての初回リリースの目標は、この新しい編集機能が皆さんにとって使いやすいかどうか、初期のフィードバックを得ることです。変更点に関し、たくさんのフィードバックから提案を汲み取れると期待しています。すでにいくつかの点の改善を念頭に置いています。なかには新しいウィキテキストエディタのリリースに先立って、ベータ機能とは別に提起する必要がありそうな案件もいくつかあります。技術的に難しいため延期されてきたものや、あるいは現実世界の既存の利用者からフィードバックを受け、できるだけ使いやすい機能作りに役立てたほうがよいものもあります。

左記のうち、第1の分類（大きな課題）として節の編集を定義し、編集ボタンを押すとページ内の編集をする範囲に限定して すべて作業可能なデザインで表示するべきと考えています。すると利用者が小さなディバイス上でもズームインしたり、あるいはその他のアクセシビリティやプラットフォームに依存する条件でも、インターフェースは滑らかにスケールを拡大縮小できるようになります。これらを実現するとモバイル版でもベータ版の拡張機能としてサンプルを提示でき、PC版利用者に限らず、すべての利用者に使ってもらえるようにしたいのです。

前述の課題のうち第2の分類（フィードバックの対象）についてはエディタ内蔵のヘルプを用意し、利用者が初めて編集ボタンを押した直後から利用者をガイドします。編集の各段階を通して、またやがて編集者として経験を積んだときにも役立つようにする必要があります。現状のウィキテキストエディターには「ヘルプ」タブが備わり、簡略なウィキテキストのガイドを提供しています。ビジュアルエディターにある利用者ガイドへのリンクをこの目標に応用できる可能性があります。この機能の内容と強調すべき点については、私たちのコミュニティにそれぞれ達観したアイデアがあるものと予想されます。これらに加え、ガジェットの利用でエディタの機能がどう拡張されるか整理する必要があります。現状では新しいエディタの統合は複雑です。いくつかのガジェットの変換を必要以上に難しくして、ユーザーを困惑させる場合があります。多くのウィキのコミュニティは特定のガジェットに依存して編集ワークフローを効率化していることから、ウィキ群には今回のような改善点を柔軟に試験できる可能性を確保しておくべきなのです。

当然ながら、この規模の変更は一部の利用者のワークフローを混乱させる可能性があり、比較的「エッジケース」では対処されていない問題がいくつかあるでしょう。ベータ機能のリリース後、数週間から数ヶ月を当てて上記の懸案の発見と対処ができることを期待しています。

あるといいもの

上に説明したものに加えて、その他可能であれば提供できたらよいというものがありますが、開発コストの高さや利用者が使うにはおそすぎることを考慮して最初から考慮していません。私たちが提供できたらと考えている機能の1つは、利用者の編集中に下書きをローカルに自動的にを保存する機能で、入力中にブラウザーやコンピューターがクラッシュしたり電源が切れたりした場合に、最初からやり直さなくても再開できるものです。これは利用者をたいへんなストレスから救い、ごくまれなケースとしても、特に状態が悪い/古いコンピューターまたはネットワーク接続の問題を抱えた利用者を救済します。

しばしば話題になるウィキテキストの構文強調機能ですが、利用者が着目する正しいコンテンツに視線を誘導する助けになります。実は、2011年に現状のウィキテキストエディター向けに開発済みだったのですが、ウィキテキストの高度な複雑性が原因となって、この機能を使おうとするとほとんどの利用者の処理速度が著しく遅延してしまうことから、開発を放棄するほかなかったのです。あれから5年が経ち、ほとんどの利用者の使用機器は当時と比べると処理速度が上がり、情況が少し好転しました。また同時に、私たちが強調表示の対象とする種類のウィキテキストをいくつか単純化した場合、パフォーマンスがどれほど向上するか、調べる価値があるかもしれません。

(この期間にRemember the dot の構文強調機能とWikEd が提供した構文強調表示を、ガジェットとして利用可能なウィキがあります)。構文強調もExtension:CodeMirror を使って、2017年版ウィキテキストエディターにgerrit:343878で導入されました。

ブロックごとにウィキテキストの構造を折りたたむ機能は、構文強調表示よりもエラーを起こしやすいものの、利用者が編集しないものを隠して作業中に目にしなくて済むようにします。例えば、長いinfoboxの呼び出しや脚注は、実際に編集するまでブロック単位で折り畳むことができます。これまでビジュアルエディターのために開発した技術は、この信頼性の高い使用事例をもたらすにはよく適していることから、今後も継続していける案件になりそうです。もちろん、構文強調表示機能ではほとんどの利用者にとって便利な機能を備えることを優先し、その代わり、ウィキテキストの構造の複雑さを妥協することも考える必要があるかもしれません。

ほかに提供できそうな便利機能としては、利用者の最近の活動をもとに割り出したワンクリックの編集要約ボタンを2、3個用意し、編集結果を保存しようとするときに使うように呼びかける機能です。すでにこのような拡張機能を取り入れたいくつかのウィキでは、ガジェットとしてたいへん人気があり、すべてのウィキの利用者に使ってもらえるようになると便利でしょう。それができない場合、ウィキごとにガジェットの達人がいるなら、それを設定して維持する手助けをしてもらう必要があります。

資料

2016年4月以降、たたき台としてデザインとモックアップをこちらで公開します。右上の角にあるカッコ付きのアイコンをクリックすると、ウィキテキストエディタを表示します。
またリンク先では旧デモ動画を2016年5月半ばから公開しています。
2017年版ウィキテキストエディタのデモ動画（2016年12月公開著作権一覧）
現行バージョンの Special:Preferences#mw-prefsection-editing-editor で有効化できます。「ウィキテキストエディターの代わりに、ビジュアルエディターのウィキテキストモードを使用する」の項目を有効して、（例えば） https://www.mediawiki.org/wiki/Project:Sandbox?veaction=editsource に移動して切り替え前後の違いを確認してみてください。
「2017年版ウィキテキストエディター」を「ビジュアルエディター」上で使えるようにする作業