March 2023 - oXygen-user - www.oxygenxml.com

IDs for new DITA topics
by Frank Dissinger 03 Apr '23

03 Apr '23

Hi all, I understand that a topic ID must be unique within the scope of the root ditamap used for publishing the content. FrameMaker, which I used previously, creates IDs of the type id172OC0C03J7 So there is an arbitrary combination of 11 digits and letters. In oXygen I have set the "DITA > ID Option" as follows: ${localName}_${id} Which creates IDs of the following type: task_rf2_vcg_ywb So there is an arbitrary combination of only 9 characters, mostly letters. But perhaps sufficient for ensuring uniqueness... However, when I use the "DITA > Insert > Insert New DITA Resource" command, oXygen does not honor the "ID Option" setting, but creates IDs which are identical to the file name. This is not what I want and surely not suitable for ensuring uniqueness. How can I get oXygen to honor the "ID Option" setting or make it otherwise generate IDs with arbitrary characters which are likely to be unique? Regards, Frank -- *Frank Dissinger* Documentation Manager .................................................................... *CGS Publishing Technologies International GmbH* *Email *frank.dissinger(a)cgs-oris.com | *Web* www.cgs-oris.com <http://www.cgs-oris.com/> *Address* Kettelerstr. 24 | D-63512 Hainburg | Germany *Phone* +49 6182 9626-27 | *Fax* +49 6182 9626-99 *Commercial register* Offenbach, HRB no. 21495 *Managing directors* Bernd Rückert, Christoph Thommessen https://www.cgs-oris.com/Signatur.png <https://www.cgs-oris.com/signatur>

3 4

[ANN] Webinar: DITA Project Management, Validation, and Translation in a Docs as Code Environment (April 5th)
by Alin Belu 29 Mar '23

29 Mar '23

Hello, Get ready to mark your calendars because the Oxygen XML live event series is making a comeback! Next Wednesday, on the *5th of April*, don't miss out on the chance to attend our first webinar of spring - we're talking about the *DITA Project Management, Validation, and Translation in a Docs as Code Environment* webinar! /Docs as Code/ is a philosophy according to which you should write documentation using the same tools and workflows that software developers use to write code. But it's not so much about the tools, as it is about the workflows and practices involved, such as continuous integration or version control. Next week, join Sorin Carbunaru (senior software developer at Syncro Soft) as he will look at such a setup using open-source tools and standards that include: * DITA, as the plain text format we'll use, because it fits the profile and brings additional benefits to the mix: semantics, content reuse, publishing options. * Storage and version control using Git (trunk-based development). * Project validation in continuous integration pipelines. * Translation workflows based on Fluenta: - Creating and sharing a Fluenta configuration. - Sending the DITA project to the translation service provider as XLIFF. - Generating the translated version of the DITA project once the XLIFF returns from translation. This is a free event but registration is required. You can register at https://oxygenxml.com/evs2023-4.html To stay in touch with us and discover what other events we have planned for you, please make sure to check https://www.oxygenxml.com/events_programme.html Best regards, Alin -- Alin Belu Oxygen XML Editor

1 0

Struggling with conkeyref/conaction=pushafter
by Frank Dissinger 29 Mar '23

29 Mar '23

Hi all, I have tested the "DITA > Push Current element" feature, but cannot get it to work. I want to inject a <dlentry> element into a shared topic which is used in two projects. The element to be injected is stored in a warehouse topic for project 1. What I want is to inject this element only when project 1 is built. When project 2 is built, the key to the warehouse topic resolves to a different file which doese not include the element. So what I hope is that the element is only injected when I build project 1 and that it is left out when I build project 2 -- without any error or warning generated in the log file or in Oxygen's editor window. However, the element does not appear in project 1 and in Oxygen it is shown as an empty <dt> struture. In a previous attempt the element was shown in the editor window, but not in output either. I can't remember what I did differently... I may not have undestood this feature correctly. Can someone enlighten me? Thank you. Regards, Frank The dita code: * * *file.dita* <dlentry conaction="mark" conkeyref="lib_ref/my_id"> <dt/> <dd> </dd> </dlentry> <dlentry conaction="pushafter"> <dt>A term. The term in lib_ref.dita should be injected after that.</dt> <dd> Explanation </dd> </dlentry> *lib_ref.dita * <dl> <dlentry id="my_id"> <dt>The term to inject after the term in file.dita</dt> <dd> Explanation </dd> </dlentry> </dl> *variables.ditamap* <keydef href="reuse/lib_ref.dita" keys="lib_ref"/> Appearance in oXygen. -- *Frank Dissinger* Documentation Manager .................................................................... *CGS Publishing Technologies International GmbH* *Email *frank.dissinger(a)cgs-oris.com | *Web* www.cgs-oris.com <http://www.cgs-oris.com/> *Address* Kettelerstr. 24 | D-63512 Hainburg | Germany *Phone* +49 6182 9626-27 | *Fax* +49 6182 9626-99 *Commercial register* Offenbach, HRB no. 21495 *Managing directors* Bernd Rückert, Christoph Thommessen https://www.cgs-oris.com/Signatur.png <https://www.cgs-oris.com/signatur>

