IIIF Curation Editor

“IIIF Curation Editor”は、IIIF Curation Viewerなどで作成したキュレーションを編集するツールである。

キュレーションをJSONとして編集する機能を持ち、キュレーションのJSONスキーマを最低限チェックする機能を提供する。

目次

動作デモ/活用例

使い方

キュレーションの指定

ヘッダの「ログイン」から、キュレーションを投稿した際のユーザアカウントでログインする(匿名で投稿されたキュレーションを編集する場合は、ログインは不要)。

トップ画面キャプチャ

編集するキュレーションのURLを入力し、Enterキーまたは「編集」ボタンの押下により、キュレーションの編集に遷移する。

キュレーションの編集

編集対象となるキュレーションのJSONデータがエディタに表示される。

エディタは編集モード(ツリー/コード)が選択でき、初期状態ではツリー編集モードで表示される。

エディタ画面(ツリー編集モード)キャプチャ

ツリー編集モードのメニューでは、全てのフィールドを開く、全てのフィールドを折り畳む、元に戻す、やり直し、編集モードの切り替え、テキスト検索の操作を行うことができる。

また、フィールド左端に表示された二つのアイコンによって、ドラッグによる順番変更やメニューによる編集操作が行える。

必要に応じて、コード編集モードに切り替えることで、より直接的な編集が可能となる。

エディタ画面(コード編集モード)キャプチャ

コード編集モードのメニューでは、JSONデータのフォーマット、圧縮(不要な空白の削除など)、修復(引用符の修正など)、編集モードの切り替えの操作を行うことができる。

編集によりJSONとして不正な内容になった場合や、JSONスキーマを満たさない内容になった場合は、エラーの旨が表示される。

キュレーションの上書き保存

キュレーションの編集を終えれば、「上書き保存」ボタン押下により、キュレーションを上書き保存する。

他ユーザが投稿したキュレーションを上書き保存しようとした場合など、保存に失敗した場合は、エラーが表示される。

設置時の設定

IIIF Curation Editor設置時のオプション指定により、Editorの挙動をカスタマイズできる。

オプション指定は、次に挙げるプロパティを持ったオブジェクトをIIIFCurationEditorの引数に与えることによって行う。

  • title:デフォルト値'IIIF Curation Editor'
  • service
    • curationJsonExportUrl:デフォルト値''
  • doc
    • aboutUrl:デフォルト値'http://codh.rois.ac.jp/software/iiif-curation-editor/'
  • jsonEditorOptions:デフォルト値{}

title

titleは、IIIF Curation Editorのヘッダ左上部分および<title>に用いられる名称を指定する。言語ごとに異なる名称とする場合、次のように@language@valueを用いて記述する。

title: [
    {
        '@language': 'en',
        '@value': '<span class="icp_navbar_brand_logo"></span>IIIF Curation Editor'
    },
    {
        '@language': 'ja',
        '@value': '<span class="icp_navbar_brand_logo"></span>IIIF Curation Editor'
    }
]

service

curationJsonExportUrlは、キュレーションを保存する際の送信先URLを設定する。

doc

aboutUrlは、ヘッダの「ヘルプ」からリンクされるURLを設定する。言語ごとにリンク先を分ける場合、次のように@language@valueを用いて記述する。

doc: {
    aboutUrl: [
        {
            '@language': 'en',
            '@value': 'http://codh.rois.ac.jp/software/iiif-curation-editor/index.en.html'
        },
        {
            '@language': 'ja',
            '@value': 'http://codh.rois.ac.jp/software/iiif-curation-editor/index.ja.html'
        }
    ]
}

jsonEditorOptions

JSON Editorのオプション(詳細)を指定する。

同オプションのschema設定値にcurationSchemaを指定することで、Curationの最低限のJSONスキーマを用いたバリデーション機能が有効となる。

設定例

index.js

var iiifEditor = (function() {
    var configExample = {
        curation: {
            service: {
                curationJsonExportUrl: 'https://mp.ex.nii.ac.jp/api/curation/json'
            },
            jsonEditorOptions: {
                schema: curationSchema
            }
        }
    };
    return IIIFCurationEditor(configExample.curation);
})();

プラグイン

IIIF Curation Editorは、IIIF Curation Viewerと同様に、プラグインを導入することによって、利用者のニーズに応じた機能拡張が可能となっている。IIIF Curation Viewerプラグイン解説資料を参照のこと。

ライセンス

IIIF Curation Editor v1.0
http://codh.rois.ac.jp/software/iiif-curation-editor/

Copyright 2018 Center for Open Data in the Humanities, Research Organization of Information and Systems
Released under the MIT license

Core contributor: Jun HOMMA (@2SC1815J)

Licenses of open source libraries, see acknowledgements.txt