Perl Advent Calendar 書き方
このドキュメントは、perl-users.jp で公開されている Advent Calendar のwriter向けにカレンダー記事の公開方法について説明したものです。
この Advent Calendar は、一般利用者に対しては以下のURLで公開されます。
/articles/advent-calendar/2012/
トラックは以下のものがあります。
- Hacker Track
- Casual Track
各トラックの内容については、上記 URL および参加者募集要項等を見てください。
各トラックの記事は、GitHub 上にテキスト形式で配置します。
https://github.com/perl-users-jp/perl-advent-calendar/tree/master/
例えば、記号トラックの2012年12月5日用の記事であれば、
https://github.com/perl-users-jp/perl-advent-calendar/tree/master/2012/sym/2012-12-05.txt
として git push することになります。
現在、上記リポジトリへの push 権は各トラックで主要な数名が保持していますので、
- githubにアカウントを持っているのであれば tokuhirom, yappo, kan_fushihara, takesako, xaicron, hasegawayosuke, makamaka, yusukebe, kazuho, lestrrat, dankogai, mattn あたりにお願いして権限を与えてもらう。連絡方法はIRC(#perl-casual@freenodeあたり)やTwitterでどうぞ。forkしてpull reqするのは面倒なので禁止です。
- 持っていないかアカウントを晒したくない人は、すでに記事を push している人(GitHub上で見えますね)にお願いして push してもらう
という方法を採って下さい。
git がよくわからないという方は、自分の書くトラックの誰かにメール等で記事を渡して更新してもらうのが簡単だと思います(頻繁に更新する場合は権限をもらって自分でgitを使いましょう!)。
各記事をpushするタイミングは任意で行って構いません。期日になれば、perl-users.jpから記事へのリンクが自動的に張られます。
期日前でも、例えば
/articles/advent-calendar/2012/sym/5
のようにURLに直接アクセスすれば、該当記事(この例では12月5日の記事)を見ることができます。プレビューがわりに表示を確認しておきましょう。
GitHub 経由やURL直接アクセスで事前に記事が見られるのがイヤだという場合は、公開ギリギリまで push しないようにしてください。
記事は、はてな記法が使えますが、完全に互換というわけではありません。HTMLタグも利用可能です。
記事の先頭行はタイトルとして使用されます。以下に記述例を示します。
記事タイトル meta-author: 記事を書いた人 meta-tags: 記事のカテゴリ 記事本文 ・・・
記事タイトルは改行を含む事が出来ません。meta-author, meta-tags は主に RSS 配信に用いられます。RSS の author として設定されるので
記事タイトル meta-author: パール 太郎 <jperl@example.com> meta-tags: perl, win32 記事本文 ・・・
という形式で記述します。meta-tags はカンマによる複数指定が可能です。なおどちらのメタ情報も省略は可能ですが、なるべく入れる様にして下さい。
その他、分からないことがあれば IRC で #perl-casual@freenode.net or #perladvent@Twitter あたりで気軽に尋ねてください。
書いた人:hsegawayosuke
※ツールが複数年対応となったので、リポジトリ url などが変わりました