- oXygen-user - www.oxygenxml.com

[ANN] Webinar: Oxygen XML & AI, Part 2 - Enhance Documentation with AI-Powered Insights (October 2, 2024)
by Alin Belu 27 Sep '24

27 Sep '24

Hello everyone, In the next part of the *Oxygen XML & AI* webinar series, taking place on *October 2nd*, we continue to explore the AI tools available to enhance your experience with the Oxygen ecosystem. This time, by looking at the ones designed to revolutionize the way your audience interacts with your technical documentation. In this 1-hour live event, you will discover how Oxygen Feedback 5.0 leverages the new *AI Assistant* feature to provide instant, context-aware answers, and also see the *AI-Enhanced Search Summary* in action, offering more relevant search results. Alin Balasa (senior developer at Syncro Soft) will demonstrate step-by-step how to seamlessly integrate these powerful tools into your WebHelp output, optimizing both content discovery and user engagement. Join us and unlock the potential of AI in your documentation workflows and empower your users to navigate and interact with your published content like never before! This event is free, but registration is required. Sign up here: https://oxygenxml.com/evs2024-5.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] New maintenance build available for oXygen 26.1 (2024091606)
by Oxygen XML Editor Support (Adrian Buza) 18 Sep '24

18 Sep '24

Dear oXygen users, We announce the release of a new maintenance build (2024091606) for oXygen 26.1 (XML Editor, XML Developer, XML Author, JSON Editor, WebHelp, Publishing Engine). The build number can be verified in the Help -> About dialog box from the application (next to the version number). You can download the new installation kits from our web site: http://www.oxygenxml.com/download.html Here you can find the complete list of bug-fixes: http://www.oxygenxml.com/build_history.html#2024091606 I would like to point out this important update for our Windows users: > *Windows/OpenJDK JRE:* Downgraded the bundled OpenJDK JRE to version > 17.0.11 due to stability issues with version 17.0.12 (crashes after > system sleep/resume). You can follow our oXygen release/build RSS feed here: http://www.oxygenxml.com/rssBuildID.xml Please let us know if you encounter any problems with this new build. Regards, Adrian -- Adrian Buza oXygen XML Editor and Author Support

1 0

[ANN] Oxygen XML & AI - a two-part webinar series coming soon!
by Alin Belu 13 Sep '24

13 Sep '24

Hello, We are thrilled to announce our upcoming two-part webinar series, *Oxygen XML & AI*, designed to help you enhance technical writing and documentation workflows with cutting-edge AI tools. Join us as we will dive into the powerful features and latest AI enhancements for the Oxygen XML suite of products! *Oxygen & AI, Part 1 - Accelerating Technical Writing* *(September 25th, 2024)* On the 25th of September, Sorin Carbunaru will introduce you to the newest version of the Oxygen AI Positron Assistant plugin - version 3.0. Discover how this tool can accelerate your workflows and boost efficiency, making your day-to-day tasks easier and faster without additional effort. Highlights will include: * The newly-implemented Retrieval-Augmented Generation (RAG) support * The AI Positron widget in the Author page * The new AI-powered actions available for working with DITA XML documents Register here: https://www.oxygenxml.com/events/2024/webinar_accelerating_technical_writin… *Oxygen & AI, Part 2 - Enhance Documentation with AI-Powered Insights* *(October 2nd, 2024)* In the second part of the series, Alin Balasa will delve into AI tools that transform user interactions with technical documentation. See how Oxygen Feedback 5.0's new AI Assistant feature can provide instant, context-aware answers, and experience the AI-Enhanced Search Summary for smarter, more relevant search results. Join us on October 2nd and learn how to: * Seamlessly integrate AI tools into your WebHelp output * Optimize content discovery and user assistance Register here: https://www.oxygenxml.com/events/2024/webinar_enhance_documentation_with_ai… Don't miss this opportunity to revolutionize your technical documentation and writing processes with Oxygen XML and the power of AI! Best regards, Alin -- Alin Belu Oxygen XML Editor

