ヘルプ:ListingEditor

提供:ウィキボヤージュ
ナビゲーションに移動 検索に移動
日本語のListing Editor

フォームベースのlisting editorを使用すると、listingテンプレートの追加や編集が可能です。Wikivoyage:Listingも参照。

使用方法[編集]

各リストは、リストフォームに以下のように入力することで記述することができます。

  • Name/名前: 目的地の名前です。
  • Alt/別名: 目的地の別名。日本国外の目的地は現地の言葉の名前を書く。言語ラベルを使うと便利。
  • Website/WEB: 目的地の公式サイト。この値は設定しておくことが推奨されます。
  • Address/住所: 目的地の所在地。住所です。この値は設定しておくことが推奨されます。
  • Directions/アクセス: 近くの駅や高速道路の出口、港さらには空港などから目的地までのルート。東京などの大都市から目的地に着くまでの交通機関の案内も可。
  • Phone/電話: 目的地と連絡が取れる電話番号。
  • Tollfree/フリーダイヤル: 目的地にフリーダイアルがある場合、それを記入。
  • Fax: FAX。
  • Email/メール: 目的地と連絡が取れるメールアドレス。
  • Last Updated: 最終更新日時。無記入で可。
  • type/タイプ: listingテンプレートのタイプ。listingテンプレートには様々な種類がある。詳細はWikivoyage:Listing#サンプルを参照。
  • Latitude/緯度: 目的地の緯度。10進法で。値についてはWikivoyage:Listing#緯度経度の情報源も参照してください。この値は設定しておくことが推奨されます。
  • Longitude/経度: 目的地の経度。10進法で。値についてはWikivoyage:Listing#緯度経度の情報源も参照してください。この値は設定しておくことが推奨されます。
    •  : lat (Latitude/緯度) とlong (Longitude/経度) は小数点以下の値が同じでなくてはなりません. 座標取得にはGeoMapがオススメです。
  • Hours/時間: 目的地が営業している時間。
  • Price/値段: 入場料や宿泊料など、その目的地を利用するために必要なお金の値段。
  • Wikidata: その目的地がWikidataにおいて項目として存在するならば、その項目の項目名をつけるのが適切でしょう。Wikidataへのリンクがあれば記述されていない情報をWikidataから取得することも可能です (「ウィキデータとの共有フィールドの同期」機能) 。
  • Wikipedia: 目的地についてのWikipediaのページ名。これを指定するとWikidataの項目名をワンクリックで書くことができます (Wikidataのボックスの「WP」を押してみてください)。
  • Image/写真: 地図上の目的地のピンに表示される画像です。名前空間名 (File:image:など) は付けないでください。
  • この値で共有フィールドを更新しますか?: クリックすると、Wikidataのロゴがついているボックスの情報が全てWikidataのものに変わります。何も書いていなかった場合Wikidataの情報が追加されます。この機能はWikidataの項目が指定されている場合のみ利用可能です。
  • listを最新のものとしてマークする: このボックスにチェックをいれると、最終更新日が更新されます。情報を更新したときなどは忘れずにここにチェックを入れてください。
  • このlistingを削除: ここにチェックを入れて投稿ボタンを押すことで、listingテンプレートを削除することができます。
  • 編集の要約: 編集の要約です。ここに書いたものは、ページの履歴に「listingeditorでリストを更新 : (名前) - (要約)」のように表示されます。
  • 細部の編集: 細部の編集です。ここにチェックを入れると、編集が細部の編集としてマークされます。

他にもパラメータが存在し、Wikivoyage:Listingで解説されています。

機能[編集]

listing editorを開く前の画面 (英語)
listing editorを開いた後の画面 (英語)

Listing Editorはとても便利な機能で、特定のパラメータを表示したり非表示にしたり、ヘルプページへのリンクのような拡張機能を提供します。エディターはテンプレートを柔軟化し、<span class="vcard">と、対応する名前 (<span class="org">)・住所 (<span class="label">)・代替のニックネーム (<span class="nickname">) がついている項目ではHTMLではなくwikitextにとても依存しています。目的地のジオコーディングは、geoテンプレートの中に<span id="geodata">lat;long</span>を含めることで実現できます。

  • ガイドページの一部セクションに[リストを追加]ボタンを追加します (「観る」・「する」・「買う」・「食べる」・「泊まる」・「困ったときは」節に追加されます)。
  • 見出しの名前によってListingテンプレートのタイプを自動で選択します。
  • Listingテンプレートに小さな「編集」ボタンが追加されます。
  • {{Listing}}テンプレートの引数を一覧表示できるポップアップ状のエディターを開きます。
  • 編集の要約が自動で生成されます。

要望[編集]

ご要望はノートに提起してください。

  • モバイル版対応 - ListingEditorをモバイル端末のモバイル版Wikivoyageでも使用できるようにする。
  • Geoコーディングの改善 - 座標を1つの入力欄にカンマ (,) で区切って記入するなど。
  • ロード時間 - listing editor の読み込みには、節の編集作業時間にフォーム作成と展開に相当する分の時間が加算されます。スクリプトはシーケンス順に走り、編集しようとする節が API から返るのを待ちフォームを作成します。技術上、フォーム作成のタイミングは待機時間の終わりではなく待機中でも可能です(読み込み時間の短縮率は20-30%の見込み。)

