LDP Author Guide

Mark F. Komarinski

VA Linux Systems

markk@linuxdoc.org

Jorge Godoy

Conectiva S.A.
Publishing Department

godoy@conectiva.com

godoy@metalab.unc.edu

David C. Merrill

dcmerrill@mindspring.com

Revision History
Revision 3.5	Dec 4, 2000	Revised by: mfk
Changed mailing list pointers to new lists.
Revision 3.4	Dec 1, 2000	Revised by: dcm
Added Crediting Translators and Converters
Revision 3.3	Nov 11, 2000	Revised by: mfk
Added links to SGML GPL and FDL
Revision 3.1	Oct 10, 2000	Revised by: mfk
Spelling changes, changed list of LDP policies to now accept DocBook XML. More information about how to use *jade with XML will follow.
Revision 3.0	Aug 24, 2000	Revised by: gjf
Integrated David Merrill's style guide document. Further clean-up and additions.
Revision 2.0	Jul 13, 2000	Revised by: mfk
Cleaned up using-docbook a bit. Moved some chapters
Revision 1.9	Jun 26, 2000	Revised by: mfk
Integrated Jorge's using-docbook document.
Revision 1.5	Jun 14, 2000	Revised by: mfk
Documented sgedit
Revision 1.4	Jun 12, 2000	Revised by: mfk
Documented vim and sgedit. Spelling and other changes from ldp list. Also added LDP guidelines under style guide.

LDP 文書の作成者が快適に文書を作成するためのツールや手順、およびヒントを、リストアップしました。

Table of Contents

1. この文書について

1.1. この文書の目的と射程

1.2. LDP について

1.3. フィードバック

1.4. 著作権と商標

1.4.1. 日本語訳について

1.5. 謝辞

1.6. この文書の表記法

2. LDP と SGML の紹介

2.1. LDP
2.2. SGML
2.3. なぜ HTML でなく、SGML なのか？
2.4. SGML は XML じゃない
2.5. 初めて寄稿する方へ
2.6. メーリングリスト

3. 文書作成ツール

3.1. DSSSL

3.1.1. Norman Walsh DSSSL
3.1.2. LDP DSSSL

3.2. DocBook DTD (version 4.1 か 3.1)

3.3. Jade

3.3.1. Jade

3.3.1.1. Jade を使う
3.3.1.2. XML モードの Jade

3.3.2. OpenJade

3.4. Jade wrappers

3.4.1. sgmltools-lite

3.4.2. Cygnus DocBook Tools

3.4.2.1. Cygnus Tools の使い方

3.5. 編集ツール

3.5.1. Emacs (PSGML)

3.5.1.1. PSGML を使って SGML を書く方法

3.5.2. VIM

3.5.2.1. はじめに
3.5.2.2. 新規文書のロードもしくは作成

3.5.3. WordPerfect 9 (Corel Office 2000)

3.5.4. sgedit

3.5.5. nedit

3.5.5.1. nedit の使い方
3.5.5.2. nedit の Tips とコツ

3.6. CVS

3.6.1. CVS アカウントの入手

3.6.2. それ以外の CVS リポジトリへのアクセス方法

3.6.2.1. 匿名 CVS アクセス
3.6.2.2. Web 経由での CVS ファイル
3.6.2.3. グラフィカルインターフェイスを使う

3.6.3. ファイルの更新と CVS

3.7. その他のツールとリファレンス

3.7.1. DocBook: The Definitive Guide
3.7.2. SGML テンプレート
3.7.3. Aspell
3.7.4. ispell

4. DocBook タグの使い方

4.1. はじめに

4.2. 必要な設定

4.3. カタログの作成と修正

4.3.1. 用語の説明
4.3.2. カタログ上での便利なコマンド

4.4. DocBook エレメントの使い方

4.4.1. 便利なコマンド

4.5. 索引をつくる

4.6. 画像の挿入

4.6.1. 上記以外の方法

4.7. 表組

4.8. プログラムコードとコメント

4.9. 翻訳者やコード変換者の氏名を表示する

4.9.1. <othercredit> タグ
4.9.2. "謝辞" (Acknowledgements) の章について
4.9.3. <revremark> タグ

4.10. ツールとヒント

4.10.1. ソースのコンパイル
4.10.2. article の最初のページに要旨を挿入する
4.10.3. 索引を自動的に挿入する
4.10.4. 文書の中の下書き部分を隠す
4.10.5. 頻繁に利用する文書を外部から取り込む

4.11. 文書のサンプル

4.11.1. article の例
4.11.2. book の例

5. LDP スタイル・ガイド

5.1. 主題を決める
5.2. アウトラインを作成する
5.3. 文章を書く
5.4. テキストの推敲と校正
5.5. 作成した HOWTO の管理
5.6. リファレンス

6. スタイル関連事項の補足

6.1. 日付の書き方
6.2. 画像フォーマット
6.3. DocBook のバージョン
6.4. 利用禁止のタグ
6.5. タグの最小化
6.6. 文書内での表記法

7. DocBook のテクニックとコツ

7.1. 画像の挿入
7.2. HTML 出力ファイルのファイル名を指定する
7.3. ldp.dsl を使う

8. 文書の公開について

8.1. 文書公開のまえに

8.1.1. SGML コードの妥当性検査

8.2. 著作権とライセンスの問題

8.3. LDP への寄稿

8.4. 作成した文書の管理

9. LDP についての FAQ

List of Tables
4-1. 便利なコマンド
4-2. 表の例

List of Figures
3-1. sgedit のスクリーンショット
3-2. nedit のスクリーンショット
3-3. nedit へのシェルコマンドの追加
3-4. エラーがない場合の nsgml の出力

List of Examples
4-1. カタログの例
4-2. 索引生成のためのコード
4-3. 属性 zone の使い方
4-4. 属性 class で、値 startofrange と endofrange を使う方法
4-5. 画像の挿入
4-6. <imageobject>の使い方
4-7. 表の挿入
4-8. compiles-sgml スクリプト
4-9. article で、自動的に要旨を挿入するための stylesheet の設定
4-10. 索引を付けるために外部エンティティを設定する
4-11. パラメータ・エンティティを使う

		Next
		この文書について