レビューメディア「ジグソー」

かなりお気に入りのドキュメントツールです^-^

みなさんは Sphinx ご存知でしょうか。

図1:何の模様?
図1:何の模様?


いえ、私もつい最近しったドキュメントツールなんですけどね。
かなりお気に入りなので、もちものとして登録させていただきました。
また、できれば長期に更新できるもちものを登録してみたいとも考え、今回このツールをzigsowに登録することにしてみました。

ちなみに冒頭の図は、下記サイトで紹介している図で、まるでエジプトのファラオのような目つきをしている印象をうけます(あるいみ怖いですが)Sphinxという名前からエジプトっぽい絵柄になっている様子です。

Sphinx - Python Documentation Generator -
http://sphinx.pocoo.org/

Sphinx でできることを一行でいうと

テキストエディタで編集した記事を 様々な形式(例えば HTML形式)に出力しなおしてくれる
 (→次項 図2と図3を参照のこと)

ということです。また、英語文書だとほぼ問題なく、PDF形式への出力も可能なツールになっています。しかしながら、日本語文書だと、PDF形式の出力が上手くできない場合があります。

日本語文章のPDF化に関しては今後のアップデートや、使用ユーザーの方々の技で今後に期待するということにして、現在私としては、仕事において作成した文章の

 テキスト文章 → HTML形式への出力

という文書整理ツールとして使用しています。今回、このもちものレビューに関しては、インストールに関する記述であったり、実際にテキスト文章を編集する際に使用したSphinxの構文(ディレクティブ)について記載していこうと考えています。

【作成するテキスト文章と出力されるHTML文章】

ようは、図2のようなテキスト文章を、図3の用に出力してくれるということです。

図2:テキスト文章(RSTファイルとして保存)
図2:テキスト文章(RSTファイルとして保存)


図3:出力されるHTMLファイル
図3:出力されるHTMLファイル


左側にリンク付きの目次も作成されます。テキストで作成したメモ書きを、多少手を加えることで綺麗なHTMLファイルに変換できるのは私にとって嬉しい限りで、最近は業務に関する資料をこのツール使ってを作成しています。(無論、その後必要に応じて、MS-Office系のソフト用の文章にしていますが)

【よく使用する参照サイト】

Sphinx - Python Documentation Generator -(日本語訳)
http://sphinx.shibu.jp/

Python製ドキュメンテーションビルダー、Sphinxの日本ユーザ会
http://sphinx-users.jp/

reStructuredText Directives
http://docutils.sourceforge.net/docs/ref/rst/directives.html



****** ****** ****** 以後、適宜更新予定 ****** ****** ******

【Sphinxをインストールしてみよう -Windows PC編- 】

 Sphinxをインストールする大まかな手順を説明します

  ・Python(という、プログラミング言語)をWindowsPCにインストールする
  ・Python上のコマンド「easy_install」をインストールする
  ・easy_installコマンドを使用して、Sphinxをインストールする

詳細な内容は、上述のURL「Sphinxの日本ユーザ会のホームページ」が詳しいのでそちらを参照願います。以下、WindowsPCにインストールした際、設定した箇所の補足メモとして記載しておきます。

 ・ Windows7 環境においてのパスの設定箇所

  
写真4:システム環境変数
写真4:システム環境変数

 
・・・、とおもっていろいろ記事みていたところ、どうやら、Windowsユーザー向けに、スタンドアロンインストーラなるものも存在するようです。以下、記事のURLを転機しておきます。

Windowsへのインストール(スタンドアロンインストール)
 http://sphinx-users.jp/gettingstarted/install_windows_sta...
 
【文章を作成してみよう 】

 Sphinxでは文章を作成する前に、ちょっとした事前準備が必要です。

  ・ sphinx-quickstart の実行
  ・ テキストエディタの準備(任意)
  
