Docs/Manual/JP/About_Doc.xml

   1 <?xml version="1.0" encoding="UTF-8"?>
   2 <article id="About_Doc">
   3   <title>WinMergeヘルプについて</title>
   4
   5   <para>このドキュメントはWinMerge &WinMergeVersion; のヘルプです。</para>
   6
   7   <section>
   8     <title>対象読者と範囲</title>
   9
  10     <para>WinMergeヘルプは、新しいユーザーと経験豊かなユーザー両方を対象としています。
  11     WinMergeヘルプは、WinMergeの使い方を説明し、能力と限界を文書化します。
  12     </para>
  13   </section>
  14
  15   <section>
  16     <title>ヘルプへのアクセス方法</title>
  17
  18     <para>WinMergeヘルプトピックは、2つの形式で提供されます:</para>
  19
  20     <itemizedlist>
  21       <listitem>
  22         <para>Microsoft HTML ヘルプ (<filename>WinMerge.chm</filename>),
  23         インストールディレクトリのWinMerge\Docsにあります。</para>
  24       </listitem>
  25
  26       <listitem>
  27         <para>WinMergeウェブサイトのHTML マニュアル</para>
  28       </listitem>
  29     </itemizedlist>
  30
  31     <para>以下のいくつかの方法でWinMergeヘルプにアクセスできます:</para>
  32
  33     <variablelist>
  34       <varlistentry>
  35         <term>WinMergeヘルプメニュー</term>
  36
  37         <listitem>
  38           <para>WinMerge使用中に、<menuchoice>
  39               <guimenu>ヘルプ</guimenu>
  40
  41               <guimenuitem>WinMergeヘルプ</guimenuitem>
  42             </menuchoice>をクリックします。 HTMLヘルプの最初(このトピック)が開かれます。</para>
  43         </listitem>
  44       </varlistentry>
  45
  46       <varlistentry>
  47         <term>状況依存のヘルプ</term>
  48
  49         <listitem>
  50           <para>何らかのWinMergeウインドウを使用中に、F1を押してください。
  51           現在のウインドウに関するトピックがあれば、そのトピックのヘルプを開きます。 もしなければ、最初のトピックを開きます。
  52           </para>
  53         </listitem>
  54       </varlistentry>
  55
  56       <varlistentry>
  57         <term>WinMergeコマンドライン</term>
  58
  59         <listitem>
  60           <para>コマンドラインからWinMergeを実行しているときは、/?か -?スイッチを使用してください。
  61           HTMLヘルプが最初のトピックを開きます。</para>
  62         </listitem>
  63       </varlistentry>
  64
  65       <varlistentry>
  66         <term>WinMergeウェブサイト</term>
  67
  68         <listitem>
  69           <para><ulink
  70           url="https://winmerge.org/">winmerge.org</ulink>をブラウザーで開いてください。<ulink
  71           url="https://winmerge.org/docs/">Documentation</ulink>の
  72           <ulink url="https://manual.winmerge.org/">Manual</ulink>
  73           リンクをたどってください。 最新版のヘルプが開きます。</para>
  74         </listitem>
  75       </varlistentry>
  76     </variablelist>
  77   </section>
  78
  79   <section>
  80     <title>ヘルプの使い方</title>
  81
  82     <para>最も重要なWinMergeの基本を学ぶために、次のトピックを読んでください。
  83     </para>
  84
  85     <variablelist>
  86       <varlistentry>
  87         <term><xref linkend="Quick_start" /></term>
  88
  89         <listitem>
  90           <para>WinMergeを手早く使い始められるようにし、基本的な使用方法を示します。
  91           </para>
  92         </listitem>
  93       </varlistentry>
  94
  95       <varlistentry>
  96         <term><xref linkend="Compare_dirs" /></term>
  97
  98         <listitem>
  99           <para>フォルダー比較ウインドウでの可能な操作、結果表示のカスタマイズの仕方を説明します。
 100           </para>
 101         </listitem>
 102       </varlistentry>
 103
 104       <varlistentry>
 105         <term><xref linkend="Compare_files" /></term>
 106
 107         <listitem>
 108           <para>ファイル比較・マージウインドウでの可能な操作、ナビゲーションの方法、モードについて説明します。
 109           </para>
 110         </listitem>
 111       </varlistentry>
 112
 113       <varlistentry>
 114         <term><xref linkend="Compare_images" /></term>
 115
 116         <listitem>
 117           <para>画像比較・マージウインドウについて説明します。</para>
 118         </listitem>
 119       </varlistentry>
 120
 121       <varlistentry>
 122         <term><xref linkend="Compare_bin" /></term>
 123
 124         <listitem>
 125           <para>HEX比較・マージウインドウについて説明します。</para>
 126         </listitem>
 127       </varlistentry>
 128
 129       <varlistentry>
 130         <term><xref linkend="Compare_table" /></term>
 131
 132         <listitem>
 133           <para>テーブル比較・マージウインドウについて説明します。</para>
 134         </listitem>
 135       </varlistentry>
 136
 137       <varlistentry>
 138         <term><xref linkend="Compare_webpages" /></term>
 139
 140         <listitem>
 141           <para>Webページ比較ウインドウについて説明します。</para>
 142         </listitem>
 143       </varlistentry>
 144
 145       <varlistentry>
 146         <term><xref linkend="Configuration" /></term>
 147
 148         <listitem>
 149           <para>空白、色、テキストエンコーディングの取り扱いを含めたWinMergeの設定方法について説明します。
 150           </para>
 151         </listitem>
 152       </varlistentry>
 153     </variablelist>
 154
 155     <para>もっと詳細にWinMergeについて学習したい場合、次のトピックを読んでください:</para>
 156
 157     <variablelist>
 158       <varlistentry>
 159         <term><xref linkend="Open_paths" /></term>
 160
 161         <listitem>
 162           <para>WinMergeでファイルとフォルダーを開くいくつかの方法(たくさんあります!)について紹介します。
 163           例えば、詳細モードでのシェル拡張コンテキストメニューの使い方を知っていますか?
 164           </para>
 165         </listitem>
 166       </varlistentry>
 167
 168       <varlistentry>
 169         <term><xref linkend="Plugins" /></term>
 170
 171         <listitem>
 172           <para>プラグイン機構を使用してWinMergeに追加できるオプション機能について説明します。
 173           </para>
 174         </listitem>
 175       </varlistentry>
 176
 177       <varlistentry>
 178         <term><xref linkend="Filters" /></term>
 179
 180         <listitem>
 181           <para>フォルダーやファイル比較ウインドウで比較される対象を制御する方法を説明します
 182           </para>
 183         </listitem>
 184       </varlistentry>
 185
 186       <varlistentry>
 187         <term><xref linkend="Command_line" /></term>
 188
 189         <listitem>
 190           <para>他のツールと連携やスクリプトから起動するときに使用できるコマンドラインパラメーターを記載します。
 191           </para>
 192         </listitem>
 193       </varlistentry>
 194
 195       <varlistentry>
 196         <term><xref linkend="Faq" /></term>
 197
 198         <listitem>
 199           <para>開発者に尋ねられたたくさんの共通的な質問に対する回答を含んでいます。
 200           </para>
 201
 202           <para>質問を<ulink
 203           url="https://github.com/WinMerge/winmerge/">GitHub</ulink>,
 204           にする前に、<xref linkend="Faq" />トピックで質問が回答されていないか確認してください。
 205           </para>
 206         </listitem>
 207       </varlistentry>
 208     </variablelist>
 209   </section>
 210
 211   <section>
 212     <title>ドキュメント表記規則<indexterm>
 213         <primary>conventions, documentation</primary>
 214       </indexterm></title>
 215     <para></para>
 216     <informaltable>
 217       <tgroup cols="2">
 218         <thead>
 219           <row>
 220             <entry>例</entry>
 221
 222             <entry>意味</entry>
 223           </row>
 224         </thead>
 225
 226         <tbody>
 227           <row>
 228             <entry>フィールドに<userinput>UTF-8</userinput>と入力してください。<para>パスを辿るために、
 229             <guibutton>参照</guibutton>ボタンをクリックしてください。
 230             </para><para>ウィンドウを更新するために、<keycap>F5</keycap>を一回押下してください。
 231             </para></entry>
 232
 233             <entry>説明文中のボールドフォントは、以下の内容を表します:<itemizedlist>
 234                 <listitem>
 235                   <para>入力を指示された、値、または、
 236                   文字列</para>
 237                 </listitem>
 238
 239                 <listitem>
 240                   <para>GUIボタンかキーの名前</para>
 241                 </listitem>
 242               </itemizedlist></entry>
 243           </row>
 244
 245           <row>
 246             <entry><keycombo>
 247                 <keycap>Ctrl</keycap>
 248
 249                 <keycap>O</keycap>
 250               </keycombo>を押下してください</entry>
 251
 252             <entry><wordasword>押下</wordasword>は、キーボード操作を表します。
 253             この例では、<keycap>Ctrl</keycap>と
 254             <keycap>O</keycap>キーの組み合わせで押下します。</entry>
 255           </row>
 256
 257           <row>
 258             <entry><para><guibutton>OK</guibutton>をクリックしてください。</para></entry>
 259
 260             <entry>クリックは、メニューアイテムやボタンの様な対象の上での、マウスの左クリックを表します。
 261             </entry>
 262           </row>
 263
 264           <row>
 265             <entry><menuchoice>
 266                 <guimenu>ファイル</guimenu>
 267
 268                 <guimenuitem>開く</guimenuitem>
 269               </menuchoice>をクリックしてください。</entry>
 270
 271             <entry>矢印は、メニューを表します。この例では、WinMergeの
 272             <guimenu>ファイル</guimenu>メニューの中の
 273             <guimenuitem>開く</guimenuitem>を選択してください。</entry>
 274           </row>
 275
 276           <row>
 277             <entry>行を右クリックして、
 278             <guimenuitem>比較</guimenuitem>ショートカットを選択してください。</entry>
 279
 280             <entry>
 281             コンテキストメニューを開くために、対象の上で右クリックしてください。そして、コンテキストメニュー中のアイテムを、左か右クリックしてください。
 282             </entry>
 283           </row>
 284
 285           <row>
 286             <entry><replaceable>options file</replaceable>.iniを入力してください。<para>
 287             操作対象からファイルを除外するために<guilabel>フィルター</guilabel>フィールドを使用してください。
 288             </para><para>連続した1つかそれ以上の差異行は、一つの差異(または
 289             <glossterm>diff差分</glossterm>)を形成します。</para></entry>
 290
 291             <entry>イタリック体のテキストは、次の内容を表します: <itemizedlist>
 292                 <listitem>
 293                   <para>
 294                   置き換え可能な値、または、文字列。
 295                   最初の例では、イタリック体の語句の代わりに実際のファイル名を用いるでしょう。
 296                   <!-- TODO: 何がいいたい？ enter the <filename>ini</filename> file extension, which is not italicized, as written.--></para>
 297                 </listitem>
 298
 299                 <listitem>
 300                   <para>WinMerge ウィンドウ内のフィールド、メニュー、コントロールの名前です。
 301                   </para>
 302                 </listitem>
 303
 304                 <listitem>
 305                   <para>重要な単語、または、フレーズです。</para>
 306                 </listitem>
 307               </itemizedlist></entry>
 308           </row>
 309
 310           <row>
 311             <entry>パス<envar>%WORKDIR%\project1</envar>は、
 312             <filename
 313             class="directory">C:\workfiles\project1</filename>に展開されます。<para><screen
 314             format="linespecific">TwoWords</screen></para></entry>
 315
 316             <entry>等幅のテキストは、次の内容を表します:<itemizedlist>
 317                 <listitem>
 318                   <para>パス、ファイル名、または、その他のシステム項目</para>
 319                 </listitem>
 320
 321                 <listitem>
 322                   <para>サンプルコードの一部</para>
 323                 </listitem>
 324
 325                 <listitem>
 326                   <para>サンプル出力</para>
 327                 </listitem>
 328
 329                 <listitem>
 330                   <para>フォームかコマンドライン上で入力する情報
 331                   </para>
 332                 </listitem>
 333               </itemizedlist></entry>
 334           </row>
 335
 336           <row>
 337             <entry><cmdsynopsis sepchar=" ">
 338                 <command moreinfo="none">command</command>
 339
 340                 <arg choice="plain"
 341                 rep="norepeat"><replaceable>inputpath</replaceable></arg>
 342
 343                 <arg choice="opt"
 344                 rep="norepeat"><replaceable>outputpath</replaceable></arg>
 345               </cmdsynopsis></entry>
 346
 347             <entry>シンタックス行では、ブラケット(大括弧)は省略可能な要素を表します。
 348               この例では、コマンドと入力パスを入力しなければなりません。
 349               出力パスも入力できますが、入力しなくてもコマンドは有効です。</entry>
 350           </row>
 351         </tbody>
 352       </tgroup>
 353     </informaltable>
 354     <para></para>
 355   </section>
 356 </article>