OSDN Git Service

Improve plugin system (#797)
[winmerge-jp/winmerge-jp.git] / Docs / Manual / EN / Plugins.xml
index a70b30a..babd607 100644 (file)
@@ -81,7 +81,7 @@
           </note>
 
           <para>Example plugin: <xref linkend="CompareMSExcelFiles" />
-          Displays the text contents of a 
+          displays the text contents of a 
           <trademark class="registered">Microsoft</trademark>
           <application>Excel</application> file.</para>
         </listitem>
 
       <itemizedlist>
         <listitem>
-          <para><function>MakeUpper</function></para>
+          <para><function>Make Uppercase</function></para>
         </listitem>
 
         <listitem>
-          <para><function>MakeLower</function></para>
+          <para><function>Make Lowercase</function></para>
         </listitem>
 
         <listitem>
-          <para><function>SortAscending</function></para>
+          <para><function>Sort Lines Ascending</function></para>
         </listitem>
 
         <listitem>
-          <para><function>SortDescending</function></para>
+          <para><function>Sort Lines Descending</function></para>
         </listitem>
 
         <listitem>
-          <para><function>ExecFilterCommand</function></para>
+          <para><function>Apply Filter Command...</function></para>
         </listitem>
 
         <listitem>
-          <para><function>InsertDate</function></para>
+          <para><function>Insert Date</function></para>
         </listitem>
 
         <listitem>
-          <para><function>InsertTime</function></para>
+          <para><function>Insert Time</function></para>
         </listitem>
       </itemizedlist>
 
       <title>Applying prediffer plugins in the Folder Compare window</title>
 
       <para>With prediffer plugins, you set the mode (<firstterm>Auto
-      prediiffer</firstterm> or <firstterm>No prediffer</firstterm>) for
+      prediffer</firstterm> or <firstterm>No prediffer</firstterm>) for
       individual files. (Contrast this with unpacker plugins, where you set the
       mode for all files.) That is, some files in the same folder have different
       prediffer modes.</para>
     <section>
       <title>Applying prediffer plugins in the File Compare window</title>
 
-      <para>In the File Compare winodw, you can apply a prediffer plugin by
+      <para>In the File Compare window, you can apply a prediffer plugin by
       clicking <menuchoice>
           <guimenu>Plugins</guimenu>
 
       </indexterm></title>
 
     <section id="CompareMSExcelFiles">
-      <title><filename>CompareMSExcelFiles.sct<indexterm>
-          <primary>CompareMSExcelFiles.sct plugin file</primary>
+      <title><filename>CompareMSExcelFiles<indexterm>
+          <primary>CompareMSExcelFiles plugin file</primary>
         </indexterm></filename></title>
 
       <para>Displays the text contents of a <trademark
 
           <segtitle>File filter</segtitle>
 
+          <segtitle>Plugin argument</segtitle>
+
           <segtitle>Packing</segtitle>
 
           <segtitle>Settings dialog support</segtitle>
           <seglistitem>
             <seg>Unpacker</seg>
 
-            <seg><filename class="extension">*.xls</filename><filename
-            class="extension">*.xlsx</filename><filename
-            class="extension">*.xlsm</filename><filename
-            class="extension">*.xlsb</filename><filename
-            class="extension">*.xla</filename><filename
-            class="extension">*.xlax</filename><filename
-            class="extension">*.xltx</filename><filename
+            <seg><filename class="extension">*.xls</filename><filename
+            class="extension">*.xlsx</filename><filename
+            class="extension">*.xlsm</filename><filename
+            class="extension">*.xlsb</filename><filename
+            class="extension">*.xla</filename><filename
+            class="extension">*.xlax</filename><filename
+            class="extension">*.xltx</filename><filename
             class="extension">*.xltm</filename></seg>
 
             <seg>No</seg>
 
+            <seg>No</seg>
+
             <seg>Yes</seg>
 
             <seg><trademark class="registered">Microsoft</trademark>
         </segmentedlist></para>
     </section>
 
-    <section id="Plugins_msword">
-      <title><filename>CompareMSWordFiles.sct<indexterm>
-          <primary>CompareMSWordFiles.sct plugin file</primary>
+    <section id="Plugins_powerpnt">
+      <title><filename>CompareMSPowerPointFiles<indexterm>
+          <primary>CompareMSPowerPointFiles plugin file</primary>
         </indexterm></filename></title>
 
       <para>Displays the text content of a <trademark
-      class="registered">Microsoft</trademark> <application>Word</application>
+      class="registered">Microsoft</trademark> <application>PowerPoint</application>
       file, stripping away all formatting and embedded objects.</para>
 
       <para><segmentedlist>
 
           <segtitle>File filter</segtitle>
 
