OpenSourceBrain Documentation: プロジェクトを文書化する
このページは外部資料の日本語訳です。原文の見出し順と本文順を保ち、コード・URL・出典表記はできるだけ原形のまま残しています。
出典とライセンス
ライセンス: CC BY 4.0。このページは日本語翻訳であり、変更点は翻訳とサイト内整形です。
プロジェクトを文書化する
OSB プロジェクトにドキュメントを追加し、注釈を付けるには、いくつかのオプションがあります。
README ファイルを GitHub リポジトリに追加し、OSB プロジェクトで再利用します
READMEファイル は、リポジトリの内容とその使用方法の概要を簡単に説明するのに最適な方法です。 GitHub でコードを共有する場合、最上位に README を追加すると、リポジトリにアクセスした人は誰でも内容の簡単な紹介を確認できるようになります。これらは通常、編集しやすい マークダウン形式 で作成されます。
説明をコピー/ペーストする必要性を回避し、概要が 1 か所のデータから消えてしまうのを避けるために、GitHub の README の正確な内容を OSB 上のメインの説明に再利用できます。 [設定] のメイン プロジェクトの説明のテキスト フィールドに次の内容を追加するだけです。
github:README.md
たとえば、次のようになります: https://github.com/OpenSourceBrain/ACnet2/blob/master/README.md は、次の OSB プロジェクト ページでプロジェクトの説明としても使用されます: http://www.opensourcebrain.org/projects/acnet2.
カスタムフィールドの値を設定します
OSB のプロジェクトのフィールドに多数の値を設定して、モデルを分類し、他のリソースにリンクし、OSB でのモデルの検索を容易にすることができます。これらには、モデルDB 上の元のスクリプトの場所、モデル化されている種と脳領域、モデルのキュレーションの状態が含まれます。
これらには「設定」からアクセスできます。 注: これらの値を変更するには、管理設定 の下にある カスタム フィールド タブをクリックする必要があります。
Wiki ページを OSB プロジェクトに追加する
新しい Wiki ページを OSB プロジェクトに追加するには、プロジェクト オプション バー (ログイン時) の [Wiki] リンクをクリックし、Wiki ページの編集を開始します。
OSB ドキュメントは マークダウン形式の構文 で書かれており、Redmine および OSB 固有の追加機能もいくつか含まれています (詳細については以下を参照してください)。 注 Markdown を使用すると、ほとんどの HTML 構文 (ビデオなど) を含めることができます。 GitHub wiki と可能な限り互換性を保つために、OSB は GitHub 風味のマークダウン を使用します。 チートシート ここ があります。
以下では、OSB 上の Wiki ページを強化するための OSB/Redmine の機能について簡単に説明します (これらは、[設定] のメイン プロジェクトの説明のテキスト フィールドでも使用できます)。
リポジトリ ファイルへの参照。
GitHub または Bitbucket リポジトリ (プロジェクトで使用されるリポジトリ) 内の任意のファイル (マークダウンまたはプレーン テキスト) を指定できます。
github:[path]
bitbucket:[path]
これにより、ファイルのコンテンツが取得され、OSB wiki ページに表示されます。これにより、リポジトリ内の 1 つのファイル (メインの README.md など) がプロジェクトのドキュメントのマスター コピーとなり、OSB でプロジェクトを閲覧している人がそのファイルにアクセスできるようになります。
例：
github:help/readme.md
bitbucket:help.txt
パブメッド 出版物への参照:
pubmed:[publicationID]
例：
pubmed:17442244
この構文は、次のような参照リンクを生成します (リンクは OSB でのみ正しく表示されます): pubmed:17442244 と、参考文献セクションがページの下部に自動的に生成されます。
数式を作成する
LaTeX 構文を使用してドキュメントに数式を記述することができます。次のように数式を囲むだけです。
{{latex(formula)}}
例：
{{latex(x=\frac{-b\pm\sqrt{b^2-4ac}}{2a})}}
これにより、GoogleチャートAPI を使用して次のイメージが自動的に生成されます。
Wiki ページへのリンク
他の Wiki ページにリンクしたい場合:
[[Wiki page]]
問題へのリンク
プロジェクト内の課題にリンクしたい場合:
Issue #12
#12 を発行します
コミットへのリンク
リポジトリ内のコミットにリンクしたい場合:
commit:f30e13e43