プラグインのフォルダ

メモ: プラグイン用のフォルダの名前は、通常は「プラグイン名.作成者のドメイン名」を逆にしたものになります。例えば「ABC」という名前のプラグインを「traction.co.jp」が作成する場合、フォルダ名は「jp.co.traction.abc」になります。しかし、必ずしもこのルールに従う必要はありません。 （参照: FAQ1683.08: TeamPage プラグイン概要）

メモ： TeamPage の開発の歴史的な理由により、「プロジェクト」は、SDL プログラムの世界では「goal」と呼ばれています。そこで、今回、プラグインのフォルダを「com.traction.projectfaqtab」ではなく「com.traction.goalfaqtab」とします。

プラグインの定義ファイル

display_name=Project FAQ Tab
description=Inserts the "FAQ" tab next to the Dashboard tab.
name=com.traction.goalfaqtab
version=1.0

新しいタブを追加するには

プロジェクトのタブはどこで定義されている？

<sdl.function name="bodytabs">
  <gwt.rpc.view name="BodyTabs" key="heading">
    { tabs: [
    { t: "#{gwtrpc_tab_dashboard}", l: "<shared#addentry href='#/project/dashboard' />"<compare.equals "<config.view.value name='viewtype' />" "single" "goal_dashboard">, x: true</compare.equals> },
    { t: "#{gwtrpc_subtab_tasks_overview}", l: "<shared#addentry href='#/project/tasks' />" },
    { t: "#{gwtrpc_subtab_tasks_milestones}", l: "<shared#addentry href='#/project/milestones' />" },
    { t: "#{gwtrpc_tab_activity}", l: "<shared#addentry href='#/project/activity' />" },
    { t: "#{gwtrpc_tab_status}", l: "<shared#addentry href='#/project/status' />" },
    { t: "#{gwtrpc_tab_calendar}", l: "<shared#addentry href='#/project/cal' />&edate=month" },
    { t: "#{gwtrpc_tab_documents}", l: "<shared#addentry href='#/project/docs' />"<scope.hasfile>, x: true</scope.hasfile> },
    { t: "#{gwtrpc_subtab_goal_discussion}", l: "<shared#addentry href='#/project/discussion' />" },
    { t: "#{related_entries}", l: "<shared#addentry href='#/project/related' />" },
    { t: "#{entrytabs_history}", l: "<shared#addentry href='#/history' />" }
    ] }
  </gwt.rpc.view>
</sdl.function>

複数のプラグインによる衝突を避けるために

メモ: 上書きされる「前者」と上書きする「後者」は、インストール済みプラグイン一覧に表示されるプラグインの順序で決まります。

 <sdl.function name="bodytabs-inner">
  <foreach list="<config.project.value name='custompmentrytabs_goal_tabs' />">
    <switch value="__foreach.current__">
      <case value="dashboard">
        <#bodytabs-dashboard />
      </case>
      <case value="tasks" value="task" value="tasks_overview">
        <#bodytabs-tasks />
      </case>
      <case value="milestones" value="milestone">
        <#bodytabs-milestones />
      </case>
      <case value="activity" value="activities">
        <#bodytabs-activity />
      </case>
      <case value="status">
        <#bodytabs-status />
      </case>
      <case value="calencar" value="cal">
        <#bodytabs-calendar />
      </case>
      <case value="documents" value="sharefolder">
        <#bodytabs-documents />
      </case>
      <case value="comments" value="discussion">
        <#bodytabs-discussion />
      </case>
      <case value="related">
        <#bodytabs-related />
      </case>
      <case value="history">
        <#bodytabs-history />
      </case>
    </switch>
  </foreach>
</sdl.function>

<sdl.function name="bodytabs-tasks">
  { t: "#{gwtrpc_subtab_tasks_overview}", l: "<shared#addentry href='#/project/tasks' />" },
</sdl.function>

{ t: "#{gwtrpc_subtab_tasks_overview}", l: "<shared#addentry href='#/project/tasks' />" },
 

