- 追加された行はこの色です。
- 削除された行はこの色です。
* 物理のかぎ記事チュートリアル [#m2da422b]
[[かぎマニュアルズ]] > [[記事制作方法>かぎマニュアルズ#wbdd8eaa]] >
これは,[[rst2hooktail]] を利用して [[物理のかぎしっぽ:http://www12.plala.or.jp/ksp/]]
の記事を書くためのチュートリアル(指導書)です.
#contents
* 序文 [#defc622a]
このチュートリアルではrst2hooktailを使った記事制作の,一連の流れを説明します.
rst2hooktail(あーるえすてぃー・とぅー・ふっくている)とは,
[[物理のかぎしっぽ:http://hooktail.maxwell.jp/rst2hooktail/index.html]] スタイルの記事を,
だれでも簡単に制作するために開発されたツールです.
一般に,ホームページのページを制作する,というのは少々大変です.
大変と言っても,ごく簡単なものなら簡単なのですが,人のスタイルに合わせる,というのは大変です.
さらに数式を入れようものなら,それはもう繁雑な作業です.
しかし,私たちにはrst2hooktailがついています.
少しのルールとrst2hooktailを用いることで,美しい数式を含み,
統一されたスタイルのHTML文書およびPDF文書を,簡単に制作するができます.
このチュートリアルは,ホームページ制作に関してゼロからの知識で,
[[物理のかぎしっぽ:http://www12.plala.or.jp/ksp/]] スタイル
の記事を制作できるようにするものです.
物理解説記事の素敵なアイディアを持ったプロジェクトメンバーが,
滞りなく記事を作成できることを願っております.
* さあはじめましょう [#a727931d]
最初にすることは,rst2hooktailの威力を体験することです.まず,サンプルソース
#ref(sample.txt)
をお手元のパソコンに保存してください.中身もちょっと見てみてくださいね.
そして,ツールを実行することができる [[rst2hooktail]] のページに移動してください
(Shiftキーを押しながらクリックすると,新しいウィンドウで開くことができます.
タブブラウザをお使いの方は,マウスホイールをクリックするか
Ctrlキーを押しながらクリックすると,新しいタブで開くことができます).
#ref(screen1.png,nolink)
[[rst2hooktail]] のページ上方にある「参照...」ボタンを押して,
今ダウンロードしたソースを選び,「CONVERT」ボタンを押してみてください.さあどうぞ.
どうですか.やってみましたか.
HTMLへのリンクと,PDFへのリンクが表示されているはずです.
#ref(screen0.png,nolink)
HTMLの方をクリックすると,
[[物理のかぎしっぽ>http://www12.plala.or.jp/ksp/]] で見慣れた
スタイルのページが表示されたと思います.
#ref(screen2.png,nolink)
PDFの方をクリックすると,PDFファイルが出来上がっていることも確認できます.
#ref(screen3.png,nolink)
すばらしい! これは,実は大変なことなのです.
同様の出力をrst2hooktailを用いずに得ようとすると,
HTMLだけでも数ステップ掛かります.
パソコンへ各種ソフトウェアをインストールするという手間もついてきます.
手作業ではちょっとばかし時間が掛かり大変なのです.
そんな繁雑な作業を,rst2hooktailはたった1つのステップで行ってくれる,
エクセレントなツールなのです!!
同じソースからPDFファイルも同時に生成されることも,大きな特徴です.
では,つぎのセクションから,順々に記事ソースの書き方を紹介して行きます.
* テキストエディタを用意してください [#z0590dae]
ここから,サンプルの記事ソースをステップごとに分け,
その構造を学びながら1つの記事として完成させることにします.
あなたの手元には,最低限テキストエディタが必要です.
たとえば,Windowsをお使いならば「メモ帳」を起動するなどしてください.
ただ,メモ帳では扱える文字コードが少ないので,
[[xyzzy:http://www.jsdlab.co.jp/~kamei/]] や
[[TeraPad:http://www5f.biglobe.ne.jp/~t-susumu/library/tpad.html]] などの
高機能なテキストエディタ(いずれもWindows用フリーソフトウェア)
をインストールして利用されることをお勧めします ;)
* 文書の骨組みをつくります [#v3b105b5]
では,これからサンプルソースファイル(&ref{sample.txt};)の構造みながら,
実際に同じソースを書いて行くことで記事制作の方法を説明したいと思います.
まずは,文書の骨組みをつくって行きます.
記事ソースに必ず必要なのは「章立て」と「著者名などの記事情報」です.
具体的には,つぎの部分です.
============================================================
運動方程式1
============================================================
運動方程式のある生活
====================
運動の法則
==========
運動方程式の表現
================
質量(慣性質量)
---------------
加速度
------
力
----
ニュートンの表現
----------------
運動方程式の限界
================
あとがき
========
@@author: 崎間@@
@@accept: 2005-04-14@@
@@category: 力学@@
この状態でHTMLに変換すると,つぎの画面になります.
#ref(t1.png,nolink)
これだけで骨組みはできましたね!上のソースで見出しっぽく書いた部分が,
rst2hooktailでコンバートすると実際に見出しに変換されています.
** 章立て [#a363f50a]
物理のかぎプロジェクトでは,記事ソースの書式に
[[reStructuredText>reStructuredTextとは]] という方式を採用しています.
reStructuredTextでは,上のように見出しとなる文字列に
アンダーライン・オーバーラインを付けることで,
文書に構造情報を与えることができるのです.
詳しいことは
[[reStructuredTextリファレンス#章立て>reStructuredTextリファレンス#mdb2d67d]]
→ 章立てについて詳しくは
[[reStructuredTextリファレンス#章立て>reStructuredTextリファレンス#mdb2d67d]]
をご覧ください.
** 著者名などの記事情報 [#f85a7280]
また,最後の3行目には,
@@author: 崎間@@
@@accept: 2005-04-14@@
@@category: 力学@@
という部分があります.これは当プロジェクト用に追加している命令です.
&color(#090){@@author: @@}; の部分には著者名を,
つまりあなたのハンドルネームを書いてください.
&color(#090){@@accept: @@}; には,査読を通過して正式公開された日付が挿入されます.
これは公開されるときに直されますので,とりあえず記事を書いているときには
@@accept: 執筆中@@
などとでも書いておいてください.
&color(#090){@@category: @@}; は,物理のかぎしっぽで
分類されている記事カテゴリ情報を記入します.
どんなカテゴリがあるかは,[[記事カテゴリ一覧]] にまとめられています.
そこにあるものから選んで日本語のカテゴリ名を書いてください.
→ @@命令について詳しくは [[reStructuredText拡張機能#@@命令>reStructuredText拡張機能#h8a78aac]] をご覧ください.
* 本文を書きます [#u69c04ea]
文書の骨組みができたら,内容を追加して行きます.
まずはリード文(最初のセクションの前にある文)を書いてみましょう
(ここからは,記事ソース中の関連のある部分だけ抜粋して示します).
============================================================
運動方程式1
============================================================
力学,いえ物理学全体の要(かなめ)となる法則,
それがニュートンの運動方程式です.
なぜそのように重要な方程式が存在しているのか,
根本的な理由は誰にも分かりません.
物理学は実験科学ですから,実験によって検証されたもの,
それが物理法則となります.
運動方程式は,数々の実験や考察を乗り越え,
今なお要として存在し続ける重要な法則です.
このページではほんの触りだけ,運動方程式というものについて書きます.
運動方程式のある生活
====================
これをコンバートすると
#ref(t2.png,nolink)
となります.記事ソース中の改行は,
変換後にはなくなっていることに注意してください.
このように,連続しない改行はなかったこととして扱われます.
* 数式を書きます [#qed80d39]
つづいて,数式も加えてみましょう.
運動方程式の表現
================
現在の言葉で運動方程式を表現すれば
- 質量 $m$ の物体が,力 $\bm{F}$ を受けるとき,
その物体には受けた力に比例した加速度 $\bm{a}$ が生じる
となります.これを定式化,つまり式で表したものが
<tex>
m\bm{a}=\bm{F} \tag{1}
</tex>
です.式(1)が,今日「運動方程式」と呼ばれている法則です.
えむえー・いこーる・えふ.
ここで, $\bm{a}$ と $\bm{F}$ が太字になっています.
これら太字で書いた量は「 ベクトル である」
ということを明示しています.
これをHTMLに変換すると下のものになります.
#ref(m1.png,nolink)
記事ソースの一部分が,数式画像として変換されていることが分かりますね.
数式はLaTeXの命令で記述します.$ と $ で括られた
$\bm{F}$
などは文中に挿入される数式として,
などは文中に挿入される数式として,<tex> と </tex> で括られた
<tex>
m\bm{a}=\bm{F} \tag{1}
</tex>
は独立した行の数式として,それぞれPNG画像に変換されHTMLに組み込まれます.
<tex> と </tex> で括るものは,LaTeXの \begin{align*} と \end{align} に相当します.
数式を用いずに物理の話をする,という行為は極めて困難でしょう.物理では,数学は話を簡単にするために,道具として組み込まれています.その大切な道具を手放す訳にはいきません.しかし,数式をノートに鉛筆で書くのは(物理的に)簡単ですが,コンピュータを使って書くのは大変ですよね.Wordで数式を書くのに四苦八苦された方も多いでしょう :(
→ 数式について詳しくは [[reStructuredText拡張機能#TeX数式描画>reStructuredText拡張機能#g8c0c9c3]] をご覧ください.
それを解決する究極的手段は,TeXというツールを用いることです.
しかしTeXで文章や数式を書くためには,それを使える環境を整備しなければなりません.ホームページの記事をちょっと書きたいだけなのに,数式用のソフトをインストールしたり設定をしなければならないなんて,そんなの面倒でナンセンスですよね(もちろん,長期的にみればいいことですよ).
// TeXはまたTeXで,いろいろと覚えることがありますし,
でも大丈夫,心配はいりません.私たちには rst2hooktail がついているんだから ;) rst2hooktailにはTeXの数式処理が組み込まれているのです.
それでは,rst2hooktail での数式の書き方を説明しましょう.
** 文中の数式 [#v896321d]
文中に数式を書く場合,
運動方程式は $ma=F$ と書かれる.ここで $m$ は物体の質量である.
のように数式部分を $ と $ で括ります.括られた部分は数式であると処理されることになっています.
$〜$ の前後には半角スペースをあけることが必要です、気をつけて!
** 独立行の数式 [#a2e18554]
独立した数式は
<tex>
ma=F
</tex>
と <tex> と </tex> で括って表記します.
***式番号 [#cb107dfa]
数式の後ろに (1) などの番号を付けたい場合
<tex>
ma=F \tag{1}
</tex>
のように
\tag{番号}
を記述します.「\tag{ }」の中身は「*」などの記号を用いることもできます.
***複数行の数式 [#q218b53c]
複数行に渡る数式の場合は
<tex>
0.5 &= \alpha e^{-\gamma \cdot 0}\\
&= \alpha e^{0}\\
&= \alpha \cdot 1
</tex>
のように,位置合わせをしたい部分に
&
を,改行したい部分に
\\
を記述します.これら「&」と「\\」は数式としては表示されません.この例では数式が3行に渡り,「=」の部分で揃えられることになります.
***ベクトル表記 [#y105faf9]
ベクトルは 太字 + 斜体 で表します.これは
\bm{a}
などとして記述します.この例では「a」が 太字 + 斜体 になります.
** 数式を書くときの注意点 [#o440dbf9]
いくつか注意点があります.必ず守ってください(守らなければエラーになります).
+ $〜$ の前後には半角スペースが必要です.特に句読点のあとでは忘れやすいので注意してください.
+ 数式の中で2バイト文字や日本語をつかうことはできません.これは TeX の仕様ではなく rst2hooktail の仕様です.
+ <tex> 〜 </tex> 中には改行を入れることができますが,$〜$ の中に改行をいれることはできません.
これらを守れば、あなたの記事にも美しい数式を入れることができます :)
* 図を挿入します [#xad18895]
* 図を挿入しましょう [#xad18895]
直感的理解には,図が大変役立ちます.できることなら,要所々々には図を挿入しておくと良いですね.
rst2hooktail で図を入れる場合,
+ 画像ファイルをサーバにアップ
+ 図を入れたい場所のソースに命令を記述
という手順で行います.例えば fig1.png という画像を入れるには,rst2hooktail のページで fig1.png をアップしておき,記事ソースの図を入れたい箇所に,
.. image:: fig1.png
という記述をします.
.. image::
というのが,図を入れるための命令です.その後ろに,挿入したい画像のファイル名を書いておきます.これで記事に図が入り,言葉ではやりにくい説明が可能になります.
**画像をアップする際の注意点 [#gcc42f55]
図を挿入するには,まず画像をサーバにアップロードしなきゃいけない訳ですが,一つ注意が必要です.それは
-同じファイル名の画像は上書きされる
という点です.ですから,他の人とは違うファイル名をつけなければなりません.そこで,自分の名前(ハンドル名)を付ける約束にしましょう.たとえば
sakima-rotatematrix-fig1.png
のように
名前-記事名-番号.拡張子
という規則で名付けておけば,自分でも混乱してくてすむでしょう.
逆に,図を修正して上書きしたい場合は,同じファイル名でアップすればよろしいです.
* 参考文献を書こう [#q36bd57c]
記事を作成するときには文献を参考にしたり、文献から引用したりするでしょう。
また、インターネット上のウェブページを参考にすることもあるでしょう。
このように何かを参考にして記事を書いた場合、「参考文献」として載せましょう。
参考文献の書き方にはいくつか種類があります。
いずれも次のようなタグを ''記事の最後'' に埋め込んでおきます。
''ウェブページを参考にした場合 (URLのみ)''
@@reference: www12.plala.or.jp/ksp/index.html@@
( http:// はつけないことに注意してください )
''ウェブページを参考にした場合 (URL,タイトル)''
@@reference: www12.plala.or.jp/ksp/index.html,物理のかぎしっぽ@@
( http:// はつけないことに注意してください )
''書籍(文献)を参考にした場合( 著者, 題名, 出版社, 出版年, ページ)''
@@reference: 山田太郎, 楽しい物理, かぎ出版, 2004, 190-220@@
''書籍(文献)を参考にした場合( 著者, 題名, 出版社, 出版年, ページ, ISBN)''
@@reference: 山田太郎, 楽しい物理, かぎ出版, 2004, 190-220, 2819393448@@
※ ISBN コードを書くと、amazon.co.jp にリンクがはられます。
それぞれのフィールドを区切るカンマは半角であることに注意してください。
フィールドを空にする場合でも、カンマは必ず打ってください。
** 捕捉:ISBNの探し方 [#ib3f160b]
ISBN(International Standard Book Number)とは,書籍の裏などに書かれている10桁の書籍番号のことです.ISBN は国際的な規格ですので,これが分かれば世界中から一つの本を特定することができます.
ISBNの探し方ですが,書籍を持っている場合は本の裏のほうをみましょう.書いてあると思います.手元に書籍がない場合 [[amazon:http://www.amazon.co.jp/]] などで書籍名や著者名で検索をかけてください.
ISBNはハイフン(-)で区切ってある場合がありますが,記事ソースの参考文献に記述する場合,ハイフンを取り除いて数字のみ記述してください.
[[amazon:http://www.amazon.co.jp]] の検索結果の下のほうに、書籍の詳細が載っています。そこに ISBN も載っています。図を参考にして探してみてください。 :)
#ref(http://www12.plala.or.jp/ksp/img/amazon_isbn.png)
* 署名をしよう [#u8be7ae0]
作成した記事には自分がつくったという署名をいれたいですよね。
また、いつ作ったのかも記録しておくと便利です。
そんなときは次のような行を ''記事の最後'' に埋め込んでおきます。
@@author: 著者名@@
@@accept: YYYY-MM-DD@@
こうしておくと、記事のフッタ部分に著者名と初版日が挿入されます。
更新日は自動で記録されます。
例を示しておきましょう。
@@author: 山田 太郎@@
@@accept: 2004-01-01@@
作成した記事には、ぜひ署名をしてくださいね。
[[かぎマニュアルズ]] > [[記事制作方法>かぎマニュアルズ#wbdd8eaa]] >
//数式を用いずに物理の話をする,という行為は極めて困難でしょう.物理では,数学は話を簡単にするために,道具として組み込まれています.その大切な道具を手放す訳にはいきません.しかし,数式をノートに鉛筆で書くのは(物理的に)簡単ですが,コンピュータを使って書くのは大変ですよね.Wordで数式を書くのに四苦八苦された方も多いでしょう :(
//それを解決する究極的手段は,TeXというツールを用いることです.
//しかしTeXで文章や数式を書くためには,それを使える環境を整備しなければなりません.ホームページの記事をちょっと書きたいだけなのに,数式用のソフトをインストールしたり設定をしなければならないなんて,そんなの面倒でナンセンスですよね(もちろん,長期的にみればいいことですよ).
//でも大丈夫,心配はいりません.私たちには rst2hooktail がついているんだから ;) rst2hooktailにはTeXの数式処理が組み込まれているのです.