物理のかぎしっぽ 物理のかぎ記事チュートリアル

物理のかぎ記事チュートリアル

かぎマニュアルズ > 記事制作方法 >

これは,rst2hooktail を利用して 物理のかぎしっぽ の記事を書くためのチュートリアル(指導書)です.

序文

このチュートリアルではrst2hooktailを使った記事制作の,一連の流れを説明します. rst2hooktail(あーるえすてぃー・とぅー・ふっくている)とは, 物理のかぎしっぽ スタイルの記事を, だれでも簡単に制作するために開発されたツールです.

一般に,ホームページのページを制作する,というのは少々大変です. 大変と言っても,ごく簡単なものなら簡単なのですが,人のスタイルに合わせる,というのは大変です. さらに数式を入れようものなら,それはもう繁雑な作業です.

しかし,私たちにはrst2hooktailがついています. 少しのルールとrst2hooktailを用いることで,美しい数式を含み, 統一されたスタイルのHTML文書およびPDF文書を,簡単に制作するができます. このチュートリアルによって, 物理解説記事の素敵なアイディアを持ったプロジェクトメンバーが, 滞りなく記事を作成できることを願います.

さあはじめましょう

最初にすることは,rst2hooktailの威力を体験することです.まず,サンプルソース

をお手元のパソコンに保存してください.中身もちょっと見てみてくださいね. そして,ツールを実行することができる rst2hooktail のページに移動してください (Shiftキーを押しながらクリックすると,新しいウィンドウで開くことができます. タブブラウザをお使いの方は,マウスホイールをクリックするか Ctrlキーを押しながらクリックすると,新しいタブで開くことができます).

screen1.png

rst2hooktail のページ上方にある「参照...」ボタンを押して, 今ダウンロードしたソースを選び,「CONVERT」ボタンを押してみてください.さあどうぞ.

どうですか.やってみましたか. HTMLへのリンクと,PDFへのリンクが表示されているはずです.

screen0.png

HTMLの方をクリックすると, 物理のかぎしっぽ で見慣れた スタイルのページが表示されたと思います.

screen2.png

PDFの方をクリックすると,PDFファイルが出来上がっていることも確認できます.

screen3.png

すばらしい! これは,実は大変なことなのです. 同様の出力をrst2hooktailを用いずに得ようとすると, HTMLだけでも数ステップ掛かります. パソコンへ各種ソフトウェアをインストールするという手間もついてきます. 手作業ではちょっとばかし時間が掛かり大変なのです. そんな繁雑な作業を,rst2hooktailはたった1つのステップで行ってくれる, エクセレントなツールなのです!! 同じソースからPDFファイルも同時に生成されることも,大きな特徴です.

では,つぎのセクションから,順々に記事ソースの書き方を紹介して行きます.

テキストエディタを用意してください

ここから,サンプルの記事ソースをステップごとに分け, その構造を学びながら1つの記事として完成させることにします. あなたの手元には,最低限テキストエディタが必要です. たとえば,Windowsをお使いならば「メモ帳」を起動するなどしてください.

ただ,メモ帳では扱える文字コードが少ないので, xyzzyTeraPad などの 高機能なテキストエディタ(いずれもWindows用フリーソフトウェア) をインストールして利用されることをお勧めします ;)

文書の骨組みをつくります

では,これからサンプルソースファイル(filesample.txt)の構造みながら, 実際に同じソースを書いて行くことで記事制作の方法を説明したいと思います. まずは,文書の骨組みをつくって行きます.

記事ソースに必ず必要なのは「章立て」と「著者名などの記事情報」です. 具体的には,つぎの部分です.

============================================================
運動方程式1
============================================================


運動方程式のある生活
====================


運動の法則
==========


運動方程式の表現
================

質量(慣性質量)
---------------

加速度
------

力
----

ニュートンの表現
----------------


運動方程式の限界
================


あとがき
========


@@author: 崎間@@
@@accept: 2005-04-14@@
@@category: 力学@@

この状態でHTMLに変換すると,つぎの画面になります.

t1.png

これだけで骨組みはできましたね!上のソースで見出しっぽく書いた部分が, rst2hooktailでコンバートすると実際に見出しに変換されています.

章立て

物理のかぎプロジェクトでは,記事ソースの書式に reStructuredText という方式を採用しています. reStructuredTextでは,上のように見出しとなる文字列に アンダーライン・オーバーラインを付けることで, 文書に構造情報を与えることができるのです.

