Commit to illustrate issue #35

oxygenxml · Aug 18, 2014 · 26c28b1 · 26c28b1
1 parent 678e324
commit 26c28b1
Show file tree

Hide file tree

Showing 7 changed files with 72 additions and 14 deletions.
diff --git a/DITA/UserManual.ditamap b/DITA/UserManual.ditamap
@@ -37,6 +37,7 @@
 
   <part>
     <mapref href="keydefs.ditamap"/>
+    <mapref href="reusables/reusables.ditamap" format="ditamap" processing-role="resource-only"/>
   </part>
 
   <part collection-type="sequence">
@@ -129,6 +130,7 @@
       <mapref href="glossary.ditamap"/>
     </topichead>
     <topicref href="topics/lost-topics.dita" type="topic" processing-role="resource-only"/>
+    <topicref href="reusables/topics/reusable.menu-elements.dita" processing-role="resource-only"/>
   </part>
   <backmatter>
     <booklists>

diff --git a/DITA/chapter.configure-application.ditamap b/DITA/chapter.configure-application.ditamap
@@ -47,7 +47,7 @@
         <topicref href="topics/preferences-plugins.dita" collection-type="sequence"/>
         <topicref href="topics/preferences-external-tools.dita" collection-type="sequence"/>
         <topicref href="topics/preferences-menu-shortcut-keys.dita" collection-type="sequence"/>
-        <topicref href="topics/preferences-file-types.dita" collection-type="sequence"/>
+        <topicref href="topics/preferences-file-types.dita" collection-type="sequence" keys="file-types-preferences"/>
         <topicref href="topics/preferences-open-find-resources.dita" collection-type="sequence"/>
         <topicref href="topics/preferences-custom-editor-variables.dita" collection-type="sequence"/>
         <mapref href="section.preferences.network-connection.ditamap" format="ditamap"/>
@@ -72,7 +72,7 @@
         <topicref href="topics/preferences-plugins.dita" collection-type="sequence"/>
         <topicref href="topics/preferences-external-tools.dita" collection-type="sequence"/>
         <topicref href="topics/preferences-menu-shortcut-keys.dita" collection-type="sequence"/>
-        <topicref href="topics/preferences-file-types.dita" collection-type="sequence"/>
+        <topicref href="topics/preferences-file-types.dita" collection-type="sequence" keys="file-types-preferences"/>
         <topicref href="topics/preferences-open-find-resources.dita" collection-type="sequence"/>
         <topicref href="topics/preferences-custom-editor-variables.dita" collection-type="sequence"/>
         <mapref href="section.preferences.network-connection.ditamap" format="ditamap"/>

diff --git a/DITA/reusables/reusables.ditamap b/DITA/reusables/reusables.ditamap
@@ -0,0 +1,12 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE map PUBLIC "-//OASIS//DTD DITA Map//EN" "map.dtd">
+<map>
+ <title>Reusable content</title>
+
+  <topicref keys="reusable.menus" href="topics/reusable.menu-elements.dita"/>
+  <keydef keys="reusable.menus.preferences" product="author developer editor svnClient" conkeyref="reusable.menus.preferences/preferences-page.editor_author_developer_svnClient"/>
+  <keydef keys="reusable.menus.preferences" product="authorEclipse" conkeyref="reusable.menus.preferences/preferences-page.authorEclipse"/>
+  <keydef keys="reusable.menus.preferences" product="developerEclipse" conkeyref="reusable.menus.preferences/preferences-page.developerEclipse"/>
+  <keydef keys="reusable.menus.preferences" product="editorEclipse" conkeyref="reusable.menus.preferences/preferences-page.editorEclipse"/>
+
+</map>
diff --git a/DITA/reusables/topics/reusable.menu-elements.dita b/DITA/reusables/topics/reusable.menu-elements.dita
@@ -0,0 +1,43 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE topic PUBLIC "-//OASIS//DTD DITA Topic//EN" "topic.dtd">
+<topic id="reusable.menu-elements">
+  <title>Reusable menu elements</title>
+  <body>
+    <p>Don't use the ids that start with 'z_'. They are used internally for creating conref start
+      and end ids which are then used to create a single conkeyrefable element.</p>
+    <p>Preferences page </p>
+    <p><menucascade>
+        <uicontrol id="start.preferences_editor_author_developer_svnClient">Options</uicontrol>
+        <uicontrol id="end.preferences_editor_author_developer_svnClient">Preferences</uicontrol>
+      </menucascade>
+      <menucascade>
+        <uicontrol id="start.preferences_editorEclipse">Window </uicontrol>
+        <uicontrol >Preferences</uicontrol>
+        <uicontrol id="end.preferences_editorEclipse">oXygen XML Editor</uicontrol>
+      </menucascade>
+      <menucascade>
+        <uicontrol id="start.preferences_authorEclipse">Window </uicontrol>
+        <uicontrol >Preferences</uicontrol>
+        <uicontrol id="end.preferences_authorEclipse">oXygen XML Author</uicontrol>
+      </menucascade>
+      <menucascade>
+        <uicontrol id="start.preferences_developerEclipse">Window </uicontrol>
+        <uicontrol >Preferences</uicontrol>
+        <uicontrol id="end.preferences_developerEclipse">oXygen XML Deveoper</uicontrol>
+      </menucascade>
+    </p>
+    <p>
+      <menucascade>                                                                
+        <uicontrol id="preferences-page.editor_author_developer_svnClient" conref="#reusable.menu-elements/start.preferences_editor_author_developer_svnClient"
+          conrefend="#reusable.menu-elements/end.preferences_editor_author_developer_svnClient"/> 
+        <uicontrol id="preferences-page.editorEclipse" conref="#reusable.menu-elements/start.preferences_editorEclipse"
+          conrefend="#reusable.menu-elements/end.preferences_editorEclipse"/>
+        <uicontrol id="preferences-page.authorEclipse" conref="#reusable.menu-elements/start.preferences_authorEclipse"
+          conrefend="#reusable.menu-elements/end.preferences_authorEclipse"/>
+        <uicontrol id="preferences-page.developerEclipse" conref="#reusable.menu-elements/start.preferences_developerEclipse"
+          conrefend="#reusable.menu-elements/end.preferences_developerEclipse"/>
+      </menucascade>
+    </p>
+    <p> </p>
+  </body>
+</topic>
diff --git a/DITA/tasks/creating-from-templates.dita b/DITA/tasks/creating-from-templates.dita
@@ -15,7 +15,8 @@
         <li>User defined templates - The user can add template files in the
                         <filepath>templates</filepath> folder of the <ph
                         keyref="product"/>
