• R/O
  • HTTP
  • SSH
  • HTTPS

提交

標籤
無標籤

Frequently used words (click to add to your profile)

javac++androidlinuxc#windowsobjective-ccocoa誰得qtpythonphprubygameguibathyscaphec計画中(planning stage)翻訳omegatframeworktwitterdomtestvb.netdirectxゲームエンジンbtronarduinopreviewer

JM 作業用 workspace


Commit MetaInfo

修訂968941e323952d8a164cec7115fed4c00c09b28e (tree)
時間2013-10-20 19:00:04
作者Akihiro MOTOKI <amotoki@gmai...>
CommiterAkihiro MOTOKI

Log Message

Remove guidance and bug_report pages

* guidance pages are moved to sf.jp wiki
* bug_report is no longer used

Change Summary

  • delete: www/bug_report/Makefile
  • delete: www/bug_report/jm-brs.cgi.m4
  • delete: www/bug_report/jm-brs.post.m4
  • delete: www/bug_report/jm-brs.pre.m4
  • delete: www/bug_report/pkgs_list2html.awk
  • delete: www/guidance/.gitignore
  • delete: www/guidance/JM-man-view.m4
  • delete: www/guidance/Makefile
  • delete: www/guidance/commentate.awk
  • delete: www/guidance/index.m4
  • delete: www/guidance/mailformat.m4
  • delete: www/guidance/pod.m4
  • delete: www/guidance/repository.m4
  • delete: www/guidance/translation_note.m4

差異

