Metadata JSON API

< 前に戻る

BuildVuは、次のようなメタデータを書き出します。

  1. ドキュメントに関するデータ (ページ数やページ範囲など)
  2. PDFデータ (タイトル、作成者、件名、ブックマーク、ページラベルなど)
  3. 出力に関するデータ (ページタイプやサムネールタイプなど)

IDRViewerモードでは、この情報はconfig.jsファイルにあります。コンテンツモードでは、properties.jsonファイルに保管されます。どちらも出力ディレクトリーの基本レベルに保管されます。

アノテーションは別のファイル (annotations.json) を参照してください。

エントリーのリスト

KeyTypeValue
pagecountintegerドキュメントのページ数 例: 15
fileNametext string変換されるPDFのファイル名 例:  my-document.pdf
boundsarrayページの幅と高さ 例:
[[909,1286],[909,1286],[909,1286]]
bookmarksarrayPDFファイルのブックマークを含む配列 (後述参照)
thumbnailTypetext string” /thumbnail “ディレクトリ (生成された場合) にあるサムネイルのファイルタイプ。例: “jpg” “png”
pageTypetext string生成されるページのタイプ 例: “html” “svg” “svgz”
pageLabelsarray of text stringPDFドキュメントでページラベルが指定されていない場合は空の配列となり、指定されていない場合はページラベルを含むページ数(pagecount)の配列となります。例:

["i", "ii", "iii", "iv", "1", "2", "3"]

または、

["Cover", "1", "2", "3"]
titletext stringPDFドキュメントのタイトル (提供されている場合)
authortext stringPDFドキュメントの作成者の名前 (提供されている場合)
subjecttext stringPDFドキュメントの件名 (提供されている場合)
keywordstext stringPDFドキュメントに関連付けられたキーワード (提供されている場合)
creatortext stringドキュメントが別の形式からPDFに変換された場合、変換元のドキュメントを作成した製品の名前 (提供されている場合)
producertext stringドキュメントが別の形式からPDFに変換された場合は、PDFに変換した製品の名前 (提供されている場合)
creationdatedatePDF文書(人が読める形式で)が作成された日時 (提供されている場合)
moddatedatePDF文書(人が読める形式で)が最後に修正された日時(提供されている場合)
trapped

Bookmarks

ブックマーク (またはアウトライン) は、ドキュメントのコンテンツリストとして機能し、再帰的にネストできます。テキスト文字列をページにリンクし、オプションでページ上の指定したオフセットまでスクロールできます。

座標は左下の原点であることに注意してください。

例:
[
{
"title": "1 Scope",
"page": 9,
"zoom": "XYZ 108 974 null"
}, {
"title": "2 Conformance",
"page": 9,
"zoom": "XYZ 108 577 null",
"children": [{
"title": "2.1 General",
"page": 9,
"zoom": "XYZ 108 534 null"
}, {
"title": "2.2 Conforming readers",
"page": 9,
"zoom": "XYZ 108 388 null"
}
]
}, {
"title": "3 Normative references",
"page": 10,
"zoom": "XYZ 55 1035 null"
}, {
"title": "4 Terms and definitions",
"page": 14,
"zoom": "XYZ 55 1162 null"
}, {
"title": "5 Notation",
"page": 18,
"zoom": ""
}
]

Dates

日付は形式のテキスト文字列である
(D:YYYYMMDDHHmmSSOHH'mm)

  • YYYYは年
  • MMは月 (01-12)
  • DDは日 (01-31)
  • HHは時間 (00–23)
  • mmは分 (00–59)
  • SSは秒 (00–59)
  • Oは現地時間と世界時(UT)の関係であり、プラス記号(U + 002B)(+)、ハイフンマイナス(U + 002D)(-)、またはラテン文字のいずれかで表されます。 レターZ(U + 005A)(Z)(下記参照)
  • HHの後にアポストロフィ(U + 0027)( ‘)は、UTからのオフセットの絶対値(時間(00〜23))
  • mmは分単位のUTからのオフセットの絶対値(00–59)

接頭辞 “D:” は年フィールド ( YYYY ) が存在し、そして他の全てのフィールドが存在することができる。ただし、それらの前のフィールドの全てが存在する場合に限られる。
時間オフセットフィールド(HH)に続くアポストロフィは、HHフィールドが存在する場合にのみ存在します。
分のオフセットフィールド(mm)は、時間のオフセットフィールド(HH)に続くアポストロフィが存在する場合にのみ存在します。
MMとDDのデフォルト値は両方とも”01″です。 他のすべての数値フィールドは、デフォルトで”0″値になります。
Oフィールドの値としてのプラス記号は、現地時間がUTより遅いことを示し、ハイフン-マイナスは現地時間がUTより早いことを示し、ラテン大文字Zは現地時間がUTに等しいことを示します。
UT情報が指定されていない場合、指定された時刻とUTの関係はGMTと見なされます。
時間帯が指定されているかどうかに関係なく、残りの日付は現地時間で指定されます。

表示例

たとえば、1998年12月23日の7:52 PM (米国太平洋標準時間) は、文字列 D:199812231952-08’00 で表されます。

    BuildVu_SML

    こちらはBuildVuご利用者専用のサポートです。一般のご質問は製品ページからお願いいたします。

    MENU