GnuCash 文書の作成
もしあなたが GnuCash 文書を改善することに興味を持っているなら、あなたは正しい場所に来ました。このページは開始するのに必要な情報をあなたに提供するでしょう。
GnuCash アプリケーションがボランティアによって長い間に開発されてきたのとまさに同様に、他の人たちが GnuCash をどのように利用するか学ぶのを助けるための文書がボランティアの開発者と利用者によって書かれてきました。この協力的な努力により、ヘルプマニュアルとチュートリアル・ コンセプトガイドという２つの主要な文書が作成されました。
GnuCash コミュニティーはプログラムとその文書両方を維持・管理し、そして改善することについての支援を歓迎します。もしあなたが GnuCash 文書の執筆、編集、あるいは翻訳を手伝うことに興味を持っているなら、このページは、取り組みに参加するためにどのように準備するかに関するガイダンスを提供します。
GnuCash 文書は文書ページで参照とダウンロードをすることができます。
導入
GnuCash の文書は xml ファイルとして保存されています。もっと正確に言うと、docbook システムを使用しています。これは比較的柔軟なシステムで xml ファイルを入力としていくつかの異なる形式 (html、pdf等) で出力することができます。
GnuCash の文書を査読または記述するときは xml を知っている必要があります。加えて、いくつかの docbook システムに関する基本的な知識も役に立ちます。
次のリンクは文書化および査読過程で非常に役に立つサイトです。
- DocBook: The Definitive Guide
- DocBook XSL: The Complete Guide
- GNOME Human Interface Guidelines
- Translating_the_GnuCash_Guide_and_Help: この GnuCash wiki ページはこれから翻訳が必要ですが、docbook ファイルを使用するために役に立つ情報が含まれています。
- Documentation_Update_Instructions: どのように文書（更新と保守）に取り組むべきかについての詳細な手引き。
次のメーリングリストを購読することも提案します gnucash-devel.
Gnome 文書ガイドライン
前に述べたように、新しい文書は docbook システムに基づいています。貢献をしようと考えている方は、査読や文書作成を行うときにこれらのガイドに従うようにしてください。
文書ソースの入手
文書ソースの最新版を入手する必要がある場合は gnucash-docs git レポジトリから文書モジュールをチェックアウトしてください。査読者は最新の文書 tar アーカイブから開始しても構いません。
もし git にあまりなじみがないなら、GnuCash wiki に説明が GnuCash のコードについて書いてあります。プログラムのソースではなく文書を得るには、書かれている git コマンドにある 'gnucash' を 'gnucash-docs' に単に置き換えてください。実際には以下のようになります。
git clone https://github.com/Gnucash/gnucash-docs.git
利用者を助ける２つの主要な GnuCash 文書パッケージがあります: ヘルプマニュアルとチュートリアル・コンセプトガイドです。上記のコマンドで、両方のソースコードがダウンロードされるでしょう。
著者
上記の方法で文書のソースを入手したら、変更を開始してください。変更した文書が満足のいく物になったら文書の最上位ディレクトリ (通常は変更しない限り gnucash-docs になります) で以下のコマンドを入力してパッチを作成してください。
git diff > my-patch-name.patch
次に GnuCash のバグデータベースで Documentation 製品の適切なコンポーネントに対してバグレポートを作成し、パッチを添付してください。パッチ送付の詳細については GnuCash' wiki page on bugzilla も併せて確認してください。
注意: 過去にはパッチを直接 gnucash-devel メーリングリストに送っても大丈夫でした。この方法は現在推奨されません。多くのメーリングリスト議論の中に埋もれてパッチが忘れられてしまうからです。その代わり Bugzilla にパッチをバグとして添付してください (既存のバグに追加するか新規のバグとして報告するかいずれかです)。もしパッチを gnucash-devel に送ろうと考えている場合は、インラインに記述するのではなく添付してください。
あなたがどの項を変更しようとしているか他の著者が分かるようにしてください。他の人が「それはすでに行っています」または「では行ってください」と言うことができるように gnucash-devel へメールを送ってください。
書いている時に、参照用として古い文書をローカルに保存しておきたいと思うかもしれません。これは古い文書内に新しい文書に移行されていない多くの役に立つ情報がある場合です。
査読者
上で説明した方法で文書のソースを入手し、査読を行ってください。
文書に関するコメントを記録して、皆が見つけられるようにしておく最良の方法は bugs.gnucash.org に文書に関してバグ登録をしておくことです。これは bug-buddy を使って行うこともできます。