3 5

Do I need a namespace declaration in dita root elements?
by Frank Dissinger 24 Mar '23

24 Mar '23

Hi all, I am cleaning up DITA files created with FrameMaker. FrameMaker has added a lot of unnecessary attributes, for example. Among others, FM has added an *xmlns:ditaarch* attribute to every top-level dita element such as concept, task or reference. Example: <concept id="id187JBI00EHS" xml:lang="en-US" *xmlns:ditaarch="http://dita.oasis-open.org/architecture/2005/"*> Can I safely remove this attribute or is it required? Regards, Frank -- *Frank Dissinger* Documentation Manager .................................................................... *CGS Publishing Technologies International GmbH* *Email *frank.dissinger(a)cgs-oris.com | *Web* www.cgs-oris.com <http://www.cgs-oris.com/> *Address* Kettelerstr. 24 | D-63512 Hainburg | Germany *Phone* +49 6182 9626-27 | *Fax* +49 6182 9626-99 *Commercial register* Offenbach, HRB no. 21495 *Managing directors* Bernd Rückert, Christoph Thommessen https://www.cgs-oris.com/Signatur.png <https://www.cgs-oris.com/signatur>

4 3

v25.1 plugins for CALS tables, LaTeX rendering
by Michael Boudreau 21 Mar '23

21 Mar '23

The notes for Oxygen 25.1 mentioned plugins to support CALS tables and LaTeX equation rendering. Where is this documented? -- Michael R. Boudreau Electronic Publishing Technology Manager The University of Chicago Press 1427 E. 60th Street Chicago, IL 60637 www.journals.uchicago.edu

2 2

Spell check exceptions per file?
by Frank Dissinger 21 Mar '23

21 Mar '23

Hi all, When spell checking a dita file, can I mark up words to be correct in the current file only, i.e. without adding them to the "learned words" for the project or globally? Regards, Frank -- *Frank Dissinger* Documentation Manager .................................................................... *CGS Publishing Technologies International GmbH* *Email *frank.dissinger(a)cgs-oris.com | *Web* www.cgs-oris.com <http://www.cgs-oris.com/> *Address* Kettelerstr. 24 | D-63512 Hainburg | Germany *Phone* +49 6182 9626-27 | *Fax* +49 6182 9626-99 *Commercial register* Offenbach, HRB no. 21495 *Managing directors* Bernd Rückert, Christoph Thommessen https://www.cgs-oris.com/Signatur.png <https://www.cgs-oris.com/signatur>

2 1

Learned Words
by Frank Dissinger 20 Mar '23

20 Mar '23

Hi list, I have a list of correctly spelt words which I collected in FrameMaker. How can I add them to the list of "learned words" in oXygen? I added them to the *.tdi file, but oXygen overwrites this file when I use the spell checker and so the words are gone. Regards, Frank -- *Frank Dissinger* Documentation Manager .................................................................... *CGS Publishing Technologies International GmbH* *Email *frank.dissinger(a)cgs-oris.com | *Web* www.cgs-oris.com <http://www.cgs-oris.com/> *Address* Kettelerstr. 24 | D-63512 Hainburg | Germany *Phone* +49 6182 9626-27 | *Fax* +49 6182 9626-99 *Commercial register* Offenbach, HRB no. 21495 *Managing directors* Bernd Rückert, Christoph Thommessen https://www.cgs-oris.com/Signatur.png <https://www.cgs-oris.com/signatur>

2 1