1 0

[ANN] Oxygen AI Positron Assistant 3.0 comes with RAG integration and new AI-powered actions!
by Alin Belu 06 Sep '24

06 Sep '24

Hi everyone, We are proud to announce the release of *version 3.0* for *Oxygen AI Positron Assistant*, the powerful tool that helps increase your productivity by providing support for using AI-generated content within Oxygen tools - Oxygen XML Editor/Author/Developer, Oxygen XML Web Author, and Oxygen Content Fusion. Version 3.0 continues to increase the efficiency of using the plugin as certain actions now leverage the *Retrieval-Augmented Generation (RAG)* process to obtain context from your current project, ensuring that the AI responses are not only more meaningful but also tailored for your particular projects. The new *AI Positron Assistant drop-down widget* offers a very quick and convenient way of accessing useful AI actions by displaying a floating contextual menu directly within the editing area. For example, it contains a useful new action named /Rewrite Content/ that opens a floating input box where you can provide the AI with instructions on how to process the selected content. Interface improvements include the possibility for you to customize your own AI actions to display as Quick Assist fixes in the editor. This feature presents a convenient pop-up menu on the left vertical navigation stripe with commonly used fixes, allowing for customization to align with individual preferences. Additionally, it is now possible to choose the OpenAI model used in chat sessions and actions right from the AI Positron Assistant view. This functionality provides a very quick and easy way to experiment with the different available models. A variety of new AI actions that are specific to working with DITA XML documents have been implemented, including a /Proofread/ action that helps identify potential issues in your content regarding logical consistency, grammar, spelling, readability, and comprehension. Furthermore, the new /Resolve Comments/ action enables the AI to change content based on suggestions found within comments and then also removes those comments to save time in the cleanup process. Other newly implemented actions include the /Improve Structure/ action that instructs the AI to enhance DITA XML documents by adding additional structure or inline elements, and the /Add Structured Content/ action continues the content from a document with additional structured content generated based upon similar content from the current project, which gives the AI more context for formulating the new XML structure. This release also comes with several additions for the Oxygen XML Web Author version of the plugin, including some of the above mentioned AI-powered actions (e.g. /Proofread/, /Resolve Comments/, and /Improve Structure/), alongside various other user experience enhancements. For more information, see: https://www.oxygenxml.com/ai_positron_assistant.html As always, thank you for your continued support and don't forget that feedback is highly appreciated! Best regards, Alin -- Alin Belu Oxygen XML Editor

1 0

[ANN] Get ready for DITA-OT Day 2025! (February 16, Copenhagen)
by Alin Belu 30 Aug '24

30 Aug '24

Hello everyone, We have great news! *DITA-OT Day* is returning for its *9th edition*, taking place this time in *Copenhagen*,*Denmark*, on *February 16*, *2025*! The full day conference dedicated to the DITA Open Toolkit project, the reference DITA implementation and the core of almost all DITA-based publishing solutions, is a *free *and *in-person event*. All you have to do to be a part of this event is to register for on-site participation, by filling out the form that is found on the DITA-OT Day 2025 event page - https://www.oxygenxml.com/events/2025/dita-ot_day.html . Furthermore, it is important to note that DITA-OT Day coincides with the pre-conference day of DITA Europe, both taking place at the Radisson Blu Scandinavia Hotel. *The call for proposals is currently in progress*, and we are actively seeking speakers who can address topics related to DITA-OT! Along with the usual updates on new features and plans, this year we want to focus on the people and teams using DITA-OT. Take a look at the Call for Proposals section for more information on how to submit your proposal and the deadline: https://www.oxygenxml.com/events/2025/dita-ot_day.html#call-for-proposals . We look forward to seeing you in Copenhagen! PS: In case you missed the opportunity to attend prior events or if you simply want to refresh your memory, you can access the recordings from past DITA-OT Day conferences at: https://www.oxygenxml.com/events/2025/dita-ot_day.html#related-events . Best regards, Alin -- Alin Belu Oxygen XML Editor

