Clean up for publishing

Set up reuse for publishing. Various clean up fixes.
nili1 · Mar 21, 2017 · fd463e4 · fd463e4
1 parent eb69f5d
commit fd463e4
Show file tree

Hide file tree

Showing 17 changed files with 133 additions and 32 deletions.
diff --git a/en-us/course08-publishing_output.ditamap b/en-us/course08-publishing_output.ditamap
@@ -4,7 +4,9 @@
      applicable licenses.-->
 <!DOCTYPE map PUBLIC "-//OASIS//DTD DITA Map//EN" "map.dtd">
 <map>
- <title>Publishing output from DITA sources</title>
+ <title>
+  <ph keyref="course_name"/>
+ </title>
  <topicmeta>
   <critdates>
    <created date="2017-02-06"/>
@@ -14,5 +16,11 @@
  <mapref href="course08-publishing_output/maps/m_setting_up.ditamap"/>
  <mapref href="course08-publishing_output/maps/m_generating_output.ditamap"/> 
  <mapref href="course08-publishing_output/maps/m_custom_plugins.ditamap"/>
- <topicref href="shared/maps/course_keys.ditamap" format="ditamap"/>
+
+ <!-- common and specific keys -->
+ <mapref href="shared/maps/course_keys.ditamap" processing-role="resource-only"/>
+ <mapref href="course08-publishing_output/maps/this_course_keys.ditamap" processing-role="resource-only"/>
+ <!-- conref push elements -->
+ <topicref href="course08-publishing_output/topics/z_conref_push_elements.dita" processing-role="resource-only"/>
+
 </map>
diff --git a/en-us/course08-publishing_output/maps/m_choosing_environment.ditamap b/en-us/course08-publishing_output/maps/m_choosing_environment.ditamap
@@ -4,14 +4,15 @@
  <title>Choosing a publishing environment</title>
  <topicref href="../topics/lc_choosing_environment.dita">
   <topicmeta lockmeta="yes">
-  <data name="lesson_id" value="020617"/>
+  <data name="lesson_id" value="10991"/>
  </topicmeta>
+  <topicref href="../../shared/topics/lc_general_housekeeping.dita"/>
   <topicref href="../topics/lc_determining_outputs.dita"/>
   <topicref href="../topics/lc_publishing_considerations.dita"/>
   <topicref href="../topics/lc_standalone_ot.dita"/>
   <topicref href="../topics/lc_oxygen.dita"/>
   <topicref href="../topics/lc_ccms.dita"/>
-  <topicref href="../../shared/topics/lcc_assessment.dita" copy-to="lcc_using_conditions.dita"
+  <topicref href="../../shared/topics/lcc_assessment.dita" copy-to="lcc_choosing_environment.dita"
    locktitle="yes">
    <topicmeta>
     <navtitle>Assessment for Choosing a publishing environment</navtitle>

diff --git a/en-us/course08-publishing_output/maps/m_custom_plugins.ditamap b/en-us/course08-publishing_output/maps/m_custom_plugins.ditamap
@@ -4,13 +4,13 @@
  <title>Custom plugins</title>
  <topicref href="../topics/lc_custom_plugins.dita">
   <topicmeta lockmeta="yes">
-   <data name="lesson_id" value="020917"/>
+   <data name="lesson_id" value="10994"/>
   </topicmeta>
   <topicref href="../topics/lc_why_customize.dita"/>
   <topicref href="../topics/lc_install_custom_plugin.dita"/>
   <topicref href="../topics/lc_update_custom_plugin.dita"/>
   <topicref href="../topics/lc_best_practices.dita"/>
-  <topicref href="../../shared/topics/lcc_assessment.dita" copy-to="lcc_using_conditions.dita"
+  <topicref href="../../shared/topics/lcc_assessment.dita" copy-to="lcc_custom_plugins.dita"
    locktitle="yes">
    <topicmeta>
     <navtitle>Assessment for Custom plugins</navtitle>

diff --git a/en-us/course08-publishing_output/maps/m_generating_output.ditamap b/en-us/course08-publishing_output/maps/m_generating_output.ditamap
@@ -4,13 +4,13 @@
  <title>Generating output</title>
  <topicref href="../topics/lc_generating_output.dita">
   <topicmeta lockmeta="yes">
