From fd463e4f339bfdf8f6cce78c40b6051bfcf8596a Mon Sep 17 00:00:00 2001 From: "Simon F. Bate" Date: Tue, 21 Mar 2017 11:26:17 -0400 Subject: [PATCH] Clean up for publishing Set up reuse for publishing. Various clean up fixes. --- en-us/course08-publishing_output.ditamap | 12 ++++- .../maps/m_choosing_environment.ditamap | 5 ++- .../maps/m_custom_plugins.ditamap | 4 +- .../maps/m_generating_output.ditamap | 4 +- .../maps/m_setting_up.ditamap | 4 +- .../maps/this_course_keys.ditamap | 42 ++++++++++++++++++ .../com.learningdita.ld_xhtml.zip | Bin .../topics/lc_ccms.dita | 2 +- .../topics/lc_folder_structure.dita | 6 +-- .../topics/lc_generating_pdf.dita | 4 +- .../topics/lc_install_custom_plugin.dita | 10 ++--- .../topics/lc_installing_the_dita_ot.dita | 2 +- .../topics/lc_troubleshooting.dita | 4 +- .../topics/lc_update_custom_plugin.dita | 8 ++-- .../topics/z_conkeyref_elements.dita | 18 ++++++++ .../topics/z_conref_push_elements.dita | 32 +++++++++++++ en-us/shared/maps/course_keys.ditamap | 8 ++-- 17 files changed, 133 insertions(+), 32 deletions(-) create mode 100644 en-us/course08-publishing_output/maps/this_course_keys.ditamap rename en-us/course08-publishing_output/samples/{ => plugins}/com.learningdita.ld_xhtml.zip (100%) create mode 100644 en-us/course08-publishing_output/topics/z_conkeyref_elements.dita create mode 100644 en-us/course08-publishing_output/topics/z_conref_push_elements.dita diff --git a/en-us/course08-publishing_output.ditamap b/en-us/course08-publishing_output.ditamap index 5ecd38ea..e3ae63a6 100644 --- a/en-us/course08-publishing_output.ditamap +++ b/en-us/course08-publishing_output.ditamap @@ -4,7 +4,9 @@ applicable licenses.--> - Publishing output from DITA sources + + <ph keyref="course_name"/> + @@ -14,5 +16,11 @@ - + + + + + + + diff --git a/en-us/course08-publishing_output/maps/m_choosing_environment.ditamap b/en-us/course08-publishing_output/maps/m_choosing_environment.ditamap index b9dba446..48dc42ad 100644 --- 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 @@ Choosing a publishing environment - + + - Assessment for Choosing a publishing environment diff --git a/en-us/course08-publishing_output/maps/m_custom_plugins.ditamap b/en-us/course08-publishing_output/maps/m_custom_plugins.ditamap index 34ab24e3..5491fcf8 100644 --- 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 @@ Custom plugins - + - Assessment for Custom plugins diff --git a/en-us/course08-publishing_output/maps/m_generating_output.ditamap b/en-us/course08-publishing_output/maps/m_generating_output.ditamap index 955b02f6..aa16149d 100644 --- 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 @@ Generating output - + - Assessment for Generating output diff --git a/en-us/course08-publishing_output/maps/m_setting_up.ditamap b/en-us/course08-publishing_output/maps/m_setting_up.ditamap index 9dc2fcb4..b946992b 100644 --- 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 @@ Setting up your publishing environment - + - Assessment for Setting up your publishing environment diff --git a/en-us/course08-publishing_output/maps/this_course_keys.ditamap b/en-us/course08-publishing_output/maps/this_course_keys.ditamap new file mode 100644 index 00000000..77fc5cda --- /dev/null +++ b/en-us/course08-publishing_output/maps/this_course_keys.ditamap @@ -0,0 +1,42 @@ + + + + + Keys for Publishing Output from DITA Sources + + + publishing_output_samples.zip + + + + + + + Publishing output from DITA sources + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/en-us/course08-publishing_output/samples/com.learningdita.ld_xhtml.zip b/en-us/course08-publishing_output/samples/plugins/com.learningdita.ld_xhtml.zip similarity index 100% rename from en-us/course08-publishing_output/samples/com.learningdita.ld_xhtml.zip rename to en-us/course08-publishing_output/samples/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 index f364002b..80402fde 100644 --- 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.