1 0

[Ann] New maintenance build available for oXygen 26.1 (2024073008)
by Oxygen XML Editor Support (Adrian Buza) 31 Jul '24

31 Jul '24

Dear oXygen users, We announce the release of a new maintenance build (2024073008) for oXygen 26.1 (XML Editor, XML Developer, XML Author, JSON Editor, WebHelp, Publishing Engine). The build number can be verified in the Help -> About dialog box from the application (next to the version number). You can download the new installation kits from our web site: http://www.oxygenxml.com/download.html Here you can find the complete list of bug-fixes: http://www.oxygenxml.com/build_history.html#2024073008 You can follow our oXygen release/build RSS feed here: http://www.oxygenxml.com/rssBuildID.xml Please let us know if you encounter any problems with this new build. Regards, Adrian -- Adrian Buza oXygen XML Editor and Author Support

1 0

[ANN] Oxygen XML Users Meetup 2024 recordings are now available!
by Alin Belu 15 Jul '24

15 Jul '24

Hello everyone, We are excited to announce that the recordings of the Oxygen XML Users Meetup 2024, held in the pre-conference day of XML Prague, are now available online! If you were unable to attend the event or just want to relive it, you can catch up on all the insightful presentations and discussions at your convenience. To watch the recordings, please visit our event page: https://www.oxygenxml.com/events/2024/oxygen_user_meetup_Prague.html As always, we appreciate your continued interest and support! Best regards, Alin -- Alin Belu Oxygen XML Editor

1 0

[ANN] Oxygen Content Fusion 7.0 introduces a personal authoring workspace and support for Continuous Deployment
by Alin Belu 10 Jul '24

10 Jul '24

Hello everyone, We are proud to announce the release of *Oxygen Content Fusion 7.0*, the web-based collaboration platform for content creation! *Oxygen Content Fusion* version *7.0* enhances the project support by introducing a *personal authoring workspace* where you can make changes across multiple files and once you are happy with the results, you can commit them directly to the repository to share them with your team. The dedicated /Changes/ side-view enables you to preview and adjust changes before committing. An XML-aware conflict resolution tool helps you pull changes from the repository, detects conflicts, suggests automated solutions, and also allows merging content manually for more complex scenarios. Along with the powerful editing features for XML documents, the built-in Web Author allows you to edit Markdown files inside the authoring workspace providing syntax preview and toolbar actions to insert common structures. The workspace feature includes a /Publications/ side-view for easy browsing of a publication's DITA map. Users can open the map in a specialized DITA map editor to modify the structure using toolbar or contextual menu actions. The intuitive interface supports drag and drop, copy/paste, and various other actions for organizing topics. The editor also supports advanced DITA features such as profiling attributes, key definitions, and map references. Continuous Deployment for the output is now possible as version 7.0 adds *support for publishing connectors* to enable uploading output to various platforms such as Amazon S3, Netlify, or servers with SFTP protocol. The output can be configured to include an "Edit Online" link in each topic that sends authors to their personal workspace where they can make changes to the source of that topic. When used in conjunction with automated builds, these changes will be live as soon as the build finishes. For more information about the new release, please see: https://www.oxygenxml.com/content_fusion/whats_new.html You may also try these new features on our public demo deployment: https://fusion.oxygenxml.com/projects We hope you will enjoy our latest release! 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

Re: [oXygen-user] [OXYGEN-15680] Re: Custom action to generate simple dialog?
by Oxygen XML Editor Support (Radu Coravu) 17 Jun '24

17 Jun '24

