# jasnaoe_template_typst

このテンプレートは，2024年秋季以降の日本船舶海洋工学会の講演会論文作成を想定して，
[Typst](https://typst.app)で作成しています．

もちろん♡非公式♡のテンプレートですので，ご使用の際は自己責任でお願いします．

このテンプレートを使ったPDFファイルの仕上がりは，[GitHub PagesのPDFファイル](https://taiga4112.github.io/jasnaoe_template_typst/main.pdf)をご確認ください．
(現在，Linux系のOSで試すと英語フォントがうまく作動しない現象が発生しています．詳しくは[issue](https://github.com/taiga4112/jasnaoe_template_typst/issues/25)で議論しています．)

> **注意**
>
> 2024年秋季講演会から[講演論文のテンプレートが大幅に変更]("https://www.jasnaoe.or.jp/lecture/2024aut/thesis.html?id=yoryo")されました．
>
> 具体的には，論文タイトル，著者情報，キーワード，要旨は講演論文投稿システムで別に作成し，本文のみを記載したファイルを講演論文投稿システムに投稿することで，システム側でマージして完成するようになりました．
>
> そのため，このテンプレートは，2024年秋季講演会から変更されたフォーマットに沿って，本文情報のみを記載することを想定しています。論文タイトル，著者情報，キーワード，要旨はこのテンプレートでは記載することを想定していません．

## 事前準備

### Typstのインストール

公式のマニュアルは[こちら](https://github.com/typst/typst?tab=readme-ov-file#installation)．

Windowsの場合は，PowerShellか何かで，以下のコマンドを実行してください．

```bash
winget install --id Typst.Typst
```

Mac OSの場合は，Terminalか何かで，[Homebrew](https://formulae.brew.sh/)を使って，以下のコマンドを実行してください．

```bash
brew install typst
```

### フォントのインストール(Mac, Linuxのみ)

現在，フォントについては以下の設定になっています．
各自のPCにインストールされているフォントと照らし合わせて，前の方から優先的に使われるようです．

```ts
#let mincho = ("Times New Roman", "MS Mincho", "IPAMincho", "Noto Serif CJK JP", "Hiragino Mincho Pro")
#let gothic = ("Times New Roman", "MS Gothic", "IPAGothic", "Noto Sans CJK JP", "Hiragino Kaku Gothic Pro")
```

基本的には，英語の場合に優先的に選択されるTimes New Roman以外を除くと，前の方がおすすめなフォントですが，

- ゴシック: MS GothicとIPAGothic
- 明朝: MS MinchoとIPAMincho

くらいまででないと，仕上がりが[指定フォーマット](https://www.jasnaoe.or.jp/lecture/2024aut/thesis.html?id=yoryo)に近づきません．

Typstで認識されているフォントを確認するには，以下のコマンドを実行すると良いです．

```bash
typst fonts
```

#### Windows

おそらく，WindowsではMS GothicとMS Mincho，Times New Romanがデフォルトで入っているので，何もする必要がありません．

#### Mac OS

おそらく，MacではTimes New Romanは入っているけども，ゴシックや明朝はフォントをインストールする必要があります．

IPAフォントであれば，[Homebrew](https://formulae.brew.sh/)を利用して簡単にインストールできます．

```bash
brew install --cask font-ipafont
```

MSフォントは，Microsoft OfficeがインストールされているPCであれば[この記事](https://note.com/tomorrow311/n/ne835a8c525a9)の方法で取り込めそうですが，ご自身の責任でお願いします．

#### Linux

IPAフォントは以下の方法でインストールできそうです．

```bash
# Debian系(Ubuntu)
sudo apt-get install fonts-ipafont
sudo apt-get install msttcorefonts # Times New Roman
```

## 使用方法

### 1. ファイルを準備する

- GitHubアカウントを持っている方は，`use this template` で．自分用のレポジトリを生成してください

- GitHubアカウントを持っていない方は，このGitHubページの `<>Code▼` から `Download ZIP` し，　ZIPファイルを解凍して使用してください．

### 2. 編集&コンパイルでpdfを作成する

編集するファイルはmain.typです．

#### コンソールでコンパイルをする場合 (推奨)

以下のコマンドを実行することでファイルの変更時に自動でコンパイルを行ってpdfファイルを生成してくれます。コンパイルが失敗する場合はエラーメッセージが表示されるので、該当の場所を修正しましょう。

```sh
typst watch main.typ main.pdf
```

詳しくは、[公式サイト](https://github.com/typst/typst?tab=readme-ov-file#usage)を参照ください．

#### Visual Studio Code (VSCode) 固有のプラグインを使用する場合 (非推奨)

1. VSCode で `File`→`Open Folder` でこのフォルダーを開く．

2. 拡張機能をインストール．  
    - [Typst LSP](https://marketplace.visualstudio.com/items?itemName=nvarner.typst-lsp)
    - 何でも良いのでpdfをVSCodeで閲覧できる拡張機能．例えば，[vscode-pdf](https://marketplace.visualstudio.com/items?itemName=tomoki1207.pdf)など．

3. [Typst LSP](https://marketplace.visualstudio.com/items?itemName=nvarner.typst-lsp)のデフォルトの設定では，typファイルを保存すると，問題がなければコンパイル後にpdfファイルが同じ階層に生成されます．
    - 問題があったときにわかりやすいように，PROBLEMS(日本語で「問題」)を常に表示させておくと良いかと思います．
        - Macだと command + shift + m ．

