カルテXML仕様

カルテの基本構造を定義するタグの仕様

ここではカルテの基本構造を定義するタグについて説明します。

<doc>

ルートのタグです。

属性

名称 必須 詳細

title

必須

値:任意のテキスト
説明:カルテの名称

order

必須

値:正の整数
説明:カルテをリストしたときの表示順序

print

値:"true","false"
説明:印刷画面の有効無効を切り替えられます。デフォルトは"true"です。

export

値:"true","false"
説明:htmlエクスポート機能の有効無効を切り替えられます。デフォルトは"true"です。

allow-external-login

値:"true","false"
説明:"true"にすると、このカルテで外部公開機能が使用できるようになります。デフォルトは"false"です。 また、<doc>タグだけではなく公開を許可する各カードについてもallow-external-login属性を"true"にする必要があります。

link-top-page-to-my-page

値:"true","false"
説明: 学生のトップ画面に、このカルテへのリンクを表示するか切り替えられます。デフォルトは"true"です。
この設定はあくまでリンクの表示を切り替えるだけで、"false"の状態でも URL を知っていればアクセスできます。
アクセスを禁止したいときは、各カードの表示設定を不可にしてください。

my-page-menu

値:"true","false"
説明: 学生がMyPageを開いたときに、このカルテへのリンクをメニューに表示するか切り替えられます。デフォルトは"true"です。
この設定はあくまでリンクの表示を切り替えるだけで、"false"の状態でも URL を知っていればアクセスできます。
アクセスを禁止したいときは、各カードの表示設定を不可にしてください。

直下に記述できるタグ

名称 必須 記述可能な数 詳細

<field_templates>

必須

1つのみ

すべての入力項目の定義を並べます

<doc_template>

必須

1つのみ

タブの数や内容の設定を記述します

<doc_template>

属性

なし

直下に記述できるタグ

名称 必須 記述可能な数 詳細

<profile>

必須

1つのみ

プロフィールに表示する項目を記述します

<cards>

1つのみ

カードの数と内容を記述します

<summary>

1つのみ

Summaryタブに表示する内容の設定を記述します。

<before_cards>

1つのみ

カードの前に表示する説明文を記述します。

<field_templates>

入力項目の定義が並びます

属性

なし

直下に記述できるタグ

名称 必須 記述可能な数 詳細

<field_template>

必須

1つ以上

入力項目の定義を記述します

<cards>

カードの数と内容を定義します

属性

なし

直下に記述できるタグ

名称 必須 記述可能な数 詳細

<static_card>

任意の数

固定されたカードの内容を記述します

<appendable_card>

任意の数

追記可能なカードの内容を記述します

入力項目を定義するタグの仕様

<field_template>

入力項目の定義を記述します。このタグは <field_templates>タグの中に定義しなければなりません。

属性

名称 必須 詳細

id

必須

値:英数字とアンダースコアのみ。
説明:<field_template>を一意に指定するためのIDです。同じcard下に含まれる<field_template>間でユニークである必要があります。主に<field>のrefから参照されます。IDに使用できる文字は半角英数字と"-"と"_"のみです。また、アルファベットから開始する必要があります。

type

必須

値:"text", "number", "file", "select","multi-select", "rubric" , "date"
説明:fieldの種類です。詳しくは下記

title

必須

値:任意
説明:入力項目に表示されるタイトルです。

edit-auth

必須

値:"self","adviser" ,"adviser,self" , "external"
説明:編集可能なユーザーを設定します。"self"にすると学生本人が編集可能です。"adviser"にするとアドバイザーが編集可能です。"external"にすると外部公開者が編集可能です。

form_type

説明: 入力フォームの形式を変更できるtypeがあります。詳しくは下記

tips

値:任意文字
説明:入力項目の入力書式など、注意書きとして表示されます。

require

値:"true","false"
説明:require="true"と記述すると必須項目になります。
入力内容を保存するときに、必須項目が未入力であれば確認ダイアログが表示されます。
また、カルテ一覧での「済」「未」の表示について、通常はすべての項目が入力されているときに「済」になりますが、
必須項目が設定されている場合は、必須項目がすべて埋まっている場合に「済」になります。

show-modified-info

値:"true","false"
説明:"false"に設定すると更新日時が表示されなくなります。

preview

値:"true","false"
説明:typeがfileのときに使用できます。アップロードされたファイルがPDFか画像ならプレビューを表示します。

preview-height

値:"200px"など CSSで設定できる値
説明:previewがtrueのときに使用できます。プレビューの高さを設定します。

max

必須

値:"数値"
説明:typeがnumberのとき、必須項目です。項目の最大値を設定します。

min

必須

値:"数値"
説明:typeがnumberのとき、必須項目です。項目の最小値を設定します。

float

値:"true","false"
説明:typeがnumberのときに使用できます。項目に小数を入力可能にします。デフォルトは"false"です。

parent-field-id

値:英数字とアンダースコアのみ。
説明:typeがselectのときに使用できます。親カテゴリになる <field> のidを指定します。

show-title

値:"true","false"
説明:"false"に設定するとタイトルが表示されなくなります。デフォルトは"true"です。

protect-from-other

値:"true","false"
説明:"true"に設定すると一度入力したら本人以外が画面から上書きできなくなります。CSVインポートによる更新は可能です。CSVインポートで空の値に戻すと他の人が更新できます。

notification