- Overview of a typical CCMSOverview of a typical CCMS

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 index 037ac7e4..e877db17 100644 --- 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.

  • Mange your shared content. If you have topics that are referenced in @@ -118,7 +118,7 @@ Copy the "ducks" folder into the "sources" folder. - @@ -128,7 +128,7 @@ Inside the "outputs" folder, create a new folder and name it "ducks_output." - diff --git a/en-us/course08-publishing_output/topics/lc_generating_pdf.dita b/en-us/course08-publishing_output/topics/lc_generating_pdf.dita index 21d8b88c..f497f962 100644 --- 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 @@

    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.

    For map content, the plugin generates a table of contents for the - entire document:

    For bookmap content, the plugin generates an individual table of contents for - each chapter:

    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.

    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 index f2e766be..257e1782 100644 --- 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 @@ - Locate the zip file com.learningdita.ld_xhtml.zip in the samples folder you + Locate the zip file com.learningdita.ld_xhtml.zip in the samples/plugin folder you downloaded at the beginning of this course. @@ -80,8 +80,8 @@ - Locate the folder com.learningdita.ld_xhtml in the samples folder you - downloaded at the beginning of this course. + Locate the zip file com.learningdita.ld_xhtml.zip in the samples/plugin + folder you downloaded at the beginning of this course. Inside your DITA OT folder, copy com.learningdita.ld_xhtml into the plugins @@ -127,10 +127,10 @@

    The version of c_wild_duck_species.html generated from - the default plugin should look like this:

    The version of c_wild_duck_species.html generated from the custom plugin should look - like this:

    Fonts and spacing may vary depending on which browser and version you are using.
    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 index c820f1eb..81d12764 100644 --- 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 @@

    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.

    At the time of this course's release, the latest version of the DITA OT was 2.4.4.

    diff --git a/en-us/course08-publishing_output/topics/lc_troubleshooting.dita b/en-us/course08-publishing_output/topics/lc_troubleshooting.dita index 0e4e61fa..41826b90 100644 --- a/en-us/course08-publishing_output/topics/lc_troubleshooting.dita +++ b/en-us/course08-publishing_output/topics/lc_troubleshooting.dita @@ -84,7 +84,7 @@ Image with a width specified vs. image with no width specified in PDF output - +

    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 @@ -92,7 +92,7 @@ Table with colspecs adjusted vs. table with default colspecs in PDF output - +

  • 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 index 65c48a1e..7f02d646 100644 --- 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 @@ Navigate to your "custom_output" folder and open the file c_wild_duck_species.html in a browser. -

    The HTML output should look like this:

    The HTML output should look like this:

    Fonts and spacing may vary depending on which browser and version you are using.
    @@ -104,7 +104,7 @@ Open c_wild_duck_species.html in a browser to see the CSS changes you made.

    The HTML output should now look like this:

    @@ -118,7 +118,7 @@ Navigate to your "custom_output" folder and open the file c_wild_duck_species.html in a browser.

    The HTML output should look like this:

    Fonts and spacing may vary depending on which browser and version you are using.
    @@ -170,7 +170,7 @@ Open c_wild_duck_species.html in a browser to see the CSS changes you made.

    The HTML output should now look like this:

    diff --git a/en-us/course08-publishing_output/topics/z_conkeyref_elements.dita b/en-us/course08-publishing_output/topics/z_conkeyref_elements.dita new file mode 100644 index 00000000..7752a91a --- /dev/null +++ b/en-us/course08-publishing_output/topics/z_conkeyref_elements.dita @@ -0,0 +1,18 @@ + + + + + Conkeyref elements for reuse advanced + + + +

    The samples folder contains two folders: ducks and + plugins.

      +
    • The ducks folder contains a DITA map, a bookmap, and 11 DITA topic + files. You use these to test aspects of publishing output from DITA sources
    • +
    • The plugins folder contains a single zip file + (com.learningdita.ld_xhtml.zip), which is a DITA plugin. You use + this to explore how to work with custom plugins.
    • +

    + +
    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 new file mode 100644 index 00000000..bd0cd3c1 --- /dev/null +++ b/en-us/course08-publishing_output/topics/z_conref_push_elements.dita @@ -0,0 +1,32 @@ + + + + Conref push elements + +

    + To view the sources for some of the examples in this course, + download 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. +

    + + +

    + 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.

    + +

    + The lessons will instruct you on which files to use for the samples. +

    + +

    + Download now. It contains the sample files for the + entire course. Extract the contents and put them in + a directory that you can access easily.

    + +
    diff --git a/en-us/shared/maps/course_keys.ditamap b/en-us/shared/maps/course_keys.ditamap index 877276e9..86ea7568 100644 --- a/en-us/shared/maps/course_keys.ditamap +++ b/en-us/shared/maps/course_keys.ditamap @@ -53,10 +53,10 @@
    - + - Introduction to Reuse + Advanced reuse in DITA - --> +