Adding options to reusables per discussion in issue #35

oxygenxml · Aug 19, 2014 · ce58b0b · ce58b0b
1 parent 8df83b1
commit ce58b0b
Show file tree

Hide file tree

Showing 5 changed files with 38 additions and 30 deletions.
diff --git a/DITA/concepts/document-templates.dita b/DITA/concepts/document-templates.dita
@@ -5,17 +5,15 @@
     <title>Document Templates</title>
     <conbody>
         <p>Templates are documents that have a predefined structure. They provide the starting point
-      from which you are able to build new documents rapidly, based on the same characteristics
-      (file type, prolog, root element, existing content). <ph keyref="product"/> offers a rich set
-      of templates for a number of XML applications. You may also create your own templates from <?oxy_comment_start author="Mark" timestamp="20140813T105032-0400" comment="Need to validate this menucascase. Pretty sure it is wrong for Eclipse."?><menucascade>
-        <uicontrol>Options</uicontrol>
-        <uicontrol product="editorEclipse authorEclipse developerEclipse">Windows</uicontrol>
-        <uicontrol>Preferences</uicontrol>
-        <uicontrol product="editorEclipse authorEclipse developerEclipse">oXygen</uicontrol>
+      from which you can build new documents rapidly, based on the same characteristics (file type,
+      prolog, root element, existing content). <ph keyref="product"/> offers a rich set of templates
+      for a number of XML applications. You may also create your own templates and share them with
+      others. </p>
+    <p>To configure templates, <ph conkeyref="reusable.menus/open-the-preferences-page"/> and go to  <menucascade>
         <uicontrol>Editor</uicontrol>
         <uicontrol>Templates</uicontrol>
         <uicontrol>Document Templates</uicontrol>
-      </menucascade><?oxy_comment_end?> and share them with others.</p>
+      </menucascade>. </p>
         <p>You can also use <xref href="../topics/editor-variables.dita">editor variables</xref> in
             the template files' content and they will be expanded when the files are opened.</p>
     </conbody>

diff --git a/DITA/reusables/topics/reusable.menu-elements.dita b/DITA/reusables/topics/reusable.menu-elements.dita
@@ -4,16 +4,30 @@
   <title>Reusable menucascade elements</title>
   <body>
     <p>Preferences page </p>
-    <p><menucascade id="preferences">
-        <uicontrol product="editor author developer svnClient">Options</uicontrol>
-        <uicontrol product="editorEclipse developerEclipse authorEclipse">Window</uicontrol>
+    <p>
+      <draft-comment author="Mark">The following is wrapped in pre tags to prevent spaces being
+        added to the result. The pre-element is not reused.</draft-comment>
+    </p>
+    <pre><ph id="preferences"><ph product="authorEclipse developerEclipse editorEclipse">in Eclipse preferences choose </ph><uicontrol product="editorEclipse">oXygen XML Editor</uicontrol><uicontrol product="authorEclipse">oXygen XML Author</uicontrol><uicontrol product="developerEclipse">oXygen XML Developer</uicontrol><menucascade product="editor author developer svnClient"><uicontrol>Options</uicontrol><uicontrol>Preferences</uicontrol></menucascade></ph></pre>
+    <p>
+      <menucascade id="preferences-standalone" product="editor author developer svnClient">
+        <uicontrol>Options</uicontrol>
         <uicontrol>Preferences</uicontrol>
-        <uicontrol product="editorEclipse">oXygen XML Editor</uicontrol>
-        <uicontrol product="authorEclipse">oXygen XML Author</uicontrol>
-        <uicontrol product="developerEclipse">oXygen XML Developer</uicontrol>
       </menucascade>
