Re-use installation instructions in plug-in topics

Signed-off-by: Roger Sheen <roger@infotexture.net>
dita-ot · Jul 19, 2023 · c6dfc46 · c6dfc46
1 parent 556238b
commit c6dfc46
Show file tree

Hide file tree

Showing 13 changed files with 31 additions and 29 deletions.
diff --git a/resources/conref-task.dita b/resources/conref-task.dita
@@ -137,7 +137,10 @@
         </info>
       </step>
       <step id="install-plugin">
-        <cmd>Install the plug-in.</cmd>
+        <cmd>Use the <cmdname>dita install</cmdname> subcommand to install the plug-in.</cmd>
+        <info>
+          <note>For more information, see
+            <xref keyref="plugins-installing"/>.</note></info>
       </step>
     </steps>
     <postreq>
@@ -152,6 +155,13 @@
           <indexterm>.properties file</indexterm></indexterm>
         <indexterm>args.input.dir</indexterm>
       </note>
+      <ol>
+        <li id="install-plugin-postreq-li">
+          <p>Use the <cmdname>dita install</cmdname> subcommand to install the plug-in.</p>
+          <note>For more information, see
+            <xref keyref="plugins-installing"/>.</note>
+        </li>
+      </ol>
     </postreq>
   </taskbody>
 </task>
diff --git a/topics/html-customization-plugin-bundle-css.dita b/topics/html-customization-plugin-bundle-css.dita
@@ -118,9 +118,7 @@
     </result>
     <postreq>
       <ol>
-        <li>Run <filepath conkeyref="conref-task/dita-cmd"/>
-          <parmname>--install</parmname> to install the plug-in and make the <option>html5-custom-css</option>
-          transformation available.</li>
+        <li conkeyref="conref-task/install-plugin-postreq-li"/>
         <li>Build output with the new transformation type to verify that the plug-in works as intended.
           <codeblock><filepath conkeyref="conref-task/dita-cmd"/> <parmname>--input</parmname>=<varname
             >my.ditamap</varname> <parmname>--format</parmname>=<option>html5-custom-css</option></codeblock>

diff --git a/topics/html-customization-plugin-javascript.dita b/topics/html-customization-plugin-javascript.dita
@@ -118,9 +118,7 @@
     </result>
     <postreq>
       <ol>
-        <li>Run <filepath conkeyref="conref-task/dita-cmd"/>
-          <parmname>--install</parmname> to install the plug-in and make the <option>html5-javascript</option>
-          transformation available.</li>
+        <li conkeyref="conref-task/install-plugin-postreq-li"/>
         <li>Build output with the new transformation type to verify that the plug-in works as intended.
           <codeblock><filepath conkeyref="conref-task/dita-cmd"/> <parmname>--input</parmname>=<varname
             >my.ditamap</varname> <parmname>--format</parmname>=<option>html5-javascript</option></codeblock></li>

diff --git a/topics/html-customization-plugin-webfont.dita b/topics/html-customization-plugin-webfont.dita
@@ -151,9 +151,7 @@
     </result>
     <postreq>
       <ol>
-        <li>Run <filepath conkeyref="conref-task/dita-cmd"/>
-          <parmname>--install</parmname> to install the plug-in and make the <option>html5-webfont</option>
-          transformation available.</li>
+        <li conkeyref="conref-task/install-plugin-postreq-li"/>
         <li>Build output with the new transformation type to verify that the plug-in works as intended.
           <codeblock><filepath conkeyref="conref-task/dita-cmd"/> <parmname>--input</parmname>=<varname
             >my.ditamap</varname> <parmname>--format</parmname>=<option>html5-webfont</option></codeblock>

diff --git a/topics/pdf-customization-example.dita b/topics/pdf-customization-example.dita
@@ -127,9 +127,7 @@
     </result>
     <postreq>
       <ol>
