XML形式論文の書き方

1.はじめに

この文書は、既に何らかのワープロソフトなどで論文原稿のテキストを用意されている方が、その文書を応募形式であるXMLの書式に整形する場合を想定しています。これから執筆されるという方は、以下の説明で原稿のテキストから貼り付ける作業を行う段階で、貼り付けを行う部分に論文の文書を記述してください。

この文書では、論文のXMLで使用できる機能を一通り解説しています。執筆に際して必要のない機能は読み飛ばして頂いてかまいません。例えば、箇条書きを利用されないのであれば5.5)の内容をお読みになる必要はありません。

2.ソフトウェアの準備

これから投稿形式のXML文書を作成し、投稿用のファイルを作成するまでの作業で、いくつか必要となるソフトウェアがあります。それらについてはこちらで説明していますのでご覧ください。既に準備がお済みの場合は、次へお進みください。

3.執筆の基礎知識

1)本文の構成について
論文の本文は、節、副節、副々節と最大で3段階までの構成をとることができます。各節の番号はXML文書を元に次のような形式で自動的に振られます。したがって、(XML文書の)本文を記述する際に節の番号はつけないようにしてください。また、参照などで節の番号が必要な場合は、「XML検証プログラム」(「2.ソフトウェアの準備」参照)を利用して目的の節の番号を確認し、その番号を利用してください。
1. 最初の節
最初の節の内容
1.1 一つ目の副節
副節の内容
1.1.1 一つ目の副々節
副々節の内容
1.2 二つ目の副節
副節の内容
2)XML文書について
XML文書は小なり記号(<)と大なり記号(>)で挟まれた「タグ」によって修飾された「要素」の集合です。タグには <要素名> の形式の「開始タグ」と、</要素名> の形式の「終了タグ」があり、各要素は次のように開始タグと終了タグで内容が挟まれた形をしています。
<Element>この部分が Element 要素の内容です。</Element>
例外として、「改行の場所」を指示するタグのように、タグで囲むものがない場合は <br/> のように、< と /> で挟まれたタグ(空要素タグ)1つを使用します。

XMLでは、ある要素の中に別の要素を含む(入れ子にする)ことが可能ですが、入れ子にしたタグは子にあたる要素が親にあたる要素の外に出ないように正しい順番(後で開始したものを先に)で閉じなければなりません。
<TagA><TagB>要素の内容</TagA></TagB> …これは誤り(BがAの中で閉じていない)
<TagA><TagB>要素の内容</TagB></TagA> …これが正解

4.XML文書の作成:(1)準備〜書誌情報の記入

1)作業用フォルダ(ディレクトリ)の作成
XML文書の作成や、画像などの関連ファイルを納めておくための作業用のフォルダ(ディレクトリ)を作成します。「XML検証プログラム」を展開してできた JCMIChecker-xxx-0.xx のようなフォルダがあれば、それを作業用フォルダとしてもお使い頂くのがいちばん簡単です。もし、作業用に別のフォルダを用意する場合は、XML検証プログラムのフォルダから stylesheet.css を作業用フォルダにコピーしておいてください。
2)テンプレートの入手(作業用ファイルの作成)
論文のXML文書を全く最初から作成するのは大変ですので、まずは大会サイトよりテンプレートを入手されることをお勧めします。テンプレートは「標準版」と「最簡易版」がありますが、最簡易版の方は最低限の情報を入力する部分しか用意されていませんので、標準版を入手されることをお勧めします。テンプレートをダウンロードしたら、万一の場合に備えてテンプレートに直接記入せず、コピーを作成してそちらを作業用として編集するようにしてください。作業用に作成したコピーは1)の作業フォルダに入れ、ファイル名を「p演題番号.txt」のように変更してください。
3)XML検証プログラムの起動
文章を全て書き終えてからXMLの検証を行い大量のミスが見つかると修正が大変ですし、執筆中に仕上がりの様子を確認したくなることもあるかと思いますので、執筆を始める前に「XML検証プログラム」を起動して2)で用意した作業用ファイル(p演題番号.txt)を読み込ませておき、こまめにチェックを行うことをお勧めします。検証プログラムは一度原稿ファイルを選択しておけば、あとは機能ボタンを押すだけで作業ができますので毎回起動しなおす必要はありません。
4)書誌情報の記入
まずは、書誌情報の部分から編集を開始しましょう。2)で用意した作業用ファイルをお好きなテキストエディタ(「2.ソフトウェアの準備」参照)で開いてください。<jcmi-paper> から、最後の </jcmi-paper> までがJCMIの論文XML文書の内容です。<jcmi-paper> の行より前にある部分は、XML文書の形式を指定している部分ですので編集しないでください。最初に、演題番号の入力を行います。
<REG_NO>10000</REG_NO> <!-- 演題番号(半角数字)を入れてください -->
の行の、「10000」をご自分の演題番号に書き換えてください。この際、半角数字で入力しなければならないことに注意してください。

 演題番号以外の論文の書誌情報は、<head></head> の間の部分に記述されます。以下の全ての書誌情報について入力を行ってください。(ただし、簡易版のテンプレートでは、* のものは予め記入されていません。邦文タイトル、著者名などは抄録のものが流用されます。)
  • 日本語タイトル(title-ja)*
  • 英語タイトル(title-en)
  • 日本語著者リスト(author-list-ja)*
  • 英語著者リスト(author-list-en)*
  • 日本語所属機関リスト(org-list-ja)*
  • 英語所属機関リスト(org-list-en)*
  • 英語抄録(abstract-en)
  • 英語キーワードリスト(keywords)