値:"true","false"
説明: "true"`に設定した入力項目を学生が更新したときに、更新通知の対象ユーザーにWebClassのメッセージを送信します。
WebClass管理画面の「メール機能設定」から「メール機能許可」が「使用許可」に設定されている場合は他のメッセージと同様にメールで転送されます。
- 更新通知の対象ユーザーは、更新通知の対象組織に直接所属し、「担当ユーザーにアドバイスする」権限を持っているユーザです。 - 更新通知の対象組織とは、更新したユーザーが直接所属しており、更新したカルテが登録されている組織(祖先組織から継承したカルテを含む)です。 - 祖先組織のユーザが対象でないのは、事務職員や学部長にメッセージを飛ばさないためです。

title-font-color

値:任意のテキスト
説明: タイトルの文字色が指定した色に固定されます。「red」 や「#ff0000」 のようにcssで有効な色の値を設定できます。

title-background-color

値:任意のテキスト
説明: タイトルの背景色が指定した色に固定されます。

rows

値:自然数
説明: デフォルト値は4。 テキストエリアの行数の初期値を設定します。 form_type="textarea"のときのみ有効です。

hide-empty-state-label

値:"true","false"
説明: デフォルト値は"false"。
"false"のときは、未入力時に「回答なし」と各入力欄に表示されます。
"true"のときは、単なる空欄になります。

直下に記述できるタグ

名称 必須 記述可能な数 詳細

<option>

任意の数

「type属性がselect」または「type属性がmulti-select」または「type属性がtextかつform_type属性がtext」の時のみ記述できます。

<rubric>

1つのみ

type属性がrubricの時のみ記述できます。

type属性

次の八種類があります。

text

記述式

number

数値

date

年月日

file

ファイル

select

単数選択

<field>タグ内の<option>タグに選択肢を記述します。

multi-select

複数選択

<field>タグ内の<option>タグに選択肢を記述します。

rubric

ルーブリック

<field>タグ内の<rubric>タグに表の設定を記述します。詳しくは下記。

title

タイトル

入力フォームでなくテキストです。title属性の値が表示されます。

form_type属性

form_type属性に指定可能な値は、type属性の値によって変わります。
対応関係は次の通りです。

typeの値 form_typeのデフォルト値 form_typeに指定可能な値 詳細

text

textarea

text textarea

text は1行の入力欄になります。 textarea は複数行の入力欄になります。

rubric

rubric

rubric dropdown

dropdown を選択するとドロップダウンで選択する形式になります。

select

selectbox

selectbox checkbox checklist

selectbox は、ドロップダウンで選択する形式になります。
checkbox は、ラジオボタンで選択する形式になります。
checklist は、チェックリストを埋める形式になります。

multi-select

checkbox

selectbox checkbox checklist

同上

<option>

  • type属性がselectあるいはmulti-selectのときは、optionの値が選択肢として反映されます。

  • type属性がtextのときは、optionの値が入力候補として反映されます。

属性

名称 必須 詳細

value

必須

値:任意文字
説明: type属性がselectあるいはmulti-selectのとき実際に保存する値です。type属性がtextのときは入力候補として表示されます。

parent-value

必須

値:任意文字
説明:`<field_template>` で parent-field-id が指定されているときに使用できます。親カテゴリの値を指定します。

テキスト

  • type属性がselectあるいはmulti-selectのときは、<option>タグ内のテキストがラベルとして表示されます。

  • type属性がtextのときは無効です。

記述例

<field_templates>

 <field_template id="grade" type="select" title="学年" edit-auth="self,adviser">
   <option value="1">1年</option>
   <option value="2">2年</option>
   <option value="3">3年</option>
   <option value="4">4年</option>
 </field_template>

 <field_template id="category" type="text" form_type="text" title="活動種別" edit-auth="self,adviser">
   <option value="ボランティア" />
   <option value="委員会" />
   <option value="クラブ" />
 </field_template>

 <field_template id="parent" title="親カテゴリ" type="select" edit-auth="self,adviser">
   <option value="動物">動物</option>
   <option value="植物">植物</option>
   <option value="菌類">菌類</option>
 </field_template>

 <field_template id="child" parent-field-id="parent" title="子項目" type="select" edit-auth="self,adviser">
   <option parent-value="動物" value="クマ">クマ</option>
   <option parent-value="動物" value="ネコ">ネコ</option>
   <option parent-value="動物" value="タヌキ">タヌキ</option>

   <option parent-value="植物" value="ヒノキ">ヒノキ</option>
   <option parent-value="植物" value="スギ">スギ</option>
   <option parent-value="植物" value="タケ">タケ</option>

   <option parent-value="菌類" value="シイタケ">シイタケ</option>
   <option parent-value="菌類" value="エノキ">エノキ</option>
   <option parent-value="菌類" value="コウジカビ">コウジカビ</option>
 </field_template>

</field_templates>

<rubric>

<rubric_header>によって表のヘッダに表示するテキストを設定します。
<dimension>は表の各行の内容を指定します。
ルーブリックに学生が入力するとき、<dimension>のid属性と紐付いて値が保存されます。
<dimension>内の<option>のデータでは表のセルの内容を指定します。
<dimension>のdefault属性で初期値を設定できます。

記述例

<field_template id="cook" type="rubric" title="調理実践" >
  <rubric>
    <rubric_header>
      <level value="0"/>
      <level value="1"/>
      <level value="2"/>
      <level value="3"/>
      <level value="4"/>
    </rubric_header>
    <dimension id="cut" title="切る" description="切り方の習熟度合を評価します" default="2">
      <option level="0">まったくできなかった</option>
      <option level="1">あまりできなかった</option>
      <option level="2">ふつう</option>
      <option level="3">少しできた</option>
      <option level="4">よくできた</option>
    </dimension>
    <dimension id="stew" title="煮る" description="煮方の習熟度合を評価します">
      <option level="0">まったくできなかった</option>
      <option level="1">あまりできなかった</option>
      <option level="2">ふつう</option>
      <option level="3">少しできた</option>
      <option level="4">よくできた</option>
    </dimension>
    <dimension id="grill" title="焼く" description="焼き方の習熟度合を評価します">
      <option level="0">まったくできなかった</option>
      <option level="1">あまりできなかった</option>
      <option level="2">ふつう</option>
      <option level="3">少しできた</option>
      <option level="4">よくできた</option>
    </dimension>
  </rubric>
</field_template>

プロフィールを定義するタグの仕様

カルテに対応付ける学生プロフィール情報を定義します。

profile

<profile>

プロフィールを定義します。システム共通と、カルテ用とあります。

属性

なし

直下に記述できるタグ

名称 必須 記述可能な数 詳細

<param>

任意の数

プロフィールの項目を記述します

<param>

プロフィール項目を定義します

属性

名称 必須 詳細

name

必須

値:"profile.grade"
説明:プロフィールに表示する値を指定します。接頭辞によってデータの保存先が変わります。接頭辞には三種類あります。
1. 「profile.」 WebClassのシステム共通のプロフィールです。WebClass管理画面のユーザ管理から編集可能です。
2. 「custom_profile.」修学カルテ用のカスタマイズのプロフィールです。自由に項目を追加できます。おおよその環境で使用可能ですが、OSが古いと使えない場合があります。
3. 「custom.」"custom_profile."の下位互換です。検索とソートができませんが、すべての環境で使用可能です。

type

必須

値:"text","file"
説明:テキスト型かファイル型か選択できます。

label

必須

説明:任意のテキスト
説明:プロフィールに表示する際のラベルです。

list-column

値:"true", "false"
デフォルト : "false"
説明:ユーザ一覧画面で表示するかどうか指定します。"profile."あるいは"custom_profile."で始まるプロフィール項目が対象です。ファイル形式の項目については無効。

edit-auth

値:"adviser","self","adviser,self"
説明:編集可能なユーザーを設定します。"self"にすると学生本人が編集可能です。"adviser"にするとアドバイザーが編集可能です。 name属性がemailのときは設定できず、常に編集不可です。

placeholder

値: 任意のテキスト
説明:テキスト型のとき、placeholderを設定できます。

form_type

値:"text","textarea"
説明:テキスト型のとき、入力欄が1行か複数行か選択できます。

search

値: "wildcard" "range"
説明:デフォルトは"wildcard"です。
wildcard ⇒ ワイルドカードで検索できるようになります
range ⇒ 数値範囲検索できるようになります。プロフィールの値が数値のみであるときに有効です。単位の文字列が含まれている場合は検索対象外です。

直下に記述できるタグ

なし

記述例

<profile>
  <param name="email" label="eメール" />
  <param name="profile.photo" label="写真" />
  <param name="profile.furigana_name" label="ふりがな" />
  <param name="profile.furigana_roma" label="Name"/>
  <param name="profile.grade" label="学年" list-column="true"/>
  <param name="profile.sex" label="性別"/>
  <param name="profile.faclt" label="学部" list-column="true"/>
  <param name="profile.dept" label="学科" list-column="true"/>
  <param name="profile.admitted_year" label="入学年度"/>
  <param name="custom_profile.comment" label="1行の入力欄(一覧での検索とソートに使用可能)" placeholder="入力例です" type="text"  edit-auth="self" list-column="true" />
  <param name="custom_profile.comment_textarea" label="複数行入力欄(一覧での検索とソートに使用可能)" type="text"  form_type="textarea" edit-auth="self" list-column="true" />
  <param name="custom_profile.attach" label="添付ファイル" type="file" edit-auth="self" />
  <param name="custom.comment" label="1行の入力欄" placeholder="入力例です" type="text"  edit-auth="self"/>
  <param name="custom.comment_textarea" label="複数行入力欄" type="text"  form_type="textarea" edit-auth="self"/>
  <param name="custom.attach" label="添付ファイル" type="file" edit-auth="self" />
</profile>

カードを定義するタグの仕様

カードには、定義した入力項目をそのまま表示・更新する<static_card>と、定義した入力項目を1つのデータセットとして複数の入力を追記する<appendable_card>の2種類があります。 カードの中には、入力項目として<field>を定義します。<field>には選択式、記述式、ファイルアップロード、ルーブリックなどの形式が用意されています。

<static_card>

固定されたカードの内容を記述します

static card

属性

名称 必須 詳細

id

必須

値: 英数字とアンダースコアのみ。
説明: cardのIDです。全てのcard間でユニークである必要があります。IDに使用できる文字は半角英数字と"-"と"_"のみです。また、アルファベットから開始する必要があります。

title

必須

値: 任意のテキスト
説明: カードのタイトルです

order

値: 正の整数
説明: カードを表示するときの順番です。orderの指定がない場合、XMLでの記述順に並びます。

default-viewable

値: "true","false"
説明: カードが学生に表示されるかどうかの初期設定。"true"にすると最初から表示されます。デフォルトは"true"

default-adviser-viewable

値: "true","false"
説明: カードがアドバイザーに表示されるかどうかの初期設定。デフォルトは"true"

edit-protect-setting

値: "true","false"
説明: 学生の入力可能期間を制限するかどうかの設定

  • 入力可能期間の制限をする場合 ("true" またはこの属性を指定しない場合)

    • 入力可能期間を設定できます。

    • 学生は設定された期間内のみ入力できます。

    • 期間を設定しない場合、学生は入力できません。

  • 入力可能期間の制限をしない場合 ("false"の場合)

    • 学生はいつでも入力可能です。

edit-protect-target

値: "self","adviser" ,"adviser,self"
説明: 編集期間の制限をする対象を設定します。デフォルトは"self"。 edit-protect-settingがtrueのときのみ反映されます。

allow-external-login

値: "true","false"
説明: このカルテで外部公開機能が有効(<doc>タグのallow-external-login属性が"true")になっているとき、このカードが公開可能かどうかを切り替えられます。デフォルトは"false"です。

tab-font-color

値: 任意のテキスト
説明: タブの文字色が指定した色に固定されます。「red」 や「#ff0000」 のようにcssで有効な色の値を設定できます。

tab-background-color

値: 任意のテキスト
説明: タブの背景色が指定した色に固定されます。

index-font-color

値: 任意のテキスト
説明: summaryのindex(カード一覧)の文字色が指定した色に固定されます。

index-background-color

値: 任意のテキスト
説明: summaryのindex(カード一覧)の背景色が指定した色に固定されます。

auto-update-title-from

値: 英数字とアンダースコアのみ。
説明: <field> のidを指定します。指定したフィールドにユーザが入力して保存すると、カードタイトル(タブ名など)が入力値に変化します。 auto-update-title-from で指定する <field>type=text かつ form_type=text か、 type=select である必要があります。

直下に記述できるタグ

名称 必須 記述可能な数 詳細

<field>

任意の数

入力項目を設定します

<rubric-chart>

任意の数

ルーブリックの回答がグラフで表示されます。このタグでグラフの設定を行います。直下に記述できるタグについてはページ下にある`<rubric-chart>`を参考にしてください。

<number-chart>

任意の数

数値式の回答がグラフで表示されます。このタグでグラフの設定を行います。直下に記述できるタグについてはページ下にある`<number-chart>`を参考にしてください。

<p>

任意の数

説明文を表示できます

<markdown>

任意の数

markdownを使用した説明文を表示できます。詳しくは`<markdown>`の項を参考にしてください。

<copy-field>

任意の数

他のカードの入力項目の値をコピーして表示します。copy-field側からは編集できません。

<table>

任意の数

表を表示できます。詳しくは`<table>`の項を参考にしてください。

<style>

任意の数

CSSを設定できます。

<message-form>

任意の数

メッセージ送信フォームを設定できます。詳しくは`<message-form>`の項を参考にしてください。

<mark-complete>

任意の数

完了ボタンを設定できます。詳しくは <mark-complete> の項を参考にしてください。

<number-chart>

任意の数

数値式の回答をグラフで表示できます。グラフの種類は、レーダーチャート折れ線グラフ積み上げ棒グラフがあります。

<appendable_card>

追記可能なカードの内容を記述します。

≪デフォルトレイアウト≫
用意したfieldを列とするテーブルで表示します。

appendable card default

≪categorizedレイアウト≫
入力項目を一まとめのセットにしてカテゴリ分けして表示します。

appendable card categorized

属性

名称 必須 詳細

id

必須

値:英数字とアンダースコアのみ。
説明:cardのIDです。全てのcard間でユニークである必要があります。IDに使用できる文字は半角英数字と"-"と"_"のみです。また、アルファベットから開始する必要があります。

title

必須

値:任意のテキスト
説明:カードのタイトルです

append-auth

必須

値:"self","adviser" ,"adviser,self"
説明:追加可能なユーザーを設定します。"self"にすると学生本人が追加可能です。"adviser"にするとアドバイザーが追加可能です

order

値:正の整数
説明:カードを表示するときの順番です。orderの指定がない場合、XMLでの記述順に並びます。

default-viewable

値:"true","false"
説明:カードが学生に表示されるかどうかの初期設定。"true"にすると最初から表示されます。デフォルトは"true"

default-adviser-viewable

値:"true","false"
説明:カードがアドバイザーに表示されるかどうかの初期設定。デフォルトは"true"

edit-protect-setting

値: "true","false"
説明: 学生の入力可能期間を制限するかどうかの設定

  • 入力可能期間の制限をする場合 ("true" またはこの属性を指定しない場合)

    • 入力可能期間を設定できます。

    • 学生は設定された期間内のみ入力できます。

    • 期間を設定しない場合、学生は入力できません。

  • 入力可能期間の制限をしない場合 ("false"の場合)

    • 学生はいつでも入力可能です。

edit-protect-target

値:"self","adviser" ,"adviser,self"
説明:編集期間の制限をする対象を設定します。デフォルトは"self"。 edit-protect-settingがtrueのときのみ反映されます。

layout

値:"categorized",""
説明:値を"categorized"にすると、category-field-idで指定したfieldの値に従って、タブ分けしてカードが表示されます。

category-field-id

値:英数字とアンダースコア。fieldタグのidの値を参照。
説明:選択したfieldの値によってタブをまとめます。fieldの種類はselect,date,textのみ有効です。

allow-external-login

値:"true","false"
説明:このカルテで外部公開機能が有効(<doc>タグのallow-external-login属性が"true")になっているとき、このカードが公開可能かどうかを切り替えられます。デフォルトは"false"です。

tab-font-color

値:任意のテキスト
説明: タブの文字色が指定した色に固定されます。「red」 や「#ff0000」 のようにcssで有効な色の値を設定できます。

tab-background-color

値:任意のテキスト
説明: タブの背景色が指定した色に固定されます。

index-font-color

値:任意のテキスト
説明: summaryのindex(カード一覧)の文字色が指定した色に固定されます。

index-background-color

値:任意のテキスト
説明: summaryのindex(カード一覧)の背景色が指定した色に固定されます。

直下に記述できるタグ

名称 必須 記述可能な数 詳細

<field>

任意の数

入力項目を設定します

<p>

任意の数

説明文を表示できます。appendable_cardの属性が、layout="categorized"のときのみ有効です。

<markdown>

任意の数

markdownを使用した説明文を表示できます。詳しくは`<markdown>`の項を参考にしてください。appendable_cardの属性が、layout="categorized"のときのみ有効です。

<copy-field>

任意の数

他のカードの入力項目の値をコピーして表示します。copy-field側からは編集できません。appendable_cardの属性が、layout="categorized"のときのみ有効です。

<mark-complete>

任意の数

完了ボタンを設定できます。詳しくは <mark-complete> の項を参考にしてください。

カード内に配置する項目を定義するタグの仕様

<field>

カードに載せる入力項目を記述します。入力項目の定義は<field_template>を参照します。

属性

名称 必須 詳細

id

必須

値:英数字とアンダースコアのみ。
説明:fieldを一意に指定します

ref

必須

値:<field_template>のid
説明:入力項目の設定を参照します

title

値:任意のテキスト
説明:<field_template>のtitleの設定を上書きします。

show-title

値:"true","false"
説明:<field_template>のshow-titleの設定を上書きします。

chain-id

値:英数字とアンダースコアのみ。
説明:同じchain-idを持つfieldは、編集時には、まず先頭のfieldだけ表示され、「入力欄の追加」ボタンを押すことで続くfieldが表示されます。
static_cardとlayout=categorizedのappendable_cardでのみ有効です。

<field>のidさえ異なれば、一つのcard内に同じ入力項目を並べることができます。

<static_card id="card1">
  <!-- <field_template id="date"> と <field_template id="comment"> を3回参照している -->
  <p>1日目</p>
  <field ref="date"    id="day1-date"/>
  <field ref="comment" id="day1-comment"/>
  <p>2日目</p>
  <field ref="date"    id="day2-date"/>
  <field ref="comment" id="day2-comment"/>
  <p>3日目</p>
  <field ref="date"    id="day3-date"/>
  <field ref="comment" id="day3-comment"/>
</static_card>

chain-idの設定例です。

<static_card id="card1">

  <field ref="file" id="file1" chain-id="aaa" title="資料1"/>
  <field ref="file" id="file2" chain-id="aaa" title="資料2"/>
  <field ref="file" id="file3" chain-id="aaa" title="資料3"/>
  <markdown display-only-while-editing="true">最大3つまで添付ファイルをアップロードできます。</markdown>

  <field ref="comment" id="comment1" chain-id="bbb" title="コメント1"/>
  <field ref="comment" id="comment2" chain-id="bbb" title="コメント2"/>
  <field ref="comment" id="comment3" chain-id="bbb" title="コメント3"/>
  <markdown display-only-while-editing="true">最大3つまでコメントを追加できます。</markdown>
</static_card>
chain id example

直下に記述できるタグ

なし

<markdown>

Markdownで書かれたテキストを挿入できます。
Markdownとは、HTMLより手軽に書ける、見出しやリストなどの構造を表現できる文章の記法です。
画面に表示する際にはHTMLに変換されます。

修学カルテのMarkdownには、標準的な書き方に次の拡張記法が追加されています。

  • 文末にスペースを2つ以上入れなくても、そのまま改行されます

  • [[br]]で表内部へ改行を挿入できます

  • 次のように記述することで文字列をcssで装飾できます

[[color:red; text-decoration:underline]]赤色と下線で装飾された文字列[[/]]

属性

名称 必須 詳細

id

値:任意のテキスト
説明:ID属性を指定できます。ページ内リンクに使用することを想定しています。

display-only-while-editing

値:"true" "false"
説明: 値がtrueに設定されている場合、編集中にのみMarkdownの内容を表示します。

記述例

<markdown>
  # 見出し1
  ## 見出し2
  ### 見出し3
  #### 見出し4
  ##### 見出し5
  ###### 見出し6

  ## 装飾

  1行目です
  2行目です

  **太字** の装飾
  [[color:red]]赤色[[/]]の装飾
  [[text-decoration:underline]]下線[[/]]の装飾
  [[color:red; text-decoration:underline]]赤色で下線[[/]]の装飾


  ## 区切り線

  ----


  ## リスト
  * Item 1
  * Item 2
      * Item 2a (半角スペース4つ必要です)
      * Item 2b


  ## 順序付きリスト
  1. Item 1
  1. Item 2
      1. Item 2a (半角スペース4つ必要です)
      1. Item 2b


  ## リンク
  [マニュアル](https://webclass.jp/manuals/admin/shugaku_carte/ja/introduction.html)
  [ページ内リンク](#markdown-test1)


  ## 表

  | Left align | Right align | Center align |
  |:-----------|------------:|:------------:|
  | This       | This        | This         |
  | column     | column      | 表の中で[[br]]改行する|
  | will       | will        | will         |
  | be         | be          | be           |
  | left       | right       | center       |
  | aligned    | aligned     | aligned      |


  ## 画像

  ![Minion](https://octodex.github.com/images/dojocat.jpg)

</markdown>
<!-- テキストに半角の `<>` を含む場合はこのように`<![CDATA[` `]]>`で全体を囲むようにしてください。 -->
<markdown>
  <![CDATA[

  ## 引用
  > 引用文
  > > > ネストした引用

  ]]>
</markdown>
<markdown id="test1">
    markdownブロックに対してページ内リンクを張ることができます。
    markdownブロックのid属性を"test1"とすると、`[ページ内リンク](#markdown-test1)`でページ内リンクを作成できます。
</markdown>

v2.14.8から ../カルテテンプレートのID をリンク先に指定することでカルテ間にリンクを張れるようになりました。

<markdown>
  ## リンク
  [臨床実習](../clinical)
  [医行為](../ikoui)
  [到達目標](../totatsu)
</markdown>

<copy-field>

`<copy-field>`を設置したカードに、他のカードで入力した値を表示できます。 たとえば年度ごとに振り返りをするカルテを作成したとき、 今年度の入力をする際に参考として前年度の目標を表示するという使い方ができます。

属性

名称 必須 詳細

card-id

必須

値:英数字とアンダースコアのみ。
説明:対象のカードのidを指定します。static_cardのみを指定できます。

field-id

必須

値:英数字とアンダースコアのみ。
説明:対象のfieldのidを指定します。

title

値:任意のテキスト
説明:タイトルを変更して表示します。たとえば前年度カードの「目標」を「前年度の目標」と表示できます。

show-title

値:"true","false"
説明:タイトルを表示するかどうかを切り替えることができます。

title-font-color

値:任意のテキスト
説明: タイトルの文字色が指定した色に固定されます。「red」 や「#ff0000」 のようにcssで有効な色の値を設定できます。

title-background-color

値:任意のテキスト
説明: タイトルの背景色が指定した色に固定されます。

show-modified-info

値:"true","false"
説明:更新日時を表示するかどうかを切り替えることができます。

form_type

値:テキスト
説明: <field_template> のform_type属性を上書きできます。
指定できるform_typeは、元の <field> の type属性によって異なります。
基本的なtype属性と対応するform_typeについては、 <field_template> タグの form_type`属性を参照してください。
上記に加えて `<copy-field>
では type="rubric" のときに form_type="value" を設定可能です。
form_type="value" を設定すると、ルーブリックの表ではなく単に選択した数値が羅列されます。

<message-form>

カルテ内にメッセージ送信フォームを設置します。記入内容は、WebClassメッセージとして送信され、カルテには保存しません。 報告内容をアドバイザー同士でも共有せず管理者などだけに知らせたいときに使用します。

属性

名称 必須 詳細

visible-auth

必須

値:"adviser","self","adviser,self","external"
説明:メッセージ送信フォームを表示するユーザーを設定します。"self"にすると学生本人が編集可能です。"adviser"にするとアドバイザーが編集可能です。"external"にすると外部公開者が編集可能です。

to

必須

値:カンマ区切りのユーザID
説明:メッセージの宛先を設定します

subject

必須

値:任意のテキスト
説明:メッセージの件名を設定します

直下に記述できるタグ

<markdown>と<message-form-param>を記述できます。

記述例

<message-form visible-auth="adviser"
              to="admin1,author1,author2"
              subject="アンプロフェッショナルな態度についての報告">
  <markdown>
    ## アンプロフェッショナルな態度についての報告
  </markdown>

  <message-form-param type="text" require="true" label="診療科"/>
  <message-form-param type="text" require="true" placeholder="2019/04/05~2019/04/23" label="実習期間"/>
  <message-form-param type="text" label="ご所属"/>
  <message-form-param type="text" require="true" label="作成医氏名"/>
  <message-form-param type="text" require="true" form_type="textarea" label="報告"/>

  <markdown>
  このままでは将来、患者の診療に関わらせることが出来ないと考えられる学生の具体的な行動や態度について、日時と事実内容を列挙下さい。できるだけ詳細にお願いします。
  </markdown>
</message-form>

上記の例では、以下のような内容のメッセージが送信されます

カルテ: 2019年度臨床実習
カード: ローテーション1
ユーザID: user1
氏名: 学生1


【診療科】
内科1

【実習期間】
2019/04/05~2019/04/23

【ご所属】
○○病院

【作成医氏名】
××太郎

【報告】
………………………
………………………
………………………

<message-form-param>

メッセージ送信フォームへの入力項目を設定します

属性

名称 必須 詳細

label

必須

値:任意のテキスト
説明:項目名を設定します

form_type

必須

値:"text" "textarea"
説明:入力項目の形式を指定します。textは1行の入力欄。textareaは複数行の入力欄です。

require

必須

値:"true" "false"
説明:必須項目かどうか設定します。必須項目を空にしたままだとメッセージ送信できなくなります

placeholder

必須

値:任意のテキスト
説明:プレースホルダに表示する文を設定します

<table>

表組で、<p><field> を表示できます。

属性

名称 必須 詳細

style

値:任意のテキスト
説明:HTMLのstyle属性で指定可能な値を設定可能です。

class

値: 任意のテキスト
説明: このタグにclass名を指定できます。ここで指定したclass名を <style> タグのCSSから参照できます。

直下に記述できるタグ

名称 必須 記述可能な数 詳細

<tr>

任意の数

表の行になります

記述例

<static_card id="test" title="テスト">

<style>
.my-table-heading{
    background-color: #DEE9FF;
}
</style>
<table style="width:500px">
 <tr class="my-table-heading">
   <td><p>実習日</p></td>
   <td><p>実習先</p></td>
   <td><p>感想</p></td>
  </tr>
  <tr>
    <td>
      <field id="jissyubi1" ref="jissyubi" />
    </td>
    <td>
      <field id="jissyusaki1" ref="jissyusaki" />
    </td>
    <td>
      <field id="kansou1" ref="kansou" />
    </td>
  </tr>
  <tr>
    <td>
      <field id="jissyubi2" ref="jissyubi" />
    </td>
    <td>
      <field id="jissyusaki2" ref="jissyusaki" />
    </td>
    <td>
      <field id="kansou2" ref="kansou" />
    </td>
  </tr>
</table>
</static_card>
table sample

<tr>

表の行です。

属性

名称 必須 詳細

style

値:任意のテキスト
説明:HTMLのstyle属性で指定可能な値を設定可能です。

class

値: 任意のテキスト
説明: このタグにclass名を指定できます。ここで指定したclass名を <style> タグのCSSから参照できます。

直下に記述できるタグ

名称 必須 記述可能な数 詳細

<td>

任意の数

表のセルになります

<td>

表のセルです。 <td>文</td> のようにセルの中に直接文を記述できません。 セルの中に文を入れるには、<td><p>文</p></td> のように記述する必要があります。

属性

名称 必須 詳細

colspan

必須

値:整数
説明:指定した数だけセルが列方向に繋がります。

rowspan

必須

値:整数
説明:指定した数だけセルが行方向に繋がります。

style

値:任意のテキスト
説明:HTMLのstyle属性で指定可能な値を設定可能です。

class

値: 任意のテキスト
説明: このタグにclass名を指定できます。ここで指定したclass名を <style> タグのCSSから参照できます。

直下に記述できるタグ

名称 必須 記述可能な数 詳細

<p>

任意の数

セルに文章を表示します

<field>

任意の数

セルに入力項目を表示します

<style>

CSSを設定できます。 設定したCSSの影響範囲はカード内に限られます。 static_card内にのみ設置可能です。

<mark-complete>

カード上部に完了ボタンを設置します。 通常、ユーザの入力状況一覧における「未」「済」の表示は、すべての入力欄(必須項目があるときは、必須項目のすべて)が埋まっている否かで切り替わります。 完了ボタンがある場合は、完了ボタンを押したかどうかで判定されるようになります。 完了ボタンは押した後に編集ロックされていなければ取り消しできます。

属性

名称 必須 詳細

id

必須

値:英数字とアンダースコアのみ。
説明: カードの中で重複がないように設定する必要があります。

title

必須

値:任意のテキスト
説明:設定したテキストがボタンに表示されます

complete-target

値:"self","adviser" の二つからカンマ区切りで複数指定可能
説明: 完了ボタンが押されたときに「未」「済」のステータスを変更する対象の権限を設定します。

edit-auth

値:"self","adviser","external" の三つからカンマ区切りで複数指定可能
説明: 完了ボタンをクリックできる権限を設定します。

lock-target

値:"self","adviser","external" の三つからカンマ区切りで複数指定可能
説明: 完了ボタンが押されたときに編集ロックされる権限を設定します。編集ロックされた権限のユーザはカードを編集できなくなります。また入力完了ボタンも編集できなくなります。

直下に記述できるタグ

名称 必須 記述可能な数 詳細

<child>

任意の数

子の完了ボタンを指定します。

<child>

一つの完了ボタンを押すと、同時に他のカードの完了ボタンも一括でステータスが変わるように設定できます。 操作するボタンを親の完了ボタン、親の完了ボタンに連動するボタンを子の完了ボタンとします。 親のボタンをクリックしたとき、子のボタンはedit-auth属性に関わらず強制的に変更されます。 子の完了ボタンのedit-auth属性を空欄にすると、親の完了ボタンでのみ操作可能なボタンになります。

属性

名称 必須 詳細

card-id

必須

値:英数字とアンダースコアのみ。
説明: 子の完了ボタンがあるカードのidを指定します。

mark-complete-id

必須

値:英数字とアンダースコアのみ。
説明: 子の完了ボタンのidを指定します。

<handout>

配布ファイル設定で登録したファイルを、学生に配布できます。
また、成績データの連携をしている場合、成績データをエクセルファイルで出力可能です。
学生は、カード内に表示されるダウンロードリンクからファイルをダウンロードできます。
<handout> は、<static_cerd> <appendable_card> <td> に設置できます。
実際の設定方法は配布ファイルをご参照ください。

shugaku handout XMLdefinition

属性

名称 必須 詳細

filename

必須

値: 配布するファイル名
説明: 配布ファイル登録をした中から、配布したいファイル名を指定します。

organization-id

必須

値: 配布ファイル登録した組織ID
説明: 配布ファイル登録した組織IDを指定します。
組織IDは、「組織の管理」から該当の組織を選択すると、組織の下に記述されています。

label

必須

値: 任意のテキスト
説明: カルテ内に表示される配布ファイルのダウンロードリンク名を設定できます。

class

値: 任意のテキスト
説明: このタグにclass名を指定できます。ここで指定したclass名を <style> タグのCSSから参照できます。

style

値:任意のテキスト
説明: HTMLのstyle属性で指定可能な値を設定可能です。

直下に記述できるタグ

名称 必須 記述可能な数 詳細

<write-excel-sheet>

任意の数

名前やプロフィール、成績をエクセルファイルで出力できます。
配布ファイルがエクセルファイルの時、指定したシートの2行目以降にデータを出力します
成績を出力するには、成績データの連携をしている必要があります。

<write-excel-sheet>

名前やプロフィール、成績データをエクセルファイルで出力できます。
配布ファイルがエクセルファイルの時、指定したシートの2行目以降にデータを出力します
成績を出力するには、成績データの連携をしている必要があります。

属性

名称 必須 詳細

name

必須

値: 任意の文字
説明: エクセルのデータを書き込むシート名を設定できます。

直下に記述できるタグ

名称 必須 記述可能な数 詳細

<write-column>

任意の数

データを書き込むエクセルの列とデータの内容を指定します。

<write-column>

属性

名称 必須 詳細

name

必須

値: エクセルの列
説明: エクセルの列を指定します。
例)a,b,c…​