-      <ph id="open-the-preferences-page"> open the <uicontrol>Preferences</uicontrol> dialog
-        (<menucascade conkeyref="reusable.menus/preferences"><uicontrol/></menucascade>)</ph>
+      <ph id="preferences-eclipse" product="editorEclipse developerEclipse authorEclipse">go to
+          <uicontrol>Windows</uicontrol> (<uicontrol>Eclipse</uicontrol> on Mac OSX) and choose <menucascade>
+          <uicontrol>Preferences</uicontrol>
+          <uicontrol product="editorEclipse">oXygen XML Editor</uicontrol>
+          <uicontrol product="authorEclipse">oXygen XML Author</uicontrol>
+          <uicontrol product="developerEclipse">oXygen XML Developer</uicontrol>
+        </menucascade></ph>
+    </p>
+    <p>
+      <ph id="open-the-preferences-page"><xref keyref="configuring-options">open the
+            <uicontrol>Preferences</uicontrol> dialog</xref></ph>
+    </p>
+    <p><ph id="Open-the-preferences-page"><xref keyref="configuring-options">Open the
+            <uicontrol>Preferences</uicontrol> dialog</xref></ph>
     </p>
   </body>
 </topic>
diff --git a/DITA/tasks/add-font-to-builtin-FOP-simplified.dita b/DITA/tasks/add-font-to-builtin-FOP-simplified.dita
@@ -32,15 +32,12 @@
             </info>
           </substep>
           <substep>
-            <cmd>Set the FOP configuration file in <uicontrol>Preferences</uicontrol>.</cmd>
-            <info>Go to menu <menucascade>
-                <uicontrol>Options</uicontrol>
-                <uicontrol>Preferences</uicontrol>
+            <cmd>Open the preferences dialog (<ph conkeyref="reusable.menus/preferences"/>), go to <menucascade>
                 <uicontrol>XML</uicontrol>
                 <uicontrol>XSLT/FO/XQuery</uicontrol>
                 <uicontrol>FO Processors</uicontrol>
-              </menucascade> and enter the path of the FOP configuration file in the
-                <uicontrol>Configuration file for the built-in FOP</uicontrol> text field.</info>
+              </menucascade>, and enter the path of the FOP configuration file in the
+                <uicontrol>Configuration file for the built-in FOP</uicontrol> text field.</cmd>
           </substep>
         </substeps>
       </step>

diff --git a/DITA/tasks/add-font-to-builtin-FOP.dita b/DITA/tasks/add-font-to-builtin-FOP.dita
@@ -160,15 +160,14 @@ $CMD $FONT_DIR/Arialuni-Italic.ttf Arialuni-Italic.xml</codeblock></li>
             </info>
           </substep>
           <substep>
-            <cmd>Set the FOP configuration file in <uicontrol>Preferences</uicontrol>.</cmd>
-            <info>Go to menu <menucascade>
-                <uicontrol>Options</uicontrol>
-                <uicontrol>Preferences</uicontrol>
+            <cmd>Open the preferences dialog (<ph conkeyref="reusable.menus/preferences">
+                <uicontrol/>
+              </ph>), go to <menucascade>
                 <uicontrol>XML</uicontrol>
                 <uicontrol>XSLT/FO/XQuery</uicontrol>
                 <uicontrol>FO Processors</uicontrol>
-              </menucascade> and enter the path of the FOP configuration file in the
-                <uicontrol>Configuration file for the built-in FOP</uicontrol> text field.</info>
+              </menucascade>, and enter the path of the FOP configuration file in the
+                <uicontrol>Configuration file for the built-in FOP</uicontrol> text field.</cmd>
           </substep>
         </substeps>
       </step>

diff --git a/DITA/topics/preferences-encoding.dita b/DITA/topics/preferences-encoding.dita
@@ -6,8 +6,8 @@
   <prolog>
     <metadata>
       <keywords>
-        <indexterm>Configure the
-            Application<indexterm>encoding</indexterm><indexterm>UTF-8</indexterm><indexterm>BOM</indexterm><indexterm>byte
+        <indexterm>Configure the Application<indexterm>character
+            encoding</indexterm><indexterm>encoding</indexterm><indexterm>UTF-8</indexterm><indexterm>BOM</indexterm><indexterm>byte
             order mark</indexterm></indexterm>
       </keywords>
     </metadata>