それぞれの書誌情報の記入方法について簡単に説明いたします。
まずはタイトルですが、以下の行の「日本語のタイトル」「This Is Your English Title」をそれぞれご自分の論文のタイトルに書き換えてください。タイトルの途中で改行したい場合は、その箇所に <br/> を挿入してください(エディタ上で改行しても無視されます)。
<title-ja>日本語のタイトル</title-ja>
<title-en>This Is Your English Title</title-en>
次に、著者リストですが記述方法はタグの名前が違うだけで日英同様ですので、日本語著者リストを例に説明します。
<author-list-ja>
<author presentor="yes" org="1">あなたの氏名</author>
<author presentor="no"  org="2">共著者の氏名</author>
<author presentor="no"  org="1">共著者の氏名</author>
</author-list-ja>
著者リストは、author 要素で表される各著者の情報を <author-list-xx></author-list-xx> で囲んだものです(xx は ja または en)。author 要素は著者1人に1つずつ記述され、各著者に関する情報(presentor および org)が含まれます。著者の人数分だけ author 要素をコピーして氏名、presentor、org を編集してください。
  • presentor は著者リストの中で発表者と共著者を識別するための情報で、発表者は presentor="yes" 、共著者は presentor="no" とします。
  • org は、後で記入する「所属機関リスト」で使用するIDです。同一の機関に所属されている方が同じ番号(org="半角数字")になるようにしてください。

著者リストを編集し終わったら、所属機関リストを編集します。これも著者リスト同様日本語所属機関リストを例に説明します。
<org-list-ja>
<org id="1">所属機関名</org>
<org id="2">所属機関名</org>
</org-list-ja>
所属機関リストは、org 要素で表される各機関の情報を <org-list-xx></org-list-xx> で囲んだものです(xx は ja または en)。org 要素は各機関に1つずつ記述され、著者リストでその機関に所属する方の org に指定した番号と同じID(id="半角数字")を持ちます。

 次は英文抄録の入力です。<abstract-en></abstract-en> の間に英文抄録を原稿から貼り付け(または入力)してください。エディタ上で改行しても無視されますので、編集しやすいように適度に改行して頂いてかまいません。完成版において、段落の区切りなどで改行する必要のある場合は、改行位置に <br/> を挿入してください。また、エディタ上で半角スペースやタブによって文章を整形しても、それらは1つの空白にまとめられてしまいます。不等号などの特殊文字を使う必要がある場合は、5.3)の「特殊文字について」をご覧ください。
英語版の書誌情報について
 大会事務局に対して欧米や韓国などの医療情報学関係者より、日本の学術成果について参照したい」との要望が寄せられており、CD-ROM 版論文集を各国の医療情報学会に若干ならが配布する事を検討しております。是非、充実した英語抄録をお願いいたします。そのため英語抄録について語数制限は設けておりません。英語抄録と図表だけでも海外の研究者にインパクトを与えられるような論文を期待しております。

書誌情報の最後の項目は、英語キーワードリストです。
<keywords>
<kw>一つ目のキーワード</kw>
<kw>二つ目のキーワード</kw>
</keywords>
1つのキーワードは、<kw></kw> で挟まれています。キーワードリストは幾つかのキーワードを <keywords></keywords> で囲んだものです。キーワード数に制限はありませんが、5つ程度までとしてください。

以上で一通り書誌情報の記入が完了しました。編集を始める前に起動しておいた「XML検証プログラム」にウィンドウを切り替え、まだ読み込んでいなければ作業ファイルを選択して「XML検証」のボタンを押してみてください。問題がなければ、続いて「仕上がりプレビュー」のボタンを押して論文の仕上がりを確認してください。最初のページに表示されている書誌情報は予定通りの内容になっていますか?もし、おかしなところがあればその箇所の編集に戻ってやり直してみてください。