data

必須

値: "user.id" "user.name" "profile.~" "result.成績データ名"
説明: "user.id"と"user.name"の指定でユーザIDと氏名の出力が可能です。
"profile.~" で写真以外のWebClassのプロフィールを出力できます。指定方法はprofile/paramタグと同じです。
"result.成績データ名" で各成績データを出力できます。有効な成績データ名は連携内容によって異なります。
例)result.科目名、result.科目コード、result.単位

type

値: number,text
説明: エクセルでセルの書式設定で、「数値」と「文字列」を選択できますが、"number"は「数値」、"text"は「文字列」に対応しています。

サマリーの表示を定義するタグの仕様

サマリーでは、各カードへの入力状況などを表示し、ルーブリックの回答をグラフで可視化します。

サマリーは <summary> で設定できます。 <summary> を設定しなかった場合も、サマリーは表示されます。この場合、<axis-type>each-dimension</axis-type> と記述したときと同じように、ルーブリックの回答がレーダーチャートで表示されます。

summary

<summary>

属性

名称 必須 詳細

show

値:"true","false"
説明:サマリーを表示するか否か設定します

直下に記述できるタグ

名称 必須 記述可能な数 詳細

<rubric-chart>

1つのみ

ルーブリックの回答がレーダーチャートで表示されます。このタグでレーダーチャートの設定を行います。

