:: wikihub-wiki

WikiHub (wikihub.org) の使い方

WikiHub は，Git や Subversion にて文書を管理したいコマンドライン大好きなプログラマーさんたちが，文書を自分にあったやり方で更新しつつ，バージョン管理しつつ，でもウェブでも見たい，という欲張りな要望をかかえているだろうと勝手に判断し作成された，バージョン管理連携wikiインターフェースです．

現在制限つきオープンベータとして運営中．

この文書もGithubをリポジトリとした，wikihub上で管理されています．

• http://github.com/sotarok/wikihub-wiki/tree/master

Wiki更新のイメージ

ログイン/ユーザ登録

OpenIDのみ対応しています．

現在制限つきオープンベータなので，ユーザ登録数が制限に達しない限り，ご自由にユーザ登録ができます．（利用状況を見ながら段階的に解除していくつもりです）

Wiki閲覧のほうは，どなたでも閲覧できます．

Wikiの登録

Wiki の登録には，2つの情報が必要です．

• Wikiの名前 (英数字 と - または _ の組み合わせ)
• Wiki リポジトリのURL
  • これは，現在，以下の2つのみ対応しています．
    • 外部からアクセス可能な Subversionリポジトリ
    • 外部からアクセス可能な Gitリポジトリ
    • 外部からアクセス可能な Mercurialリポジトリ
    • * いまのところ，ssh プロトコルには対応していません．

例えば，

git://github.com/sotarok/wikihub-wiki.git

などです．

対象のファイル

WikiHub上に表示されるファイルは，拡張子が .txt となったファイルまたは README ファイルのどちらかです．

また，指定されたWikiのトップは，指定したリポジトリの README ファイルを表示します．

URL とファイルの対応

簡単のため，

• WikiHub： http://wikihub.org/wiki/wikihub-wiki
• リポジトリ：http://github.com/sotarok/wikihub-wiki/tree/master (リポジトリのルートを，REPOSITORY_ROOTとします)

を用いて解説します．

• http://wikihub.org/wiki/wikihub-wiki
  • WikiHub の文書トップ: リポジトリ上の REPOSITORY_ROOT/README ファイルが整形されて表示される
• http://wikihub.org/wiki/wikihub-wiki/hoge
  • リポジトリ上の REPOSITORY_ROOT/hoge.txt ファイルが整形されて表示される
• http://wikihub.org/wiki/wikihub-wiki/hoge/fuga
  • リポジトリ上の REPOSITORY_ROOT/hoge/fuga.txt ファイルが整形されて表示される

といった具合です．

2009/10/17以降，どのサブディレクトリをWikiのトップにするかを指定できるようになりました．

これにより，プログラムのソースコードとドキュメントが同居したようなリポジトリでも，たとえばサブディレクトリに「doc」と指定することで，上位ディレクトリを無視し，doc ディレクトリ以下を WikiHub に表示することができるようになります．(*1)

Wikiの更新

Wikiの更新は，リポジトリの更新にHookして Ping URL にアクセスしてください．

Githubで管理された文書なら設定は簡単です．

1. リポジトリの Admin へアクセスする
2. Service Hooksへアクセス
3. Post-Receive URLsへ，http://wikihub.org/ping/WIKI_NAME などとURLを入力して追加する
   • ここでいう WIKI_NAME は，WikiHub上に作成した Wikiの名前になります

送信されたPingは順次処理されます．最大1分ほどのタイムラグがあります．気長にお待ちください．

Subversion を使っている場合は少し面倒で，リポジトリのあるサーバで，コミットフックを設定しなければいけません．Post Commit Hook で Ping URL にアクセスするようにしてください．

• see. HookSettings

Wikiの整形

Wiki文書スタイルは現在，はてな記法のみをサポートしています．

• ref. はてな記法一覧

バグ・不具合など

sotarokまでどうぞ：

• http://twitter.com/sotarok

問い合わせ

sotarokまでどうぞ：

• http://twitter.com/sotarok
• sotaro.k /at/ gmail.com