「FAQ」タブの作成と配置

「FAQ」タブの関数の作成

<sdl.function name="bodytabs-faq">
  { t: "FAQ", l: "<shared#addentry href='#/project/faq' />" },
</sdl.function>

「ダッシュボード」タブの隣に配置

<sdl.function name="bodytabs-dashboard">
  <##bodytabs-dashboard />
  <#bodytabs-faq />
</sdl.function>

{ t: "#{gwtrpc_tab_dashboard}", l: "<shared#addentry href='#/project/dashboard' />", x: true },
{ t: "FAQ", l: "<shared#addentry href='#/project/faq' />" },

「FAQ」タブの表示確認

対応するビューを作成するには

ビューの定義

# 「project_tasks.properties」の設定を引き継ぐ
__inherits=project_tasks
# 「viewtype」という属性の値を「goal_faq」とする
viewtype=goal_faq

ビューを表示する SDL テンプレート

テンプレートの所在

sdl=com.traction.sdl.gwtrpc.goal

<switch value="<config.view.value name='viewtype' />">
  <case value="goal_dashboard" value="single">
    <#dashboard />
  </case>
  <case value="goal_tasks">
    <#tasks />
  </case>
  <case value="goal_milestones">
    <#milestones />
  </case>
  <case value="goal_activity">
    <com.traction.sdl.tasks.actfeed#entry-activity />
  </case>
  <!--- This view configuration still exists, so we still handle it,
  but isn't exposed in the UI. [shep 28.Mar.2011] -->
  <case value="goal_desc">
    <shared#entry-desc />
  </case>
  <case value="goal_cal">
    <#calendar />
  </case>
  <case value="goal_docs">
    <shared#entry-docs />
  </case>
  <case value="goal_discussion">
    <shared#entry-discussion />
  </case>
  <case value="goal_related">
    <shared#entry-related />
  </case>
  <case value="goal_status">
    <shared#entry-status />
  </case>
</switch>

「entry」関数を丸ごとコピーして利用する

<switch value="<config.view.value name='viewtype' />">
  <case value="goal_faq">
    <#faq />
  </case>
  <case value="goal_dashboard" value="single">
    <#dashboard />
  </case>
  <case value="goal_tasks">
    <#tasks />
  </case>
  <case value="goal_milestones">
    <#milestones />
  </case>
  <case value="goal_activity">
    <com.traction.sdl.tasks.actfeed#entry-activity />
  </case>
  <!--- This view configuration still exists, so we still handle it,
  but isn't exposed in the UI. [shep 28.Mar.2011] -->
  <case value="goal_desc">
    <shared#entry-desc />
  </case>
  <case value="goal_cal">
    <#calendar />
  </case>
  <case value="goal_docs">
    <shared#entry-docs />
  </case>
  <case value="goal_discussion">
    <shared#entry-discussion />
  </case>
  <case value="goal_related">
    <shared#entry-related />
  </case>
  <case value="goal_status">
    <shared#entry-status />
  </case>
</switch>

「FAQ記事を一覧表示する」部分を作成する

<sdl.function name="faq">
  <gwt.rpc.view name="HTML" region="entries"> 
    <#faq-entries />
  </gwt.rpc.view>
  <shared#chunkmore-custom />
</sdl.function>

<sdl.function name="faq-entries">
  <div class="entries faq-entries">
    <div class="feed">
      <entries type="cat" cat=":-e:goal:__entry.tractionid.entry__" search='x(::*:FAQ)' proj="*" volume="feed">
        __entry.content__
      </entries>
    </div>
  </div>
</sdl.function>

動作確認

さらに…

「次のN件を表示」の実装

メモ: この「25件ずつ」の件数は、ユーザー毎に、パーソナルセットアップの 1画面に表示する記事の数 で変更できます。または、サーバーセットアップ > 既定値で、すべてのユーザーの既定の件数を変更できます。

プラグインのダウンロード