インストール方法[編集]

日本語版Wikivoyageではガジェット化されているため、個人設定から導入することが可能です。

バージョン[編集]

設定[編集]

ListingEditorにはローカル言語に合わせて変更しなければいけない点がいくつかあります。

TRANSLATIONS
ローカル言語に翻訳するべき単語 (文章) の一覧です。
MAX_DIALOG_WIDTH
ListingEditorの最大幅 (px単位)
ALLOW_UNRECOGNIZED_PARAMETERS
Editorが認識できなかったパラメータを自動的に消していいか。Editorが認識するパラメータの一覧はLISTING_TEMPLATESにあります。
SECTION_TO_TEMPLATE_TYPE
Listingテンプレートを追加するためのリンクを表示するセクション名。'⧼セクション名⧽': '⧼Listingテンプレートの種類⧽'の形式で記述。
DISALLOW_ADD_LISTING_IF_PRESENT
「リストを追加」のリンクを表示しないページの種類・セクションの一覧。
DEFAULT_LISTING_TEMPLATE
Listingのデフォルトのテンプレート。
LISTING_TYPE_PARAMETER
Listingテンプレートの種類を指定するパラメータの名前。日本語版Wikivoyageではtypeです。
LISTING_CONTENT_PARAMETER
目的地についての説明を書くパラメータ名を指定します。日本語版Wikivoyageではcontentです。
EDIT_LINK_CONTAINER
Template:Listing must be configured with an HTML element that will contain "edit listing" links, and this parameter specifies a JQuery selector that matches that HTML element.
LISTING_TEMPLATE_PARAMETERS
This configuration object links the listing editor HTML (as specified in the EDITOR_FORM configuration value) to the wiki syntax used as the template parameters. A single configuration array can be specified if all listing templates behave the same, or multiple arrays can be specified to support different behavior for different templates - for example, on English Wikivoyage a separate SLEEP_TEMPLATE_PARAMETERS array is configured to support the fact that the sleep template uses "checkin" and "checkout" instead of "hours.
LISTING_TEMPLATES
リストがどのテンプレートを使用して表示されるのか指定します。日本語版Wikivoyageではseeやeat等すべてのリストに於いてTemplate:Listingを使用しているためLISTING_TEMPLATE_PARAMETERSを指定します。
EDITOR_FORM_SELECTOR
A JQuery selector that will match the listing editor UI specified in EDITOR_FORM.
EDITOR_CLOSED_SELECTOR
A JQuery selector that will match the listing editor UI specified in EDITOR_FORM corresponding to the input indicating that a listing should be removed from the site.
EDITOR_SUMMARY
A JQuery selector that will match the listing editor UI specified in EDITOR_FORM corresponding to the edit summary input field.
EDITOR_MINOR_EDIT
A JQuery selector that will match the listing editor UI specified in EDITOR_FORM corresponding to the checkbox indicating that an edit is a minor edit.
EDITOR_FORM
The HTML to use for the listing editor UI.

コールバック[編集]

ListingEditorを拡張したい場合にListingEditor.Callbacksモジュールによってサポートされているコールバックが使用できます :

CREATE_FORM_CALLBACKS
ListingEditorのUIが作成されたときに呼び出されます。デフォルトでは、Geoマップと通貨記号追加機能を初期化するコールバックが書かれています。
SUBMIT_FORM_CALLBACKS
ListingEditorの入力情報が送信された直後 (データ検証前) に呼び出されます。デフォルトでは最終編集日時を処理する機能が置かれています。
VALIDATE_FORM_CALLBACKS
ListingEditorの入力情報が送信されSUBMIT_FORM_CALLBACKSが実行された後に呼び出されます。validator 機能はリスティングが空欄ではないか、入力されたメールアドレスがすべて存在するか検証します。もし validator からメッセージ文字列が返るとその値をユーザーに表示し、フォームは搭載されない仕組みです。

バージョン情報[編集]

日本語版WikivyageのListingEditorは、英語版から翻訳された後改良がなされています。現在の最新のバージョンはja 1.1です。

JavaScript
ja 1.0
英語版から翻訳された当初のバージョン。非常に細かな変更はあったものの英語版のListingEditorを翻訳しただけに等しい。
ja 1.1
ガジェット化の提案が行われていた水茶屋で出ていたタグ付け機能の搭載。タグ名はListing Editor。「地図で見つける」リンクが表示されなくなってしまう問題が修正された。
ja 1.2
markerテンプレートの変更によりListingテンプレートに追加されたlink引数に対応。解説ページが日本語のものに変更された他、日本語訳の一部修正が行われ、ヘッダーに解説ページへのリンクが追加され、モバイル版でのスタイル破壊に対策がなされた。また、保存完了時に保存した旨のバブル通知を表示し、Listing Editorによる編集に付けられる「Listing editor」タグの表示が変更された(ヘルプページへのリンクが追加された)。なお、保存中には円形の動くアイコンが表示される機能も導入予定であったが、画像が読み込まれないため先送りとなった。
ja 2.1
モバイル版に対応。

CSS
ja 1.0
英語版からの導入当初のバージョン。英語版とは特に変更点なし。
ja 2.1
モバイル版に対応したバージョン。