5.XML文書の作成:(2)本文の記入

1)本文の記述方法
論文の本文は、書誌情報の <head> 〜 </head> に続く <body></body> の間の部分に記述されます。本文は3.1)「本文の構成について」でも説明しましたように、次のような最大で3段階(節、副節、副々節)の節構成をとることができます。
1. 最初の節
最初の節の内容
1.1 一つ目の副節
副節の内容
1.1.1 一つ目の副々節
副々節の内容
1.2 二つ目の副節
副節の内容
各節は、 <section title="…"></section> で節の内容(本文)を囲んだ構造をしています。節のタイトルは、 title="節のタイトル" のように、本文の中ではなく section タグの中の title="…" で指定します。以下、副節(subsection)、副々節(subsubsection)も同様です。節、副節、副々節は入れ子の構造をとり、必ず副節は節の、副々節は副節の内側になければなりません。また、節の外側に文を記述することはできません。

 したがって、上の例はXML文書中では以下のように表現されます。(副節、副々節の字下げは入れ子構造を見やすくするためのもので、実際に記述する際には必要ありません。)
<section title="最初の節">
最初の節の内容
<subsection title="一つ目の副節">
副節の内容
<subsubsection title="一つ目の副々節">
副々節の内容
</subsubsection>
</subsection>
<subsection title="二つ目の副節">
副節の内容
</subsection>
</section>
ワープロソフトなどから各節の本文を貼り付ける際には、ミスを減らすために次のような手順で行われることをお勧めします。
  1. テンプレートの <section> 〜 </section> の部分をコピーして、論文中の節の数だけ section を用意する
  2. 各節の構成に合わせてタグ部分の構造(section, subsection, subsubsection)を変更する
  3. 各節のタイトル(title="…")を入力する(文法チェックの際に、タイトルは必須です)
  4. 「XML検証プログラム」で文法チェックを行い、タグ構造(入れ子)のミスがないことを確認する
  5. 各節の本文をワープロソフトなどから貼り付ける
  6. 再度検証プログラムで間違いがないか確認する
2)改行と空白について
英文抄録と同様(XMLの一般的な規則により)、エディタ上で改行しても無視されますので編集しやすいように適度に改行して頂いてかまいません。完成版において、段落の区切りなどで改行する必要のある場合は、改行位置に <br/> を挿入してください(ただし、下線を引いている部分とハイパーリンクが設定されている部分では改行が使用できません)。また、エディタ上で半角スペースやタブによって文章を整形しても、それらは1つの空白にまとめられてしまいます。この規則は全角スペースには当てはまりませんので、空白により文章の整形を行う必要のある場合には全角スペースを使用してください。
3)特殊文字について
不等号はタグの開始・終了と認識されてしまいますので、そのままでは原稿中で使用できません。原稿中に不等号(<,>)を使用したい場合は、< ならば &LT;(Less Than) 、> ならば &GT;(Greater Than) という記号を不等号の代わりに使用してください。これらは処理の際に不等号に置き換えられます。また、& もこのような記号の表現に使われていますので、原稿中に & を使用したい場合は、&AMP; という記号を使用する必要があります。既にワープロソフトなどで作成されている原稿を貼り付ける場合は、貼り付ける前に「置換」などの機能でこれらの記号を置き換えておかれることをお勧めします(貼り付け後では、タグに使われている不等号が多く置換は困難になります)。
なお、これらの制限は半角記号の場合のみですので、日本語で記述されている本文部分では全角記号を使用すれば、特殊文字として認識されません。
4)文字装飾について
文字の装飾としては「下線」のみがお使いいただけます。太字はシステムが使用しますので、執筆者による太字指定はできません。
下線を引くには、下線を引く部分を <under-line> </under-line> で囲んでください。
5)箇条書きについて
論文で使用できる箇条書きには「見出し記号つき箇条書き」と「見出し番号つき箇条書き」の2種類があります。箇条書きの各項目には長い文章を書くこともでき、2行目以降は自動的に字下げをされます。また、2)の方法で途中で改行することも可能です。

「見出し記号つき箇条書き」は、各項目の前に丸などの記号が表示されるタイプの箇条書きです。見出し記号つき箇条書きは、項目毎に <li></li> で挟まれた箇条書きの項目群を <ul type="…"></ul> で囲んだものです。
<ul type="disc">
<li>一つ目の項目</li>
<li>二つ目の項目</li>
<li>三つ目の項目</li>
</ul>
ul タグの type="…" は、各項目の前につく記号の形状を指定しています。type の値としては以下のようなものがあり、それぞれの指定で表示される記号の例を示します。
  • type="disc"   (黒丸)
  • type="circle" (白丸)
  • type="square" (塗りつぶし正方形)

