Zenn
📚

TEI/XMLファイルをGitHubで公開する手順書

に公開
GitHub
XML
TEI
人文学
デジタル・ヒューマニティーズ
tech

はじめに

この記事では、TEI（Text Encoding Initiative）形式のXMLファイルをGitHubにアップロードし、誰でも参照できるURLを作成する手順を説明します。

TEI/XMLは、歴史文献や文学作品などのテキストを構造的に記述するための国際標準形式です。GitHubを使うことで、あなたの研究データを世界中の研究者と共有できるようになります。

必要なもの

  • パソコン（Windows、Mac、Linuxのいずれか）
  • インターネット接続
  • TEI/XMLファイル（すでにお持ちのもの）
  • メールアドレス（GitHubアカウント作成用）

サンプルファイルについて

TEI/XMLファイルをお持ちでない方は、以下の『校異源氏物語』のTEI/XMLファイルを練習用として使用できます：

サンプルファイルURL:

https://raw.githubusercontent.com/kouigenjimonogatari/kouigenjimonogatari.github.io/master/tei/01.xml

このファイルをダウンロードする方法：

  1. 上記URLをブラウザで開く
  2. 右クリック→「名前を付けて保存」を選択
  3. ファイル名を「koukin_genji_01.xml」などに設定して保存

ステップ1：GitHubアカウントの作成

1-1. GitHubのウェブサイトにアクセス

  1. ブラウザ（Chrome、Firefox、Safari等）を開きます
  2. アドレスバーに https://github.com と入力してEnterキーを押します

1-2. アカウント作成

  1. 右上の「Sign up」ボタンをクリックします

  2. 以下の情報を入力します：

    • メールアドレス：普段お使いのメールアドレス
    • パスワード：安全なパスワード（8文字以上、数字と記号を含む）
    • ユーザー名：他の人と重複しない名前（例：yamada-taro2024）

  3. 「Create account」をクリックします

  4. メールに届いた認証コードを入力します

💡 ヒント: ユーザー名は後から変更できないので、慎重に選びましょう。研究者として使う場合は、実名に基づいた名前がおすすめです。

ステップ2：新しいリポジトリの作成

リポジトリとは、ファイルを保管する「プロジェクトフォルダ」のようなものです。

2-1. リポジトリ作成画面へ

  1. GitHubにログインした状態で、右上の「+」マークをクリックします
  2. 「New repository」を選択します

2-2. リポジトリの設定

以下の項目を入力・選択します：

Repository name（リポジトリ名）

  • 英数字とハイフン（-）が使えます
  • 例：tei-xml-collection、medieval-texts-tei

Description（説明）※任意

  • プロジェクトの簡単な説明
  • 例：「中世文献のTEI/XMLファイル集」

Public/Private（公開設定）

  • Publicを選択：誰でも閲覧可能（推奨）
  • Private：招待した人のみ閲覧可能

Initialize this repository with:（初期化オプション）

  • ✅ Add a README fileにチェックを入れる
  • その他はそのままで大丈夫です
  1. 緑色の「Create repository」ボタンをクリックします

ステップ3：TEI/XMLファイルのアップロード

3-1. アップロード画面へ

  1. リポジトリが作成されると、ファイル一覧画面が表示されます
  2. 「Add file」ボタンをクリックします
  3. 「Upload files」を選択します

3-2. ファイルのアップロード

方法A：ドラッグ&ドロップ

  1. エクスプローラー（Windows）またはFinder（Mac）でTEI/XMLファイルがある場所を開きます
  2. アップロードしたいファイルを選択します（複数選択可）
  3. ブラウザの点線枠内にドラッグ&ドロップします

方法B：ファイル選択

  1. 「choose your files」をクリックします
  2. ファイル選択ダイアログでTEI/XMLファイルを選択します
  3. 「開く」をクリックします

実例：『校異源氏物語』のTEI/XMLファイルをアップロード

サンプルファイルを使った具体例：

  1. 先ほどダウンロードした「koukin_genji_01.xml」を選択
  2. ファイルサイズ（約100KB程度）が小さいので、すぐにアップロードされます
  3. ファイル名が日本語の場合は、英数字に変更することを推奨（例：genji_chapter01.xml）

3-3. アップロードの確定

  1. ファイルがアップロードされたことを確認します
  2. Commit changes（変更の確定）セクションで：
    • 最初の入力欄に簡単な説明を入力（例：「TEI/XMLファイルを追加」）
    • 詳細説明は任意です
  3. 緑色の「Commit changes」ボタンをクリックします

💡 ヒント: フォルダごとアップロードすることも可能です。フォルダ構造を保ったままアップロードされます。

ステップ4：ファイルの参照URLを取得

4-1. ファイルを開く

  1. リポジトリのファイル一覧から、共有したいTEI/XMLファイルをクリックします
  2. ファイルの内容が表示されます

4-2. URLの取得方法