<number-chart>

任意の数

数値式の回答がレーダーチャートで表示できます。このタグでレーダーチャートの設定を行います。

<extract-static-field>

任意の数

fieldへの入力値を各カードから抽出して、サマリーに表示します。

<extract-static-field>

fieldを各カードから抽出して、サマリーに表示します。<static_card>の値のみ抽出します。

属性

名称 必須 詳細

target-id-list

必須

値:fieldのid
説明:抽出するfieldのidを指定します。

title

値:任意のテキスト
説明:タイトルを付けることができます。

直下に記述できるタグ

なし

グラフの表示を定義するタグの仕様

<rubric-chart>

ルーブリックの回答がレーダーチャートで表示されます。このタグでレーダーチャートを設定します。

属性

名称 必須 詳細

show

値:"true","false"
説明:レーダーチャートを表示するか否か

hide-if-empty

値:"true","false"
説明:trueに設定すると、seriesがすべて非表示であるときにグラフごと非表示にします。seriesタグのhide-if-empty属性と同時に使用することを想定しています。

直下に記述できるタグ

名称 必須 記述可能な数 詳細

<radar>

任意の数

このタグ一つにつき、一つのレーダーチャートを表示します。

<axis-type>

任意の数

値:"each-dimension","each-field"
説明: <radar> の省略記法です。学生に表示されているカードとルーブリックが対象になります。値がeach-dimensionであれば、ルーブリックごとにレーダーチャートが表示され、ルーブリックのdimensionがレーダーチャートの軸になります。each-fieldであれば、各ルーブリックがレーダーチャートの軸になり、ルーブリックごとの平均値が表示されます。

