前へ 次へ

5–2 UBテキスト

CAS-UB V5から、クラウドサービスで編集中の記事をテキスト（「UB テキスト」と呼びます）としてPCにダウンロードし、Windowsのテキストエディタなどで編集したあと、再アップロードできるようにしました。V5.0

UBテキスト

UBテキストとは

出版物を構成する単位である記事について、全ての記事または一部の記事を一つに結合したテキストファイルです。出版物の構成とツリー構造を表現できます。各記事の内部は、CAS 記法でマークアップします。

UBテキストZIPファイル

ファイル形式

UBテキストをダウンロード／アップロードするときのファイル形式は次の２通りあります。

  • UBテキストZIPファイル
  • UBテキストファイル（出版物全体）

UBテキストZIPファイルはUBテキストファイルと画像ファイルをまとめてZIPで圧縮したファイルです。

<出版物識別名>.b/casbulk.txt <出版物識別名>.b/images/

  •  ○ 出版物識別名は出版物新規作成時に設定する出版物名です。
  •  ○ casbulk.txtは、ファイル名固定のUBテキストファイルです。

UBテキストファイルについては次項を参照してください。

UBテキストファイル

  • テキストファイルの符号化方式は“UTF-8”（BOMなし）としてください。
  • 一つの記事のみでも、複数の記事を一つのファイルにまとめてもどちらでも構いません。
  • 出版物全体をUBテキストにするときは、ファイルの先頭に出版物ヘッダー部を置きます。一部の記事のみをUBテキストにするときは、出版物ヘッダー部は不要です。
  • 各記事の先頭には記事ヘッダー部を置きます。一部の記事のみをUBテキストにするときは、ファイルの先頭に記事ヘッダーを置きます。
  • UBテキストファイルのファイル名は半角英数字を使用してください。

出版物ヘッダー部の構成

  • 出版物ヘッダー部の各行は'+'項目名':'項目データの構成です。
表5･1 出版物ヘッダーの項目名と項目データ
項目名項目データ
updated（オプション）更新日です。ダウンロードの時に設定されます。変更してもアップロードでは無効です。
ahax$kind （オプション：固定）article。ダウンロードの時に設定されます。変更してもアップロードでは無効です。
author （オプション）ダウンロードの時に設定されることがあります。変更してもアップロードでは無効です。
title（オプション）出版物名。ダウンロードの時に設定されます。変更してもアップロードでは無効です。
name （必須：固定）publ
ahax$entryClass （オプション：固定）book3。ダウンロードの時に設定されます。変更してもアップロードでは無効です。

出版物ヘッダー部のサンプル

+ updated: 2017-12-06T14:17:44+0900
+ ahax$kind: article
+ author: Antenna House 
+ title: 新しい本
+ name: publ
+ ahax$entryClass: book3

記事ヘッダー部の構成

  • 記事のヘッダー先頭行は'+'8文字からなる行でなければなりません。
  • ヘッダーの2行目以降は、ヘッダーのデータ行を置きます。
  • データ行は'+'項目名':'項目データの構成です。'+'と項目名、項目名と':'、':'項目データの間の半角空白はあっても無視されます。
表5･2 記事ヘッダーの項目名と項目データ
項目名項目データ
updated（オプション）更新日をアラビア数字により（YYYY-MM-DD形式）で記述します。
ahax$kind（オプション） article（記事のとき）またはfragment （記事の続きのとき）
author （オプション）ダウンロードのときのみ設定されることがあります。変更してもアップロードでは無効です。
title（オプション）記事のタイトル（日本語も使えます）。設定しないと記事のタイトル欄が空になります。
name （必須）記事のファイル名をラテンアルファベットとアラビア数字で設定します。クラウド上の出版物に同名のファイルがあるときクラウド上のファイルを置き換えます。
ahax$parent（オプション）親記事のファイル名をラテンアルファベットとアラビア数字で指定します。クラウド上に該当する親記事があるとき、その子供として登録します。章の場合は出版物自体が親になりますので'publ'（固定）を設定します。親記事が指定されていないときは「ドラフト」に登録されます。
ahax$entryClass （オプション）記事の種類を「記事クラス名」で指定します。指定していないとき「未定」となります。

記事ヘッダー部のサンプル

++++++++
+ updated: 2017-12-06T14:15:59+0900
+ ahax$kind: article
+ author:  
+ title: 最初の章
+ name: i02-0001
+ ahax$parent: publ
+ ahax$entryClass: chapter

章の記事内容

++++++++
+ updated: 2017-12-06T14:17:15+0900
+ ahax$kind: article
+ title: 節の記事
+ name: 1-1
+ ahax$parent: i02-0001
+ ahax$entryClass: section

節の記事内容

前へ 次へ