メタデータJSON API

BuildVuは、以下のような様々なメタデータを出力します：

ドキュメントに関するデータ（ページ数やページの境界など）
PDFファイルからのデータ（タイトル、著者、サブジェクト、ブックマーク、ページラベルなど）
出力に関するデータ（ページやサムネイルのタイプなど）

IDRViewerモードでは、この情報はconfig.jsファイルに、contentモードではproperties.jsonファイルに格納されます。これらのファイルはいずれも出力ディレクトリのベースレベルに保存されます。

アノテーションは別のファイル（annotations.json）に格納されており、こちらで説明されています。

エントリーリスト

pagecount

型：整数

値：ドキュメント内のページ数。例：15

fileName

型：テキスト文字列

値：変換されるPDFのファイル名。例：“my-document.pdf”

bounds

型：配列

値：ページの幅と高さ。例：

[[909,1286],[909,1286],[909,1286]]

bookmarks

型：配列

値： PDFファイルからのブックマークを含む配列（以下で説明）。

thumbnailType

型：テキスト文字列

値： /thumbnailsディレクトリ内のサムネイル画像のファイルタイプ（生成された場合）。例：“jpg"または"png”

pageType

型：テキスト文字列

値：生成されたページのタイプ。例：“html”、“svg”、または"svgz"

pageLabels

型：テキスト文字列の配列

値： PDFドキュメントがページラベルを指定していない場合は空の配列になり、それ以外の場合はページカウント分の長さの配列で、ページラベルが含まれます。例：

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

または

["Cover", "1", "2", "3"]

title

型：テキスト文字列

値： PDFドキュメントのタイトル（提供されている場合）。

author

型：テキスト文字列

値： PDFドキュメントを作成した人の名前（提供されている場合）。

subject

型：テキスト文字列

値： PDFドキュメントのサブジェクト（提供されている場合）。

keywords

型：テキスト文字列

値： PDFドキュメントに関連するキーワード（提供されている場合）。

creator

型：テキスト文字列

値：ドキュメントが別のフォーマットからPDFに変換された場合、変換元の元のドキュメントを作成した適合製品の名前（提供されている場合）。

producer

型：テキスト文字列

値：ドキュメントが別のフォーマットからPDFに変換された場合、PDFに変換した適合製品の名前（提供されている場合）。

creationdate

型：日付

値： PDFドキュメントが作成された日時（人間が読める形式）（提供されている場合）。

moddate

型：日付

値： PDFドキュメントが最後に変更された日時（人間が読める形式）（提供されている場合）。

ブックマーク

ブックマーク（またはアウトライン）は、ドキュメントの目次のような役割を果たし、再帰的にネストされる場合があります。テキスト文字列をページにリンクし、オプションでページ上の指定されたオフセットまでスクロールすることができます。

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

例

[
    {
    "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": ""
  }
]

日付

日付は次の形式のテキスト文字列でなければなりません

(D:YYYYMMDDHHmmSSOHH'mm)

ここで：

YYYYは年
MMは月（01～12）
DDは日（01～31）
HHは時（00～23）
mmは分（00～59）
SSは秒（00～59）
Oは現地時間と協定世界時（UT）との関係を示し、PLUS SIGN（U+002B）（+）、HYPHEN-MINUS（U+002D）（-）、またはLATIN CAPITAL LETTER Z（U+005A）（Z）のいずれかの文字で表されます（以下を参照）
HHの後にAPOSTROPHE（U+0027）（’）が続き、UTからのオフセットの絶対値を時間単位で表します（00～23）
mmはUTからのオフセットの絶対値を分単位で表します（00～59）

プレフィックスD:は必須、年フィールド（YYYY）は必須で、その他のフィールドは存在してもかまいませんが、その前にあるすべてのフィールドが存在する場合に限ります。時オフセットフィールド（HH）の後のAPOSTROPHEは、HHフィールドが存在する場合にのみ存在します。分オフセットフィールド（mm）は、時オフセットフィールド（HH）の後のAPOSTROPHEが存在する場合にのみ存在します。MMとDDのデフォルト値はどちらも01で、その他すべての数値フィールドのデフォルト値はゼロです。OフィールドがPLUS SIGNの場合は現地時間がUTより遅いことを、HYPHEN-MINUSの場合は現地時間がUTより早いことを、LATIN CAPITAL LETTER Zの場合は現地時間がUTと等しいことを意味します。UT情報が指定されていない場合、指定された時刻とUTとの関係はGMTとみなされます。タイムゾーンが指定されているかどうかにかかわらず、日付の残りの部分は現地時間で指定する必要があります。

例

たとえば、1998年12月23日午後7時52分、米国太平洋標準時は、文字列D:199812231952-08'00で表されます