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

[ANN] Webinar: OpenAPI Editing, Testing, and Documenting (April 6)
by Alin Belu 31 Mar '22

31 Mar '22

Hello everyone, OpenAPI is a community-driven open specification that defines a language-agnostic interface used to describe, produce, consume, and visualize RESTful APIs and web services. OpenAPI documents describe the API (or its elements) and are represented in either YAML or JSON formats. Next Wednesday, on the *6th of April*, Octavian Nadolu (project manager at Syncro Soft) will help you *discover the support offered in Oxygen for OpenAPI documents* as well as how to create, edit, test, and generate documentation. During this live webinar, you will get the chance to learn how to: * Edit OpenAPI documents in the Oxygen Text mode. * Use OpenAPI documents in Author mode - you have access to some form controls, collapsible sections, and other features that help you visualize and edit these types of documents. * Test an OpenAPI, execute API requests, and validate responses on the fly to ensure that they work as expected. * Generate documentation for OpenAPI components in HTML format, including comprehensive annotations and cross-references. This is a free event but registration is required. You can register at https://oxygenxml.com/evs2022-7.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

[ANN] Webinar: Techniques for Customizing the WebHelp Responsive Output (March 30)
by Alin Belu 24 Mar '22

24 Mar '22

Hello, The need to customize the appearance of published documentation is something that is being addressed constantly by our users. As a solution, Oxygen WebHelp offers a predefined set of layouts and styles, resulting in several different customization methods or combinations of methods. To get you accustomed to these options, Alin Balasa (software developer at Syncro Soft) put together a comprehensive live webinar that will walk you through some of the several techniques available for customizing the WebHelp Responsive output. By joining us on the 30th of March, you will get the chance to learn the following: * What are the page types available and their components * What is the Publishing Template – its purpose, structure, and resources * Using CSS to change the layout and styles of your output * Inserting additional HTML content * How to insert dynamic content using WebHelp Macros * Adding new functionalities using JavaScript * How to copy additional resources in the output folder * Modifying the page structure using XSLT * Various customization examples This is a free event but registration is required. You can register at https://oxygenxml.com/evs2022-3.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

[ANN] Webinar: Create JSON Schema in Design Mode (TODAY)
by Alin Belu 23 Mar '22

23 Mar '22

Hello everyone, Don't miss today's chance to find out more about the improved and even more powerful and expressive visual schema diagram editor for editing JSON Schemas! From the start, the structure of the diagram editor, known as the *JSON Schema Design mode*, was created to be intuitive and easy to use, no matter the level of your experience. And with the help of Octavian Nadolu, project manager at Syncro Soft, you will get to see how the Design mode can help both content authors who want to visualize or understand a schema and schema designers who develop complex schemas. By joining TODAY's (March 23rd) live webinar, you will also get the chance to learn: * How to create JSON schemas from scratch * How to use the new Pallet view to add new components * How to use the drag-and-drop support to design your JSON Schema * How to use refactoring actions * How to visualize and edit complex JSON Schemas This is a free event but registration is required. You can register at https://oxygenxml.com/evs2022-6.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

[ANN] Webinar: Create JSON Schema in Design Mode (March 23, 2022)
by Alin Belu 17 Mar '22

17 Mar '22

Hello everyone, With the recent release of version 24.1, Oxygen XML Editor now provides an improved and even more powerful and expressive visual schema diagram editor for editing JSON Schemas! From the start, the structure of the diagram editor, known as the *JSON Schema Design mode*, was created to be intuitive and easy to use, no matter the level of your experience. And with the help of Octavian Nadolu, project manager at Syncro Soft, you will get to see how the Design mode can help both content authors who want to visualize or understand a schema and schema designers who develop complex schemas. By joining next Wednesday's (March 23rd) live webinar, you will also get the chance to learn: * How to create JSON schemas from scratch * How to use the new Pallet view to add new components * How to use the drag-and-drop support to design your JSON Schema * How to use refactoring actions * How to visualize and edit complex JSON Schemas This is a free event but registration is required. You can register at https://oxygenxml.com/evs2022-6.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

[ANN] Oxygen XML Editor version 24.1 is now available!
by Alin Belu 10 Mar '22

10 Mar '22

