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

Back to archive index
Akihiro Motoki amoto****@gmail*****
2021年 4月 9日 (金) 19:50:44 JST


元木です。

On Fri, Apr 9, 2021 at 3:41 PM 長南洋一 <cyoic****@maple*****> wrote:
>
> 長南です。
>
> 文案を拝見しました。このぐらい簡単でよいと思います。

確認ありがとうございます。

> ただ、「git repository の取り出し方 (取り出す)」とお書きになっていますが、
> これはよくある言い方なんですか。clone と言ってしまって、構わないのではないで
> しょうか。

定番の言い方はないと思います。
「取り出す」って言い方は、以前のバージョン管理システムの CVS や subversion を
使っていたときの自分の中での名残です。cvs checkout / svn checkout で手元に
リポジトリを取得していたので。

> それから、repository、リポジトリ、レポジトリ、どれでもよいけれど、
> ガイド中で統一しておいた方がよいと思います。

これは統一しておきました。

> 「備考」「JM git repository の取り出し方」は、LDP man-pages と
> GNU_coreutils の翻訳ガイドでも、管理ガイドでも必要な情報ですから、
> 独立したセクションにして、文書群の先頭に出した方がよいのではないでしょうか。
> 一例を挙げると、こんな感じです。sphinx の書き方をよく知らないので、
> 変なところがあっても、大目に見てください。

長南さんの提案を取り込んだ上で、少し内容を調整しました。
私が調整した内容は ↓ です。
https://github.com/amotoki/jm/commit/10cfceaf814e1403345163ef178fc6a2c2894779
リポジトリ、レポジトリ、repository のゆらぎ解消は ↓
https://github.com/amotoki/jm/commit/b360c3e794dec78cb51c219a6b5bc0140a3d3cad

これらを全部反映した HTML 変換後の内容はここで確認できます。
https://amotoki.github.io/jm/

JM リポジトリにはコミットしていません。

以上です。

>
> まず、guide/index.rst の「翻訳ガイド」の上に、こんな風に書いておきます。
>
>     ---- 引用 ----
> はじめに
> ========
>
> .. toctree::
>    :maxdepth: 1
>
>    basic_info.rst
>
>     ---- 引用終わり ----
>
> それから、次の内容の basic_info.rst を作ります。
>
>     ---- 引用 ----
> ========
> 一般情報
> ========
>
> JM では、原稿の管理に git ジポリトリを使用していますが、マニュアルを翻訳するために
> JM の共有リポジトリをローカルにコピーしておく必要は必ずしもありません。
> 一般の man ページについては、今まで通り、開発元から原文の roff
> ファイルを入手し、それを翻訳して、投稿してくだされば十分です
> (更新するときの便宜を考えて、翻訳に po4a(7) の使用を推奨していますけれど)。
>
> しかし、プロジェクトの管理はもちろん、LDP man-pages や GNU_coreutils
> のマニュアルの翻訳や管理、それにガイドドキュメントの執筆・編集をするには、
> JM のリポジトリをローカルにコピーしておく必要があります。それには、git
> コマンドを使って、リポジトリの clone をします。
>
> git のプロトコルには、読み出し専用なら、git と http が使えます。
> 読み書き両用には、ssh か https を使用します。https を使用する場合は、
> 次のように指定します (ssh を使う場合は、URLの scn.osdn.jp の部分を
> git.osdn.jp に書き換えてください)。
>
> .. code-block:: console
>
>     $ git clone https://scn.osdn.jp/linuxjm/jm.git
>
> こうすると、カレントディレクトリの jm/ というディレクトリ以下に、JM
> のローカルリポジトリが作られます。
>
> ローカルリポジトリでした変更を JM の共有ディレクトリに書き込むには、
> 公開鍵を作成して、osdn に登録しておく必要があります。その方法については、
> https://ja.osdn.net/docs/Register_PublicKey をご覧になってください。
>
> なお、自分が作成した man ページを確認したいときは、man
> コマンドを使いますが、単に "man -l ./sample.1" などでは、日本語の整形が乱れます。
>
>   (echo .mso ja.tmac; cat ./sample.1) | man -l -
>
> などとしてみてください。
>
>     ---- 引用終わり ----
>
> 文書群全体を見ると、セクション同士とのつながりが悪いところや、URL が
> sourceforge になっているところなんかももあるでしょうが、それはおいおい
> 直していくことにして、とりあえず、上のようなセクションを作っておけば、
> 当座の用に足りるのではないでしょうか。
>
> --
> 長南洋一
>
> _______________________________________________
> linuxjm-discuss mailing list
> linux****@lists*****
> https://lists.osdn.me/mailman/listinfo/linuxjm-discuss


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