-        <li>Run <filepath conkeyref="conref-task/dita-cmd"/>
-          <parmname>--install</parmname> to install the plug-in and make the <option>print-pdf</option> transformation
-          available.</li>
+        <li conkeyref="conref-task/install-plugin-postreq-li"/>
         <li>Build output with the new transformation type to verify that the plug-in works as intended.
           <codeblock><filepath conkeyref="conref-task/dita-cmd"/> <parmname>--input</parmname>=<varname
             >my.ditamap</varname> <parmname>--format</parmname>=<option>print-pdf</option></codeblock>

diff --git a/topics/plugin-antpreprocess.dita b/topics/plugin-antpreprocess.dita
@@ -42,8 +42,8 @@
             <li><varname>Ant-target</varname> is the name of the Ant target.</li>
           </ul></info>
       </step>
-      <step>
-        <cmd>Install the plug-in.</cmd>
+      <step conkeyref="conref-task/install-plugin">
+        <cmd/>
       </step>
     </steps>
     <result>The new target is added to the Ant dependency list. The new target is now always run in conjunction with the

diff --git a/topics/plugin-anttarget.dita b/topics/plugin-anttarget.dita
@@ -39,8 +39,8 @@
             <li><varname>build-file</varname> is the Ant project file that contains the new build target(s).</li>
           </ul></stepxmp>
       </step>
-      <step>
-        <cmd>Install the plug-in.</cmd>
+      <step conkeyref="conref-task/install-plugin">
+        <cmd/>
       </step>
     </steps>
     <result>

diff --git a/topics/plugin-javalib.dita b/topics/plugin-javalib.dita
@@ -54,8 +54,8 @@
               <filepath>myJavaLibrary.jar</filepath>. </li>
           </ul></info>
       </step>
-      <step>
-        <cmd>Install the plug-in.</cmd>
+      <step conkeyref="conref-task/install-plugin">
+        <cmd/>
       </step>
     </steps>
     <result>The Ant or XSLT code now can make use of the Java code.</result>

diff --git a/topics/plugin-messages.dita b/topics/plugin-messages.dita
@@ -79,8 +79,8 @@
           </ul>
         </info>
       </step>
-      <step>
-        <cmd>Install the plug-in.</cmd>
+      <step conkeyref="conref-task/install-plugin">
+        <cmd/>
       </step>
     </steps>
     <postreq>

diff --git a/topics/plugin-newtranstype.dita b/topics/plugin-newtranstype.dita
@@ -58,8 +58,8 @@
           <p>Exclude the content that is highlighted in bold if the transformation is not intended for print.</p>
         </info>
       </step>
-      <step>
-        <cmd>Install the plug-in.</cmd>
+      <step conkeyref="conref-task/install-plugin">
+        <cmd/>
       </step>
     </steps>
     <result>You now can use the new transformation.</result>

diff --git a/topics/plugin-overridestyle.dita b/topics/plugin-overridestyle.dita
@@ -41,8 +41,8 @@
                 <filepath>xsl/header.xsl</filepath>. </li>
           </ul></info>
       </step>
-      <step>
-        <cmd>Install the plug-in.</cmd>
+      <step conkeyref="conref-task/install-plugin">
+        <cmd/>
       </step>
     </steps>
     <result>The plug-in installer adds an XSL import statement to the default DITA-OT code, so that the XSL override

diff --git a/topics/plugin-xmlcatalog.dita b/topics/plugin-xmlcatalog.dita
@@ -52,8 +52,8 @@
         <cmd>Save the new XML catalog file to your plug-in. Be sure that the local file references are relative to the
           location of the catalog and plug-in.</cmd>
       </step>
-      <step>
-        <cmd>Install the plug-in.</cmd>
+      <step conkeyref="conref-task/install-plugin">
+        <cmd/>
       </step>
     </steps>
     <result>The catalog entries inside of the new catalog file are added to the core DITA-OT catalog file.</result>

diff --git a/topics/plugin-xsltparams.dita b/topics/plugin-xsltparams.dita
@@ -57,8 +57,8 @@
             </li>
           </ul></info>
       </step>
-      <step>
-        <cmd>Install the plug-in.</cmd>
+      <step conkeyref="conref-task/install-plugin">
+        <cmd/>
       </step>
     </steps>
     <result>The <filepath>plugin.xml</filepath> file passes the parameters to the specified transformation or