Hello everyone, We are incredibly proud to announce the immediate availability of *version 24.1* of its industry-leading XML suite of products: *Oxygen XML Editor*, *Author*, *Developer, Web Author, Publishing Engine, WebHelp, PDF Chemistry, *and*Oxygen XML Scripting*! This release includes productivity improvements for DITA authors and publishers, such examples being the possibility to rename referenced non-DITA resources directly in the DITA Maps Manager and performance enhancement when opening DITA maps with all of the referenced content expanded. On the DITA publishing side, the bundled DITA Open Toolkit was updated to the latest version and various updates, improvements, and new customization possibilities were implemented for DITA to WebHelp and CSS-based PDF output. The innovative JSON Schema Design mode received a lot of improvements with a new Palette view that makes it very easy to build JSON schemas and content completion is now available for in-place editing within the diagram. Some of the existing JSON tools were also enhanced. Add-ons were a major focus of this release, with many of the most popular ones receiving lots of updates, including the Git Client, Batch Documents Converter, OpenAPI Documentation Generator, OpenAPI Tester, and more, while an interesting new Smart Autocomplete add-on is also available to help writers create content by providing text completions. With a focus on authoring experience and collaboration, the Oxygen XML Web Author now features a new Search side-view that makes it easier to find and replace content, support for @ mentions, and various security and component updates were also implemented. ============================================================================= *Oxygen XML Editor version 24.1* is an incremental release for the industry's most advanced bundle of tools used by technical writers, developers, collaborators, and publishers everywhere. The focus of this release was to expand upon the new features and improvements that were added in version 24.0. An example of a productivity enhancement for DITA authors is that you can now rename referenced non-DITA resources directly in the DITA Maps Manager and performance was improved when opening DITA maps with all of the referenced content expanded. Meanwhile, on the DITA publishing side, the bundled DITA Open Toolkit was updated to the latest version and new transformation parameters make it possible to display media objects with an external link and to have glossary entries sorted and grouped. The innovative JSON Schema Design mode that was recently introduced in the previous version received a lot of further enhancements. You can now move and re-order components within the diagram, a new Palette view makes it very easy to build JSON schemas by offering quick access to components that can be dragged and dropped into the diagram, new items were added to the contextual menu for easier access to various actions, and content completion is now available for in-place editing within the diagram. Some of the existing JSON tools were also enhanced. You can now mark properties to be required when using the JSON Schema Generator tool, the XML to JSON converter tool now offers the possibility of controlling how empty elements are converted, and the JSON Schema Documentation generator tool now presents diagrams in the generated documentation for components from referenced files and you can choose to include hyperlinks that navigate to the particular component. Add-ons were a major focus of this release, with many of the most popular ones receiving lots of updates. The Git Client add-on continued to be enhanced with the addition of a revision graph within the History view, various actions were added while the toolbar was simplified to display the most common actions, performance was optimized, and some components were updated. The Batch Documents Converter add-on now includes the possibility of converting content from Atlassian Confluence to DITA, and the DocBook to DITA conversion offers an option to convert all sections into individual DITA topics that are referenced in a new DITA map. It also now provides options for configuring the mappings between elements for certain types of conversions and tables are now handled better when converting Markdown to DITA. For OpenAPI developers, a new OpenAPI Documentation generator tool is available to easily generate full documentation for OpenAPI components in HTML format and a new OpenAPI Tester is available to inspect OpenAPI request responses and to ensure they work as expected. This release also marks the introduction of an interesting new Smart Autocomplete add-on that helps writers create content by providing text completions. It contributes a side-view where you can choose between a Built-in or OpenAI engine for generating the proposals for text completion. The Built-in engine analyzes all XML, HTML, or Markdown files in a project and then offers completion proposals when editing text content, while the OpenAI engine uses language models provided by the OpenAI company. Not only does that engine offer text completion proposals, but it also contributes various configurable actions that can be used to transform the selected text in the editor, and it allows you to create your own fine-tuned language models. Some examples of the actions that are available to transform the selected text include grammar corrections, paraphrasing, translating content into other languages, adding markup, creating ordered lists, and many more. XSLT and XQuery transformations and debugging features were enhanced as the built-in version of Saxon was updated to version 10.6, which is considered to be the most stable and reliable version of Saxon. Also, a new option was added in the Compile XSL Stylesheet for Saxon dialog box that allows you to set the default namespace for unprefixed element names. Other improvements include the complete removal of the Apache Log4j library to prevent security vulnerabilities associated with it, a new setting to control the initial display mode for tracked changes in the Author visual editing mode, more Markdown rules were added, and as usual, this release includes various important component updates and bug fixes. For more information, see: https://www.oxygenxml.com/xml_editor/whats_new.html ============================================================================= *Oxygen XML Scripting* provides a variety of functions that can be scheduled or triggered using a command-line tool on Windows, Linux, or macOS. The main focus for version 24.1 was various additions and improvements for the Batch Converter script. For details, see: https://www.oxygenxml.com/xml_scripting/whats_new.html ============================================================================= *Oxygen Publishing Engine version 24.1* encompasses all of the improvements and new customization possibilities implemented in Oxygen XML WebHelp and Oxygen PDF Chemistry. For Oxygen XML WebHelp publishers, this release added some Ant extension points to allow custom tasks to be executed before and after various transformation steps, the context-sensitive help system was optimized, and new transformation parameters were added to help you customize your WebHelp output. Some examples of the improvements and updates that were added to Oxygen PDF Chemistry include the processor now offering support for absolute positioning for inline elements and the dependency on the Log4j library was removed to help prevent possible security vulnerability issues. For more information, see: https://www.oxygenxml.com/publishing_engine/whats_new.html ============================================================================= *Version 24.1.0 of Oxygen XML Web Author* is the latest release for the innovative web-based XML authoring tool. This release expands upon the features that were recently added in Version 24.0.0 with further improvements to some of those features, along with several new enhancements. A new Search side-view makes it easier to find and replace content, @ mentions are now supported, performance was optimized, new functionality improves customizations and integrations, and various bugs were fixed, security was enhanced, and some components were updated. For more information, see: https://www.oxygenxml.com/xml_web_author/whats_new.html ============================================================================= We hope you will enjoy our latest release of the Oxygen XML suite of products! As always, feedback is welcome! Best regards, Alin -- Alin Belu Oxygen XML Editor