レーダーチャート省略記法記述例

各ルーブリックごとにレーダーチャートを表示する
<summary>
  <rubric-chart>
    <axis-type>each-dimension</axis-type>
  </rubric-chart>
</summary>
radar chart default
一つのルーブリックにまとめる

<axis-type>each-field</axis-type> と記述すると、各ルーブリックがレーダーチャートの軸になり、ルーブリックごとの平均値が表示されます。

<summary>
  <rubric-chart>
    <axis-type>each-field</axis-type>
  </rubric-chart>
</summary>
radar chart each field

<number-chart>

数値式の回答をグラフで表示します。このタグ内にグラフの詳細を設定します。

属性

名称 必須 詳細

直下に記述できるタグ

名称 必須 記述可能な数 詳細

<radar>

任意の数

このタグ一つにつき、一つのレーダーチャートを表示します。

<line-graph>

任意の数

このタグ一つにつき、一つの折れ線グラフを表示します。

<stacked-bar-graph>

任意の数

このタグ一つにつき、一つの積み上げ棒グラフを表示します。

<radar>

属性

名称 必須 詳細

title

値:任意文字
説明:グラフのタイトルを指定します。

width

値:整数値
説明:グラフの幅を指定します。単位はpxです。

ticks

値:数値
説明:値軸の目盛りの値の間隔を指定します。