※フォントのサイズによっては、「黒丸(disc)」と「塗りつぶし正方形(square)」が区別しにくい場合があります。

「見出し番号つき箇条書き」は、各項目の前に番号が表示されるタイプの箇条書きです。見出し番号つき箇条書きも「記号つき」同様、項目毎に <li></li> で挟まれた箇条書きの項目群を <ol type="…"></ol> で囲んだものです。番号は1(またはA)から順に自動的に振られます。
<ol type="decimal">
<li>一つ目の項目</li>
<li>二つ目の項目</li>
<li>三つ目の項目</li>
</ol>
ol タグの type="…" は、各項目の前につく番号の書式を指定しています。type の値としては以下のようなものがあり、それぞれの指定で表示される記号の例を示します。
  1. type="decimal"     (アラビア数字)
  2. type="lower-roman" (ローマ数字・小文字)
  3. type="upper-roman" (ローマ数字・大文字)
  4. type="lower-alpha" (アルファベット・小文字)
  5. type="upper-alpha" (アルファベット・大文字)

どちらの箇条書きも、要素内(<ul> 〜 </ul>、<ol> 〜 </ol>)でさらに箇条書きを使って(違う種類の箇条書きも含め)箇条書きを重ねることができますが、重ねるほど左側に空白ができて1行の文字数が少なくなりますのでご注意ください。
<ol type="decimal">
<li>1番目の項目</li>
<ul type="disc">
<li>一つ目の項目</li>
<li>二つ目の項目</li>
</ul>
<li>2番目の項目</li>
</ol>

このように記述すると、次のように表示されます。

  1. 1番目の項目
    • 一つ目の項目
    • 二つ目の項目
  2. 2番目の項目
6)参考文献について
参考文献を引用する場合は、引用場所に <cite label="…"/> を挿入します。参考文献の番号は自動的に振られますので、この際に番号を使う必要はなく、代わりに「引用ラベル」を使います。引用ラベルの名前は、cite タグの中で label="ラベル名" のように指定します。
 参考文献の一覧は本文のあとにまとめて記述し、その際に「引用ラベル」が使用されます。詳しくは、6.1)「参考文献リスト」をご覧ください。
7)ハイパーリンクについて
本文中には、通常のwebページと同様、ハイパーリンクを設定することができます。ハイパーリンクは以下のように記述します。
<hyper-link href="参照先のURL">
ハイパーリンクの設定される文
</hyper-link>
「参照先のURL」は通常のインターネット上のアドレス以外に jcmi-paper:連合大会の開催回番号/演題登録番号 のように書くと、論文集中の他の論文を参照する事ができます。執筆時に参照したい論文の著者に演題登録番号をもらってください。論文集CDを作成する際にはこのURLはCDの中でのアドレスに書き換えられます。また、将来インターネット上での論文公開となった際にも、サーバ上のアドレスなどに書き換えられます。

また、論文には別途書類(ファイル)を添付することができ、その書類もハイパーリンクを利用して参照することができます。添付文書を参照する場合は、以下のように記述します。
<hyper-link href="ファイル名" attach="yes">
ハイパーリンクの設定される文
</hyper-link>

6.XML文書の作成:(3)その他

1)参考文献リスト
参考文献の一覧は、本文(<body> 〜 </body>)の後の <bibliography></bibliography> の間の部分に記述されます。
<bibliography>
<bibitem label="Label1">文献の著者、タイトルなど</bibitem>
<bibitem label="Label2">文献の著者、タイトルなど</bibitem>
</bibliography>
参考文献リストは、bibitem 要素で表される参考文献の情報を <bibliography></bibliography> の間の部分に列挙したものです。bibitem 要素は1つの文献に1つずつ記述され、本文中でその文献の引用箇所に挿入した <cite label="引用ラベル名"/> で指定した引用ラベルと同じラベル(label="引用ラベル名")を持ちます。
2)式
通常、式は指定形式(幅400ピクセルまたは800ピクセルのJPEG或いはPNG形式)の画像として用意していただき、次のように記述することで本文中に挿入することができます。
<math number="1" width="400" height="60">
<img src="ファイル名"/>
</math>
img タグは、画像ファイルのファイル名(src="ファイル名")を指定し、貼り付けるためのものです。ファイル名は空白を含まない半角英数のものである必要があります。<math></math> の間には、この img タグ以外のものを記述することはできません。したがって、通常の文字で構成された簡単な数式でもこの方法で挿入する場合には画像として用意する必要があります。
 math 要素には、数式番号(number)および画像の幅(width)と高さ(height)の情報を指定します。画像の幅は400ピクセル(width="400")または800ピクセル(width="800")に固定されていますが、高さについては制限はありません。また、番号(number)を指定しますが式にはキャプションはつきません。

