[JM:02117] Re: ドキュメント編集メモのページを書き直してみました

Back to archive index
長南洋一 cyoic****@maple*****
2021年 3月 27日 (土) 09:25:09 JST


長南です。

原稿は使用することになるかもしれないわけですから、メールに添付してください。
手元にないと、チェックしにくいですし。

JM の共有リポジトリ (リモートリポジトリと書いている方もいます) の URL を
どこかにはっきり書いておきたかったのですね。私も賛成です。

ただ、共有リポジトリの URL は、ここで必要なだけでなく、プロジェクトの
管理はもちろん、LDP man_pages や GNU_coreutils の man page の
翻訳でも必要な情報ですから、index.html の一番上、つまり「翻訳ガイド」の
上に「基本情報」といったセクションを作って (もっと適切な名前や場所があるかも
しれません)、そちらに書いておいた方がよいと思います。そことここと両方に
あってもよいでしょう。

私は、sphinx については何も知らないので、具体的な文章はおまかせしますが、
「基本情報」というセクションを作るとして、書いておくべき情報は、もちろん、
リポジトリの URL。それに、「jm のリポジトリをローカルにコピーしておくことは、
翻訳原稿を投稿するのに必ずしも必要ではないが、プロジェクトの管理はもちろん、
LDP man-pages や GNU_coreutils のマニュアルページの翻訳、それに
ガイドドキュメントの執筆・編集には必要である」と言った情報は、書いておく
べきでしょう。

管理者が osdn にある共有リポジトリに git push するためには、
公開鍵を作成して登録しておく必要があることも、書いておいた方がよいと
思います。「詳しくは、https://ja.osdn.net/docs/Register_PublicKey
を見よ」で十分かもしれません (このページは、URL を書く以外には、どんなふうに
紹介・説明したらよいのでしょう)。書いておく位置は、「投稿された man ページの
レポジトリへの登録方法」の「6. sourceforge.jp の git repo に push
します」のあたりでしょうか。なお、この部分、まだ URL が sourceforge.jp
になっています (ほかにもあるかもしれません)。

それから、元木さんへのメールにも書いたことですが、作成した日本語 man を
読むには、

  (echo .mso ja.tmac; cat manfile) |man -l -

とすると日本語の整形がまともになるというのも、どこかに書いておきたいと
思います。そうでないと、自分が翻訳した man page を man コマンドで見て、
整形に失敗しているんじゃないかと、心配する方もいらっしゃるでしょうから。
確かに、元木さんがおっしゃるように、これは、作成した日本語 man page の
読み方という一般的な知識ですから、「LDP man-pages 翻訳ガイド」よりも
もっとふさわしい場所がありそうですが、それはどこなのか。
適当なところが見つからないなら、「LDP man-pages 翻訳ガイド」でも
よさそうに思います。どこであれ、書いてあった方がよいことですから。

必要な sphinx パッケージは debian の場合は、pyton3 版なら、
python3-sphinx と python3-sphinx-bootstrap-theme、
python2 なら、python-sphinx と python-sphinx-bootstrap-theme
です。ubuntu や RedHat 系はどうなんでしょうか。

> build 方法
> ----------
>
> カレントディレクトリに、先にダウンロードしたファイルが含まれるディレクトリ
> jm があるとします。まず、ドキュメントが含まれるサブディレクトリまで移動します。
> 次に、make を実行し、表示用のファイルを作成します。

ちょっとゴタゴタしてしまったようですね。もっと簡単でよいのではありませんか。
たとえば、

  ローカルリポジトリの jm/guide に移動し、make を実行して、sphinx の
  rst ファイルから html ファイルを作成します。

「ローカルリポジトリ」という言葉が唐突かなあ。まあ、これは例ですから、
もうちょっと全体のつながりのよい表現を考えてください。

-- 
長南洋一



linuxjm-discuss メーリングリストの案内
Back to archive index