[ANN] Oxygen XML Editor version 25.1 has been released!
by Alin Belu 17 Mar '23

17 Mar '23

Hello everyone, We are incredibly excited to announce the immediate availability of *version 25.1* of its industry-leading XML suite of products: *Oxygen XML Editor*, *Author*, *Developer*, *Web Author*, *Publishing Engine*, *WebHelp*, *PDF Chemistry*, and *Scripting*, as well as *version 3.0* of the *Oxygen Feedback* comment management platform. Some of the highlights of this release include various productivity improvements for *DITA authors* and new possibilities for *DITA publishers* who produce either CSS-based PDF or WebHelp output. *JSON schema designers* can look forward to more functionality to help them in Design mode, as well as upgrades to some of the JSON tools, and support for editing JSON Lines documents. *YAML developers* will be happy to see that the YAML editing support was bolstered to a level similar to Oxygen's JSON support. Many of Oxygen's *popular add-ons* were updated with new options, visual improvements, performance enhancements, and ease-of-use features. The *scripting community* now has access to some *ready-to-use GitHub project templates and GitHub actions* that allow users to automate scripts and some of the existing scripts were improved, while new ones were added. This release also provides various important *component updates*, *bug fixes*, and *security enhancements*. *Oxygen XML Web Author*, the cutting-edge web-based XML authoring tool, comes with even more improvements and updates. This release brings you updates for the *comparison* tool and *image maps*, new plugins are available for adding support for *CALS tables in custom frameworks*, rendering *LaTeX equations*, and providing *client-side evaluation of XPath* expressions. Various other enhancements were implemented as well. One of the major additions in the latest version of *Oxygen Feedback* is the *Content Indexing and Search* feature, which enables you to utilize Oxygen Feedback as an external search engine for your published Oxygen WebHelp Responsive output. =============================================================================** *What's new in Oxygen XML Editor 25.1* *Oxygen XML Editor version 25.1* is a minor release of the industry-leading bundle of tools for content authors, developers, collaborators, and publishers. This release offers both enhancements to existing functionality and some brand new features that were requested by the community. For *DITA authors*, when working with DITA-OT projects that define multiple output configurations (called contexts), it is easier to select the current context used to see how the DITA content looks like in that configuration using the *re-designed interface*. It facilitates the *context selection with improved grouping and filtering options*. Starting with DITA 1.3, it is possible to *specify filters for a branch of a DITA map* through a functionality called branch filtering. Oxygen's advanced *DITA map validation and completeness check now factors in branch filtering*. DITA 1.3 also introduced the concept of key scopes, enabling you to specify different sets of key definitions for different map branches. Oxygen's *DITA Reusable Components view* has a new filtering option to show keys with the closest relative key scope to the current editing location, and key references are validated taking the key scope into account. The *DITA Map Metrics Report* that contains useful statistics for the current DITA map was *redesigned to allow easier navigation* to its various categories. *Performance was improved when editing large DITA maps* and the Change or remove profiling attribute value refactoring action also updates DITAVAL filter files. *DITA publishers* who produce CSS-based PDF output have the possibility of *displaying line numbers or visual markers for whitespace characters in code blocks*, making code snippets easier to read in the output. The *error reporting was improved* when publishing DITA-OT Project files. For example, the transformation error messages displayed in the Results pane contain the ID of the deliverable. You can also *c**ontrol the behavior of footnotes* using a new transformation parameter that when set to yes, causes footnotes that are referenced multiple times throughout a publication to be cloned and placed at the bottom of the page for each occurrence instead of subsequent references pointing back to the original footnote. For *WebHelp publishers*, this release added new parameters for *disabling the generation of index terms* and *excluding topic IDs from context-sensitive help*, a new extension point can also be used to help you *fine-tune the XSLT transformation* that generates the mapping for context-sensitive help, and the JQuery library that comes bundled with WebHelp is accessible in the browser's global context enabling developers to use it. The innovative *JSON Schema Design mode* received further enhancements. A new action was added to *flatten the entire hierarchy of JSON schemas*, the Extract Definition type actions work on multiple selections of components, and the *functionality of search actions was extended* to enable them to be used on the root schema component. The *XSD to JSON Schema conversion tool* and the *JSON Schema Documentation Generator* were both upgraded to fix various issues and enhance performance. Also, basic *editing support was added for JSON Lines documents*, and JSON property names are now displayed after ending brackets to make the code more readable when editing JSON documents in Text mode. *YAML developers* have *access to an Outline view* that displays the list of all the components of the document in a hierarchical (tree-like) representation and can be used to navigate to a specific part, or to move or delete components. *Content completion assistance* was implemented to help you *edit YAML documents by offering proposals for inserting YAML structures* that are valid at the current editing location. Various actions (e.g. *Toggle Line Comments*, *Copy JSON Pointer*, and *Copy XPath*) were also implemented to bring the *YAML editing support to a level similar to Oxygen's JSON support*. For *XSLT and XQuery users*, a new version of the *Saxon XSLT and XQuery Transformer add-on is now available for Saxon 12 *and the Saxon 11 version of the add-on was also updated to incorporate Saxon 11.5, the latest maintenance release of the Saxon 11 engine. Also, the output of *XQuery Trace functions* (used in XML refactoring actions for debugging purposes) is presented in the Results view to make the information more readily available. Many of the most *popular add-ons received updates* and some interesting *new add-ons were implemented*. The *Git Client add-on* offers *new options, visual improvements, performance enhancements, and ease-of-use features*. Various performance, layout, and rendering improvements were implemented for both the *JSON Schema and OpenAPI Documentation Generator tools*, and the *Batch Documents Converter and Terminology Checker add-ons* also received various updates to bolster their functionality. A *new Live Tutorials add-on* is available to help you create tutorials for learning various editing functions for a certain vocabulary. This add-on also comes bundled with some *small tutorials that teach you how to do various DITA editing tasks*. Another new add-on is available to help you *manage Fluenta DITA translation projects*. Other improvements include basic editing support and syntax highlights for *Dockerfile* documents, relative references in Framework Extension Script files are automatically resolved, certain *XML refactoring operations process faster*, and as usual, this release includes various important *component updates*, *bug fixes*, and *security enhancements*. For more information, see: https://www.oxygenxml.com/xml_editor/whats_new.html ============================================================================= *What's new in Oxygen XML Scripting 25.1* *Oxygen XML Scripting version 25.1* offers updates and improvements for some of the scripts that are available to provide a variety of functions that can be scheduled or triggered using a command-line tool on Windows, Linux, or macOS. The *scripting community *now has access to some *ready-to-use GitHub project templates and GitHub actions* that allow users to automate scripts that will be triggered every time you push changes to your repository. For example, there are templates that execute *validation* and *transformation* operations, while other templates allow you to *compare directories* or *generate **XSD/XSL/WSDL Documentation*. The Validation script also received various improvements. For example, *framework validation scenarios are automatically detected for OpenAPI, AsyncAPI, and JSON-LD documents*. New scripts were added for *generating JSON Schema or OpenAPI Documentation*. For more information, see: https://www.oxygenxml.com/xml_scripting/whats_new.html ============================================================================= *What's new in Oxygen XML Web Author 25.1* *Version 25.1.0* of *Oxygen XML Web Author* is a minor release for the innovative web-based XML authoring tool. This release brings you improvements for the comparison tool and image maps, new plugins are available for adding support for CALS tables in custom frameworks, rendering LaTeX equations, and providing client-side evaluation of XPath expressions, while various other enhancements also were implemented. This latest version includes several notable improvements. One of the main areas of focus was on *enhancing stability and performance for non-Latin language input method editors (IME)*. The Web Author's file comparison tool has also been improved with new parameters and better visual highlighting of *surround-type edits*. New actions that *move selected block elements* have been introduced to help improve productivity. *Image maps* now support images referenced using keys, and several *new open-source plugins are available*, including one for adding *support for CALS tables in custom frameworks*, one for rendering *LaTeX equations*, and another for *evaluating XPath expressions* client-side. This version also includes a range of other *productivity improvements*, *component updates*, *bug fixes*, and *security enhancements*. For more information, see: https://www.oxygenxml.com/xml_web_author/whats_new.html ============================================================================= *What's new in Oxygen Feedback 3.0* *Version 3.0* of *Oxygen Feedback* offers exciting new enhancements for the modern comment management platform that provides a simple and efficient way for your community to interact with and offer feedback about your content. Some of the most significant additions for this version include the new *search functionality* that allows you to use Oxygen Feedback as an external search engine for your published Oxygen WebHelp Responsive output. The benefit of this functionality is the *efficiency of the search process*, which is performed on a pre-built index of the HTML content. Oxygen Feedback supports a vast list of languages to be used in the indexing process. The page ratings component was enhanced to provide the possibility of displaying a survey when a user gives a negative rating for a page. The *page ratings statistics page* in the administration interface now has columns for both positive and negative votes, and shows the negative survey messages, which are also sent to admins in daily email notifications. You also have the ability to choose whether to display like/dislike icons instead of text responses (e.g. Yes and No) for the page ratings component. Both Cloud and Enterprise editions also include other *productivity improvements*, *bug fixes*, and *customization options*. For more information about the *Oxygen Feedback Cloud edition*, see: https://www.oxygenxml.com/oxygen_feedback_cloud/whats_new.html For more information about the *Oxygen Feedback Enterprise edition*, see: https://www.oxygenxml.com/oxygen_feedback_enterprise/whats_new.html ============================================================================= *What's new in Oxygen Publishing Engine 25.1* *Oxygen Publishing Engine* offers the same publishing functionality from Oxygen XML Editor to be used for automation and continuous integration/delivery (CI/CD) tasks. *Version 25.1* includes the improvements and additions implemented in *Oxygen XML WebHelp* and *Oxygen PDF Chemistry*. For *Oxygen XML WebHelp publishers*, this release added a new parameter for excluding topic IDs from context-sensitive help mappings, a new parameter to disable the generation of index terms, a new extension point to help you insert custom XSLT code to modify the XSLT transformation that generates the mapping for context-sensitive help, and the JQuery library that comes bundled with WebHelp is accessible in the browser's global context enabling developers to use it. Starting with *version 25.1* of *Oxygen PDF Chemistry*, you have the ability to *embed videos in your PDF output*. It is possible to *display line numbers or markers for whitespace characters* in code blocks to make your code snippets easier to read. You can also *control the behavior of footnotes* using a new transformation parameter that when set to yes, causes footnotes that are referenced multiple times throughout a publication to be cloned and placed at the bottom of the page for each occurrence, instead of subsequent references pointing back to the original footnote. This release also includes various *bug fixes* and *security enhancements*. For more information, see: https://www.oxygenxml.com/publishing_engine/whats_new.html ============================================================================= We hope you will enjoy our latest release of the Oxygen XML suite of products! As always, thank you for your support and don't forget that feedback is welcome! Best regards, Alin -- Alin Belu Oxygen XML Editor