+          <segtitle>Plugin argument</segtitle>
+
           <segtitle>Packing</segtitle>
 
           <segtitle>Settings dialog support</segtitle>
           <seglistitem>
             <seg>Unpacker</seg>
 
-           <seg><filename class="extension">*.doc</filename>, <filename
-            class="extension">*.docx</filename>, <filename
-            class="extension">*.docm</filename>, <filename
-            class="extension">*.dot</filename>, <filename
-            class="extension">*.dotx</filename>, <filename
-            class="extension">*.dotm</filename></seg>
+            <seg><filename class="extension">*.ppt</filename>, <filename
+            class="extension">*.pptx</filename>, <filename
+            class="extension">*.pptm</filename>, <filename
+            class="extension">*.ppa</filename>, <filename
+            class="extension">*.ppam</filename>, <filename
+            class="extension">*.pot</filename>, <filename
+            class="extension">*.potx</filename>, <filename
+            class="extension">*.potm</filename></seg>
+
+            <seg>No</seg>
 
             <seg>No</seg>
 
             <seg>Yes</seg>
 
             <seg><trademark class="registered">Microsoft</trademark>
-            <application>Word</application></seg>
+            <application>PowerPoint</application></seg>
           </seglistitem>
         </segmentedlist></para>
     </section>
 
-    <section id="Plugins_powerpnt">
-      <title><filename>CompareMSPowerPointFiles.sct<indexterm>
-          <primary>CompareMSPowerPointFiles.sct plugin file</primary>
+    <section id="Plugins_visio">
+      <title><filename>CompareMSVisioFiles<indexterm>
+          <primary>CompareMSVisioFiles plugin file</primary>
         </indexterm></filename></title>
 
       <para>Displays the text content of a <trademark
-      class="registered">Microsoft</trademark> <application>PowerPoint</application>
+      class="registered">Microsoft</trademark> <application>Visio</application>
       file, stripping away all formatting and embedded objects.</para>
 
       <para><segmentedlist>
 
           <segtitle>File filter</segtitle>
 
+          <segtitle>Plugin argument</segtitle>
+
           <segtitle>Packing</segtitle>
 
           <segtitle>Settings dialog support</segtitle>
           <seglistitem>
             <seg>Unpacker</seg>
 
-            <seg><filename class="extension">*.ppt</filename>, <filename
-            class="extension">*.pptx</filename>, <filename
-            class="extension">*.pptm</filename>, <filename
-            class="extension">*.ppa</filename>, <filename
-            class="extension">*.ppam</filename>, <filename
-            class="extension">*.pot</filename>, <filename
-            class="extension">*.potx</filename>, <filename
-            class="extension">*.potm</filename></seg>
+            <seg><filename class="extension">*.vsd</filename>, <filename
+            class="extension">*.vsdx</filename>, <filename
+            class="extension">*.vsdm</filename>, <filename
+            class="extension">*.vss</filename>, <filename
+            class="extension">*.vssx</filename>, <filename
+            class="extension">*.vssm</filename>, <filename
+            class="extension">*.vst</filename>, <filename
+            class="extension">*.vstx</filename>, <filename
+            class="extension">*.vstm</filename></seg>
+
+            <seg>No</seg>
 
             <seg>No</seg>
 
             <seg>Yes</seg>
 
             <seg><trademark class="registered">Microsoft</trademark>
-            <application>PowerPoint</application></seg>
+            <application>Visio</application></seg>
           </seglistitem>
         </segmentedlist></para>
     </section>
 
-    <section id="EditorAddin">
-      <title><filename>editor addin.sct<indexterm>
-          <primary>editor addin.sct plugin file</primary>
+    <section id="Plugins_msword">
+      <title><filename>CompareMSWordFiles<indexterm>
+          <primary>CompareMSWordFiles plugin file</primary>
         </indexterm></filename></title>
 
-      <para>Adds five functions to the <menuchoice>
-          <guimenu>Plugins</guimenu>
-
-          <guisubmenu>Scripts</guisubmenu>
-        </menuchoice> menu:</para>
-
-      <itemizedlist>
-        <listitem>
-          <simpara><guimenuitem>MakeUpper</guimenuitem> convert the selection to
-          UPPER CASE.</simpara>
-        </listitem>
+      <para>Displays the text content of a <trademark
+      class="registered">Microsoft</trademark> <application>Word</application>
+      file, stripping away all formatting and embedded objects.</para>
 
-        <listitem>
-          <simpara><guimenuitem>MakeLower</guimenuitem> convert the selection to
-          lower case.</simpara>
-        </listitem>
+      <para><segmentedlist>
+          <segtitle>Category</segtitle>
 
