ヘルプ内検索
TOP > マニュアル > アプリの構成

アプリの構成

アプリのXMLファイルの構成について説明します

アプリのXMLファイルの構成

XMLファイルは大きく3つのセクションから成り立っています

アプリを作る際にはcontentsセクションが重要となります。

contentsを記述する

contents内では文字を直接表示させたり、外部のURLからデータを取得することが可能です。

1

<data>タグを使って直接表示する

以下のように<data></data>で囲むと入力したHTMLが表示されます。 

<contents>
  <data>
    <![CDATA[
      <div>
         <a id="logo" title="nifty logo"
              target="_blank" href="http://www.nifty.com">
            <img border="0" alt="niftylogo"
              src="http://www.nifty.com/img/logo.gif" title="@niftyへジャンプ！">
         </a>
       </div>
    ]]>
  </data>
</contents>

このcontentsから作られた例を管理画面で表示すると以下の画像のようになります。
contents data sample

2

<url>タグを使って外部のURLからデータを取得する

以下のように<url></url>で囲むとそのURLからデータを取得することが可能です。 

<contents>
    <url>
      http://www.nifty.com/
    </url>
</contents>

このcontentsから作られた例を管理画面で表示すると以下の画像のようになります。
contents url sample

URLの指定先にフラッシュを取り込むHTMLやCGIを指定することにより様々なものをコンテンツにすることができます。

configを記述する

作成するアプリのcontentsが設定を必要とするような場合にはconfigセクションによって実現することが可能です。

例えば、configセクションを記述することで以下の画像のように「設定」というボタンが表示されます。

config close

「設定」ボタンをクリックすると以下のように設定画面が開き、編集できます。

config open

この例の場合のconfigセクションは以下のようになります。 

  <config>
    <item>
      <name>subdomain</name>
      <caption>サブドメインを入力</caption>
      <type>string</type>
      <require>true</require>
      <default>aplug</default>
    </item>

    <item>
      <name>subdomainSelect</name>
      <caption>サブドメインを選択</caption>
      <type>enum</type>
      <require>false</require>
      <default>aplug</default>
      <enum>
        <option>
          <caption>アプラグ</caption>
          <value>aplug</value>
        </option>
  
        <option>
          <caption>クリップ</caption>
          <value>clip</value>
        </option>
  
        <option>
          <caption>インターポット</caption>
          <value>interpot</value>
        </option>
      </enum>
    </item>
  </config>

<type>には以下の4つを指定することができます。詳しくはアプリのリファレンスをご覧ください。

  • string : text
  • bool : check
  • enum : select
  • hidden : hidden

このconfigセクションで<name>の中に設定した変数名を「##」で囲むことにより<value>の値を呼び出すことができます。
contentsセクションで利用可能です。 

    <contents>
    <data>
      <![CDATA[
      <div>
      <a id="img" title="nifty logo"
	 target="_blank" href="http://##subdomain##.nifty.com">
      <img border="0" alt="niftylogo"
	 src="http://www.nifty.com/img/logo.gif"
	 title="##subdomain##.nifty.comへジャンプ！">
      </a>
      <p>##subdomainSelect##.nifty.comへジャンプ！</p>
      </div>
      ]]>
    </data>

  </contents>

上記の完全なXMLファイルはこちらをご覧ください。

defineを記述する

defineセクションにより、アプリのタイトル、説明文、大きさ、表示方法などが設定できます。
具体的にはアプリのリファレンスをご覧ください。

以下、例となります。 

    <define>
        <info>
            <custom>アプラグ</custom>
            <custom>##title##</custom>
            <link>http://aplug.nifty.com/</link>
            <description>アプリ1</description>
            <image>http://aplug.nifty.com/common/images/aplug_logo.gif</image>
        </info>
        <cache_time>1000</cache_time>
        <min_width>120</min_width>
        <height>300</height>
    </define>