sphinx-quickstartを実行し、どこのフォルダに、どのようなバージョン管理をするのか、プロジェクト名、および筆者はだれなのか等、一問一答形式の問いに答えます。

 ※ 都度質問に回答するのが、、、という場合は、一度作成したプロジェクトのフォルダをコピーし名前を変えて使う事も可能です。

また、Windowsのメモ帳だと、少々使い勝手が悪いため、他のテキストエディタを利用した方がいいです。私はMeryというフリーソフトを用いて編集作業をしています。

【 PDFファイル化に関して 】 

 ※ 現時点では満足のいくPDFファイルに仕上がらないため、いい方法が見つかり次第更新する予定

 以下のコマンドを実行することで、PDFファイルを作成することは可能でした。

ebb *.png
platex -kanji=utf8 ”xxxxxx”
dvipdfmx ”xxxxxx”

【 よく使う/新たに使用した ディレクティブ、およびマークアップに関して 】

1) コードブロック

::

 文章

 「図5掲載予定」

2) 箇条書き

 * リスト1
 * リスト2
 * リスト3

 「図6掲載予定」

3)図

 .. image:: testimage.png
:scale: 40%
:height: 100px
:width: 200px
:align: left

4)注釈

 .. note::

文章

 .. warning::

文章

5) 表

.. csv-table:: 表の名前
:header: "項目1", "項目2", "項目3"
:widths: 15, 10, 30
  :header-rows:1

" 値1-1 " 値1-2 "値1-3 "
" 値2-1 " 値2-2 "値2-3 "
" 値3-1 " 値3-2 "値3-3 "


 「図6掲載予定」

6) 見出し

========================
第1章 ○○○○
======================== 

1-1 見出し1
==================

1-1-1 小見出し1
------------------ 

1-1-2 小見出し1
------------------ 

1-2 見出し2
================== 

1-3 見出し3
==================

========================
第2章 ○○○○
========================

7) コメントアウト(HTMLにする際に表示されないようにする)

.. コメントアウトしたいときは、ピリオドを二個頭につけます
  • 購入金額

    0円

  • 購入日

    2012年02月頃

  • 購入場所

14人がこのレビューをCOOLしました!

コメント (2)

  • klein_reviewさん

    2012/03/13

    以前ニワンゴだかドワンゴだかの技術系セミナー?(データベース系の話だったような)の動画を見たときに講師らしき人がこれの話をしていたのを見ました。

    未だによくわかりませんが、文書を扱うのが便利になったりするんでしょうか?
  • ぽんさん

    2012/03/13

    こんにちは^-^

    私も使い始めたばかりなので、はっきりと断言しづらいのですが。。。

    テキストエディタで書いた程度のメモ書きが、簡単にHTML化できる!

    とでもいうのでしょうか。私自身においての具体例あげると、

    乱雑に近かった私のメモ書きが、綺麗なHTMLに早変わりしたのに気分がよくなり、なにかと文章でまとめるような癖がついてきた。

    ということになります。

    下記URL先の一番下に、いろいろ記述があるので、もしよければご一読下さい。
    http://sphinx-users.jp/whatsthis.html

ZIGSOWにログインするとコメントやこのアイテムを持っているユーザー全員に質問できます。

YouTube の動画を挿入

YouTube の URL または動画の ID を入力してください

動画の ID が取得できません。ID もしくは URL を正しく入力してください。

ニコニコ動画の動画を挿入

ニコニコ動画の URL または動画の ID を入力してください

動画の ID が取得できません。ID もしくは URL を正しく入力してください。

ZIGSOWリンク挿入

検索対象とキーワードを入力してください

    外部リンクを挿入

    リンク先の URL とタイトルを入力してください

    URL を正しく入力してください。

    画像を挿入(最大サイズ6MB)

    画像を選択してください

    ファイルサイズが6MBを超えています

    別の画像を追加

    ZIGSOW にログイン

    ZIGSOW会員登録(無料)はこちらから