-        <listitem>
-          <simpara><guimenuitem>SortAscending</guimenuitem> sort the selection 
-          in ascending order.</simpara>
-        </listitem>
+          <segtitle>File filter</segtitle>
 
-        <listitem>
-          <simpara><guimenuitem>SortDescending</guimenuitem> sort the selection 
-          in descending order.</simpara>
-        </listitem>
+          <segtitle>Plugin argument</segtitle>
 
-        <listitem>
-          <simpara><guimenuitem>ExecFilterCommand</guimenuitem> replace the selection 
-          with the output of the specified filter command.</simpara>
-        </listitem>
-      </itemizedlist>
+          <segtitle>Packing</segtitle>
 
-      <para><segmentedlist>
-          <segtitle>Category</segtitle>
           <segtitle>Settings dialog support</segtitle>
 
+          <segtitle>Dependency</segtitle>
+
           <seglistitem>
-            <seg>Editor complement</seg>
+            <seg>Unpacker</seg>
+
+           <seg><filename class="extension">*.doc</filename>, <filename
+            class="extension">*.docx</filename>, <filename
+            class="extension">*.docm</filename>, <filename
+            class="extension">*.dot</filename>, <filename
+            class="extension">*.dotx</filename>, <filename
+            class="extension">*.dotm</filename></seg>
+
             <seg>No</seg>
+
+            <seg>No</seg>
+
+            <seg>Yes</seg>
+
+            <seg><trademark class="registered">Microsoft</trademark>
+            <application>Word</application></seg>
           </seglistitem>
         </segmentedlist></para>
     </section>
 
     <section id="IgnoreColumns">
-      <title><filename>IgnoreColumns.dll<indexterm>
-          <primary>IgnoreColumns.dll plugin file</primary>
+      <title><filename>IgnoreColumns<indexterm>
+          <primary>IgnoreColumns plugin file</primary>
         </indexterm></filename></title>
 
       <para>This plugin ignores characters at specified columns. The first
-      column is number 1</para>
+      column is number 1.</para>
 
       <para>Note that this plugin does not support files with tabs: the plugin
       does not fail, but all tabs are be treated as normal characters.</para>
       </itemizedlist>
 
       <example>
-        <title><filename>IgnoreColumns.dll</filename> examples</title>
+        <title><filename>IgnoreColumns</filename> examples</title>
 
         <variablelist>
           <varlistentry>
 
           <segtitle>File filter</segtitle>
 
+          <segtitle>Plugin argument</segtitle>
+
           <segtitle>Settings dialog support</segtitle>
 
           <seglistitem>
     </section>
 
     <section>
-      <title><filename>IgnoreCommentsC.dll<indexterm>
-          <primary>IgnoreCommentsC.dll plugin file</primary>
+      <title><filename>IgnoreCommentsC<indexterm>
+          <primary>IgnoreCommentsC plugin file</primary>
         </indexterm></filename></title>
 
       <para>The plugin ignores comments within<constant> //</constant>... and
 
           <segtitle>File filter</segtitle>
 
+          <segtitle>Plugin argument</segtitle>
+
           <segtitle>Settings dialog support</segtitle>
 
           <seglistitem>
             class="extension">*.hxx</filename>, <filename
             class="extension">*.c</filename>, <filename
             class="extension">*.php</filename>, <filename
-            class="extension">*.js</filename>,</seg>
+            class="extension">*.js</filename>, <filename
+            class="extension">*.cs</filename>, <filename
+            class="extension">*.ts</filename></seg>
+
+            <seg>No</seg>
 
             <seg>No</seg>
           </seglistitem>
     </section>
 
     <section>