1 0

[ANN] Version 4.0.2 of the Git Client add-on has been released!
by Alin Belu 07 Mar '22

07 Mar '22

Hello everyone, We are extremely proud to announce the release for *version 4.0.2* of the *Git Client add-on*! From the beginning, the main purpose for this add-on was to increase the functionality of the Oxygen ecosystem by providing our users with a dependable Git staging option that is easy to access right from the editor. In version 4.0.2 of the Git Client add-on, we expanded its functionality even further with improvements such as: * The History view now includes a new revision graph that helps you understand how commits connect with one another. * You now have the ability to manage remote repositories (add, edit or delete), track a remote branch for the current branch, or to edit the repository's configuration file. * A new Git menu that contains various Git actions was added to the main menu bar. * In the History view you can choose which branches will have the history shown. You have the following options: Current branch, Current local branch, All branches, All local branches. * A new Checkout action was added to the History view contextual menu to check out a branch at a specific commit (either in detached head form or by creating a new branch at that commit). * A combo box was added in the Git staging view to switch between local branches. * The Git Staging view toolbar was simplified to only include the most important actions (while all actions are available in a new three vertical dots menu). * Performance was improved by optimizing the process of checking the status of the repository. * The Stash dialog box now has a column that shows the creation time for each stash. * Fixed an issue where the index got reset after pulling changes from the remote. To install the add-on, follow this procedure: 1. Go to *Help > Install new add-ons* to open an add-on selection dialog box. Enter or paste https://www.oxygenxml.com/InstData/Addons/default/updateSite.xml in the Show add-ons from field or select it from the drop-down menu. 2. Select the *Git Client* add-on and click *Next*. 3. Read the end-user license agreement. Then select the *I accept all terms of the end-user license agreement* option and click *Finish*. 4. Restart the application. *Result:* The Git Staging view is now available. To open the view, select *Git Staging* from the *Window > Show View* menu (or select *Git Client* from the *Tools* menu). This view acts as a basic Git client integrated directly in Oxygen XML Editor, and it provides support for committing changes to a Git repository, comparing and merging changes, resolving conflicts, and other Git commands. For more information, see the details for the Git Client add-on on the page below: https://www.oxygenxml.com/doc/ug-editor/topics/git-addon.html We hope that you will enjoy using the latest release of the Git Client add-on as much as we enjoyed developing it. As always, feedback is welcome! Best regards, Alin -- Alin Belu Oxygen XML Editor

1 0

[ANN] Framework for AH Formatter hyphenation exception dictionaries
by Tony Graham 04 Mar '22

04 Mar '22

A new Oxygen framework for editing AH Formatter hyphenation exception dictionaries is available at: https://github.com/AntennaHouse/hyphenation-info The 'hyphenation-info' update site URL is: https://raw.githubusercontent.com/AntennaHouse/hyphenation-info/master/add-… The add-on provides a Relax NG schema and Schematron for validating AH Formatter hyphenation exception dictionary XML files plus CSS styles for editing the files in Author mode. For more information about hyphenation support in AH Formatter, see: https://www.antenna.co.jp/AHF/help/en/ahf-hyp.html Comments and suggestions for improvement are welcome. Regards, Tony Graham. -- Senior Architect XML Division Antenna House, Inc. ---- Skerries, Ireland tgraham(a)antenna.co.jp