尚、式を多用し美麗な印刷をご希望にの場合には別途ご相談ください。
3)図、表
図や表も、式と同様に指定の形式(幅400ピクセルまたは800ピクセルのJPEG或いはPNG形式)の画像として用意していただき、次のような記述で論文に貼り付ける方法をとります。基本的な内容は式の場合と同じですが、図表にはそれぞれ「図1〜」「表1〜」といったキャプションがつきますので、タイトル(title)の設定が必要となることに注意してください。
表の貼り付け
<table number="1" title="表のタイトル" width="400" height="600">
<img src="ファイル名"/>
</table>
図の貼り付け
<figure number="1" title="図のタイトル" width="400" height="600">
<img src="ファイル名"/>
</figure>
通常、図や表は文末の <endfigures></endfigures> の間にまとめて記述します。また、箇条書きの項目(li)の中を除けば、本文の段落(section, subsection, subsubsection)中に図や表を挿入することもでき、HTML版では指定した位置に図表が表示されます。しかし、冊子体の論文集では表示位置の指定にかかわらず図表は全て文末にまとめてレイアウトされます。

 尚、図などはカラーでも結構ですが、冊子体論文集では白黒に変換されますのでご注意ください。

7.仕上がりの確認〜投稿用アーカイブの作成

1)仕上がりプレビュー
大会サイトより入手した「XML検証プログラム」を起動し、原稿ファイルとして作業ファイル(p演題番号.txt)を選択します。続いて、「仕上がりプレビュー」のボタンを押すと、まずXMLの文法チェックが行われ、問題がなければ冊子体論文集の形式(B5サイズ、2段組)でレイアウトされた論文が表示されます。規定のページ数に論文が収まっていること、表示に問題がないことを確認してください。(ただし、このプログラムの目的はレイアウトの確認のため、図表が枠線で表示されるなど一部表示が簡略化されていることをご承知ください。)
2)HTML版の仕上がり確認
冊子体の仕上がりやページ数を確認したら、次にHTML版の仕上がりを確認します。検証プログラムで「HTMLへ変換」のボタンを押してください。仕上がりプレビューと同様、XMLの文法チェックの結果に問題がなければHTML形式に変換されたファイルの保存先を聞かれますので、作業用フォルダに保存してください。

 変換されたファイルの仕上がりを確認するには、同じフォルダにstylesheet.css を置いて Internet Explorer でHTMLファイル(p演題番号.html)を開いてください。式・図・表の画像がある場合は、それも同じフォルダに置くと画像も表示されます。

尚、論文中で <, >, & などの特殊記号を使用している場合は「HTMLへ変換」の際にDTD(Document Type Definition:文書型定義)ファイルの変更が必要になります。「XML検証プログラム」のフォルダにある jcmipapr.dtd をテキストエディタで開き、ファイルの最初の方にある
<!--
 for HTML Generation: INCLUDE
 for Page Preview: IGNORE
-->
<![IGNORE[
<!ENTITY LT "&lt;" >
<!ENTITY GT "&gt;" >
<!ENTITY AMP "&amp;" >
]]>
の部分の(上では5行目にある) IGNORE を、その上の指示どおりHTMLに変換する際には「INCLUDE」、仕上がりプレビューの際には「IGNORE」に変更してください。
3)投稿用ファイルの作成
いよいよ最終段階です。「仕上がりプレビュー」「HTMLへ変換」とも結果に問題がなければ、検証プログラムの「投稿用ファイル作成」ボタンを押してください。検証プログラムが原稿XMLを解析して自動的に論文中で参照されている添付文書や画像を収集し、原稿XMLファイルとともに1つのアーカイブファイルにまとめます。アーカイブファイルの保存先を聞かれますので、作業用フォルダに保存してください。

この投稿用のアーカイブファイルを所定の方法で投稿すれば完了です。お疲れ様でした。

8.エラーの対処法

「XML検証プログラム」で原稿ファイルのチェックを行ったときにエラーが発生した場合の対処法をこちらにまとめました。


この文書は Windows 98 上の Microsoft Internet Explorer 5.5 、フォントサイズ「小」で表示の確認を行っています。
Cascading Sytle Sheet(CSS) を多用していますので、ブラウザ・バージョンによってはレイアウト等が乱れる可能性があります。