-      <title><filename>IgnoreFieldsComma.dll<indexterm>
-          <primary>IgnoreFieldsComma.dll plugin file</primary>
+      <title><filename>IgnoreFieldsComma<indexterm>
+          <primary>IgnoreFieldsComma plugin file</primary>
         </indexterm></filename></title>
 
       <para>This plugin is for files with fields and commas as delimiters (CSV
 
           <segtitle>File filter</segtitle>
 
+          <segtitle>Plugin argument</segtitle>
+
           <segtitle>Settings dialog support</segtitle>
 
           <seglistitem>
             <seg><filename class="extension">*.csv</filename></seg>
 
             <seg>Yes</seg>
+
+            <seg>Yes</seg>
           </seglistitem>
         </segmentedlist></para>
     </section>
 
     <section>
-      <title><filename>IgnoreFieldsTab.dll<indexterm>
-          <primary>IgnoreFieldsTab.dll plugin file</primary>
+      <title><filename>IgnoreFieldsTab<indexterm>
+          <primary>IgnoreFieldsTab plugin file</primary>
         </indexterm></filename></title>
 
       <para>This plugin is for files that use fields and tabs as delimiters
-      (<application>for examle, Excel</application> files saved in the <filename
+      (<application>for example, Excel</application> files saved in the <filename
       class="extension">*.txt</filename> format). It ignores the delimiter
       characters. The first field is number 1.</para>
 
 
           <segtitle>File filter</segtitle>
 
+          <segtitle>Plugin argument</segtitle>
+
           <segtitle>Settings dialog support</segtitle>
 
           <seglistitem>
             <seg><filename class="extension">*.txt</filename></seg>
 
             <seg>Yes</seg>
+
+            <seg>Yes</seg>
           </seglistitem>
         </segmentedlist></para>
     </section>
 
     <section>
-      <title><filename>IgnoreLeadingLineNumbers.dll<indexterm>
-          <primary>IgnoreLeadingLineNumbers.dll plugin file</primary>
+      <title><filename>IgnoreLeadingLineNumbers<indexterm>
+          <primary>IgnoreLeadingLineNumbers plugin file</primary>
         </indexterm></filename></title>
 
       <para>This plugin ignores the leading line numbers in text files (for
 
           <segtitle>File filter</segtitle>
 
+          <segtitle>Plugin argument</segtitle>
+
           <segtitle>Settings dialog support</segtitle>
 
           <segtitle>Requirement</segtitle>
 
             <seg>No</seg>
 
+            <seg>No</seg>
+
             <seg><xref linkend="MSVBVM60" /></seg>
           </seglistitem>
         </segmentedlist></para>
     </section>
 
+    <section id="EditorAddin">
+      <title><filename>editor addin<indexterm>
+          <primary>editor addin plugin file</primary>
+        </indexterm></filename></title>
+
+      <para>Adds five functions to the <menuchoice>
+          <guimenu>Plugins</guimenu>
+
+          <guisubmenu>Scripts</guisubmenu>
+        </menuchoice> menu:</para>
+
+      <itemizedlist>
+        <listitem>
+          <simpara><guimenuitem>Make Uppercase</guimenuitem> convert the selection to
+          UPPER CASE.</simpara>
+        </listitem>
+
+        <listitem>
+          <simpara><guimenuitem>Make Lowercase</guimenuitem> convert the selection to
+          lower case.</simpara>
+        </listitem>
+
+        <listitem>
+          <simpara><guimenuitem>Sort Lines Ascending</guimenuitem> sort the selection 
+          in ascending order.</simpara>
+        </listitem>
+
+        <listitem>
+          <simpara><guimenuitem>Sort Lines Descending</guimenuitem> sort the selection 
+          in descending order.</simpara>
+        </listitem>
+
+        <listitem>
+          <simpara><guimenuitem>Apply Filter Command...</guimenuitem> replace the selection 
+          with the output of the specified filter command.
+          Specifying %1 in the argument of the filter command replaces it with the filename of the active pane.</simpara>
+        </listitem>
+      </itemizedlist>
+
+      <para><segmentedlist>
+          <segtitle>Category</segtitle>
+          <segtitle>File filter</segtitle>
+          <segtitle>Settings dialog support</segtitle>
+
+          <seglistitem>
+            <seg>Editor complement</seg>
+            <seg>*</seg>
+            <seg>No</seg>
+          </seglistitem>
+        </segmentedlist></para>
+    </section>
+
     <section id="Plugins_datetime">
-      <title><filename>insert datetime.sct<indexterm>
-          <primary>insert datetime.sct plugin file</primary>
+      <title><filename>insert datetime<indexterm>
+          <primary>insert datetime plugin file</primary>
         </indexterm></filename></title>
 
       <para>Adds two functions to the <menuchoice>
 
       <itemizedlist>
         <listitem>
-          <simpara><guimenuitem>InsertDate</guimenuitem> insert date in the
+          <simpara><guimenuitem>Insert Date</guimenuitem> insert date in the
           current locale format.</simpara>
         </listitem>
 
         <listitem>
-          <simpara><guimenuitem>InsertTime</guimenuitem> insert time in the
+          <simpara><guimenuitem>Insert Time</guimenuitem> insert time in the
           current locale format.</simpara>
         </listitem>
       </itemizedlist>
       <para><segmentedlist>
           <segtitle>Category</segtitle>
 
+          <segtitle>File filter</segtitle>
+
           <segtitle>Settings dialog support</segtitle>
 
           <seglistitem>
             <seg>Editor complement</seg>
 
+            <seg>*</seg>
+
             <seg>No</seg>
           </seglistitem>
         </segmentedlist></para>