小窓キャスト配信者向けドキュメント

0. このドキュメントについて

このドキュメントは、 OpenPNE2.12 で実装された「小窓キャスト機能」を利用し、小窓の配信をおこなうための手順を書いたものです。

小窓キャスト機能の概要については、小窓キャスト機能について?をご覧ください。

配信されている小窓を利用するためのドキュメントについては、小窓キャスト利用者向けドキュメントをご覧ください。

1. 準備するもの

小窓キャスト機能を利用して小窓の配信をおこなうには、以下に掲げるものと、これらを設置し公開することのできるサーバ(レンタルサーバなど)が必要です。

  • 配信したい小窓のJavaScriptファイル
  • 配信対象の小窓が羅列された小窓キャストRSS(後述)

2. 小窓キャストRSSについて

形式

  • RSS2.0に則っている必要があります
  • channel 要素(配信元を示す要素)は必須です。また、 channel 要素は以下の内容を含んでいなければいけません
    • title 要素(配信元の名前を示す要素)
    • link 要素(配信元のURLを示す要素)
    • description 要素(配信元の説明を示す要素)
  • item要素(配信されている小窓を示す要素) は以下の内容を含んでいなければいけません
    • title 要素(配信されている小窓のタイトルを示す要素)
    • enclosure 要素(配信されている小窓の本体を示す要素)
    • pubDate 要素(配信されている小窓の更新日時を示す要素)
  • enclosure 要素によって配信できる小窓のJavaScriptには以下のような制限があります
    • url 属性(小窓の存在するURLを示す属性)は必須です
    • type 属性(小窓の MIME type を示す属性)は必須です
    • length 属性(小窓のファイルサイズを示す属性)は必須です
    • url 属性値は .js で終わっていなければいけません
    • type 属性値 は text/javascript もしくは application/javascript でなければいけません

サンプル

<?xml version="1.0" encoding="UTF-8"?>
<rss version="2.0">
<channel>

<title>小窓キャストサンプル</title>
<link>http://cmdcast.example.com/</link>
<description>小窓キャストのサンプルです</description>

<item>
    <title>小窓1</title>
    <description>小窓その1</description>
    <enclosure url="http://cmdcast.example.com/example.com.js" length="1542" type="text/javascript" />
    <pubDate>Tue, 29 Apr 2008 01:15:00 +0900</pubDate>
</item>

<item>
    <title>小窓2</title>
    <description>小窓その2</description>
    <enclosure url="http://cmdcast2.example.com/example.com.js" length="1542" type="text/javascript" />
    <pubDate>Tue, 29 Apr 2008 01:15:00 +0900</pubDate>
</item>

</channel>
</rss>

3. 小窓を配信してみる

  1. 配信したい小窓の JavaScript ファイルをWEBサーバの公開領域に設置してください
  2. サンプルを参考にして、小窓キャストRSSファイルを作成してください
    • enclosure 要素の url 属性値に 1. で設置した小窓の JavaScript ファイルのURLを指定します
  3. 作成した小窓キャストRSSファイルをWEBサーバの公開領域に設置してください

3. で設置した小窓キャストRSSファイルのURLを管理画面の「小窓キャスト設定」から登録することで、1. で設置した JavaScript を小窓として使用することができるようになります。

4. 配信対象の小窓を追加する

  1. 配信したい小窓の JavaScript ファイルをWEBサーバの公開領域に設置してください
  2. 小窓キャストRSSファイルに 1. で設置した小窓についての item 要素を追加してください
  3. 2. で更新した小窓キャストRSSファイルをWEBサーバの公開領域に設置してください

管理画面の「小窓キャスト設定」にある「更新」ボタンを押下することで、1. で追加した JavaScript を小窓として使用することができるようになります。

5. 配信中の小窓を編集する

  1. 小窓キャストRSSファイルの pudDate 要素に記されている日時を新しいものに更新してください
  2. 1. で更新した小窓キャストRSSファイルをWEBサーバの公開領域に設置してください

管理画面の「小窓キャスト設定」にある「更新」ボタンを押下することで、1. で変更した内容が反映されるようになります。