diff --git a/.github/actions/render/action.yml b/.github/actions/render/action.yml index 75cfd3052..5f20e4281 100644 --- a/.github/actions/render/action.yml +++ b/.github/actions/render/action.yml @@ -6,7 +6,7 @@ inputs: default: 'master' DITA_OT_VERSION: description: 'DITA-OT version used for rendering' - default: '4.2' + default: '4.2.1' runs: using: 'composite' steps: diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index 1a47c42b5..4a8fa94b8 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -17,7 +17,7 @@ jobs: runs-on: ubuntu-latest env: WEBSITE_PLUGIN_BRANCH: 'master' - DITA_OT_VERSION: '4.2' + DITA_OT_VERSION: '4.2.1' steps: - name: Parse arguments run: | diff --git a/package-lock.json b/package-lock.json index 3179b60a6..d47fa37d5 100644 --- a/package-lock.json +++ b/package-lock.json @@ -7,10 +7,10 @@ "name": "docs", "license": "Apache-2.0", "devDependencies": { - "@prettier/plugin-xml": "3.2.2", - "husky": "^9.0.10", - "lint-staged": "15.2.1", - "prettier": "3.2.4", + "@prettier/plugin-xml": "3.3.1", + "husky": "^9.0.11", + "lint-staged": "15.2.2", + "prettier": "3.2.5", "stylelint": "^15.11.0", "stylelint-config-recommended": "^13.0.0", "stylelint-config-sass-guidelines": "^10.0.0" @@ -235,9 +235,9 @@ } }, "node_modules/@prettier/plugin-xml": { - "version": "3.2.2", - "resolved": "https://registry.npmjs.org/@prettier/plugin-xml/-/plugin-xml-3.2.2.tgz", - "integrity": "sha512-SoE70SQF1AKIvK7LVK80JcdAe6wrDcbodFFjcoqb1FkOqV0G0oSlgAFDwoRXPqkUE5p/YF2nGsnUbnfm6471sw==", + "version": "3.3.1", + "resolved": "https://registry.npmjs.org/@prettier/plugin-xml/-/plugin-xml-3.3.1.tgz", + "integrity": "sha512-kllNJk6n2pXJjGWdj+HAr1GhOoOTrlmeWkDYCGBzkyZS2l0K6h2gsUQcVif2cNqAE1MNC+nUrzN6QwEsCukPnQ==", "dev": true, "dependencies": { "@xml-tools/parser": "^1.0.11" @@ -1083,9 +1083,9 @@ } }, "node_modules/husky": { - "version": "9.0.10", - "resolved": "https://registry.npmjs.org/husky/-/husky-9.0.10.tgz", - "integrity": "sha512-TQGNknoiy6bURzIO77pPRu+XHi6zI7T93rX+QnJsoYFf3xdjKOur+IlfqzJGMHIK/wXrLg+GsvMs8Op7vI2jVA==", + "version": "9.0.11", + "resolved": "https://registry.npmjs.org/husky/-/husky-9.0.11.tgz", + "integrity": "sha512-AB6lFlbwwyIqMdHYhwPe+kjOC3Oc5P3nThEoW/AaO2BX3vJDjWPFxYLxokUZOo6RNX20He3AaT8sESs9NJcmEw==", "dev": true, "bin": { "husky": "bin.mjs" @@ -1331,9 +1331,9 @@ "dev": true }, "node_modules/lint-staged": { - "version": "15.2.1", - "resolved": "https://registry.npmjs.org/lint-staged/-/lint-staged-15.2.1.tgz", - "integrity": "sha512-dhwAPnM85VdshybV9FWI/9ghTvMLoQLEXgVMx+ua2DN7mdfzd/tRfoU2yhMcBac0RHkofoxdnnJUokr8s4zKmQ==", + "version": "15.2.2", + "resolved": "https://registry.npmjs.org/lint-staged/-/lint-staged-15.2.2.tgz", + "integrity": "sha512-TiTt93OPh1OZOsb5B7k96A/ATl2AjIZo+vnzFZ6oHK5FuTk63ByDtxGQpHm+kFETjEWqgkF95M8FRXKR/LEBcw==", "dev": true, "dependencies": { "chalk": "5.3.0", @@ -1932,9 +1932,9 @@ "dev": true }, "node_modules/prettier": { - "version": "3.2.4", - "resolved": "https://registry.npmjs.org/prettier/-/prettier-3.2.4.tgz", - "integrity": "sha512-FWu1oLHKCrtpO1ypU6J0SbK2d9Ckwysq6bHj/uaCP26DxrPpppCLQRGVuqAxSTvhF00AcvDRyYrLNW7ocBhFFQ==", + "version": "3.2.5", + "resolved": "https://registry.npmjs.org/prettier/-/prettier-3.2.5.tgz", + "integrity": "sha512-3/GWa9aOC0YeD7LUfvOG2NiDyhOWRvt1k+rcKhOuYnMY24iiCphgneUfJDyFXd6rZCAnuLBv6UeAULtrhT/F4A==", "dev": true, "bin": { "prettier": "bin/prettier.cjs" @@ -2916,9 +2916,9 @@ } }, "@prettier/plugin-xml": { - "version": "3.2.2", - "resolved": "https://registry.npmjs.org/@prettier/plugin-xml/-/plugin-xml-3.2.2.tgz", - "integrity": "sha512-SoE70SQF1AKIvK7LVK80JcdAe6wrDcbodFFjcoqb1FkOqV0G0oSlgAFDwoRXPqkUE5p/YF2nGsnUbnfm6471sw==", + "version": "3.3.1", + "resolved": "https://registry.npmjs.org/@prettier/plugin-xml/-/plugin-xml-3.3.1.tgz", + "integrity": "sha512-kllNJk6n2pXJjGWdj+HAr1GhOoOTrlmeWkDYCGBzkyZS2l0K6h2gsUQcVif2cNqAE1MNC+nUrzN6QwEsCukPnQ==", "dev": true, "requires": { "@xml-tools/parser": "^1.0.11" @@ -3540,9 +3540,9 @@ "dev": true }, "husky": { - "version": "9.0.10", - "resolved": "https://registry.npmjs.org/husky/-/husky-9.0.10.tgz", - "integrity": "sha512-TQGNknoiy6bURzIO77pPRu+XHi6zI7T93rX+QnJsoYFf3xdjKOur+IlfqzJGMHIK/wXrLg+GsvMs8Op7vI2jVA==", + "version": "9.0.11", + "resolved": "https://registry.npmjs.org/husky/-/husky-9.0.11.tgz", + "integrity": "sha512-AB6lFlbwwyIqMdHYhwPe+kjOC3Oc5P3nThEoW/AaO2BX3vJDjWPFxYLxokUZOo6RNX20He3AaT8sESs9NJcmEw==", "dev": true }, "ignore": { @@ -3728,9 +3728,9 @@ "dev": true }, "lint-staged": { - "version": "15.2.1", - "resolved": "https://registry.npmjs.org/lint-staged/-/lint-staged-15.2.1.tgz", - "integrity": "sha512-dhwAPnM85VdshybV9FWI/9ghTvMLoQLEXgVMx+ua2DN7mdfzd/tRfoU2yhMcBac0RHkofoxdnnJUokr8s4zKmQ==", + "version": "15.2.2", + "resolved": "https://registry.npmjs.org/lint-staged/-/lint-staged-15.2.2.tgz", + "integrity": "sha512-TiTt93OPh1OZOsb5B7k96A/ATl2AjIZo+vnzFZ6oHK5FuTk63ByDtxGQpHm+kFETjEWqgkF95M8FRXKR/LEBcw==", "dev": true, "requires": { "chalk": "5.3.0", @@ -4123,9 +4123,9 @@ "dev": true }, "prettier": { - "version": "3.2.4", - "resolved": "https://registry.npmjs.org/prettier/-/prettier-3.2.4.tgz", - "integrity": "sha512-FWu1oLHKCrtpO1ypU6J0SbK2d9Ckwysq6bHj/uaCP26DxrPpppCLQRGVuqAxSTvhF00AcvDRyYrLNW7ocBhFFQ==", + "version": "3.2.5", + "resolved": "https://registry.npmjs.org/prettier/-/prettier-3.2.5.tgz", + "integrity": "sha512-3/GWa9aOC0YeD7LUfvOG2NiDyhOWRvt1k+rcKhOuYnMY24iiCphgneUfJDyFXd6rZCAnuLBv6UeAULtrhT/F4A==", "dev": true }, "punycode": { diff --git a/package.json b/package.json index 739fee594..57c848269 100644 --- a/package.json +++ b/package.json @@ -45,10 +45,10 @@ } }, "devDependencies": { - "@prettier/plugin-xml": "3.2.2", - "husky": "^9.0.10", - "lint-staged": "15.2.1", - "prettier": "3.2.4", + "@prettier/plugin-xml": "3.3.1", + "husky": "^9.0.11", + "lint-staged": "15.2.2", + "prettier": "3.2.5", "stylelint": "^15.11.0", "stylelint-config-recommended": "^13.0.0", "stylelint-config-sass-guidelines": "^10.0.0" diff --git a/release-notes/index.dita b/release-notes/index.dita index 0847ebb89..33253c050 100644 --- a/release-notes/index.dita +++ b/release-notes/index.dita @@ -28,7 +28,7 @@ DITA-OT <keyword keyref="maintenance-version"/> - <!--<ph outputclass="small text-muted">released MMMM DD, YYYY</ph>--> + <ph outputclass="small text-muted">released March 1, 2024</ph>
diff --git a/resources/dita-ot-day-video-keys.ditamap b/resources/dita-ot-day-video-keys.ditamap index bf1bcbd75..421868d97 100644 --- a/resources/dita-ot-day-video-keys.ditamap +++ b/resources/dita-ot-day-video-keys.ditamap @@ -10,4 +10,5 @@ + diff --git a/resources/ditaotdaykeys/dita-ot-day-2024-keys.ditamap b/resources/ditaotdaykeys/dita-ot-day-2024-keys.ditamap new file mode 100644 index 000000000..e6f053be3 --- /dev/null +++ b/resources/ditaotdaykeys/dita-ot-day-2024-keys.ditamap @@ -0,0 +1,312 @@ + + + + + DITA-OT Day 2024 + + + Search, Style and More - Extending DITA Bootstrap + The basic Bootstrap HTML provides a professional looking framework for DITA documents, however with a single extension point you can do so much more. A short presentation on adding Lunr Search, extending and customising the Bootstrap CSS and making additional modifications to the Bootstrap look-and-feel. + Jason Fox + + + + + Lessons Learned: Migrating DITA-OT For an IT Hardware Product +Documentation + The migration of DITA-OT poses unique challenges, particularly when applied to the context of IT hardware product documentation. The narrative explains the crucial decision-making processes, including the initial assessment of legacy documentation systems, the formulation of migration strategies, and the execution of the migration plan. Key focus areas include content reusability, metadata structuring, and adaptation of DITA-OT functionalities to cater specifically to the nuances of IT hardware documentation. Drawing from first-hand experiences, I will outline the technical challenges encountered during the migration process and innovative solutions and best practices adopted to overcome them. It addresses issues such as maintaining document integrity, preserving hyperlink structures, and ensuring seamless integration with existing IT infrastructure. + + Amit Siddhartha + + + + + Syntax Diagrams: If you can't avoid them... + Syntax diagrams belong to the kind of special-purpose documentation that +nobody really wants to deal with, the presenter included. This is a brief overview of +real-world challenges in general and how to represent syntax diagrams in DITA in particular. + Frank Wegmann + + + + + Using DITA Open Toolkit Project to Implement a Publishing Service +in a Commercial Application + Oxygen Content Fusion version 6 started using DITA Open Toolkit project +files to define publications and deliverables and then to publish based on the defined +deliverables using a publishing service. In this small talk I will present the usefulness of +the DITA OT project file when it comes to defining deliverables, publication parameters and +publishing in the Oxygen Content Fusion commercial application. + Radu Coravu + + + + + + + DITA-OT "How far can you go" + I will demonstrate a plugin, which adds functions to the DITA-OT that are +very useful in particular for industry and reseach. Out of many helpful extensions there are +mechanisms like "Auto-Bibliography Generation", "Auto-Image Sizing", Page Control (e.g. +"Landscape page in a flow of upright pages") and many more. All extensions are convertible +into DOCX, HTML and CHM. A full documentation is available for all implemented extensions. + Helmut Scherzer + + + + + PDF5-ML Plugin Update + An update on the features of the PDF5-ML Plugin, including details of the +new automated ability to show Oxygen change tracking and comments in PDF output. + Tony Graham + + + + + DITA-OT and ensuring DITA Map conversion + DeltaXML software were until now focused on comparing two XML documents of +same structure and similar data to identify the changes between them by considering the +structure. However, we recently started to look at the use case where there is a need to +compare XML documents with different structure but similar data. We came across some of +partners and customers who convert their documents from one form of XML to another which needs +a manual process to check if there were any errors or inconsistencies during the document +conversion. DeltaXML's new product, ConversionQA, understands different document formats such +DITA, Microsoft Word, etc and performs a comparison between original and converted document +provide a quality assurance report. ConversionQA makes use of the DITA-OT transformation to +process DITA Maps into a single DITA file for conversion checking process with another single +file format. We have used DITA-OT Java Application Programming Interface in product to process +DITA Maps as a part of overall workflow. The lightning the talk will focus on how we have +integrated DITA-OT in conversion. We will also discuss the issues we faced during DITA OT +integration and how they were resolved. + Tejas Pradip Barhate + + + + + DITA and Markdown Interoperability using new schema-provider +extension mechanism + In order to support a new DITA <topicmeta> specialization, we added +support for it in Markdown content by leveraging the new schema-provider mechanism to +customize Markdown parsing and transparent DITA conversion. + John Kirkilis + + + + + Publishing with iiRDS from DITA + iiRDS, the tekom standard for the standardized exchange and delivery of +technical documentation, has been on the market for a few years. We have demonstrated in the +past why an XML standard like DITA is a good fit. Coming in 2024, tekom is publising an OT +plugin that allows to generate iiRDS packages from standard DITA, based on the metadata that +you already have. After a brief introduction to iiRDS, you will learn how you can make use of +the plugin in your DITA environment. + Marion Knebel + + + + + DITA-OT plug-in for work instructions: Say goodbye to manual +summaries and hello to accuracy and efficiency! + We understand the importance of having a clear and concise summary at the +beginning of each work instruction. That's why we've developed a plug-in that automates the +creation of these summaries based on the information in the individual steps of the work +instruction. With our DITA-OT plug-in, content creators can now easily add the tools, +supplies, and spare parts in the individual steps of the work instruction, knowing that the +summary will always reflect the most up-to-date information. No more worrying about +inconsistencies or discrepancies between the summary and the steps! This plug-in not only +saves time for the writer but also ensures that mechanics in the workshops have access to +accurate and reliable information. + Pieterjan Vandenweghe + + + + + Deploying and Maintaining DITA OTs in an Enterprise +environment + For our clients, we support DITA OTs from 1.5.2 to 4.x. More advanced users +can maintain and update their own OTs while others are maintained by Ixiasoft. We will discuss +some of the challenges in in supporting DITA OTs in an enterprise environment. + Eric Sirois + + + + + Cheap and Easy Cross-Deliverable Link Implementation + ServiceNow uses cross-deliverable key references to author and publish +links between publications, primarily published through Zoomin (https://docs.servicenow.com). +We implemented this by generating "delivery keydef maps" from our root maps from the peer map +references in each root map. We then use a simple OT extension and XSLT transform to swap the +peer maprefs for references to the delivery keydef maps at build time. The delivery keydef +maps are managed in a dedicated git repository. + Eliot Kimber + + + + + From zero to DITA-OT hero – a story of a DITA-OT implementation in +a small documentation team + So you just got a new job as a technical writer in a modern, high-tech +company. They want to move away from MS Word documentation to a structured documentation but +have no idea how to do it and guess what – you are the person who will do it from beginning to +the end! The problem is you don’t even know how to start... You have been doing documentation +in Adobe InDesign and MS Word so far. You only heard about this DITA thing and heard it’s +quite cool but haven’t done any work with it. In addition, your teammate is about to retire +and you are soon to learn that the Internet is NOT full of easy-access information about +DITA-OT. Embark with me on this exciting journey of big successes and many challenges +in setting up a working environment to write and publish user documentation with DITA and +DITA-OT. A light-hearted view on learning DITA and DITA Open Toolkit from scratch +while trying to prove to your new employer that yes, structured documentation is the best +solution and it will bring cost savings. + Justyna Hietala + + + + + IBM Workflow Manager: an automated build environment + In this presentation, I will talk about what IBM has been doing the last 5 +years with DITA, and how we integrated the DITA-OT as the center piece of our automated build +system for technical documentation, called IBM Workflow Manager (WFM). WFM is a cloud based +solution meant to automatically build DITA files stored in GitHub (possibility from multiple +repositories), test Accessibility, and publish the outputs to their final location (either IBM +Documentation website at ibm.com/docs or other channel like Box or sFTP servers). It also +connects to communication channels like Slack to give real-time feedback on any failure that +might happen. Along with edit links based on Oxygen Web Author, it creates a 0 click user +experience where users can edit their documentation from their browser, and see the output +live a few minutes later. + Guillaume Delory + + + + + Documentation Developments + This talk provides an overview of recent changes to the DITA-OT +documentation and project website, points out open issues, highlights ideas for future +improvements, and closes with room for suggestions from the community and a call for +contributions. + Roger Sheen - Documentation Lead + + + + + Moving an HTML plugin to preprocess2: how scared should you +be? + Our custom HTML plugin includes several extension points that hook into the +old "preprocess" steps -- meaning that when the base code moves to "preprocess2", those +extensions are lost. In this session, I will talk about what was required to adopt the updated +model, what worked and didn't, how we re-integrated the old extensions, and how we went about +testing the changes. + Robert D. Anderson - DITA-OT Project Lead + + + + + Retrospective - DITA-OT improvements between 3.7 and 4.1 + Taking a look at what features, improvements and bug fixes were added +between DITA OT 3.7 and 4.1. + Jarno Elovirta - DITA-OT Main Developer + + + diff --git a/resources/source-files.ditamap b/resources/source-files.ditamap index 4b1a61837..cf31aaa1d 100644 --- a/resources/source-files.ditamap +++ b/resources/source-files.ditamap @@ -36,6 +36,7 @@ + diff --git a/topics/dita-ot-day-2024.ditamap b/topics/dita-ot-day-2024.ditamap new file mode 100644 index 000000000..4df73b612 --- /dev/null +++ b/topics/dita-ot-day-2024.ditamap @@ -0,0 +1,33 @@ + + + + + DITA-OT Day 2024 + + + 2024 Helsinki + Helsinki 2024 + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/topics/dita-ot-day-videos-intro-2024.dita b/topics/dita-ot-day-videos-intro-2024.dita new file mode 100644 index 000000000..c56fa86a5 --- /dev/null +++ b/topics/dita-ot-day-videos-intro-2024.dita @@ -0,0 +1,17 @@ + + + + + DITA-OT Day Conference – Helsinki 2024 + February 11, 2024 in Helsinki, Finland. DITA-OT Day was not held in 2023. + + + + DITA-OT Day 2024 videos + + + + +

+ + diff --git a/topics/dita-ot-day-videos.ditamap b/topics/dita-ot-day-videos.ditamap index 798114721..0d9ee3d07 100644 --- a/topics/dita-ot-day-videos.ditamap +++ b/topics/dita-ot-day-videos.ditamap @@ -5,6 +5,7 @@ DITA-OT Day Videos +