1 0

[ANN] OpenAPI Tester add-on version 1.1.0 is now available!
by Alin Belu 02 Mar '22

02 Mar '22

Hello everyone, We are excited to announce that the *OpenAPI Tester add-on version 1.1.0* is now released and available in the Oxygen add-on library! Version 1.1.0 of the add-on comes with the following improvements: * You can now use the testing tool for OpenAPI documents represented in YAML format, as well as in JSON format. * Added basic support for the OpenAPI 3.1.0 specification (except for webhooks). * Various bugs related to schema references and rendering parameters were fixed. * The layout of the view has been improved. To install the add-on, follow these instructions: 1.Go to *Help > Install new add-ons* to open an add-on selection dialog box. 2. Enter or paste https://www.oxygenxml.com/InstData/Addons/default/updateSite.xml in the *Show add-ons from* field or select it from the drop-down menu. 3. Select the *OpenAPI Tester* add-on and click *Next*. 4. Read the end-user license agreement. Then select the I accept all terms of the end-user license agreement option and click Finish. 5. Restart the application. *Result:* The OpenAPI Tester is now available. To use the tool, select *OpenAPI Tester* from the *Tools > JSON Tools* menu. This opens a dialog box where you can specify the location of the OpenAPI file that you want to test. For more information on the OpenAPI Tester add-on, we invite you to check the page below: https://www.oxygenxml.com/doc/ug-editor/topics/openapi-tester.html We hope you will find this add-on useful and as always, your feedback is welcome! Best regards, Alin -- Alin Belu Oxygen XML Editor

1 0

[ANN] Webinar: Real-time concurrent editing with Oxygen Web Author integrated in a CCMS
by Jean-Luc Borie 01 Mar '22

01 Mar '22

Hello, Next week, we will be hosting a webinar to demonstrate *real-time concurrent editing with Oxygen Web Author* integrated in a CCMS and managed using secure workflows designed for regulated industries: *Pain relief for convoluted review cycles: **Agile meets compliance!* - Ever wondered what it would be like to have your draft reviewed and approved in just one cycle? - Tired of multiple emails between you and SMEs? - Does your agile team exclude the documentation team from sprint planning? Come and see an example of *how you can use Oxygen Web Author to perform concurrent reviews and editing*. This is enhanced using a workflow that assigns tasks, changes document status and responds to change management requirements in regulated industries, including the need to *trace all actions for full auditability*. 10 March 2022 7am PST / 10 AM EST / 4PM CET This is a free event but registration is required: https://register.gotowebinar.com/register/1360469039262305550?source=oXygen… -- Kind regards, Jean-Luc Borie Componize Software

1 0

[ANN] Version 4.0.0 of the Oxygen Batch Documents Converter add-on has been released!
by Alin Belu 01 Mar '22

01 Mar '22

Hello everyone, We are excited to announce that *version 4.0.0* of the *Oxygen Batch Documents Converter add-on *is now available! The newest version of this add-on comes with the following useful improvements: * The addition of a Confluence to DITA conversion. * The addition of a DocBook to DITA conversion. * The name of the extracted DITA topic files when converting to a DITA map with topics has been improved. * The extraction title of the DITA map when converting to a DITA map with topics has been improved. * The 'alt' attributes from images are now handled properly when converting HTML to DITA. To install the add-on, follow these instructions: 1. Go to *Help > Install new add-ons* to open an add-on selection dialog box. 2. Enter or paste https://www.oxygenxml.com/InstData/Addons/default/updateSite.xml in the *Show add-ons from* field. 3. Select the *Batch Documents Converter* add-on and click *Next*. 4. Read the end-user license agreement. Then select the *I accept all terms of the end-user license agreement* option and click*Finish*. 5. Restart the application. *Result:* A Batch Documents Converter submenu will now be available in the Tools menu and in the contextual menu. This submenu will contain a list of the various types of available conversions. Selecting one of the types of conversions will open a dialog box where you can configure options for the conversion. For more information on the Oxygen Batch Documents Converter add-on, check the page below: https://www.oxygenxml.com/doc/ug-editor/topics/batch-converter-addon.html We hope you will find this add-on useful and as always, your feedback is welcome! Best regards, Alin -- Alin Belu Oxygen XML Editor

1 0