→ 章立てについて詳しくは reStructuredTextリファレンス#章立て をご覧ください.

著者名などの記事情報

また,最後の3行目には,

@@author: 崎間@@
@@accept: 2005-04-14@@
@@category: 力学@@

という部分があります.これは当プロジェクト用に追加している命令です.

@@author: @@ の部分には著者名を, つまりあなたのハンドルネームを書いてください.

@@accept: @@ には,査読を通過して正式公開された日付が挿入されます. これは公開されるときに直されますので,とりあえず記事を書いているときには

@@accept: 執筆中@@

などとでも書いておいてください.

@@category: @@ は,物理のかぎしっぽで 分類されている記事カテゴリ情報を記入します. どんなカテゴリがあるかは,記事カテゴリ一覧 にまとめられています. そこにあるものから選んで日本語のカテゴリ名を書いてください.

→ @@命令について詳しくは reStructuredText拡張機能#@@命令 をご覧ください.

本文を書きます

文書の骨組みができたら,内容を追加して行きます. まずはリード文(最初のセクションの前にある文)を書いてみましょう (ここからは,記事ソース中の関連のある部分だけ抜粋して示します).

============================================================
運動方程式1
============================================================

力学,いえ物理学全体の要(かなめ)となる法則,
それがニュートンの運動方程式です.
なぜそのように重要な方程式が存在しているのか,
根本的な理由は誰にも分かりません.
物理学は実験科学ですから,実験によって検証されたもの,
それが物理法則となります.
運動方程式は,数々の実験や考察を乗り越え,
今なお要として存在し続ける重要な法則です.
このページではほんの触りだけ,運動方程式というものについて書きます.

運動方程式のある生活
====================

これをコンバートすると

t2.png

となります.記事ソース中の改行は, 変換後にはなくなっていることに注意してください. このように,連続しない改行はなかったこととして扱われます.

数式を書きます

つづいて,数式も加えてみましょう.

運動方程式の表現
================

現在の言葉で運動方程式を表現すれば

- 質量 $m$ の物体が,力 $\bm{F}$ を受けるとき,
  その物体には受けた力に比例した加速度 $\bm{a}$ が生じる

となります.これを定式化,つまり式で表したものが
<tex>
 m\bm{a}=\bm{F} \tag{1}
</tex>
です.式(1)が,今日「運動方程式」と呼ばれている法則です.
えむえー・いこーる・えふ.
ここで, $\bm{a}$ と $\bm{F}$ が太字になっています.
これら太字で書いた量は「ベクトルである」
ということを明示しています.

これをHTMLに変換すると下のものになります.

m1.png

記事ソースの一部分が,数式画像として変換されていることが分かりますね. 数式はLaTeXの命令で記述します.$ と $ で括られた

$\bm{F}$

などは文中に挿入される数式として,<tex> と </tex> で括られた

<tex>
 m\bm{a}=\bm{F} \tag{1}
</tex>

は独立した行の数式として,それぞれPNG画像に変換され HTMLに組み込まれます.<tex> と </tex> で括るものは, LaTeXの \begin{align*} と \end{align} に相当します.

→ 数式について詳しくは reStructuredText拡張機能#TeX数式描画 をご覧ください.

数式を書くときの注意点

いくつか注意点があります.必ず守ってください(守らなければエラーになります).

  1. $〜$ の前後には半角スペースが必要です.特に句読点のあとでは忘れやすいので注意してください.
  2. 数式の中で2バイト文字や日本語をつかうことはできません.これは TeX の仕様ではなく rst2hooktail の仕様です.
  3. <tex> 〜 </tex> 中には改行を入れることができますが,$〜$ の中に改行をいれることはできません.

図を挿入します

直感的理解には,図が大変役立ちます. できることなら,要所々々には図を挿入しておくと良いです. 記事に図を挿入するには,

  1. 画像ファイルをサーバにアップ
  2. 図を入れたい場所のソースに命令を記述

という手順で行います. filesakima-equationOfMotion-01.png という画像ファイルを, これまで書いてきた記事中に挿入してみましょう.

まずは,rst2hooktail のページにある「画像アップローダ」から, 用意した画像ファイルをサーバへ送ります (画像を用意するのは結構大変ですが,そこはなんとか頑張ってください!).

