コンテンツにスキップ

Asciidoctorを用いた論文作成

概要

Asciidoctorという言語を用いて効率的に論文作成を行う方法を学びましょう。

前提条件

開始キットの入手

PDFの作成テスト

  • GitHubレポジトリのREADMEファイルを参考に、PDF作成までの手順を試してみましょう。
  • 手順の冒頭ではRubyというプログラミング言語環境や関連パッケージをインストールします。

基本的な設定と記述方法

文書設定の変更

  • index.adocの以下の部分を適宜 
    = 論文題目
// Settings to change 変更する設定
:author: 著者名
:revnumber: 1.0 // 版番号
:revdate: 2020-01-01 // 作成日時
:revremark: この版の簡単な説明
  • 目次の表示設定 
    // 目次を表示
toc::[]

// 目次を非表示
// toc::[]

章ファイルのインポート

  • テンプレートをダウンロードした段階では、以下のファイルのみがインポートされる設定になっている
  • 抄録：abstract.adoc
  • 序論：introduction.adoc
  • 引用文献：reference.adoc
  • 他の章をインポートする場合は、index.adocの設定を以下のように変更する（方法の章の例） 
    // 方法の章の非インポート
// include::methods.adoc[]

// 方法の章のインポート
include::methods.adoc[]

原稿の執筆

各章のファイル名

💡 章の構成は以下を基本としつつも、必要に応じて変更してもよい

  • 抄録：abstract.adoc
  • 序論：introduction.adoc
  • 方法：methods.adoc
  • 結果：results.adoc
  • 議論：discussion.adoc
  • 結論：conclusion.adoc
  • 引用文献：reference.adoc
  • 付録：appendix.adoc（任意）

段落

  • 段落は空行を入れます。
これは段落の文です。これは段落の文です。これは段落の文です。これは段落の文です。これは段落の文です。これは段落の文です。これは段落の文です。これは段落の文です。これは段落の文です。これは段落の文です。
これは段落の文です。これは段落の文です。これは段落の文です。これは段落の文です。これは段落の文です。これは段落の文です。これは段落の文です。

これは次の段落の文です。これは次の段落の文です。これは次の段落の文です。これは次の段落の文です。これは次の段落の文です。これは次の段落の文です。これは次の段落の文です。これは次の段落の文です。
これは次の段落の文です。これは次の段落の文です。これは次の段落の文です。

句読点

  • 「、」「。」で統一してください。
  • 引用文献リストのSIST02の記述についてはその限りでありません。

章・図表・コード・引用文献の参照

章の参照

章・節・項は、それぞれ以下の記法を用いる。 

== 章の名前
=== 節の名前
==== 項の名前

論文の題目や章節項の名前に改行を入れたい場合は、pass:[<br/>]を入れる。 

= 長い長い題目なのでここら辺で pass:[<br/>] 改行を入れる
// Settings to change 変更する設定
:author: 著者名
:revnumber: 1.0 // 版番号
:revdate: 2020-01-01 // 作成日時
:revremark: この版の簡単な説明

あるセクションを文書内で参照するには、まずセクション名の上にアンカー（[[...]]）を入れる。 

[[toc:introduction]]
== 序論

ここに研究の序論を書く。

その後、文書内では以下のように<<アンカー名,表示名>>の記法でリンクを作成することで参照する。 

<<toc:introduction,序論>> で述べた通り、・・・

図表・コードのアンカー

サンプル文書を参照のこと

引用文献のアンカー

  • 引用文献の書誌事項はreference.adocにまとめて書く。
  • [[筆頭著者苗字:出版年]] 書誌情報 の形で記述する
    • 文献リストは筆頭著者名字のA-Zあ～んの順序で並べる
  • アンカータグは英語のみ（良い例：[[Joho:2020]]、悪い例：[[上保:2020]]）
  • 書誌情報はSIST02で記述する
[bibliography]
== 引用文献
* [[Hunt:99]] Andy Hunt & Dave Thomas. The Pragmatic Programmer: From Journeyman to Master. Addison-Wesley. 1999.
* [[Allen:08]] Dan Allen. Seam in Action. Manning Publications.2008.
* [[Joho:2022]] 上保秀夫．（2022）誰でも書ける卒業論文．筑波大学出版．p.3

論文中の引用方法

  • 引用論文を主語として使う場合、<<タグ, 執筆者（出版年）>> の形で記述する
<<Hunt:99, HuntとThomas（1999）>> は・・・した。
  • 引用論文を文中や文末で使う場合は、文章 <<タグ，（執筆者，出版年）>> の形で記述する
・・・している <<Allen:08, (Allen, 2008)>>。

アンカータグの例

アンカーに使うタグは統一しておくとよい

  • 章・節・項：toc:○○
  • 図：fig:○○
  • 表：tab:○○
  • コード：code:○○
  • 引用：第一著者名字:出版年（例：Joho:2020）

画像ファイル

  • 画像ファイルはimagesフォルダに保存して、以下のようにファイル名のみを指定する方法で挿入する
[.center]
.キャプション
image::UTLogo_150.png[]

その他

フットノート（脚注）

  • フットノートは極力使用しない
  • 参照するWebページがある場合は、引用文献に書誌事項を記載して、論文同様に引用する
  • ただしホームページを示したい場合は、URLをフットノートに入れる
・・・としてレファレンス共同データベースがある footnote:[https://crd.ndl.go.jp/reference/ （参照日時：2021/12/01）]。

レファレンス資料