-   <data name="lesson_id" value="020817"/>
+   <data name="lesson_id" value="10993"/>
   </topicmeta>
   <topicref href="../topics/lc_output_commands.dita"/>
   <topicref href="../topics/lc_generating_pdf.dita"/>
   <topicref href="../topics/lc_generating_html.dita"/>
   <topicref href="../topics/lc_troubleshooting.dita"/>
-  <topicref href="../../shared/topics/lcc_assessment.dita" copy-to="lcc_using_conditions.dita"
+  <topicref href="../../shared/topics/lcc_assessment.dita" copy-to="lcc_generating_output.dita"
    locktitle="yes">
    <topicmeta>
     <navtitle>Assessment for Generating output</navtitle>

diff --git a/en-us/course08-publishing_output/maps/m_setting_up.ditamap b/en-us/course08-publishing_output/maps/m_setting_up.ditamap
@@ -4,13 +4,13 @@
  <title>Setting up your publishing environment</title>
  <topicref href="../topics/lc_setting_up.dita">
   <topicmeta lockmeta="yes">
-   <data name="lesson_id" value="020717"/>
+   <data name="lesson_id" value="10992"/>
   </topicmeta>
   <topicref href="../topics/lc_installing_the_dita_ot.dita"/>
   <topicref href="../topics/lc_installing_java.dita"/>
   <topicref href="../topics/lc_folder_structure.dita"/>
   <topicref href="../topics/lc_testing_ot.dita"/>
-  <topicref href="../../shared/topics/lcc_assessment.dita" copy-to="lcc_using_conditions.dita"
+  <topicref href="../../shared/topics/lcc_assessment.dita" copy-to="lcc_setting_up.dita"
    locktitle="yes">
    <topicmeta>
     <navtitle>Assessment for Setting up your publishing environment</navtitle>

diff --git a/en-us/course08-publishing_output/maps/this_course_keys.ditamap b/en-us/course08-publishing_output/maps/this_course_keys.ditamap
@@ -0,0 +1,42 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE map PUBLIC "-//OASIS//DTD DITA Map//EN" "map.dtd">
+<!-- This file is part of the DITA Training project hosted on      github.com. See the accompanying LICENSE file for      applicable licenses.-->
+<map>
+ <title>Keys for Publishing Output from DITA Sources</title>
+ <keydef keys="sample_file" href="http://www.learningdita.com/wp-content/uploads/2017/03/publishing_output_samples.zip" format="zip" scope="external">
+  <topicmeta>
+   <linktext>publishing_output_samples.zip</linktext>
+  </topicmeta>
+ </keydef>
+
+ <keydef keys="course_name">
+  <topicmeta>
+   <keywords>
+    <keyword>Publishing output from DITA sources</keyword>
+   </keywords>
+  </topicmeta>
+ </keydef>
+
+ <!-- keys for other conkeyref elements: -->
+<!-- <keydef keys="ditaval_topic" href="../topics/lc_conditions_ditaval.dita" format="dita"/>
+--> 
+ <!-- key for warehouse file containing conkeyref elements. -->
+ <keydef keys="sample_contents" href="../topics/z_conkeyref_elements.dita"/>
+
+ <!-- IMAGES -->
+ <keydef keys="i_conkeyref" href="../images/conkeyref-01.png" format="png"/>
+ <keydef keys="i_conrefend" href="../images/conrefend-01.png" format="png"/>
+ <keydef keys="i_keysubmap" href="../images/submap_of_keys-01.png" format="png"/>
+ <keydef keys="i_conref_push" href="../images/conref_push-01.png" format="png"/>
+
+ <!-- Screen shots -->
+ <keydef keys="i_with_filtering" href="../images/with_filtering.png" format="png"/>
+ <keydef keys="i_without_filtering" href="../images/without_filtering.png" format="png"/>
+ <keydef keys="i_flagging_product" href="../images/flagging_product.png" format="png"/>
+ <keydef keys="i_show_rev" href="../images/show_rev.png" format="png"/>
+ <keydef keys="i_no_push" href="../images/no_conref_push.png" format="png"/>
+ <keydef keys="i_ex_push_replace" href="../images/ex_push_replace.png" format="png"/>
+ <keydef keys="i_ex_push_before" href="../images/ex_push_before.png" format="png"/>
+ <keydef keys="i_ex_push_after" href="../images/ex_push_after.png" format="png"/>
+
+</map>
diff --git a/...put/samples/com.learningdita.ld_xhtml.zip → ...les/plugins/com.learningdita.ld_xhtml.zip b/...put/samples/com.learningdita.ld_xhtml.zip → ...les/plugins/com.learningdita.ld_xhtml.zip
diff --git a/en-us/course08-publishing_output/topics/lc_ccms.dita b/en-us/course08-publishing_output/topics/lc_ccms.dita
@@ -23,7 +23,7 @@
                 stores content and manages it at the topic or component level rather than at the
                 document level. This makes a CCMS an ideal way to manage XML content; there are many
                 CCMS options designed specifically for DITA content.</p>