legend-max-column-count

値:整数値
説明: 1行に表示する凡例の最大数を指定します。設定した数ごとに改行します。

レーダーチャート記述例

レーダーチャート表示の対象とするデータ、グラフの幅、ラベル、各系列の色を指定できます。

<summary>
  <rubric-chart>
    <radar title="分野別の自己評価[[br]]←これで改行できます" width="700">
      <header>
        <axis label="生徒についての理解[[br]]←これで改行できます" />
        <axis label="他者との協力" />
        <axis label="コミュニケーション" />
      </header>
      <data>
        <series label="1年[[br]]←これで改行できます">
          <value card-id="grade1" field-id="understanding_of_children" />
          <value card-id="grade1" field-id="cooperation" />
          <value card-id="grade1" field-id="communication" />
        </series>
        <series label="2年">
          <value card-id="grade2" field-id="understanding_of_children" />
          <value card-id="grade2" field-id="cooperation" />
          <value card-id="grade2" field-id="communication" />
        </series>
        <series label="3年">
          <value card-id="grade3" field-id="understanding_of_children" />
          <value card-id="grade3" field-id="cooperation" />
          <value card-id="grade3" field-id="communication" />
        </series>
      </data>
    </radar>

    <radar title="生徒についての理解">
      <header>
        <axis label="心理・発達論" />
        <axis label="学習集団の形成" />
        <axis label="いじめ、不登校、特別支援教育" />
      </header>
      <data>
        <series label="1年" color="#000">
          <value card-id="grade1" field-id="understanding_of_children"  dimension-id="psychology" />
          <value card-id="grade1" field-id="understanding_of_children"  dimension-id="organize" />
          <value card-id="grade1" field-id="understanding_of_children"  dimension-id="problem_solving" />
        </series>
        <series label="2年" color="#fff">
          <value card-id="grade2" field-id="understanding_of_children"  dimension-id="psychology" />
          <value card-id="grade2" field-id="understanding_of_children"  dimension-id="organize" />
          <value card-id="grade2" field-id="understanding_of_children"  dimension-id="problem_solving" />
        </series>
        <series label="3年" color="#f00" hide-if-empty="true">
          <value card-id="grade3" field-id="understanding_of_children"  dimension-id="psychology" />
          <value card-id="grade3" field-id="understanding_of_children"  dimension-id="organize" />
          <value card-id="grade3" field-id="understanding_of_children"  dimension-id="problem_solving" />
        </series>
      </data>
    </radar>
  </rubric-chart>