Hi Scott, I'll add an internal issue to improve the DocumentTypeInformation API. Possibly a not so elegant approach would be to get access to the framework XML file "DocumentTypeInformation.getFrameworkStoreLocation()", parse it and obtain the information from there. Regards, Radu Radu Coravu Oxygen XML Editor On 6/14/24 20:05, Scott Prentice wrote: > > Hi Radu, > > Thanks! I'll play with the script parameter a bit more to see how that > works. > > It seems that the DocumentTypeInfo API is different than the > DocumentTypeInformation API. I'm trying to get the active framework's > "Description", which is available from > DocumentTypeInfo.getDescription() but not > DocumentTypeInformation.getDescription(). Interestingly, > DocumentTypeInformation.getName() does work. > > Any ideas on how to access the framework description from the > authorAccess object? > > Thanks, > > Scott > > On 6/13/24 9:39 PM, Oxygen XML Editor Support (Radu Coravu) wrote: >> >> Hi Scott, >> >> So the "script" parameter should be a piece of Javascript content. >> For example you can pass as value of the "script" parameter this >> entire Javascript code here: >> >> https://github.com/oxygenxml/javascript-sample-operations/blob/master/copy-… >> >> To the value passed using "script" we add the entire Javascript from >> the "commons.js". So I guess in your case you have placed the entire >> content in the "commons.js" and passed an empty "script" parameter, >> which should also work as long as you have a "doOperation()" function. >> >> About accessing the DocumentTypeInfo API, your script has global >> access to an object named "authorAccess" which maps to this Java class: >> >> https://www.oxygenxml.com/InstData/Editor/SDK/javadoc/ro/sync/ecss/extensio… >> >> So something like this in the JS code: >> >> authorAccess.getEditorAccess().getDocumentTypeInformation() >> >> should give you access to this Java class: >> >> https://www.oxygenxml.com/InstData/Editor/SDK/javadoc/ro/sync/exml/workspac… >> >> That similar >> "ro.sync.ecss.extensions.api.webapp.doctype.DocumentTypeInfo" API >> that you wanted access to is specific for our web author in browser >> editor tool. >> >> Regards, >> >> Radu >> >> Radu Coravu >> Oxygen XML Editor >> On 6/13/24 19:48, Scott Prentice wrote: >>> >>> Thanks, Radu. >>> >>> I have a couple questions. >>> >>> It's not clear to me how the "script" parameter works with the >>> JSOperation class. I assume it can be used to pass in values to the >>> code in commons.js, but I'm not seeing how you'd do that. Can you >>> point me to any examples? >>> >>> Also. I see that commons.js has access to the AuthorAccess API. I'd >>> like to access DocumentTypeInfo interface >>> (ro.sync.ecss.extensions.api.webapp.doctype.DocumentTypeInfo) .. can >>> I do that from commons.js? I've tried a few things, without much >>> success. >>> >>> Thanks! >>> >>> Scott >>> >>> >>> On 6/12/24 8:27 PM, Oxygen XML Editor Support (Radu Coravu) wrote: >>>> >>>> Hi Scott, >>>> >>>> Right. We do not have a special Author operation to show a message >>>> to the end user. >>>> >>>> This operation could be used to open a web page if for example you >>>> want to present to the end user the information in a web browser: >>>> >>>> https://www.oxygenxml.com/doc/versions/26.1/ug-editor/topics/dg-default-aut… >>>> >>>> Regards, >>>> Radu >>>> >>>> Radu Coravu >>>> Oxygen XML Editor >>>> On 6/13/24 03:06, Scott Prentice wrote: >>>>> If you're interested, here's one way to do this. I'm sure there's >>>>> a more elegant way and this is probably a bit if a hack, but it >>>>> does what I need right now. >>>>> >>>>> 1. In. your framework's Document Type dialog, on the >>>>> Author:Actions subtab, add an action to the framework, give it an >>>>> ID and a Name. >>>>> 2. In the Action dialog select this Operation: >>>>> ro.sync.ecss.extensions.commons.operations.JSOperation >>>>> 3. A 'script' argument will be added, leave the value empty. >>>>> 4. Choose OK. (Leave the Document Type dialog up for now.) >>>>> 5. Create a commons.js file in the root of your framework >>>>> directory, with the following content .. >>>>> >>>>> function doOperation(){ >>>>> parentFrame = authorAccess.getParentFrame(); >>>>> javax.swing.JOptionPane.showMessageDialog(parentFrame, "MESSAGE >>>>> HERE"); >>>>> } >>>>> >>>>> 6. In the Document Type dialog, on the Author:Menu subtab, add >>>>> your new action to your menu (assuming one exists). >>>>> 7. Choose OK, then OK. >>>>> >>>>> Open a document in Author view that uses your framework. You >>>>> should see the new menu item. >>>>> >>>>> Clearly, if you're already using the commons.js file for something >>>>> else, you'll need to pass in some parameter and tweak the JS code >>>>> .. but this is a start. :-) >>>>> >>>>> Cheers, >>>>> >>>>> Scott >>>>> >>>>> On 6/12/24 1:32 PM, Scott Prentice wrote: >>>>>> >>>>>> Hi, >>>>>> >>>>>> Is there a built-in method for creating an action (to call from a >>>>>> toolbar or menu) that displays a simple dialog that contains >>>>>> informational text? I'd like to have an "About" dialog that's >>>>>> associated with a framework. I assume I can do this by creating a >>>>>> custom class, but wanted to see if there was an OOB option for this. >>>>>> >>>>>> Thanks! >>>>>> >>>>>> Scott >>>>>> >>>>>> >>>>>> >>>>>> >>>>>> _______________________________________________ >>>>>> oXygen-user mailing list >>>>>> oXygen-user(a)oxygenxml.com >>>>>> https://www.oxygenxml.com/mailman/listinfo/oxygen-user >>>>> >>>>> _______________________________________________ >>>>> oXygen-user mailing list >>>>> oXygen-user(a)oxygenxml.com >>>>> https://www.oxygenxml.com/mailman/listinfo/oxygen-user >>>> >>>> _______________________________________________ >>>> oXygen-user mailing list >>>> oXygen-user(a)oxygenxml.com >>>> https://www.oxygenxml.com/mailman/listinfo/oxygen-user >>> >>> _______________________________________________ >>> oXygen-user mailing list >>> oXygen-user(a)oxygenxml.com >>> https://www.oxygenxml.com/mailman/listinfo/oxygen-user >> >> _______________________________________________ >> oXygen-user mailing list >> oXygen-user(a)oxygenxml.com >> https://www.oxygenxml.com/mailman/listinfo/oxygen-user > > _______________________________________________ > oXygen-user mailing list > oXygen-user(a)oxygenxml.com > https://www.oxygenxml.com/mailman/listinfo/oxygen-user