-                    install directory. Also in the option page <menucascade
+                    install directory. Also in the option page 
+                    <menucascade
                         product="editor author developer">
                         <uicontrol>Options</uicontrol>
                         <uicontrol>Preferences</uicontrol>

diff --git a/DITA/topics/preferences-editor.dita b/DITA/topics/preferences-editor.dita
@@ -11,7 +11,8 @@
     </metadata>
   </prolog>
   <body>
-    <p>To open the <uicontrol>Editor</uicontrol> preferences page, go to <menucascade>
+    <p>To open the <uicontrol>Editor</uicontrol> preferences page, go to 
+      <menucascade>
         <uicontrol product="editor author svnClient developer">Options</uicontrol>
         <uicontrol product="editorEclipse authorEclipse developerEclipse">Window</uicontrol>
         <uicontrol>Preferences</uicontrol>

diff --git a/DITA/topics/preferences-encoding.dita b/DITA/topics/preferences-encoding.dita
@@ -14,22 +14,21 @@
   </prolog>
   <body>
     <p>To open the <uicontrol>Encoding</uicontrol> preferences page, go to <menucascade>
-        <uicontrol>Options</uicontrol>
-        <uicontrol>Preferences</uicontrol>
+        <uicontrol keyref="reusable.menus.preferences"/>
         <uicontrol>Encoding</uicontrol>
       </menucascade>. The following encoding preferences are available:</p>
     <ul>
       <li product="author developer editor svnClient"><uicontrol>Encoding for non XML
           files</uicontrol> -
         <?oxy_comment_start author="Mark" timestamp="20140818T110557-0400" comment="JSON has a default encoding (UTF-8) and a method for detecting alternate encodings. Presumably Oxygen recognizes this and does not use this setting when reading and writing JSON files?  Python (for which Oxygen has an editor, also has a default and a convention for specifying alternate encodings. It should be made clear in the text (and in the interface) whether these conventions are supported or ignored. "?>This
-        setting specifies the default character encoding used to open non-XML
-        documents.<?oxy_comment_end?> More precisely, this is the encoding used for files opened in
-        editors other than the XML editor. The file types opened by each editor are specified in
-          <xref keyref="file-types-preferences"/>. For XML files, the default encoding is UTF-8, and
-        other encodings must be declared explicitly in the XML declaration (for example
-          <codeph>&lt;?xml version="1.0" encoding="UTF-16<b>"</b>?&gt;</codeph>). Most other text
-        formats do not have a default character encoding, nor a standard method of indicating the
-        character encoding.
+        setting specifies the default character encoding used to open non-XML documents.<?oxy_comment_end?>
+        <ph product="author developer editor">More precisely, this is the encoding used for files
+          opened in editors other than the XML editor. The file types opened by each editor are
+          specified in <xref keyref="file-types-preferences"/>.</ph> For XML files, the default
+        encoding is UTF-8, and other encodings must be declared explicitly in the XML declaration
+        (for example <codeph>&lt;?xml version="1.0" encoding="UTF-16<b>"</b>?&gt;</codeph>). Most
+        other text formats do not have a default character encoding, nor a standard method of
+        indicating the character encoding.
         <?oxy_comment_start author="Mark" timestamp="20140818T110959-0400" comment="Does Oxygen attempt to do any kind of encoding detection, or does it just default to this setting?"?>This
         option sets which encoding will be used for reading and writing these
         files.<?oxy_comment_end?>