-            <fig><title>Overview of a typical CCMS</title><image href="images/ccms-01.svg"
+            <fig><title>Overview of a typical CCMS</title><image href="images/ccms.png" base="2017/03"
                 id="image_atz_qlq_fz"/></fig><p>Different systems offer different sets of features;
                 however, some features are common across almost all systems. Most CCMS options will
                 connect with authoring tools (such as oXygen) and publishing tools (such as DITA OT

diff --git a/en-us/course08-publishing_output/topics/lc_folder_structure.dita b/en-us/course08-publishing_output/topics/lc_folder_structure.dita
@@ -45,7 +45,7 @@
                         in folders may interfere with the DITA OT's ability to parse the content and
                         generate output from it. If you store a map file in a folder that lives
                         below the topic files referenced in the map, the DITA OT will most likely
-                        fail to build output.</p><image href="images/folder_structure.png"
+                        fail to build output.</p><image href="images/folder_structure.png" base="2017/03"
                         width="500" id="image_u1d_1nw_fz"/></li>
                 <li>
                     <p><b>Mange your shared content.</b> If you have topics that are referenced in
@@ -118,7 +118,7 @@
                 </step>
                 <step>
                     <cmd>Copy the "ducks" folder into the "sources" folder.</cmd>
-                    <info><image href="images/source_folders.png" width="500" id="image_e1t_wpq_fz"
+                    <info><image href="images/source_folders.png" width="500" id="image_e1t_wpq_fz" base="2017/03"
                         /></info>
                 </step>
                 <step>
@@ -128,7 +128,7 @@
                 <step>
                     <cmd>Inside the "outputs" folder, create a new folder and name it
                         "ducks_output."</cmd>
-                    <info><image href="images/output_folders" width="500" id="image_qpx_xpq_fz"
+                    <info><image href="images/output_folders.png" width="500" id="image_qpx_xpq_fz" base="2017/03"
                         /></info>
                 </step>
             </steps>

diff --git a/en-us/course08-publishing_output/topics/lc_generating_pdf.dita b/en-us/course08-publishing_output/topics/lc_generating_pdf.dita
@@ -22,9 +22,9 @@
         <lcInstruction><p>In the previous lesson, your first test build with the DITA OT used the
                 pdf2 plugin to generate PDF output. The plugin handles maps and bookmaps
                 differently.</p><p>For map content, the plugin generates a table of contents for the
-                entire document:</p><image href="images/map.png" width="450" id="image_gph_3sx_fz"
+                    entire document:</p><image href="images/map.png" width="450" id="image_gph_3sx_fz" base="2017/03"
                 /><p>For bookmap content, the plugin generates an individual table of contents for
-                each chapter:</p><image href="images/bookmap.png" width="450" id="image_hph_3sx_fz"
+                    each chapter:</p><image href="images/bookmap.png" width="450" id="image_hph_3sx_fz" base="2017/03"
                 /><p>The following instructions show you how to use the DITA OT to create PDF output
                 from the same collection of topics stored in both a map and a
             bookmap.</p></lcInstruction>

diff --git a/en-us/course08-publishing_output/topics/lc_install_custom_plugin.dita b/en-us/course08-publishing_output/topics/lc_install_custom_plugin.dita
@@ -29,7 +29,7 @@
         <taskbody>
             <steps id="steps_ezx_ztg_2z">
                 <step>
-                    <cmd>Locate the zip file com.learningdita.ld_xhtml.zip in the samples folder you
+                    <cmd>Locate the zip file com.learningdita.ld_xhtml.zip in the samples/plugin folder you
                         downloaded at the beginning of this course.</cmd>
                 </step>
                 <step>
@@ -80,8 +80,8 @@
         <taskbody>
             <steps id="steps_sqz_tvg_2z">
                 <step>
-                    <cmd>Locate the folder com.learningdita.ld_xhtml in the samples folder you
-                        downloaded at the beginning of this course.</cmd>
+                    <cmd>Locate the zip file com.learningdita.ld_xhtml.zip in the samples/plugin
+                        folder you downloaded at the beginning of this course.</cmd>
                 </step>
                 <step>
                     <cmd>Inside your DITA OT folder, copy com.learningdita.ld_xhtml into the plugins
@@ -127,10 +127,10 @@
                 </step>
             </steps>
             <result id="result_ong_2dy_fz"><p>The version of c_wild_duck_species.html generated from
-                    the default plugin should look like this:</p><image
+                the default plugin should look like this:</p><image base="2017/03"
                     href="images/xhtml_default.png" width="500" id="image_bbl_fdy_fz"/><p>The
                     version of c_wild_duck_species.html generated from the custom plugin should look
-                    like this:</p><image href="images/xhtml_custom.png" width="500"
+                    like this:</p><image href="images/xhtml_custom.png" width="500" base="2017/03"
                     id="image_lk2_gdy_fz"/><note>Fonts and spacing may vary depending on which
                     browser and version you are using.</note></result>
         </taskbody>

diff --git a/en-us/course08-publishing_output/topics/lc_installing_the_dita_ot.dita b/en-us/course08-publishing_output/topics/lc_installing_the_dita_ot.dita
@@ -45,7 +45,7 @@
                     <info><p>The latest DITA OT distribution package will be displayed at the top of
                             the page. The page also contains a link to the latest version that is
                             under development for testing, followed by a list of previous versions
-                            of the DITA OT.</p><image href="images/download_ot.png" width="450"
+                            of the DITA OT.</p><image href="images/download_ot.png" width="450" base="2017/03"
                             id="image_lf3_gmq_fz"/><note>
                             <p>At the time of this course's release, the latest version of the DITA
                                 OT was 2.4.4.</p>

diff --git a/en-us/course08-publishing_output/topics/lc_troubleshooting.dita b/en-us/course08-publishing_output/topics/lc_troubleshooting.dita
@@ -84,15 +84,15 @@
                     <fig id="fig_cm1_jzx_fz">
                         <title>Image with a width specified vs. image with no width specified in PDF
                             output</title>
-                        <image href="images/image_display.png" width="500" id="image_dm1_jzx_fz"/>
+                        <image href="images/image_display.png" base="2017/03" width="500" id="image_dm1_jzx_fz"/>
                     </fig>
                     <p>For tables, you can use the colspec attribute to adjust the column widths
                         from their default setting of equal widths into widths that work better for
                         your content.</p>
                     <fig id="fig_jyr_jzx_fz">
                         <title>Table with colspecs adjusted vs. table with default colspecs in PDF
                             output</title>
-                        <image href="images/table_display.png" width="500" id="image_sjn_gcy_fz"/>
+                        <image href="images/table_display.png" base="2017/03" width="500" id="image_sjn_gcy_fz"/>
                     </fig>
                 </li>
             </ul>

diff --git a/en-us/course08-publishing_output/topics/lc_update_custom_plugin.dita b/en-us/course08-publishing_output/topics/lc_update_custom_plugin.dita
@@ -51,7 +51,7 @@
                 <step>
                     <cmd>Navigate to your "custom_output" folder and open the file
                         c_wild_duck_species.html in a browser.</cmd>
-                    <info><p>The HTML output should look like this:</p><image
+                    <info><p>The HTML output should look like this:</p><image base="2017/03"
                             href="images/xhtml_custom.png" width="500" id="image_n24_3dy_fz"
                             /><note>Fonts and spacing may vary depending on which browser and
                             version you are using.</note></info>
@@ -104,7 +104,7 @@
                     <cmd>Open c_wild_duck_species.html in a browser to see the CSS changes you
                         made.</cmd>
                     <info><p>The HTML output should now look like this:</p><image
-                            href="images/xhtml_updated.png" width="500" id="image_ojr_kdy_fz"
+                        href="images/xhtml_updated.png" width="500" id="image_ojr_kdy_fz" base="2017/03"
                         /></info>
                 </step>
             </steps>
@@ -118,7 +118,7 @@
                     <cmd>Navigate to your "custom_output" folder and open the file
                         c_wild_duck_species.html in a browser.</cmd>
                     <info><p>The HTML output should look like this:</p><image
-                            href="images/xhtml_custom.png" width="500" id="image_qgq_jdy_fz"
+                        href="images/xhtml_custom.png" width="500" id="image_qgq_jdy_fz" base="2017/03"
                             /><note>Fonts and spacing may vary depending on which browser and
                             version you are using.</note></info>
                 </step>
@@ -170,7 +170,7 @@
                     <cmd>Open c_wild_duck_species.html in a browser to see the CSS changes you
                         made.</cmd>
                     <info><p>The HTML output should now look like this:</p><image
-                            href="images/xhtml_updated.png" width="500" id="image_vs1_ldy_fz"
+                        href="images/xhtml_updated.png" width="500" id="image_vs1_ldy_fz" base="2017/03"
                         /></info>
                 </step>
             </steps>

diff --git a/en-us/course08-publishing_output/topics/z_conkeyref_elements.dita b/en-us/course08-publishing_output/topics/z_conkeyref_elements.dita
@@ -0,0 +1,18 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE topic PUBLIC "-//OASIS//DTD DITA Topic//EN" "topic.dtd">
+<!-- This file is part of the DITA Training project hosted on      github.com. See the accompanying LICENSE file for      applicable licenses.-->
+<topic id="topic_nxn_1t4_tx">
+  <title>Conkeyref elements for reuse advanced</title>
+  <body>
+    <!-- List the folders that are in the sample zip file for this course. -->
+    <!-- This content is pulled in by conkeyref to the reusable housekeeping file. -->
+    <p id="folder_contents">The samples folder contains two folders: <filepath>ducks</filepath> and
+        <filepath>plugins</filepath>. <ul>
+        <li>The <filepath>ducks</filepath> folder contains a DITA map, a bookmap, and 11 DITA topic
+          files. You use these to test aspects of publishing output from DITA sources</li>
+        <li>The <filepath>plugins</filepath> folder contains a single zip file
+            (<filepath>com.learningdita.ld_xhtml.zip</filepath>), which is a DITA plugin. You use
+          this to explore how to work with custom plugins.</li>
+      </ul></p>
+  </body>
+</topic>
diff --git a/en-us/course08-publishing_output/topics/z_conref_push_elements.dita b/en-us/course08-publishing_output/topics/z_conref_push_elements.dita
@@ -0,0 +1,32 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE topic PUBLIC "-//OASIS//DTD DITA Topic//EN" "topic.dtd">
+<topic id="topic_oyt_5r4_tx">
+  <title>Conref push elements</title>
+  <body>
+    <p conref="../../shared/topics/lc_general_housekeeping.dita#download" conaction="pushreplace">
+      To view the sources for some of the examples in this course, 
+      download <xref keyref="sample_file"/> now. 
+      Extract the contents and put them in a directory that you can access easily.
+      If you have access to an output generator (usually the DITA Open Toolkit), you can 
+      use it to generate output and see these principles in action. 
+    </p>
+
+    <!-- This description omits the Oxygen editor and any mention of videos. -->
+    <p conref="../../shared/topics/lc_general_housekeeping.dita#editor_info" conaction="pushreplace">
+      In the instructions and examples, we show you the DITA code for the sample files.
+      Most DITA editors have auto-complete or other similar features to guide you through
+      the process of adding elements (for example, if you type the opening tag of an
+      element, most DITA editors will automatically add the closing tag for you).
+      Therefore, you will probably not need to create every piece of code from scratch as
+      you work.</p>
+
+    <p conref="../../shared/topics/lc_general_housekeeping.dita#saving" conaction="pushreplace">
+      The lessons will instruct you on which files to use for the samples. 
+       </p>
+
+    <p conref="../../shared/topics/lc_general_housekeeping.dita#download" conaction="pushreplace">
+      Download <xref keyref="sample_file"/> now. It contains the sample files for the
+      entire <keyword keyref="course_name"/> course. Extract the contents and put them in
+      a directory that you can access easily.</p>
+  </body>
+</topic>
diff --git a/en-us/shared/maps/course_keys.ditamap b/en-us/shared/maps/course_keys.ditamap
@@ -53,10 +53,10 @@
   </topicmeta>
  </keydef>
 
-<!-- <!-\- Course 7, title. -\->
- <keydef keys="reuse_advanced_url" href="http://www.learningdita.com/courses/intro-to-reuse-in-dita" scope="external" format="html">
+ <!-- Course 7, title. -->
+ <keydef keys="reuse_advanced_url" href="http://www.learningdita.com/courses/advanced-reuse-in-dita" scope="external" format="html">
   <topicmeta>
-   <linktext>Introduction to Reuse</linktext>
+   <linktext>Advanced reuse in DITA</linktext>
   </topicmeta>
- </keydef>-->
+ </keydef>
 </map>