2 1

Re: [oXygen-user] [OXYGEN-15680] Re: Custom action to generate simple dialog?
by Oxygen XML Editor Support (Radu Coravu) 14 Jun '24

14 Jun '24

Hi Scott, So the "script" parameter should be a piece of Javascript content. For example you can pass as value of the "script" parameter this entire Javascript code here: https://github.com/oxygenxml/javascript-sample-operations/blob/master/copy-… To the value passed using "script" we add the entire Javascript from the "commons.js". So I guess in your case you have placed the entire content in the "commons.js" and passed an empty "script" parameter, which should also work as long as you have a "doOperation()" function. About accessing the DocumentTypeInfo API, your script has global access to an object named "authorAccess" which maps to this Java class: https://www.oxygenxml.com/InstData/Editor/SDK/javadoc/ro/sync/ecss/extensio… So something like this in the JS code: authorAccess.getEditorAccess().getDocumentTypeInformation() should give you access to this Java class: https://www.oxygenxml.com/InstData/Editor/SDK/javadoc/ro/sync/exml/workspac… That similar "ro.sync.ecss.extensions.api.webapp.doctype.DocumentTypeInfo" API that you wanted access to is specific for our web author in browser editor tool. Regards, Radu Radu Coravu Oxygen XML Editor On 6/13/24 19:48, Scott Prentice wrote: > > Thanks, Radu. > > I have a couple questions. > > It's not clear to me how the "script" parameter works with the > JSOperation class. I assume it can be used to pass in values to the > code in commons.js, but I'm not seeing how you'd do that. Can you > point me to any examples? > > Also. I see that commons.js has access to the AuthorAccess API. I'd > like to access DocumentTypeInfo interface > (ro.sync.ecss.extensions.api.webapp.doctype.DocumentTypeInfo) .. can I > do that from commons.js? I've tried a few things, without much success. > > Thanks! > > Scott > > > On 6/12/24 8:27 PM, Oxygen XML Editor Support (Radu Coravu) wrote: >> >> Hi Scott, >> >> Right. We do not have a special Author operation to show a message to >> the end user. >> >> This operation could be used to open a web page if for example you >> want to present to the end user the information in a web browser: >> >> https://www.oxygenxml.com/doc/versions/26.1/ug-editor/topics/dg-default-aut… >> >> Regards, >> Radu >> >> Radu Coravu >> Oxygen XML Editor >> On 6/13/24 03:06, Scott Prentice wrote: >>> If you're interested, here's one way to do this. I'm sure there's a >>> more elegant way and this is probably a bit if a hack, but it does >>> what I need right now. >>> >>> 1. In. your framework's Document Type dialog, on the Author:Actions >>> subtab, add an action to the framework, give it an ID and a Name. >>> 2. In the Action dialog select this Operation: >>> ro.sync.ecss.extensions.commons.operations.JSOperation >>> 3. A 'script' argument will be added, leave the value empty. >>> 4. Choose OK. (Leave the Document Type dialog up for now.) >>> 5. Create a commons.js file in the root of your framework directory, >>> with the following content .. >>> >>> function doOperation(){ >>> parentFrame = authorAccess.getParentFrame(); >>> javax.swing.JOptionPane.showMessageDialog(parentFrame, "MESSAGE HERE"); >>> } >>> >>> 6. In the Document Type dialog, on the Author:Menu subtab, add your >>> new action to your menu (assuming one exists). >>> 7. Choose OK, then OK. >>> >>> Open a document in Author view that uses your framework. You should >>> see the new menu item. >>> >>> Clearly, if you're already using the commons.js file for something >>> else, you'll need to pass in some parameter and tweak the JS code .. >>> but this is a start. :-) >>> >>> Cheers, >>> >>> Scott >>> >>> On 6/12/24 1:32 PM, Scott Prentice wrote: >>>> >>>> Hi, >>>> >>>> Is there a built-in method for creating an action (to call from a >>>> toolbar or menu) that displays a simple dialog that contains >>>> informational text? I'd like to have an "About" dialog that's >>>> associated with a framework. I assume I can do this by creating a >>>> custom class, but wanted to see if there was an OOB option for this. >>>> >>>> Thanks! >>>> >>>> Scott >>>> >>>> >>>> >>>> >>>> _______________________________________________ >>>> oXygen-user mailing list >>>> oXygen-user(a)oxygenxml.com >>>> https://www.oxygenxml.com/mailman/listinfo/oxygen-user >>> >>> _______________________________________________ >>> oXygen-user mailing list >>> oXygen-user(a)oxygenxml.com >>> https://www.oxygenxml.com/mailman/listinfo/oxygen-user >> >> _______________________________________________ >> oXygen-user mailing list >> oXygen-user(a)oxygenxml.com >> https://www.oxygenxml.com/mailman/listinfo/oxygen-user > > _______________________________________________ > oXygen-user mailing list > oXygen-user(a)oxygenxml.com > https://www.oxygenxml.com/mailman/listinfo/oxygen-user

2 1