wiki:publishingVLMag

Version 21 (modified by tanakanata, 13 years ago) (diff)

--

Vine Linux Magazine の書き方とアップロード

Vine Linux Magazine(vlmag)の作成には VineSeed Trac/BTS account が必要です。

Subversion

vlmag の原稿は Subversion で管理されています。執筆の前に subversion パッケージをインストールしておいてください。

Subversion では「コピー・修正・マージ」の手順で操作します。

  1. 自 PC の作業用ディレクトリで「チェックアウト」して Vine Linux Web ソースのリポジトリツリー(の一部)をコピー
  2. 自 PC 上で原稿を作成/追加/修正
  3. 完成/修正した原稿を「コミット」して Vine Linux Web ソースのリポジトリにマージ

チェックアウトしてリポジトリをコピー

  1. 自 PC にチェックアウト用のディレクトリを作成します。ここでは ~/vlmag を作成したとします。
 $ mkdir ~/vlmag
  1. Subversion で Vine Linux サイトの Web ソースリポジトリをチェックアウトします。
 $ cd ~/vlmag
 $ svn co http://trac.vinelinux.org/repos/projects/web/trunk

Vine Linux のサーバ上の Web ソースファイルが ~/vlmag に取り込まれます。

vlmag 執筆者に関連するファイルは以下のものです。

trunk
|-- Makefile
|-- css
|   |-- dlwin.css
|   |-- docs.css
|   `-- layout.css
`-- vlmagazine
    |-- YYYYMMDD.dat
    `-- images
        `-- YYYYMMDD-*.{png,jpeg,etc.}

記事を作成する

執筆/作成するのは以下のファイルです。

  • trunk/vlmagazine/YYYYMMDD.dat(HTMLの元になる記事本文)
  • trunk/vlmagazine/images/YYYYMMDD-*.{png,jpeg,svg,etc.}(HTML がリンクする画像)

YYYYMMDD は作成した vlmag の公開(予定)日になります。

datファイルの書式

YYYYMMDD.datの書式は次の通りです。

<date>
YYYY,MM,DD

<author>
執筆者名

<title>
タイトル

<description>
概要

<h2>見だし</h2>

<p>……</p>

それぞれの意味は次のようになります。

<date>
日付を「YYYY,MM,DD」の形で。2011年4月20日であれば「2011,04.20」とする。
<author>
執筆者名。開発者アカウントのIDが推奨される。
<title>
Vine Linux Magazine記事のタイトル。
<description>
Vine Linux Magazine記事の概要。
<h2>
ここから本文。以下、普通のHTMLを書く。記事内で使う見だしはh2が最大なのでh2からはじめる。

date, author, title, descriptionの各タグについては、ソースの見通しの良さなどを考えて改行を入れてください。

既存記事をベースに編集する場合

適当な既存記事のファイルをコピーして雛形として作業を始めることもできます。

 $ cd ~/vlmag/trunk/vlmagazine
 $ cp 適当な既存記事のファイル YYYYMMDD.dat
 $ cd ../
 $ make 

すると、YYYYMMDD.dat から YYYYMMDD.html が生成されます。

「html ls: /home/ftp/pub/Vine/VineSeed/pool/*.rpm にアクセスできません: そのようなファイルやディレクトリはありません rpmq: 問い合わせのための引数が指定されていません。」というような警告がいくつか出ますが、無視してかまいません。

生成されたのは確認用の HTML です。エディタで開いて css のリンク PATH を以下のように修正してブラウザで確認してください。

<link href="../css/layout.css" rel="stylesheet" type="text/css" media="screen,tv,print" />

この HTML を作成用に使ってもかまいませんが、$ make clean コマンドを走らせると、~/vlmag/trunk 以下のすべての HTML が削除されるので要注意。

使えるタグ、書式規則とも、冒頭の{<date>,<author>,<title>,<description>}を除き、通常の HTML と変わりません。<!DOCTYPE html PUBLIC "-W3CDTD XHTML 1.0 TransitionalEN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> と言われてわかる方はそういう風に書いてください。 使い慣れた HTML エディタなどがある方はそれで書いて <body> と </body> に挟まれた部分を YYYYMMDD.dat に貼り付けても良いでしょう。

原稿は .dat 形式で完成させます。完成したら

 $ make clean ; make

して HTML で最終確認を行なってください。

出版する

出来上がった原稿を Vine Linux サイトの Web ソースリポジトリにマージします。YYYYMMDD が有効な日付か再度確認しておいてください。

ファイルを Subversion 管理下に追加

追加するのは YYYYMMDD.dat と画像ファイルです。make で生成した 確認用/執筆用 HTML は追加しません

 $ cd ~/vlmag/trunk
 $ svn add vlmagazine/YYYYMMDD.dat

同様に vlmagazine/images 以下に追加した画像も全て管理下に追加します。

Vine Linux リポジトリに送る

 $ svn commit -m "commit log(簡潔なコミットコメント)"

VineSeed Trac/BTS account のユーザ名、パスワードを訊かれます。

追加しています              vlmagazine/YYYYMMDD.dat
追加しています  (バイナリ)  vlmagazine/images/YYYYMMDD_01.jpg
追加しています  (バイナリ)  vlmagazine/images/YYYYMMDD_02.png
……

などとなれば OK。http://trac.vinelinux.org/browser/projects/web/trunk/vlmagazine を確認してください。

リポジトリに格納されても、公開日までは  http://vinelinux.org/vlmagazine/ の「記事一覧」には現れませんが、http://vinelinux.org/vlmagazine/your-yyyymmd.html で確認できます。ミスを発見したら、速攻修正、再 commit。

後始末

作業が終わったら ~/vlmag/trunk は手続きなしに根こそぎ捨ててしまって OK。

捨てた後で修正の必要が発生した場合は、また(どこでも好きなところに)ディレクトリを用意して

 $ svn co http://trac.vinelinux.org/repos/projects/web/trunk

して「コピー・修正・マージ」を行います。