Portfolio XML specification
The structure of the portfolio
The portfolio consists of the following blocks;
-
Profile
-
Contains the basic data of the student.
-
-
Card
-
Contains the input items defined in each portfolio
-
You can set for each card whether to show / hide or allow/disallow edit.
-
You can have multiple cards.
-
-
Summary
-
Displays the data input in each card.
-
These are described in the following XML structure;
<?xml version="1.0" ?>
<doc title="Sample" order="1">
<doc_template>
<profile>
<param name="username" label="User ID" />
<param name="name" label="Username" />
…
</profile>
<summary >…</summary>
<cards>
<static_card>…</static_card>
<static_card>…</static_card>
<appendable_card>…</appendable_card>
…
</cards>
</doc_template>
<field_templates>
<field_template>…</field_template>
…
</field_templates>
</doc>
Tags that define the basic structure of the portfolio
This section describes the <doc> tag that defines the basic structure of the portfolio.
<doc>
The root tag
Attributes
Name | Required | Detail |
---|---|---|
title |
Required |
Value: Any text |
order |
Required |
Value: Positive integer |
Value:"true"/"false" |
||
export |
Value:"true"/"false" |
|
allow-external-login |
Value:"true"/"false" |
|
link-top-page-to-my-page |
Value: "true"/"false" |
|
my-page-menu |
Value: "true"/"false" |
<doc_template>
Subordinate tags
Name | Required | Max Number | Detail |
---|---|---|---|
|
Only one |
Describes the items to be displayed in the profile |
|
|
Only one |
Describes the number and contents of cards |
|
|
Only one |
Describes the settings for the contents displayed on the summary tab |
|
|
Only one |
Describes the descriptions before the cards |
Tags that define the profile
Defines the student profile to be included in the portfolio.
<param>
Defines the profile attribute
Attributes
Name | Required | Detail |
---|---|---|
name |
Required |
Value: "profile.grade" |
type |
Required |
Value: "text","file" |
label |
Required |
Value: Any text |
list-column |
Value: "true","false" |
|
edit-auth |
Value: "adviser","self","adviser,self" |
|
placeholder |
Value: Any text |
|
form_type |
Value: "text","textarea" |
|
title-font-color |
value: any text Description: Title font color is fixed to the specified color. |
title-background-color |
Sample script
<profile>
<param name="email" label="eメール" />
<param name="profile.photo" label="Photo" />
<param name="profile.furigana_name" label="Furigana" />
<param name="profile.furigana_roma" label="Name"/>
<param name="profile.grade" label="Academic year" list-column="true"/>
<param name="profile.sex" label="Sex"/>
<param name="profile.dept" label="Department" list-column="true"/>
<param name="profile.faclt" label="Faculty" list-column="true"/>
<param name="profile.admitted_year" label="Admitted Year"/>
<param name="custom.comment" label="Comment on one row" placeholder="Input sample" type="text" edit-auth="self" list-column="true" />
<param name="custom.comment_textarea" label="Comment on multiple row" type="text" form_type="textarea" edit-auth="self" />
<param name="custom.attach" label="Attachements" type="file" edit-auth="self" />
</profile>
Tags that define the card
There are two types of cards: <static_card>, which displays and updates defined input items as it is, and <appendable_card>, which appends multiple inputs with the defined input items as one data set. In the card, you can define <field> as an input item. For <field>, formats such as selection formula, description formula, file upload, rubric etc. are prepared.
<static_card>
Describes the contents of a fixed card.
Attributes
Name | Required | Detail |
---|---|---|
id |
Required |
Value: Alphanumeric and underscore only |
title |
Required |
Value: Any text |
order |
Value: Positive integer |
|
default-viewable |
Value: "true","false" |
|
default-adviser-viewable |
Value: "true","false" |
|
edit-protect-setting |
Value: "true","false" |
|
edit-protect-target |
Value:"self","adviser" ,"adviser,self" |
|
allow-external-login |
Value: "true","false" |
Subordinate tags
Name | Required | Max Number | Detail |
---|---|---|---|
|
Any number |
Specifies the input items |
|
|
Any number |
Shows explanations . |
|
|
Any number |
You can display a description using markdown. Please refer to the |
|
|
Any number |
The rubrics' answers are displayed in the radar chart. Use this tag to set up a radar chart. Please see the bottom of the page for details. |
|
|
Any number |
Copy and display the input field values of other cards, not editable from the copy-field side. |
<appendable_card>
Describes the contents of a recordable card.
≪Default layout≫
Display the prepared fields as a column in a table.
≪categorized layout≫
Display input items as a set of grouped items.
Attributes
Name | Required | Detail |
---|---|---|
id |
Required |
Value: Alphanumeric and underscore only |
title |
Required |
Value: Any text |
append-auth |
Required |
Value: "self","adviser","adviser,self" |
order |
Value: Positive integer |
|
default-viewable |
Value: "true","false" |
|
default-adviser-viewable |
Value: "true","false" |
|
edit-protect-setting |
Value: "true","false" |
|
edit-protect-target |
Value:"self","adviser" ,"adviser,self" |
|
layout |
Value: "categorized","" |
|
category-field-id |
Value: Alphanumeric and underscore only. Please refer to the id value of the field tag. |
|
allow-external-login |
Value: "true","false" |
|
tab-font-color |
value: any text Description: Tab font color is fixed to the specified color. |
tab-background-color |
value: any text |
index-font-color |
|
value: any text |
index-background-color |
Subordinate tags
Name | Required | Max Number | Detail |
---|---|---|---|
|
Any number |
Specifies input items |
|
|
Any number |
Shows explanations. It is valid only when the attribute of appendable_card is layout="categorized". |
|
|
Any number |
You can display a description using markdown. Please refer to the |
|
|
Any number |
Copy and display the input field values of other cards, not editable from the copy-field side. It is valid only when the attribute of appendable_card is layout="categorized". |
<field>
Describes the input item. Refer to <field_template> for definitions of input items.
Attributes
Name | Required | Detail |
---|---|---|
id |
Required |
Value: Alphanumeric and underscore only |
ref |
Required |
Value:id of <field_template> |
title |
Value:Any text |
|
show-title |
Value:"true","false" |
|
chain-id |
Value:Alphanumeric and underscore only |
As long as the id of the <field> is different, the same input items can be arranged in a single card.
|
This is an example of chain-id configuration.
|
<field_template>
Describes the definitions of the input items. This tab must be defined within the <field_templates> tab.
Attributes
Name | Required | Detail |
---|---|---|
id |
Required |
Value: Alphanumeric and underscore only |
type |
Required |
Value:"text", "number", "file", "select", "multi-select", "rubric", "date" |
title |
Required |
Value: Any value |
edit-auth |
Required |
Value: "self", "adviser", "adviser, self" |
form_type |
Description: There is a type that can change the form of the input form. Please see below for detail. |
|
tips |
Value: Any character |
|
require |
Value:"true", "false" |
|
show-modified-info |
Value:"true", "false" |
|
preview |
Value: "true", "false" |
|
preview-height |
Value:Any value that can be set in CSS, such as "200px". |
|
max |
Required |
Value:Any number |
min |
Required |
Value:Any number |
float |
Value:"true","false" |
|
parent-field-id |
Value:Alphanumeric and underscore only |
|
show-title |
Value:"true","false" |
|
protect-from-other |
Value:"true","false" |
|
notification |
値:"true","false" |
Subordinate tags
Name | Required | Max Number | Detail |
---|---|---|---|
|
Any number |
This can be described only when "type attribute is select" or "type attribute is multi-select" or "type attribute is text and form_type attribute is text". |
|
|
Only one |
When the type attribute is rubric. |
Type attributes
text |
Description |
|
number |
Numerical value |
|
date |
year/month/date |
|
file |
||
select |
Select single item |
Write the selected item in the <option>tag in the <field>tag. |
multi-select |
Select multiple items |
Write the selected items in the <option>tag in the <field>tag. |
rubric |
Write table settings in the <rubric>tag in the <field>tag. Please see below for details. |
|
title |
This is not an input form but a text showing the value of title attribute. |
form_type attributes
-
When
type="text"
, you can set text or textarea as the form_type. The default value is textarea. -
When
type="rubric"
, you can set rubric or dropdown as the form_type. The default value is rubric. -
When
type="select"
ortype="multi-select"
, you can set selectbox, checkbox or checklist as the form_type.
Checklist changes the display of answers from a comma-devided list to a checklist.
Whentype="select"
, the default value is selectbox.
Whentype="multi-select"
, the default value is checkbox.
<option>
-
When the type attribute is select or multi-select, the value of option is reflected as a choice.
-
When the type attribute is text, the value of option is reflected as an input candidate.
Attributes
Name | Required | Detail |
---|---|---|
value |
Required |
Value: Any character |
parent-value |
Required |
Value:Any character |
Text
-
When the type attribute is select or multi-select, the text in the <option> tag is displayed as the label.
-
When the type attribute is text, there is no effect. ==== Sample script
<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> sets the text that will be displayed in the table header.
<dimension> specifies the contents of each row of the table.
When the student enters values in the rubric, the value is stored in association with the id attribute of <dimension>.
<level> in <dimension> specifies the contents of each cell of the table.
Sample script
<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="切り方の習熟度合を評価します">
<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>
<copy-field>
You can display values entered on other cards on the card where you placed the <copy-field>
.
For example, if you have created a portfolio to reflect on each year, you can use it to display the previous year’s goals as a reference when entering the current year’s data.
Attributes
Name | Required | Detail |
---|---|---|
card-id |
Required |
Value: Alphanumeric and underscore only |
field-id |
Required |
Value: Alphanumeric and underscore only |
title |
Value: Any character |
|
show-title |
Value:"true","false" |
|
title-font-color |
value: any text Description: Title font color is fixed to the specified color. |
title-background-color |
value: any text |
show-modified-info |
<message-form>
Set up a message sending form in the portfolio. The message is sent as WebClass message and not saved in the portfolio. You can use this tag when sending a report to the administrator etc. without sharing the contents with other advisers.
Attributes
Name | Required | Detail |
---|---|---|
visible-auth |
Required |
Value: "self", "adviser", "adviser, self" |
to |
Required |
Value: User IDs separated with commas. |
subject |
Required |
Value: Any text |
Sample script
<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>
In the example above, the following message will be sent;
カルテ: 2019年度臨床実習
カード: ローテーション1
ユーザID: user1
氏名: 学生1
【診療科】
内科1
【実習期間】
2019/04/05~2019/04/23
【ご所属】
○○病院
【作成医氏名】
××太郎
【報告】
………………………
………………………
………………………
<message-form-param>
Sets the input items in the sending message form.
Attributes
Name | Required | Detail |
---|---|---|
label |
Required |
Value: Any text |
form_type |
Required |
Value: "text" "textarea" |
require |
Required |
Value:"true" "false" |
placeholder |
Required |
Value: Any text |
Tags that define the summary display
The summary displays the status of the input to each card and provides a graphical representation of the rubrics' answers.
<summary>
<rubric-chart>
The rubrics' answers are displayed in the radar chart. Use this tag to set up a radar chart.
Attributes
Name | Required | Detail |
---|---|---|
show |
Value:"true","false" |
Subordinate tags
Name | Required | Max Number | Detail |
---|---|---|---|
|
Any number |
One radar chart is displayed for each tag. ==== Attributes [cols="5,1,10"] |
|Name |Required |Detail
|tick | |Value:Number value |Description:Specify the scale width of the value when displaying a radar chart.
|<line-graph>
|
|Any number
|One line graph is displayed for each tag.
Attributes
Name | Required | Detail |
---|---|---|
legend-max-column-count |
Value:Integer value |
|
|
Any number |
|Name |Required |Detail
|ticks
|
|Value:Number value
Description:Specifies the y-axis scale width when displaying a line chart.
|height
|
|Value:Integer value
Description:specify the height of the chart when displaying a line chart
|legend-max-column-count
|
|Value:Integer value
Description:Specifies the number of legends to display on a single line when wrapping a radar chart legend.
=== Numerical answers can be displayed on the radar chart. Use this tag to set the radar chart. ==== Attributes [cols="5,1,10"] |
|Name |Required |Detail
==== Subordinate tags [cols="5,1,1,10"] |
|Name |Required |Max Number |Detail
|<radar>
|
|Any number
|One radar chart is displayed for each tag.
=== ==== Attributes [cols="5,1,10"] |
|Name |Required |Detail
|legend-max-column-count
|
|Value:Integer value
Description:Specifies the number of legends to display on a single line when wrapping a radar chart legend.
|Name |Required |Detail
|target-id-list
|Required
|Value: field id
Description: Specifies the field id
|title
|
|Value: Any text
Description: A title can be attached.
==== Subordinate tags None == Etc tags === The following extended notations have been added to the standard writing style of the reflective portfolio Markdown. * Even if you do not insert two or more spaces at the end of the sentence, it will be a line feed as it is. * Line breaks can be inserted inside the table with [[br]]. * You can decorate a string with css by writing as follows; [source] ---- [[color:red; text-decoration:underline]]a string decorated with red and underline [[/]] ---- ==== Attributes [cols="5,1,10"] |
|Name |Required |Detail
|id
|
|Value: Any text
Description: The ID attribute can be specified. It is intended to be used for in-page links.
|display-only-while-input
|
|Value:"true" "false"
Description: If the value set to true, the Markdown content will be displayed only while editing.
==== Sample script [source] ---- <markdown> # Header1 Header2 # Header3 # Header4 Header5 # Header6 装飾 1行目です 2行目です 太字 の装飾 赤色[[/]]の装飾 下線[[/]]の装飾 [[color:red; text-decoration:underline]]赤色で下線[[/]]の装飾 区切り線 ---- リスト * Item 1 * Item 2 * Item 2a * Item 2b 順序付きリスト 1. Item 1 1. Item 2 1. Item 2a 1. Item 2b リンク [マニュアル](https://webclass.jp/manuals/user/integrated-portfolio/plugins/shugaku_carte/xml-definition.html) [ページ内リンク](#markdown-test1) # 表 |
Left align |
Right align |
Center align |
:----------- |
------------: |
:------------: |
This |
This |
This |
column |
column |
will |
will |
will |
be |
be |
be |
left |
right |
center |
aligned |
aligned |
aligned |
画像 ![Minion](https://octodex.github.com/images/dojocat.jpg) </markdown>
<!-- テキストに半角の 引用 > 引用文 > > > ネストした引用 ]]>
</markdown>
<markdown id="test1">
markdownブロックに対してページ内リンクを張ることができます。
markdownブロックのid属性を"test1"とすると、[ページ内リンク](markdown-test1) ---- From v2.14.8, you can link between the portfolios by specifying `../id as the link destination. [source] ---- <markdown> # リンク [臨床実習](../clinical) [医行為](../ikoui) [到達目標](../totatsu) </markdown> ---- === ==== Attributes None ==== Subordinate tags [cols="5,1,1,10"] |
|Name |Required |Max Number |Detail
|<markdown>
|
|Any
|Fill in the description to be displayed before selecting a card.