方法1：Raw（生データ）URL（推奨）

プログラムで処理する場合に便利：

  1. ファイル表示画面の右上にある「Raw」ボタンをクリックします
  2. 新しいタブで開いたURLをコピーします
  3. 例：https://raw.githubusercontent.com/[ユーザー名]/[リポジトリ名]/main/[ファイル名].xml

方法2：ブラウザ表示用URL

このURLをそのまま共有できます：

  • ブラウザのアドレスバーに表示されているURLをコピーします
  • 例：https://github.com/[ユーザー名]/[リポジトリ名]/blob/main/[ファイル名].xml

方法3：ダウンロード用URL

  1. ファイル表示画面の右上にある「Download」ボタンを右クリックします
  2. 「リンクのアドレスをコピー」を選択します

4-3. TEI/XMLビューワーでの表示例

GitHubで公開したTEI/XMLファイルは、専用のビューワーで見やすく表示することもできます。

ビューワー1：TEI古典籍ビューワ

https://candra.dhii.jp/nagasaki/tei/tei_viewer/?file=[あなたのGitHub Raw URL]

具体例：

https://candra.dhii.jp/nagasaki/tei/tei_viewer/?file=https://raw.githubusercontent.com/kouigenjimonogatari/kouigenjimonogatari.github.io/master/tei/01.xml

このように、GitHubにアップロードしたファイルのRaw URLを使えば、様々な外部ツールと連携できます。研究目的や閲覧者のニーズに応じて、最適なビューワーを選択してください。

ステップ5：複数ファイルの整理（応用編）

5-1. フォルダの作成

GitHubでは直接フォルダを作成できませんが、ファイル名にスラッシュ（/）を含めることでフォルダ構造を作れます。

  1. 「Add file」→「Create new file」を選択
  2. ファイル名入力欄に「フォルダ名/ファイル名」と入力
    • 例：manuscripts/text001.xml
  3. 内容を入力またはペーストして「Commit new file」

5-2. 既存ファイルの移動

  1. 移動したいファイルをクリックして開く
  2. 鉛筆アイコン（Edit）をクリック
  3. ファイル名の前にフォルダ名を追加
    • 変更前：text001.xml
    • 変更後：manuscripts/text001.xml
  4. 「Commit changes」をクリック

よくある質問（FAQ）

Q1. アップロードできるファイルサイズに制限はありますか？

A: ブラウザ経由でのアップロードは1ファイルあたり25MBまでです。それ以上の場合は、Git LFSという機能を使う必要があります。

Q2. 間違ってアップロードしたファイルを削除するには？

A:

  1. 削除したいファイルを開く
  2. ゴミ箱アイコンをクリック
  3. 削除理由を入力して「Commit changes」

Q3. プライベートリポジトリを後から公開できますか？

A:

  1. リポジトリページの「Settings」タブを開く
  2. 一番下の「Danger Zone」セクションへ
  3. 「Change visibility」をクリック
  4. 「Make public」を選択

Q4. 他の研究者と共同編集できますか？

A:

  1. リポジトリの「Settings」→「Manage access」
  2. 「Invite a collaborator」をクリック
  3. 共同研究者のGitHubユーザー名またはメールアドレスを入力

Q5. TEI/XMLファイルをきれいに表示する方法は？

A: GitHubは基本的にXMLをテキストとして表示しますが、以下の方法で見やすくできます：

  • ブラウザの拡張機能（XML Tree等）をインストール
  • GitHub Pagesを使ってウェブサイトとして公開（別途設定が必要）

セキュリティとプライバシーの注意点

公開前の確認事項

  • 個人情報（メールアドレス、電話番号等）が含まれていないか
  • 著作権的に問題ないか
  • 研究倫理上、公開して問題ないか
  • 共同研究者の同意を得ているか

推奨事項

  1. ライセンスの明記：README.mdファイルに使用条件を記載
  2. 定期的なバックアップ：ローカルにもコピーを保管
  3. 変更履歴の活用：GitHubは全ての変更を記録します

さらに学びたい方へ

参考リンク

次のステップ

  1. GitHub Pages：TEI/XMLをウェブサイトとして公開
  2. XSLT変換：XMLをHTMLに変換して見やすく表示
  3. DOI取得：Zenodoと連携して学術的な引用を可能に

まとめ

この手順書では、TEI/XMLファイルをGitHubで公開する基本的な方法を説明しました。

主なステップ：

  1. GitHubアカウントの作成
  2. リポジトリの作成
  3. ファイルのアップロード
  4. 共有用URLの取得
  5. ファイルの整理

GitHubを使うことで、研究データの保存、共有、バージョン管理が簡単にできるようになります。最初は慣れないかもしれませんが、使っていくうちに便利さを実感できるはずです。

ご不明な点があれば、GitHubのヘルプドキュメントを参照するか、デジタル・ヒューマニティーズのコミュニティで質問してみてください。

Discussion