1 0

Ditamap archive?
by Frank Dissinger 14 Mar '23

14 Mar '23

Hi all, Does oXygen provide a tool which creates a ZIP archive of a ditamap with all referenced files? Frank -- *Frank Dissinger* Documentation Manager .................................................................... *CGS Publishing Technologies International GmbH* *Email *frank.dissinger(a)cgs-oris.com | *Web* www.cgs-oris.com <http://www.cgs-oris.com/> *Address* Kettelerstr. 24 | D-63512 Hainburg | Germany *Phone* +49 6182 9626-27 | *Fax* +49 6182 9626-99 *Commercial register* Offenbach, HRB no. 21495 *Managing directors* Bernd Rückert, Christoph Thommessen https://www.cgs-oris.com/Signatur.png <https://www.cgs-oris.com/signatur>

2 2

Warning from ODD processor
by Lou Burnard 10 Mar '23

10 Mar '23

Not sure whose problem this is, but the built in ODD to RELAXNC processor (part of the oXygen TEI framework) at release 25 of oxygen editor still seems to be using a component that needs updating. [xslt] Loading stylesheet /home/lou/Oxygen XML Editor 25/frameworks/tei/xml/tei/stylesheet/profiles/default/relaxng/to.xsl [echo] TRANG generate RNC from RELAXNG files WARNING: A terminally deprecated method in java.lang.System has been called WARNING: System::setSecurityManager has been called by org.apache.tools.ant.types.Permissions (file:/home/lou/Oxygen%20XML%20Editor%2025/tools/ant/lib/ant.jar) WARNING: Please consider reporting this to the maintainers of org.apache.tools.ant.types.Permissions WARNING: System::setSecurityManager will be removed in a future release [delete] Deleting: /home/lou/Public/odd4crit/out/odd4crit.rnc.rng "terminally deprecated" sounds a lot worse than it probably is...

2 1