そして,図を入れたい部分に

.. image:: sakima-equationOfMotion-01.png

という命令を書きます.つぎの例をみてください.

<tex>
 m\bm{a}=\bm{F} \tag{1}
</tex>
です.式(1)が,今日「運動方程式」と呼ばれている法則です.
えむえー・いこーる・えふ.
ここで, $\bm{a}$ と $\bm{F}$ が太字になっています.
これら太字で書いた量は「ベクトルである」
ということを明示しています.

.. image:: sakima-equationOfMotion-01.png

ご覧の通り,運動方程式は質量と加速度と力を結ぶ関係式です.

このように命令を追加した記事ソースをHTMLに変換すると,以下のようになります.

i2.png

画像を入れる命令を記述した部分に,実際に画像が挿入されましたね. 別の画像を挿入したい場合,

.. image:: fig2.png

などのように,.. image:: に続く部分を変更します.

→ 画像の挿入について詳しくは reStructuredTextリファレンス#画像 をご覧ください.

画像を挿入する際の注意

.. image::

命令の前後は必ず空白行でなければならないので,注意してください.

画像をアップロードする際の注意

図を挿入するには,まず画像をサーバにアップロードしなきゃいけない訳ですが, 一つ注意が必要です.それは

  • 同じファイル名の画像は上書きされる

という点です.ですから,他の人とは違うファイル名をつけなければなりません.そこで,自分の名前(ハンドル名)を付ける約束にしましょう.たとえば

sakima-rotatematrix-fig1.png

のように

名前-記事名-番号.拡張子

という規則で名付けておけば,自分でも混乱してくてすむでしょう. 逆に,図を修正して上書きしたい場合は,同じファイル名でアップすればよろしいです.

参考文献を書きます

記事を作成するときには文献を参考にしたり、文献から引用したりするでしょう。 また、インターネット上のウェブページを参考にすることもあるでしょう。 このように何かを参考にして記事を書いた場合、「参考文献」として載せましょう。

参考文献の書き方にはいくつか種類があります。 いずれも次のようなタグを 記事の最後 に埋め込んでおきます。

ウェブページを参考にした場合 (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の探し方

ISBN(International Standard Book Number)とは,書籍の裏などに書かれている10桁の書籍番号のことです.ISBN は国際的な規格ですので,これが分かれば世界中から一つの本を特定することができます.

ISBNの探し方ですが,書籍を持っている場合は本の裏のほうをみましょう.書いてあると思います.手元に書籍がない場合 amazon などで書籍名や著者名で検索をかけてください.

ISBNはハイフン(-)で区切ってある場合がありますが,記事ソースの参考文献に記述する場合,ハイフンを取り除いて数字のみ記述してください.

amazon の検索結果の下のほうに、書籍の詳細が載っています。そこに ISBN も載っています。図を参考にして探してみてください。 :)

amazon_isbn.png

まとめ

このチュートリアルでは,物理のかぎプロジェクトで記事を書き上げる基本的な流れを説明しました. LaTeXの数式を覚えるのに少し手こずるかもしれませんが, 基本的にはテキストファイルに文章を書いて,rst2hooktailでコンバートすれば良いだけです. 記事を書いていて分からないことがあったら, 遠慮せず 技術的質問,FAQ やMLでメンバーに質問してみましょう!

 
 

かぎマニュアルズ > 記事制作方法 >


添付ファイル: filescreen1.png 417件 [詳細] filescreen2.png 426件 [詳細] filescreen3.png 408件 [詳細] filesample.txt 1179件 [詳細] filesakima-equationOfMotion-01.png 756件 [詳細] filem1.png 460件 [詳細] filescreen0.png 408件 [詳細] filet2.png 387件 [詳細] filet1.png 399件 [詳細] fileamazon_isbn.png 442件 [詳細] filei2.png 447件 [詳細]
トップ   編集 凍結 差分 バックアップ 添付 複製 名前変更 リロード   新規 一覧 単語検索 最終更新   ヘルプ   最終更新のRSS
Modified by 物理のかぎプロジェクト PukiWiki 1.4.6 Copyright © 2001-2005 PukiWiki Developers Team. License is GPL.
Based on "PukiWiki" 1.3 by yu-ji Powered by PHP 5.2.17 HTML convert time to 0.201 sec.