</summary>
radar chart custom

<line-graph>

属性

名称 必須 詳細

title

値:任意文字
説明:グラフのタイトルを指定します。

ticks

値:数値
説明:値軸の目盛りの値の間隔を指定します。

grid

値:数値
説明:値軸の補助目盛線の値の間隔を指定します。

height

値:整数値
説明:グラフの高さを指定します。単位はpxです。

width

値:整数値
説明:グラフの幅を指定します。単位はpxです。

legend-max-column-count

値:整数値
説明: 1行に表示する凡例の最大数を指定します。設定した数ごとに改行します。

hide-if-empty

値:"true","false"
説明:trueに設定すると、seriesがすべて非表示であるときにグラフごと非表示にします。seriesタグのhide-if-empty属性と同時に使用することを想定しています。

折れ線グラフ記述例

<line-graph title="折れ線グラフ"
            height="150"
            ticks="20"
            grid="10">
  <header>
    <axis label="総合"/>
    <axis label="数理"/>
    <axis label="構造的把握"/>
    <axis label="言語"/>
  </header>
  <data>
    <series label="1年次" color="red">
      <value card-id="grade1" field-id="score1"/>
      <value card-id="grade1" field-id="score2"/>
      <value card-id="grade1" field-id="score3"/>
      <value card-id="grade1" field-id="score4"/>
    </series>
    <series label="2年次" color="blue" dashed="true">
      <value card-id="grade2" field-id="score1"/>
      <value card-id="grade2" field-id="score2"/>
      <value card-id="grade2" field-id="score3"/>
      <value card-id="grade2" field-id="score4"/>
    </series>
    <series label="3年次" color="green" hide-if-empty="true">
      <value card-id="grade3" field-id="score1"/>
      <value card-id="grade3" field-id="score2"/>
      <value card-id="grade3" field-id="score3"/>
      <value card-id="grade3" field-id="score4"/>
    </series>
  </data>