--- a/www/bug_report/Makefile
+++ /dev/null
@@ -1,27 +0,0 @@
1-# include ../JM.rules
2-
3-.SUFFIXES: .m4 .html
4-
5-.m4.html:
6- m4 -P $*.m4 | nkf -w > $*.html
7-
8-OBJS = jm-brs.html jm-brs.cgi
9-
10-PKGS_LIST = ../../dist/script/pkgs.list
11-
12-default: $(OBJS)
13-
14-clean:
15- @rm -f $(OBJS) *.html
16-
17-jm-brs.html: jm-brs.pre.html jm-brs.post.html $(PKGS_LIST)
18- awk -f pkgs_list2html.awk $(PKGS_LIST) \
19- | cat -s jm-brs.pre.html - jm-brs.post.html \
20- > $@
21-
22-jm-brs.cgi: jm-brs.cgi.m4
23- m4 -P $@.m4 | nkf -w > $@
24-
25-*.html: ../jm_www.m4
26-*.cgi: ../jm_www.m4
27-
--- a/www/bug_report/jm-brs.cgi.m4
+++ /dev/null
@@ -1,61 +0,0 @@
1-#!/usr/bin/perl
2-
3-m4_dnl # jm-bres.cgi.m4: GNU m4 source for jm-brs.cgi
4-m4_dnl # -------------------------------------------------------------------
5-m4_dnl #
6-m4_dnl # [その他に make 時点で依存を参照するファイル]
7-m4_dnl #
8-m4_dnl # -------------------------------------------------------------------
9-m4_dnl
10-m4_dnl # HTML 4.0/css は分からんので、tagging は適当(^^;
11-m4_dnl # jperl じゃなくても大丈夫なように EUC にすること。
12-m4_dnl # 一方、mail は ISO-2022-JP で出す
13-m4_dnl # ↑ よって jcode.pl が必要なはず
14-m4_include(../jm_www.m4)
15-# ====================================================================
16-# DO NOT EDIT THIS FILE. EDIT M4 SOURCE FILE OR M4 INCLUDE FILE.
17-# このファイルは編集しないでください. M4 のソース または include
18-# されているファイルを編集してください.
19-# ====================================================================
20-
21-use CGI;
22-
23-$jm_address = '_EMAIL_ADDRESS';
24-
25-$query = new CGI(\*STDIN);
26-
27-$name = $query->param('name');
28-$mail = $query->param('mail');
29-$package = $query->param('package');
30-$page = $query->param('page');
31-$text = $query->param('text');
32-
33-$output = new CGI;
34-
35-print $output->header(-type=>'text/html; charset=EUC-JP');
36-
37-print '
38-_HEADER(`JM bug reporting system: accepted')
39-
40-';
41-
42-print "
43-あなたのバグ報告は JM プロジェクトへ伝えられました。
44-ありがとううございました。
45-
46-<hr>
47-内容は以下の通りです。
48-
49-<pre>
50-お名前: $name
51-Mail address: $mail
52-パッケージ: $package
53-man ページ: $page
54-バグ内容:
55-</pre>
56-";
57-
58-print $output->blockquote($text);
59-
60-print '_CREDITS';
61-print $output->end_html;
--- a/www/bug_report/jm-brs.post.m4
+++ /dev/null
@@ -1,34 +0,0 @@
1-m4_dnl # jm-brs.post.m4: GNU m4 source for jm-brs.html's last part.
2-m4_dnl # -------------------------------------------------------------------
3-m4_dnl #
4-m4_dnl # [その他に make 時点で依存を参照するファイル]
5-m4_dnl #
6-m4_dnl # -------------------------------------------------------------------
7-m4_dnl
8-m4_dnl # HTML 4.0/css は分からんので、tagging は適当(^^;
9-m4_dnl # jm-brs.pre.m4 と漢字コードを揃えること
10-m4_dnl
11-
12-
13-m4_define(_SUB_ONE)
14-m4_include(../jm_www.m4)
15-
16- </TD>
17- <TH ALIGN="RIGHT" NOWRAP>ページ: </TH>
18- <TD><INPUT NAME="page" SIZE="20"></TD>
19-</TR>
20-<TR>
21- <TH ALIGN="RIGHT" NOWRAP>内容: </TH>
22- <TD COLSPAN="3"><TEXTAREA NAME="text" COLS="70" ROWS="5" WRAP="SOFT"></TEXTAREA></TD>
23-</TR>
24-<TR>
25- <TH></TH>
26- <TD COLSPAN="3"><INPUT TYPE="SUBMIT" VALUE=" 投稿 "> <INPUT TYPE="RESET" VALUE=" リセット "></TD></TR>
27-</TABLE>
28-</FORM>
29-
30-_CREDITS
31-_BACK_TO_HOME
32-
33-</BODY>
34-</HTML>
--- a/www/bug_report/jm-brs.pre.m4
+++ /dev/null
@@ -1,28 +0,0 @@
1-m4_dnl # jm-brs.pre.m4: GNU m4 source for jm-brs.html's first part.
2-m4_dnl # -------------------------------------------------------------------
3-m4_dnl #
4-m4_dnl # [その他に make 時点で依存を参照するファイル]
5-m4_dnl #
6-m4_dnl # -------------------------------------------------------------------
7-m4_dnl
8-m4_dnl # HTML 4.0/css は分からんので、tagging は適当(^^;
9-m4_dnl # jm-brs.post.m4 と漢字コードを揃えること
10-m4_dnl
11-
12-m4_define(_SUB_ONE)
13-m4_include(../jm_www.m4)
14-_HEADER(`JM bug reporting system')
15-_EDIT_WARNING(index)
16-
17-<FORM method="POST" ACTION="jm-brs.cgi">
18-_Start_Table
19-
20-<TR>
21- <TH ALIGN="RIGHT" NOWRAP>名前: </TH>
22- <TD><INPUT NAME="name" SIZE="20" ></TD>
23- <TH ALIGN="RIGHT" NOWRAP>E-mail: </TH>
24- <TD><INPUT NAME="mail" SIZE="20"></TD>
25-</TR>
26-<TR>
27- <TH ALIGN="RIGHT" NOWRAP>パッケージ: </TH>
28- <TD>
--- a/www/bug_report/pkgs_list2html.awk
+++ /dev/null
@@ -1,11 +0,0 @@
1-BEGIN {
2- print " <SELECT NAME=\"package\">";
3-}
4-
5-/^[^#]/ {
6- printf "\t<OPTION VALUE=\"%s\">%s\n", $1, $1;
7-}
8-
9-END {
10- print " </SELECT>";
11-}
--- a/www/guidance/.gitignore
+++ /dev/null
@@ -1,3 +0,0 @@
1-/JM-man-view.el
2-/JMpost
3-/JMpost-*.el
--- a/www/guidance/JM-man-view.m4
+++ /dev/null
@@ -1,105 +0,0 @@
1-m4_dnl # index.m4: GNU m4 source for index.html.
2-m4_dnl # -------------------------------------------------------------------
3-m4_dnl #
4-m4_dnl # [その他に make 時点で依存を参照するファイル]
5-m4_dnl # jf_www.m4: 各種 M4 マクロ定義ファイル
6-m4_dnl #
7-m4_dnl # -------------------------------------------------------------------
8-m4_dnl
9-m4_define(_SUB_ONE)
10-m4_include(../jm_www.m4)
11-_EDIT_WARNING(translation_note)
12-_HEADER(`JM-man-view.el の使い方')
13-
14-<P>
15-JM-man-view とは、メール本文が
16-man page のファイルのものを整形して表示するための
17-Emacs Lisp です
18-(Emacs 上で動くメーラを使っている人は特に便利です)。
19-</P>
20-
21-<H2>必要なもの</H2>
22-<UL>
23-<LI>_LINK(JM-man-view.el,JM-man-view.el)</LI>
24-<LI>_LINK(http://centaur.maths.qmw.ac.uk/Emacs/WoMan/,woman.el)
25- (emacs21 以降では標準添付になっており、特に入手の必要はありません)</LI>
26-<LI>Emacs (woman.el が XEmacs 上では動かないので XEmacs はダメです)
27-</UL>
28-
29-<H2>設定方法</H2>
30-<OL>
31-<LI>
32- <P>woman.el と JM-man-view.el を load-path に置きます。
33- 具体的には、例えば ~/elisp/ に両者を置き、 .emacs に
34- </P>
35-<PRE>
36-(setq load-path (cons (expand-file-name "~/elisp") load-path))
37-</PRE>
38- <P>
39- と追記するとよいでしょう。
40- </P>
41-
42-<LI>
43- <P>
44- .emacs に以下を追記します。
45- </P>
46-<PRE>
47-;; woman
48-(autoload 'woman "woman"
49- "Decode and browse a UN*X man page." t)
50-(autoload 'woman-find-file "woman"
51- "Find, decode and browse a specific UN*X man-page file." t)
52-;; JM-man-view
53-(autoload 'JM-man-view "JM-man-view" nil t)
54-(autoload 'JM-man-mail-view "JM-man-view" nil t)
55-</PRE>
56-</OL>
57-<P>
58-以上で設定は終わりです。
59-</P>
60-
61-<H2>使いかた</H2>
62-<P>
63-メールが表示されているバッファに移動して、
64-M-x JM-man-view とすれば、
65-woman によって整形されたマニュアルが別フレーム
66-(X ならウィンドウ) に表示されます。
67-Wanderlust/Mew を使っている場合は、
68-Summary モードで
69-M-x JM-man-mail-view とすればマニュアルが表示されます。
70-</P>
71-
72-<H2>メールの条件</H2>
73-<P>
74-JM-man-view.el は、整形対象とするバッファにおける
75-roff 文書に対して、以下の仮定を置いています。
76-</P>
77-<OL>
78-<LI>マニュアル部分の先頭行は、roffのコメントである .\" で始まる (行頭が .\")
79-<LI>メール本文の最後まで manual である(= 本文の末尾にコメント等がない)
80-</OL>
81-<P>
82-_LINK(./mailformat.html#JMpost,JMpost)
83-で投げられるマニュアルは上の条件を満たしますので、
84-特に意識しなくともかまいません。
85-</P>
86-
87-<H2>制限</H2>
88-<P>
89- 現在のところ、woman.el は mdoc 形式のマニュアルの変換ができないようです。
90- したがって JM-man-view.el でも、
91- この形式のマニュアルは閲覧できないことになります。
92-</P>
93-
94-_CREDITS
95-
96- <P>
97- <IMG SRC="../images/grey.png" WIDTH="14" ALT="* " HEIGHT="14">
98- _LINK(index.html,JM 翻訳作業の手引きに戻る)
99- </P>
100-
101-_BACK_TO_HOME
102-
103-</BODY>
104-</HTML>
105-
--- a/www/guidance/Makefile
+++ /dev/null
@@ -1,43 +0,0 @@
1-#
2-# Makefile for contents in www/status
3-#
4-include ../../JM.rules
5-
6-ifndef WORKDIR
7- WORKDIR = /var/tmp/JM
8-endif
9-
10-JMPOST = ../../admin/JMpost
11-JMPOST_WL = ../../admin/JMpost-wl.el
12-JMPOST_MEW = ../../admin/JMpost-mew.el
13-JMMANVIEW = ../../admin/JM-man-view.el
14-
15-TARGET = index.html mailformat.html translation_note.html\
16- repository.html pod.html JM-man-view.html
17-EXTRAS = JMpost JMpost-wl.el JMpost-mew.el JM-man-view.el
18-
19-.SUFFIXES: .m4 .html
20-
21-.m4.html:
22- m4 -P -D _WORKDIR=$(WORKDIR) -D _WWWROOT=$(WWWROOT) $*.m4\
23- | nkf -w > $*.html
24-
25-all: $(TARGET) $(EXTRAS)
26-
27-*.html: ../jm_www.m4
28-
29-JMpost: $(JMPOST)
30- cp -p $< $@
31-JMpost-wl.el: $(JMPOST_WL)
32- cp -p $< $@
33-JMpost-mew.el: $(JMPOST_MEW)
34- cp -p $< $@
35-
36-JM-man-view.el: $(JMMANVIEW)
37- cp -p $< $@
38-
39-clean:
40- @rm -f $(TARGET) $(EXTRAS)
41-
42-install: all
43-
--- a/www/guidance/commentate.awk
+++ /dev/null
@@ -1,8 +0,0 @@
1-#!/usr/bin/awk -f
2-{
3- if ($0 ~ /^\.\\"/) {
4- print
5- } else {
6- printf(".\\\"O %s\n", $0)
7- }
8-}
--- a/www/guidance/index.m4
+++ /dev/null
@@ -1,177 +0,0 @@
1-m4_dnl # index.m4: GNU m4 source for index.html.
2-m4_dnl # -------------------------------------------------------------------
3-m4_dnl #
4-m4_dnl # [その他に make 時点で依存を参照するファイル]
5-m4_dnl # jf_www.m4: 各種 M4 マクロ定義ファイル
6-m4_dnl #
7-m4_dnl # -------------------------------------------------------------------
8-m4_dnl
9-m4_define(_SUB_ONE)
10-m4_include(../jm_www.m4)
11-_EDIT_WARNING(index)
12-_HEADER(`JM 翻訳作業の手引き')
13-
14-<P>
15- このページ以下では、
16- JM Project における man ページ翻訳作業に関する
17- ガイドラインを記述します。
18-</P>
19-
20-<UL>
21- <LI>まず本ページでは、
22- JM Project の活動の場である
23- _LINK(#subscribe-ML,JM-ML への参加方法)
24- と、大まかな
25- _LINK(#flow,翻訳作業の流れ)
26- について説明します。
27-
28- <LI>_LINK(repository.html,→JM 文書の管理方法)
29- のページでは、
30- man ページの管理に利用している git リポジトリの構成と、
31- ページの情報を管理しているテキストデータベースの書式に関して
32- 記述しています。
33-
34- <LI>このリポジトリへの登録作業を自動化するため、
35- JM-ML に送信するメールでは、
36- 一定のフォーマットに従った記述をお願いしています。
37- このフォーマットと、そのためのツールを
38- _LINK(mailformat.html,→作業メールのフォーマット)
39- のページで紹介します。
40-
41- <LI>ML に流れたメールの校正を支援するツールとして、
42- JM-man-view.el が開発されました。この利用法は
43- _LINK(JM-man-view.html,→JM-man-view.el の使い方)
44- のページで説明しています。
45-
46- <LI>実際に翻訳を行うときの文体や訳語・書式等に関する
47- ガイドラインは
48- _LINK(translation_note.html,→翻訳の指針)
49- にまとめました。
50-
51- <LI>POD マニュアルに関する翻訳作業のガイドラインは
52- _LINK(pod.html,→podマニュアル翻訳の手引き)
53- をご覧下さい。
54-</UL>
55-
56-<H2><A NAME="subscribe-ML">JM-ML への参加方法・退会方法</A></H2>
57-<P>
58- JM Project における翻訳作業では
59- _LINK(mailto:linuxjm-discuss@lists.sourceforge.jp,JM-ML)
60- が活動の中心となっています。
61- 作業の予約、結果の登録、内容に関する議論などが
62- ここでやりとりされることになります。
63- したがって JM Project に参加したい方は、
64- まず JM-ML に参加してください。
65-</P>
66-
67-<P>
68- JM-ML (= linuxjm-discuss ML) への加入は
69- _LINK(http://lists.sourceforge.jp/mailman/listinfo/linuxjm-discuss,こちらのページ)
70- から手続きを行って下さい。
71-</P>
72-
73-<P>
74- JM-ML の講読を中止したい場合も、
75- _LINK(http://lists.sourceforge.jp/mailman/listinfo/linuxjm-discuss,こちらのページ)
76- から手続きを行って下さい。
77-
78-<H2><A NAME="flow">翻訳作業の流れ</A></H2>
79-<P>
80- 翻訳作業は以下のステップを踏んで行われます。
81- 作業の節目節目では ML に報告を行ってもらいます。
82- そのメールのフォーマットと、
83- 定型メールを送信するためのツールについての解説は
84- _LINK(mailformat.html,メールフォーマット)
85- を参照してください。
86-</P>
87-<OL>
88- <LI><A HREF="#step1">予約</A></LI>
89- <LI><A HREF="#step2">ドラフト (草稿) 作成</A></LI>
90- <LI><A HREF="#step3">校正</A></LI>
91- <LI><A HREF="#step4">リリース</A></LI>
92-</OL>
93-
94-<H3><A NAME="step1">翻訳の予約</A></H3>
95-<P>
96- JM Project において作業対象となっているマニュアルは
97- _LINK(../INDEX/progress.html,`JM インデックス(作業状況)')
98- のページにまとめられています。
99- ここから作業したいページを選び、
100- _LINK(mailformat.html,メールフォーマット)
101- の要領で宣言メールをポストして下さい。
102-</P>
103-
104-<P>
105- もしインデックスページにないマニュアルを翻訳したい場合は、
106- その旨を ML で発言してください。
107- そのマニュアルが含まれているパッケージの
108- 一次配布元がわかっている場合は、
109- その情報も併せて連絡して下さい。
110- git コミッターが作業してページに反映させますので、
111- 確認後改めて予約宣言をしてください。
112-</P>
113-
114-<H3><A NAME="step2">ドラフト</A></H3>
115-<P>
116- 作業するページが決まったら、
117- _LINK(translation_note.html,翻訳の指針)
118- に従ってページを作成してください。
119- 翻訳作業中に疑問点などが生じた場合は、
120- 気軽に ML で尋ねましょう。
121-</P>
122-<P>
123- 作業が完成したら、結果を
124- _LINK(mailformat.html,メールフォーマット)
125- に従って ML にポストして下さい。
126- 校正者・査読者の便宜を考えて、
127- 原文を残すかたちでの投稿が推奨されます。
128-</P>
129-
130-<H3><A NAME="step3">校正</A></H3>
131-<P>
132- ドラフトが提出されると、ページは校正に入ります。
133- 校正作業は翻訳者と同じ人が行ってもかまいませんし、
134- あるいは別の人を ML で募ってもかまいません。
135- ただしそれぞれの場合で
136- _LINK(mailformat.html,メールフォーマット)
137- が変わりますので注意してください。
138-</P>
139-<P>
140- もしドラフトを作成した人が、そのページを
141- 「校正募集」のステータスにおいた場合は、
142- 校正作業を希望する人は予約のメールを ML に
143- ポストしてから作業をはじめてください。
144-</P>
145-<P>
146- 校正の際には、
147- ドラフト原稿に対して ML から寄せられた意見を参考にしたり、
148- 語句の修正・訳語の統一などを行ってください。
149-</P>
150-<P>
151- なお ML に流れたメールの整形閲覧用のツールとして、
152- Emacs Lisp で書かれた
153- _LINK(JM-man-view.html,JM-man-view.el)
154- がありますので環境に応じて利用してください。
155-</P>
156-
157-<H3><A NAME="step4">リリース</A></H3>
158-<P>
159- 作業が終わったら結果を ML にポストします。
160- フォーマットは
161- _LINK(mailformat.html,メールフォーマット)
162- を参考にしてください。
163-</P>
164-<P>
165- このときも原文は残したかたちでポストしましょう。
166- オリジナルが更新されたときの追随作業の役にたちますから。
167- 配布に含まれるページでは原文を除去しますが、
168- その作業はシステム側で自動的に行われます。
169-</P>
170-
171-_CREDITS
172-
173-_BACK_TO_HOME
174-
175-</BODY>
176-</HTML>
177-
--- a/www/guidance/mailformat.m4
+++ /dev/null
@@ -1,291 +0,0 @@
1-m4_dnl # index.m4: GNU m4 source for index.html.
2-m4_dnl # -------------------------------------------------------------------
3-m4_dnl #
4-m4_dnl # [その他に make 時点で依存を参照するファイル]
5-m4_dnl # jf_www.m4: 各種 M4 マクロ定義ファイル
6-m4_dnl #
7-m4_dnl # -------------------------------------------------------------------
8-m4_dnl
9-m4_define(_SUB_ONE)
10-m4_include(../jm_www.m4)
11-_EDIT_WARNING(mailformat)
12-_HEADER(`作業メールのフォーマット')
13-
14-<P>
15- _LINK(repository.html,JM 文書の管理方法)
16- に述べたように、 JM では翻訳作業対象の man ページを
17- git リポジトリとテキストデータベースによって管理しています。
18-</P>
19-
20-<P>
21- こちらへの登録を省力化・自動化するために、
22- ML に翻訳を post する際にはこのページに記述されたような
23- フォーマットにすることが推奨されます。
24- (sourceforge 以降後は自動登録は行っていませんが、
25- 登録作業の省略化のため、このフォーマットの使用をお願いします。)
26-</P>
27-
28-<P>
29- 投稿を省力化するために、 bash の使える環境の方は
30- _LINK(#JMpost,JMpost スクリプト)
31- を使っていただくといいでしょう。
32- また、Wanderlust や Mew のユーザの場合には、JMpost 形式のメールを作成してくれる
33- _LINK(JMpost-wl.el,JMpost-wl.el) や
34- _LINK(JMpost-mew.el,JMpost-mew.el)
35- も用意されていますので、お試し下さい。
36-</P>
37-
38-
39-<H2><A NAME="format">メールのフォーマット</A></H2>
40-<H3>送信先</H3>
41-<P>
42- 送信先アドレスは
43-</P>
44-
45-<BLOCKQUOTE><STRONG>
46-linuxjm-discuss@lists.sourceforge.jp
47-</STRONG></BLOCKQUOTE>
48-
49-<P CLASS="noindent">
50- としてください。
51-m4_dnl これは実際には JM@linux.or.jp へのエイリアスで、
52-m4_dnl JM ML のメンバに通常のポストと全く同じように届きます。
53-m4_dnl 送信先アドレスを変えるのは、自動処理のためです。
54-</P>
55-
56-<H3>サブジェクト</H3>
57-<P>
58- メールヘッダの Subject 行は
59-</P>
60-
61-<BLOCKQUOTE>
62-Subject: [POST:XX] (package 名) (page ファイル名)
63-</BLOCKQUOTE>
64-
65-<P CLASS="noindent">
66- のようにしてください。
67- XX のところには、後述する
68- <A HREF="#stat">stat</A> を書いてください。
69- (例: [POST:TR] LDP man-pages strcmp.3)。
70-</P>
71-
72-<H3>ヘッダ</H3>
73-<P>
74- メールの本文の先頭に、ページの情報を記述したヘッダを置いてください。
75- &lt;STATUS&gt;, &lt;/STATUS&gt; に挟まれた部分がヘッダ情報になります。
76- ヘッダ情報は 1 行 1 レコードからなり、
77- 区切りは ": " (コロンとスペース) です。
78- 必要なレコードは以下の 6 つです。
79-</P>
80-
81-<DL>
82- <DT><A NAME="stat"><STRONG>stat</STRONG></A></DT>
83- <DD>
84- ページのステータスです。
85- ("TR", "DO", "DP", "PR", "RO", "RR") のどれか一つを
86- 指定します。それぞれの意味は以下のようになります。
87- <UL>
88- <LI>TR: 翻訳の予約。 (Translation Reservation)
89- <LI>DO: ドラフトの投稿。自分では校正を行わない。
90- (Draft Only)
91- <LI>DP: ドラフトの投稿。引き続き自分で校正を行う。
92- (Draft and Proof reservation)
93- <LI>PR: 校正待ち状態のドラフトに対する校正作業の予約。
94- (Proof Reservation)
95- <LI>RO: リリースの投稿。原文更新時の予約はしない。
96- (Release Only)
97- <LI>RR: リリースの投稿です。原文更新時の改訂作業を予約する。
98- (Release and update Reservation)
99- </UL>
100-
101- <DT><STRONG>ppkg</STRONG></DT>
102- <DD>この man ページが含まれるパッケージの名前</DD>
103-
104- <DT><STRONG>page</STRONG></DT>
105- <DD>ページのファイル名</DD>
106-
107- <DT><STRONG>date</STRONG></DT>
108- <DD>_LINK(repository.html#translation_list,translation_list)
109- データベースに記録される日付</DD>
110-
111- <DT><STRONG>mail</STRONG></DT>
112- <DD>投稿者のメールアドレス</DD>
113-
114- <DT><STRONG>name</STRONG></DT>
115- <DD>投稿者の Real Name (ローマ字表記が望ましい)</DD>
116-</DL>
117-
118-<P>
119- 例えば翻訳作業の予約の場合は、以下のようになります。
120-</P>
121-
122-<PRE>
123-&lt;STATUS&gt;
124-stat: TR
125-ppkg: GNU sharutils
126-page: shar.1
127-date: 1999/10/04
128-mail: nakano@apm.seikei.ac.jp
129-name: NAKANO Takeo
130-&lt;/STATUS&gt;
131-</PRE>
132-
133-<H3>本文</H3>
134-<P>
135- ヘッダの後、 man ページの本文を置いてください。
136- ヘッダ以降に最初に現れた「空行以外の行」から、
137- メールの末尾までが man ページとして登録されます。
138- 従って signature 等は置かないようにしてください。
139-</P>
140-
141-<P>
142- man ページ自体の書式や、記述に関する注意などは
143- _LINK(translation_note.html,翻訳の指針)
144- を参考にしてください。
145-</P>
146-
147-<H2><A NAME="JMpost">JMpost コマンド</A></H2>
148-<P>
149- 以上のフォーマットのメール送信を簡単に行うため、
150- bash のシェルスクリプト
151- _LINK(JMpost,JMpost)
152- を用意しました。
153- 以下に使い方を説明します。
154-</P>
155-
156-<H3>コマンドライン</H3>
157-<PRE>
158- JMpost [-S stat] [-P pkg] [-F page] [-D date]
159- [-M mail] [-R name] [filename] [-post]
160-</PRE>
161-
162-<H3>使い方</H3>
163-<P>
164- 予約・作業ページの登録ともに用います。
165- 作業したファイルを CVS リポジトリに登録する場合
166- (-S オプションの DO, DP, RO, RR に対応) は、
167- そのファイルをコマンドラインに指定します。
168-</P>
169-
170-<P>
171- オプションは全て省略可能ですが、
172- 必要に応じて質問のプロンプトが出されます。
173- プロンプトは標準エラー出力に出され、
174- 標準入力から回答を受付けます。
175-</P>
176-
177-<P>
178- コマンドラインの最後に -post オプションをつけると、
179- 結果は /usr/lib/sendmail を用いて JM-ML にポストされます。
180- -post オプションをつけない場合は、
181- ML に流される内容が標準出力に書き出されます。
182-</P>
183-
184-<H3>オプション</H3>
185-
186-<DL>
187- <DT><A NAME="status"><STRONG>-S</STRONG></A></DT>
188- <DD>
189- 文書のステータスを記述します。有効なものは以下のどれかです。
190- <UL>
191- <LI>TR: 翻訳の予約です。 (Translation Reservation)
192- <LI>DO: ドラフトの投稿です。自分では校正を行わない場合です。
193- (Draft Only)
194- <LI>DP: ドラフトの投稿です。引き続き自分で校正を行う場合です。
195- (Draft and Proof reservation)
196- <LI>PR: 校正待ち状態のドラフトに対する校正作業の予約です。
197- (Proof Reservation)
198- <LI>RO: リリースの投稿です。原文更新時の予約はしない場合です。
199- (Release Only)
200- <LI>RR: リリースの投稿です。原文更新時の改訂作業の予約を含みます。
201- (Release and update Reservation)
202- </UL>
203- メールに翻訳原稿が添付されるのは
204- DO, DP, RO, RR のいずれかの場合になります。
205- _LINK(repository.html#translation_list,translation_list の書式)
206- も参考にすると良いでしょう。
207- </DD>
208-
209- <DT><STRONG>-P</STRONG></DT>
210- <DD>
211- パッケージの名前です。(例: util-linux, "GNU bash")
212- </DD>
213-
214- <DT><STRONG>-F</STRONG></DT>
215- <DD>
216- ページの名前です。 (例: mount.8, bash.1)
217- </DD>
218- <DT><STRONG>-D</STRONG></DT>
219- <DD>
220- 日付です。省略すると date コマンドの結果が用いられます。
221- </DD>
222- <DT><STRONG>-M</STRONG></DT>
223- <DD>
224- 作業者のメールアドレスです。
225- </DD>
226- <DT><STRONG>-R</STRONG></DT>
227- <DD>
228- 作業者の Real Name です。
229- </DD>
230-</DL>
231-
232-<H3>ノート</H3>
233-<P>
234- スクリプトの先頭部分にある <CODE>name</CODE> および
235- <CODE>mail</CODE> 変数を適宜設定しておくと、
236- -M オプションや -P オプションの指定を省略できます。
237-</P>
238-
239-<H3>例</H3>
240-<P>
241- LDP man-pages パッケージにある
242- printf.3 に関する例を示します。
243- -M オプションと -R オプションは省略します。
244-</P>
245-
246-<H4>翻訳を予約する場合</H4>
247-<PRE>
248- % JMpost -S TR -P "LDP man-pages" -F printf.3 -post
249-</PRE>
250-
251-<H4>ドラフトを投稿する場合</H4>
252-<P>
253- 翻訳されたファイルは printf.3.draft
254- に記述されているものとします。
255-</P>
256-<PRE>
257- % JMpost -S DP -P "LDP man-pages" -F printf.3 printf.3.draft -post
258-</PRE>
259-<P CLASS="noindent">
260- これは引き続き自分で校正を行う場合です。
261- 校正を他の人に任せる場合は -S DO とします。
262-</P>
263-
264-<H4>リリース版を投稿する場合</H4>
265-<P>
266- 翻訳されたファイルは同じく printf.3.draft
267- に記述されているものとします。
268- なお、このとき原文のコメント (.\"O..) を
269- 自分で削除する必要は<STRONG>ありません</STRONG>。
270- 登録システムが自動的に strip します。
271-</P>
272-<PRE>
273- % JMpost -S RO -P "LDP man-pages" -F printf.3 printf.3.draft -post
274-</PRE>
275-<P CLASS="noindent">
276- "-S RR" で投稿すると、次に printf.3 のオリジナルが update
277- されたとき、投稿者に翻訳予約が自動的に割り当てられます。
278-</P>
279-
280-_CREDITS
281-
282- <P>
283- <IMG SRC="../images/grey.png" WIDTH="14" ALT="* " HEIGHT="14">
284- _LINK(index.html,JM 翻訳作業の手引きに戻る)
285- </P>
286-
287-_BACK_TO_HOME
288-
289-</BODY>
290-</HTML>
291-
--- a/www/guidance/pod.m4
+++ /dev/null
@@ -1,256 +0,0 @@
1-m4_dnl # index.m4: GNU m4 source for index.html.
2-m4_dnl # -------------------------------------------------------------------
3-m4_dnl #
4-m4_dnl # [その他に make 時点で依存を参照するファイル]
5-m4_dnl # jf_www.m4: 各種 M4 マクロ定義ファイル
6-m4_dnl #
7-m4_dnl # -------------------------------------------------------------------
8-m4_dnl
9-m4_define(_SUB_ONE)
10-m4_include(../jm_www.m4)
11-_EDIT_WARNING(translation_note)
12-_HEADER(`podマニュアル翻訳の手引き')
13-
14-
15-<H2>概要</H2>
16-
17-<H3>この手引きの目的</H3>
18-
19-<P>
20- このドキュメントは、JM プロジェクトにおいて
21- pod ドキュメントの翻訳作業をする手引きです。
22-</P>
23-<P>
24- _LINK(index.html,JM 翻訳作業の手引き)
25- とともに参照してください。
26-</P>
27-
28-<H3>pod とは</H3>
29-
30-<P>
31- pod とは、
32- perl スクリプトのドキュメントを記述するためのドキュメント形式です。
33- 以下のような特色を持っています。
34-</P>
35-
36-<UL>
37- <LI>単体のドキュメント (.podファイル) としても使えるが、
38- perlスクリプトに埋めこむこともできる。
39-
40- <LI>簡潔で書きやすいフォーマット
41-
42- <LI>man 形式, html 形式への変換ツールがある
43-</UL>
44-
45-<P>
46- roff, html, latex などの他のマークアップ言語と比較すると、
47- 機能は非常に限定されていますが、
48- ソーステキストが読みやすく書きやすいことが特色です。
49- 通常のマークアップ言語は、
50- 生成されたドキュメントを指定のビューアで見た場合は
51- (当然ながら) 読みやすいのですが、
52- ソースとなるテキストファイルは読むのが困難です。
53-</P>
54-
55-<P>
56- pod のソースは、通常のテキストファイルと大きな隔たりがなく、
57- ソースのままでもある程度読めることが特色です。
58- そのため、書く側への負担が小さく、気軽に書けるフォーマットであると言えます。
59-</P>
60-
61-<P>
62- 同様の目的のフォーマットとして Ruby 言語のスクリプトでよく使われる、
63- RD というフォーマットもあります。
64-</P>
65-
66-<H2>pod マニュアルをJM向けに翻訳する場合の作業方法</H2>
67-
68-<H3>リポジトリ内でのディレクトリ構成</H3>
69-
70-<P>
71- JM のリポジトリ内でのディレクトリ構成は以下のようになります。
72- (zebedeeというプログラムの場合)
73-</P>
74-<PRE>
75- JM -+- pod -+- zebedee -+- ChangeLog
76- +- translation_list
77- +- original -+- zebedee.pod
78- | +- ftpgw.tcl.pod
79- |
80- +- draft -+- zebedee.pod
81- | +- ftpgw.tcl.pod
82- |
83- +- release -+- zebedee.pod
84- +- ftpgw.tcl.pod
85-</PRE>
86-
87-<P>
88- すなわち、通常のroff形式のマニュアルと次の点が違います。
89-</P>
90-<UL>
91-<LI>トップディレクトリがJM/manualでなくJM/pod
92-<LI>man1,man3のようなセクション別のサブディレクトリがない
93-</UL>
94-
95-<P>
96- podの下がプログラム名になり、その下が
97- original/draft/releaseになることと、
98- この 3 つのディレクトリの使用法はroff形式の場合と同じで、次のとおりです。
99-</P>
100-
101-<DL>
102- <DT>original<DD>オリジナルのソース
103- <DT>draft<DD>翻訳作業中の日本語ソース(コメントとして原文を含む)
104- <DT>release<DD>翻訳が完了した日本語ソース
105-</DL>
106-
107-<H3>translation_list の書式</H3>
108-<P>
109- translation_list は以下のようになります。
110-</P>
111-
112-<PRE>
113-△:zebedee:2.0.0:2000/05/30:zebedee:pod:2000/6/21:(G):tnaka@brain-tokyo.com:NAKAJIMA Taku:::
114-×:zebedee:2.0.0:2000/05/30:ftpgw.tcl:pod:::::::
115-</PRE>
116-
117-<P>
118- すなわち、セクション名(6番目のフィールド)が"pod"になります。
119- それ以外は、roff形式のマニュアルと同じです。
120-</P>
121-
122-<H3><A NAME="comment-format">原文のコメント化</A></H3>
123-<P>
124- JMでは、draft文書については、
125- 校正者の便宜のために原文をコメントで残すことが推奨されています。
126- pod ドキュメントの一般的なコメントの形式は =begin/=end ですが、
127- 原文をコメント化した部分と通常のコメントを区別するため、
128- 以下のような"JM-comment"というタグ付きのコメントを使用してください。
129-</P>
130-
131-<PRE>
132-=begin JM-comment
133-
134-If a key is described as being a boolean then its value must be one of the
135-words B<true> or B<false>.
136-
137-=end JM-comment
138-
139-キーワードが真偽値(boolean)と書かれていたら、
140-その値は"B<true>" または "B<false>"でなければならない。
141-</PRE>
142-<P>
143- このようにしておくと、htmlやmanに変換した時に原文は削除されます。
144- また、
145- _LINK(#remove-comment,以下)
146- に述べるように簡単なコマンドでソースから原文を取り除くこともできます。
147-</P>
148-
149-<H3>ポストの方法</H3>
150-<P>
151- JMでは、JM メーリングリストに特定の形式で投稿することで
152- CVS リポジトリに commit する方法が用意されていますが、
153- 現状ではpodマニュアルの場合はこの方法は使用できません。
154-</P>
155-<P>
156- そのため、pod の翻訳作業を投稿するためには、
157- CVS のアカウントをもらって CVS committer になるか、
158- CVS committer に依頼する必要があります。
159-</P>
160-<P>
161- 作業にあたっては、ポストの方法について
162- JM のメーリングリストでご相談下さい。
163-</P>
164-
165-<H2>pod マニュアル翻訳上の注意、TIPS</H2>
166-
167-<H3>翻訳確認の方法</H3>
168-
169-<P>
170- 作業結果の確認のためには、以下のコマンドを使います。
171-</P>
172-
173-<P CLASS="noindent">
174-<STRONG>html変換してから表示</STRONG>
175-</P>
176-<PRE>
177-$ pod2html podソース名 > 作業用htmlファイル名
178-$ netscape 作業用htmlファイル名
179-</PRE>
180-
181-<P CLASS="noindent">
182-<STRONG>man変換してから表示</STRONG>
183-</P>
184-<PRE>
185-$ mkdir man1
186-$ pod2man podソース名 > man1/xxxxxx.1
187-$ man -M . xxxxxx
188-</PRE>
189-
190-<P>
191- pod はドキュメントフォーマットの細部が確立してないためか、
192- pod2html と pod2man で違う結果となる (片方だけでエラーが出る)
193- ことがたまにありますから、
194- 常に両方の結果を確認した方がいいと思います。
195-</P>
196-
197-<P>
198- また、どちらのコマンドもparagraph単位(段落)のエラー表示で、
199- エラーの行番号が表示されないし、
200- エラーメッセージもわかりやすいとは言えません。
201- そのため、こきざみに変換コマンドを実行した方がいいと思います。
202- たくさんの作業を一度にしてからエラーを出すと、原因をつきとめるのが困難です。
203-</P>
204-
205-<H3>段落名の翻訳の注意点</H3>
206-
207-<P>
208- pod2manは、変換元のpodドキュメントが
209- 以下の条件を満たしていることを前提としているようです。
210-</P>
211-
212-<OL>
213- <LI>最初の段落が"=head1 NAME"から初まること
214- <LI>"=head1 DESCRIPTION"という段落が存在すること
215- <LI>=head1 =head2以外の見出しを使わない
216-</OL>
217-
218-<P CLASS="noindent">
219- そのため、=head...の翻訳には注意を要します。
220-</P>
221-
222-<P>
223- pod2html には段落への
224- HTMLリンクタグを自動生成する機能があるのですが、
225- pod ドキュメントがこれを使用している場合は、
226- 段落名を翻訳してしまうと、このリンクが正しく張れなくなります。
227-</P>
228-
229-<P>
230- このため、段落名の翻訳は非常に注意が必要です。
231- この問題に対する一般的な対応方法はまだ決定していません。
232- 現状では、段落名は原文のままにしておいて、
233- 個別に JM メーリングリストで対応方法を相談してください。
234-</P>
235-
236-<H3><A NAME="remove-comment">原文の削除</A></H3>
237-<P>
238- _LINK(#comment-format,先に述べたような形式)
239- で原文を保持している場合、
240- この原文を削除するには、次のようなコマンドを使用します。
241-</P>
242-<PRE>
243-perl -n -e 'print unless /^=begin\s*JM-comment/../^=end\s*JM-comment/' zebedee.pod > ../release/zebedee.pod
244-</PRE>
245-
246-_CREDITS
247-
248- <P>
249- <IMG SRC="../images/grey.png" WIDTH="14" ALT="* " HEIGHT="14">
250- _LINK(index.html,JM 翻訳作業の手引きに戻る)
251- </P>
252-
253-_BACK_TO_HOME
254-
255-</BODY>
256-</HTML>
--- a/www/guidance/repository.m4
+++ /dev/null
@@ -1,308 +0,0 @@
1-m4_dnl # index.m4: GNU m4 source for index.html.
2-m4_dnl # -------------------------------------------------------------------
3-m4_dnl #
4-m4_dnl # [その他に make 時点で依存を参照するファイル]
5-m4_dnl # jf_www.m4: 各種 M4 マクロ定義ファイル
6-m4_dnl #
7-m4_dnl # -------------------------------------------------------------------
8-m4_dnl
9-m4_define(_SUB_ONE)
10-m4_include(../jm_www.m4)
11-_EDIT_WARNING(translation_note)
12-_HEADER(`JM 文書の管理方法')
13-
14-<P>
15- JM Project では、git によって文書の管理をしています。
16- このページでは、
17- _LINK(#structure,リポジトリ内部の配置)
18- と、 man ページの作業情報などが記述されたテキストデータベース
19- _LINK(#translation_list,transalation_list)
20- の書式に関する説明をします。
21-</P>
22-
23-<H2><A NAME="structure">ディレクトリの構成</A></H2>
24-<P>
25- JM Project の用いている git リポジトリのディレクトリ構成は
26- 以下のようになっています。
27-</P>
28-<PRE>
29-/ +- www
30- |
31- +- admin
32- |
33- +- manual -+- 0unclassified -
34- |
35- +- GNU_bash -
36- |
37- +- GNU_binutils -
38- :
39-</PRE>
40-
41-<P>
42- このうちの manual/ 以下が、本サイトの
43- _LINK(../manual,manual ディレクトリ)
44- 以下にミラーされています。
45- このディレクトリには、
46- マニュアルの一次ソースとなるアーカイブパッケージ
47- (例えば util-linux-2.9v.tar.gz など) の
48- basename と同名のサブディレクトリ (util-linux) を設けます。
49- ただし GNU のパッケージと LDP のパッケージだけには、
50- 便宜上 GNU_, LDP_ という prefix をつけています。
51- このサブディレクトリを、以下では
52- 「パッケージディレクトリ」と呼びます。
53-</P>
54-
55-<P>
56- 各パッケージディレクトリのサブ構造は以下のようになっています。
57-</P>
58-
59-<PRE>
60-- pkg -+- ChangeLog
61- +- translation_list
62- +- original -+- man1
63- | +- man5
64- | +- man8
65- |
66- +- draft -+- man1
67- | +- man5
68- | +- man8
69- |
70- +- release -+- man1
71- | +- man5
72- | +- man8
73- |
74- +- contrib -+- man1
75- +- man5
76- +- man8
77-</PRE>
78-
79-<UL>
80- <LI>ChangeLog ファイルは変更履歴を記述したファイルです。
81- CVS システムで標準的に用いられれる形式です。
82- </LI>
83-
84- <LI>translation_list は各マニュアルページのバージョンや作業情報、
85- 著作権情報等を含むテキストデータベースファイルです。
86- このファイルの書式については
87- _LINK(#translation_list,translation_list の書式)
88- で説明します。</LI>
89-
90- <LI>ディレクトリ <tt>original/</tt> には、
91- パッケージに含まれている原文が置かれます。</LI>
92-
93- <LI>ディレクトリ <tt>draft/</tt> には、
94- 「原文のコメントつき」の翻訳版が置かれます。
95- ここに置かれるページは、ドラフト版・リリース版を問わず、
96- 常に翻訳作業の最新版になります。</LI>
97-
98- <LI>ディレクトリ <tt>release/</tt> には、
99- 「原文を取り去ったリリース版」が置かれます。</LI>
100-
101- <LI>ディレクトリ <tt>contrib/</tt> には、
102- JM 以外で翻訳されたページの寄贈を受けた場合に、
103- そのファイルが置かれます。
104-</UL>
105-
106-<P>
107- 実作業との対応は
108- _LINK(index.html#flow,翻訳作業の流れ)
109- を参考にしてください。
110-</P>
111-
112-
113-<H2><A NAME="translation_list">translation_list の書式</A></H2>
114-<P>
115- translation_list はパッケージディレクトリのルートに
116- 一つだけ置かれるテキストデータベースファイルで、
117- そのディレクトリ以下に含まれる man ページの情報が
118- 一つのページにつき一行ずつ書かれています。
119- フィールドの区切りはコロン (:) です。
120- 以下に例を示します。
121- 1行目が
122- _LINK(#roffpage,通常のページ)
123- の、 2 行目が
124- _LINK(#linkpage,リンクページ)
125- のそれぞれ例になっています。
126-</P>
127-
128-<PRE>
129-○:LDP man-pages:1.26:1998/10/03:bind:2:1999/08/02::uv9h-hykw@asahi-net.or.jp:HAYAKAWA Hitoshi:
130-@:LDP man-pages:1.26:1996/04/15:break:2:unimplemented:2:
131-</PRE>
132-
133-<H3><A NAME="roffpage">通常のページ</A></H3>
134-
135-<p>
136- 「通常のページ」とは、
137- _LINK(#linkpage,→リンクページ)
138- 以外のページ、実際に文章が書かれているページを指します。
139-</P>
140-<p>
141- まず第 1 フィールドの内容を説明します。
142- それぞれのマークの説明に書いてある r:, d:, o: とは、
143- そのマークのステータスにおいて、
144- release/, draft/, original/ 各ディレクトリに
145- マニュアルページが存在するかどうかを示したものです。
146- _LINK(index.html#flow,翻訳作業の流れ)
147- と併せてご覧ください。
148-</P>
149-<UL>
150- <LI>0: ページ無し
151- <LI>1: 第一世代
152- <LI>2: 第二世代
153-</UL>
154-<P CLASS="noindent">
155-を表します。
156-</P>
157-
158-<UL>
159- <LI>?: 不明、要調査
160- <LI>×: 未着手 (r:0, d:0, o:1)
161- <LI>▲: 翻訳予約・作業中 (r:0, d:0, o:1)
162- <LI>△: 翻訳終了。校正者募集中 (r:0, d:1, o:1)
163- <LI>●: 校正中 (r:o, d:1, o:1)
164-</UL>
165-
166-<UL>
167- <LI>☆: 原文の改訂版がリリースされた。要改訂 (r:1, d:1, o:2)
168- <LI>■: 改訂予約・作業中 (r:1, d:1, o:2)
169- <LI>□: 改訂終了。校正者募集 (r:1, d:2, o:2)
170- <LI>◆: 改訂版校正中 (r:1, d:2, o:2)
171-</UL>
172-
173-<UL>
174- <LI>○: 校正終了 (r:1, d:1, o:1 または r:2, d:2, o:2)
175- <LI>◎: 校正終了。改訂版における更新予約
176- (o:1, d:1, r:1 または o:2, d:2, r:2)
177-</UL>
178-
179-<P>
180- ステータスの遷移をまとめると以下のようになります。
181-</P>
182-
183-<PRE>
184-未翻訳状態から:
185- × → ▲ →(△)→ ● → ○
186- → ◎
187-オリジナル改訂後:
188- (○)→ ☆ → ■ →(□) → ◆ → ○
189- (◎)→ → → ↑ →(◎)
190-</PRE>
191-
192-<P>
193- なお、JM 以外のプロジェクトから寄贈を受けたページについては、
194- 以下のようなステータスを用います。
195- なお寄贈もとの URL がわかる場合は、
196- 「備考」のフィールドに書いておいてください
197- (コロン ":" が含まれていても大丈夫です)。
198-</P>
199-<UL>
200- <LI>C: オリジナルの最新アーカイブの翻訳
201- <LI>c: オリジナルのアーカイブの最新版より古い版の翻訳
202-</UL>
203-
204-<P>
205- 第二フィールド以下の内容は以下の通りです。
206-</P>
207-
208-<OL START=2>
209- <LI>パッケージ名。
210- パッケージディレクトリ名と基本的に同じものになります。</LI>
211- <LI>man ページのバージョン。
212- リリース後にオリジナルが改定された場合や、
213- ドラフト作成作業中にさらにオリジナルの改訂があった場合など、
214- リリース版・ドラフト版・オリジナル版でバージョンが異なってしまった場合には、
215- "=&gt;" で区切って記述してください。その際には
216- "release=&gt;draft=&gt;original" の順にしてください。
217- バージョンが同じならわざわざ分けて書かなくても OK です。
218- なぜなら
219- <UL>
220- <LI>一番右には常にオリジナル版のバージョンが入る
221- <LI>改訂作業 (☆■□◆) では、
222- 一番左は常にリリース版のバージョンになる。
223- <LI>ドラフト版のバージョンは決してリリース版とは同じにならない。
224- </UL>
225- という条件を考えれば、
226- どのバージョンがどの版に対応するかを決定するのは容易でしょうから。</LI>
227-
228- <LI>オリジナル man-page の日付。
229- または原文が cvs に commit された日付になっていることもある。</LI>
230- <LI>マニュアルファイルの basename。</LI>
231- <LI>マニュアルのセクション番号。</LI>
232- <LI>作業の日付。
233- 作業中であることを示すステータス(▲●■◆)では
234- 作業をする宣言をした日になり、
235- それ以外のステータス(△○◎☆□)では
236- 翻訳ページの最終更新日にします。</LI>
237-
238- <LI>
239- 翻訳・再配布に関する条件。
240- 翻訳や配布に関する条件を著作者に確認をとったら、
241- 各著作権に従って以下のステータスを設定します。
242- <UL>
243- <LI>G: GPL2 (GNU Public License Version 2)
244- <LI>B: BSD (BSD License)
245- <LI>M: Misc.(翻訳、配布とも問題ないが、
246- 著作権に関しては GPL2、BSD のどちらでもなく
247- 原文を参照するなどの必要があるもの)
248- <LI>N: Non commercial use only (商用での配布を禁止しているもの)
249- <LI>o: 原著者に確認済 (obsolete)
250- </UL>
251- 確認を取っていないものに関しては、以上のステータスを "()"
252- で囲んでください。</LI>
253-
254- <LI>翻訳作業者のメールアドレス。</LI>
255- <LI>翻訳作業者の名前 (ローマ字表記が望ましい)。</LI>
256- <LI>備考など。</LI>
257-
258-</OL>
259-
260-<H3><A NAME="linkpage">リンクページ</A></H3>
261-<p>
262- 「リンクページ」とは、
263- 別のマニュアルページにシンボリックリンクされていたり、あるいは
264-</P>
265-
266-<BLOCKQUOTE>
267-.so man1/hoge.1
268-</BLOCKQUOTE>
269-
270-<P CLASS="noindent">
271- のように roff 的にリンクされているページのことです。
272- この種のページに対するステータス行の各フィールドは以下のようになります。
273- 通常の翻訳作業の際には、
274- このステータスはあまり意識しないでも良いでしょう。
275-</P>
276-
277-<P>
278- なお、オリジナルではシンボリックリンクになっている場合でも、
279- JM で配布する際には .so によるリンクに書き換えています。
280-</P>
281-
282-<OL>
283- <LI>ステータス
284- <UL>
285- <LI>※: リンク先が未翻訳・未公開 (ステータスでいうと ×▲△●)</LI>
286- <LI>@: リンク先が翻訳・公開済み (上記以外)</LI>
287- </UL></LI>
288- <LI>パッケージ名(リンク先と同じ)</LI>
289- <LI>バージョン(リンク先と同じ)</LI>
290- <LI>日付(リンク先と同じ)</LI>
291- <LI>このマニュアル自体の名前</LI>
292- <LI>このマニュアル自体のセクション</LI>
293- <LI>リンク先の名前</LI>
294- <LI>リンク先のセクション</LI>
295-</OL>
296-
297-_CREDITS
298-
299- <P>
300- <IMG SRC="../images/grey.png" WIDTH="14" ALT="* " HEIGHT="14">
301- _LINK(index.html,JM 翻訳作業の手引きに戻る)
302- </P>
303-
304-_BACK_TO_HOME
305-
306-</BODY>
307-</HTML>
308-
--- a/www/guidance/translation_note.m4
+++ /dev/null
@@ -1,286 +0,0 @@
1-m4_dnl # index.m4: GNU m4 source for index.html.
2-m4_dnl # -------------------------------------------------------------------
3-m4_dnl #
4-m4_dnl # [その他に make 時点で依存を参照するファイル]
5-m4_dnl # jf_www.m4: 各種 M4 マクロ定義ファイル
6-m4_dnl #
7-m4_dnl # -------------------------------------------------------------------
8-m4_dnl
9-m4_define(_SUB_ONE)
10-m4_include(../jm_www.m4)
11-_EDIT_WARNING(translation_note)
12-_HEADER(`翻訳の指針')
13-
14-<P>
15- この文章は JM Project における
16- man page 翻訳作業に関する指針です。
17- 翻訳者のみなさんには余計な手間になるとは思いますが、
18- より良い日本語マニュアルを作成するためにご協力ください。
19-</P>
20-
21-<H2>マニュアル本文のフォーマットについて</H2>
22-<P>
23- 本来のフォーマットや著作権を尊重するために、
24- 一次配布フォーマットは roff 形式を採用します。
25- また roff での作業が困難である場合には、
26- その旨を _LINK(mailto:linuxjm-discuss@lists.sourceforge.jp,JM-ML)
27- まで連絡してください。他に roff 化のボランティアを募集します。
28-</P>
29-
30-<P>
31- 全体としての文体の統一のため、
32- 特に理由がなければ常体 (「である」調) を用いてください。
33- マニュアルページの語尾としては、
34-</P>
35-<PRE>
36-「〜だ。」
37-「〜である。」
38-「〜する。」
39-「〜できる。」
40-「〜となる。」
41-</PRE>
42-
43-<P CLASS="noindent">
44- などを使用してください。
45-</P>
46-
47-<P>
48- 句読点は「、」および「。」を使用してください。ただし、英単語や英文の
49- 部分の区切りには「,」「.」を用いてもかまいません。
50-</P>
51-
52-
53-<H2><A NAME="commentize">原文のコメント化</A></H2>
54-<P>
55- 校正作業や改版作業の便宜を図るため、
56- できれば原文をコメントで残しておいてください。
57- ただし「原文に元からあったコメント」と区別するため、
58- 「.\"O」という形式のコメントとしてください
59- (O はアルファベット o の大文字)。
60- 登録システムは、リリース版を作成するときに
61- このコメントを自動的に除去します。
62-</P>
63-
64-<P>
65- コメント化には以下のような内容の
66- _LINK(commentate.awk,awk スクリプト)
67- を用いると良いでしょう。
68-</P>
69-
70-<PRE>
71-#!/usr/bin/awk -f
72-{
73- if ($0 ~ /^\.\\"/) {print}
74- else {printf(".\\\"O %s\n", $0)}
75-}
76-</PRE>
77-
78-<P>
79- これをオリジナルの roff ファイルに対して
80-</P>
81-
82-<pre>
83- awk -f commentate.awk ar.1 &gt; ar.1.draft
84-</pre>
85-
86-<P CLASS="noindent">
87- のように用い、 ar.1.draft に対して作業をします。
88-</P>
89-
90-<P>
91- 以上の作業では原文はすべてコメントアウトされてしまいますが、
92- .TH 行や .TP 行のように、
93- そのまま翻訳版にも残しておきたい行もあると思います。
94- このような行を元に戻す作業には vi を用いるのが楽でしょう。
95- vim 系なら作業ディレクトリに
96-</P>
97-
98-<PRE>
99- map ^T 5xj
100-</PRE>
101-
102-<P>
103- というような内容の .vimrc ファイルを置いておきます (^T は Ctrl-T です)。
104- コメント化した roff ファイルを vi で開き、
105- アンコメントしたい行の先頭で Ctrl-T を打てば、
106- 次々に取っていけます。失敗した場合は u で undo。
107-</P>
108-
109-
110-<H2>著作権表示について</H2>
111-<P>
112- roff 形式において roff のコメントとして書かれている著作権表示は、
113- 英文のまま残してください。
114- さらにその後にコメントとして、
115- 英文で翻訳者の著作権表示を加えてください。
116- 翻訳者の権利表示の例を以下に示します。
117-</P>
118-
119-<PRE>
120-.\"
121-.\" Japanese Version Copyright (c) 1996 HANATAKA Shinya
122-.\" all rights reserved.
123-.\" Translated Wed Nov 20 17:42:39 JST 1996
124-.\" by HANATAKA Shinya
125-</PRE>
126-
127-<P>
128- 本文 (man コマンドの整形結果で見える部分) に著作権表示がある場合には、
129- それも原文のまま残してください。
130-</P>
131-
132-<P>
133- 原文に著作権表示が含まれていない場合には、
134- 個別対応になると思いますので
135- JM@linux.or.jp で相談してください。
136-</P>
137-
138-<P>
139- GNU のマニュアルページにはマニュアルページ中に著作権表示のないもの
140- がありますが、その場合、上記の翻訳版著作権に加えて、以下の文をマニュ
141- アルの先頭に付加してください。
142-</P>
143-
144-<PRE>
145-.\" Copyright (C) 1994-1999 Free Software Foundation, Inc.
146-.\"
147-.\" Permission is granted to make and distribute verbatim copies of
148-.\"this
149-.\"manual provided the copyright notice and this permission notice are
150-.\"preserved on all copies.
151-.\"
152-.\" Permission is granted to copy and distribute modified versions of
153-.\"this manual under the conditions for verbatim copying, provided that
154-.\"the entire resulting derived work is distributed under the terms of a
155-.\"permission notice identical to this one.
156-.\"
157-.\" Permission is granted to copy and distribute translations of this
158-.\"manual into another language, under the above conditions for modified
159-.\"versions, except that this permission notice may be stated in a
160-.\"translation approved by the Foundation.
161-.\"
162-</PRE>
163-
164-
165-<H2>特殊用語の翻訳について</H2>
166-<P>
167- 特殊用語の翻訳は以下の方針に従ってください。
168-</P>
169-<UL>
170- <LI>コマンド名、関数名、引き数名などは翻訳せず、
171- アルファベットのままで記述する。</LI>
172-
173- <LI>英文との相互参照や用語の統一を簡単にするために、
174- 専門用語を翻訳する場合には、
175- 訳語の後ろにかっこつきで原語を併記してください。
176- <PRE>
177-例) 共有メモリ(shared memory)
178- </PRE></LI>
179-
180- <LI>専門用語は無理に日本語にせずカタカナ表記を使用する。
181- <PRE>
182-例) ×記述子(descriptor)
183- ○ディスクリプター(descriptor)
184- </PRE></LI>
185-</UL>
186-
187-<P>
188- マニュアル間での訳語の統一を行うために、
189- できれば専門用語について単語リストを作成してください。
190- 単語リストは、それぞれのマニュアルページの頭に
191- 以下のような roffのコメント形式で埋め込んでください。
192-</P>
193-<PRE>
194-.\"WORD: effective uid 実効ユーザーID
195-.\"WORD: out-of-band 帯域外
196-.\"WORD: physical address 物理アドレス
197-.\"WORD: signal シグナル
198-</PRE>
199-
200-<H2>音引きについて</H2>
201-<P>
202- 片仮名語の語尾の音引き(ー)には以下の方針を用いてください。
203-</P>
204-<UL>
205- <LI>既に日本語になっているものについてはそれを用いる。</LI>
206- <LI>できるだけ原語の発音に近い表現を用いる。
207- <PRE>
208-例) ×メモリー(memory)
209- ○メモリ(memory)
210- </PRE></LI>
211- <LI>それ以外の場合に語尾の音引きは省略しない。
212- <PRE>
213-例) ×コンパイラ(compiler)
214- ○コンパイラー(compiler)
215- </PRE></LI>
216-</UL>
217-
218-<H2>セクション名について</H2>
219-<P>
220- セクション名については以下のものを使用してください。
221-</P>
222-<PRE>
223-ACKNOWLEDGEMENTS 謝辞
224-ARGUMENTS 引き数
225-AUTHOR 著者
226-AUTHORS 著者
227-BUGS バグ
228-CAVEATS 警告
229-COMMAND LINE OPTIONS オプション
230-COMPATIBILITY 移植性
231-CONFORMING TO 準拠
232-CONFORMS TO 準拠
233-COPYING 著作権
234-COPYRIGHT 著作権
235-DESCRIPTION 説明
236-DIAGNOSTICS 返り値
237-ENVIRONMENT 環境変数
238-ENVIRONMENT VARIABLES 環境変数
239-ERROR エラー
240-ERRORS エラー
241-EXAMPLE 例
242-EXAMPLES 例
243-EXIT CODES 返り値
244-EXTENSION 拡張
245-EXTENSIONS 拡張
246-FILES ファイル
247-FLAGS フラグ
248-HISTORY 履歴
249-KEYWORDS キーワード
250-LIMITATIONS 制限
251-NAME 名前
252-NOTE 注意
253-NOTES 注意
254-OPTION オプション
255-OPTIONS オプション
256-PARAMETERS 引き数
257-PORTABILITY 移植性
258-RESTRICTIONS 制限
259-RETURN VALUE 返り値
260-SEE ALSO 関連項目
261-SOLICITATION 要請
262-STANDARDS 準拠
263-SYNOPSIS 書式
264-SYNTAX 書式
265-VERSION バージョン
266-WARNING 警告
267-WARNINGS 警告
268-</PRE>
269-
270-<P>
271- その他、何かありましたら
272- JM@linux.or.jp まで問い合わせてください。
273-</P>
274-
275-_CREDITS
276-
277- <P>
278- <IMG SRC="../images/grey.png" WIDTH="14" ALT="* " HEIGHT="14">
279- _LINK(index.html,JM 翻訳作業の手引きに戻る)
280- </P>
281-
282-_BACK_TO_HOME
283-
284-</BODY>
285-</HTML>
286-