</line-graph>
line graph

<stacked-bar-graph>

属性

名称 必須 詳細

title

値:任意文字
説明:グラフのタイトルを指定します。

ticks

値:数値
説明:値軸の目盛りの値の間隔を指定します。

grid

値:数値
説明:値軸の補助目盛線の値の間隔を指定します。

height

値:整数値
説明:グラフの高さを指定します。単位はpxです。

width

値:整数値
説明:グラフの幅を指定します。単位はpxです。

legend-max-column-count

値:整数値
説明: 1行に表示する凡例の最大数を指定します。設定した数ごとに改行します。

hide-if-empty

値:"true","false"
説明:trueに設定すると、seriesがすべて非表示であるときにグラフごと非表示にします。seriesタグのhide-if-empty属性と同時に使用することを想定しています。

積み上げ棒グラフ記述例

<stacked-bar-graph title="積み上げ棒グラフ" ticks="20" height="360" grid="10">
  <header>
    <axis label="総合"/>
    <axis label="数理"/>
    <axis label="構造的把握"/>
    <axis label="言語"/>
  </header>
  <data>
    <series label="1年次" color="red">
      <value card-id="grade1" field-id="score1"/>
      <value card-id="grade1" field-id="score2"/>
      <value card-id="grade1" field-id="score3"/>
      <value card-id="grade1" field-id="score4"/>
    </series>
    <series label="2年次" color="blue" dashed="true">
      <value card-id="grade2" field-id="score1"/>
      <value card-id="grade2" field-id="score2"/>
      <value card-id="grade2" field-id="score3"/>
      <value card-id="grade2" field-id="score4"/>
    </series>
    <series label="3年次" color="green" hide-if-empty="true">
      <value card-id="grade3" field-id="score1"/>
      <value card-id="grade3" field-id="score2"/>
      <value card-id="grade3" field-id="score3"/>
      <value card-id="grade3" field-id="score4"/>
    </series>
  </data>
</stacked-bar-graph>
stacked bar graph

<series>

グラフの系列を設定します。

属性

名称 必須 詳細

label

値:任意文字
説明:系列のラベルを指定します。

color

値:任意文字
説明:系列の色を指定します。カラーコードを入力してください。

dashed

値:"true" "false"
説明:trueを指定すると系列の線が点線になります。

hide-if-empty

値:"true","false"
説明:trueに設定すると、valueで参照しているfieldの値がすべて未入力のとき、seriesが丸ごと非表示になります。

直下に記述できるタグ

名称 必須 記述可能な数 詳細

<value>

任意の数

どのfieldの値をどこのグラフの点に反映するかを設定します

その他のタグの仕様

<before_cards>

プロフィールとカードの間に挟む説明文を記述します。

属性

なし

直下に記述できるタグ

名称 必須 記述可能な数 詳細

<markdown>

任意の数

カードを選択する前に表示する説明文などを記入します