February 2018 - oXygen-sdk - www.oxygenxml.com

DITA: 'Refresh references' of a topic with nested conrefs, removes the first character of the text content of this element (node) with the conref attribute
by Pascal Beutels 01 Mar '18

01 Mar '18

Hi, When diving deeper into our custom variable resolver, we found an issue with resolving of nested conrefs (which affects our custom variable resolver which can have nested variables or nested conrefs). Below an example case with standard DITA files (not from our repository, nor customized) and standard Oxygen XML Author to explain the issue: We have a topic with a ph element that has some text inside the element (simple_topic.dita -> <ph conref="...">Text content inside ph element that has the conref attribute.</ph>) This ph element has a conref attribute to a ph inside conref_niv_1.dita. This ph element in conref_niv_1.dita, contains another ph with a conref to conref_niv_2.dita. The example topics at the end of the e-mail (and attached) make it more clear. The issue is that with every refresh of the references (Oxygen menu: DITA -> Refresh references), a character is removed from the text content of the ph element in simple_topic.dita, change the content of this topic... We noted this when improving our custom 'variable' resolving which is based on the Oxygen DITAConRefResolver (package ro.sync.ecss.extensions.dita.conref -> DITAConRefResolver.java). We do an override of: public SAXSource resolveReference( AuthorNode node, String systemID, AuthorAccess authorAccess, EntityResolver entityResolver) And while debugging, we notice that in the incoming AuthorNode parameter (node) this character is already removed. This can be seen when: * getting the text of all the content nodes using node.getTextContent(), there the first character is already gone. * converting the node to an AuthorElement (which it is) and creating an AuthorDocumentFragment from it and then serialize it using AuthorDocumentController.serializeFragmentToXML, the text content of that element is also already stripped. Code sample/snippet: if (node instanceof AuthorElement) { AuthorElement element = (AuthorElement) node; .... AuthorDocumentController documentController = authorAccess.getDocumentController(); AuthorDocumentFragment fragFromNode = documentController.createDocumentFragment(element, true); xml = documentController.serializeFragmentToXML(fragFromNode); ... * using your suggested approach using a AuthorElementDomWrapper created from this AuthorElement. We found this for Oxygen 19.1, we can also reproduced on Oxygen 17.1 Kind regards, Pascal Example topics: simple_topic.dita <?xml version="1.0" encoding="UTF-8"?> <!DOCTYPE topic PUBLIC "-//OASIS//DTD DITA Topic//EN" "topic.dtd"> <topic id="simple_topic"> <title>Simple Topic</title> <body> <ph conref="conref_niv_1.dita#conref_niv_1/id_conref_niv_1">Text content inside ph element that has the conref attribute.</ph> </body> </topic> conref_niv_1.dita <?xml version="1.0" encoding="UTF-8"?> <!DOCTYPE topic PUBLIC "-//OASIS//DTD DITA Topic//EN" "topic.dtd"> <topic id="conref_niv_1"> <title>Conref niv 1</title> <body> <ph id="id_conref_niv_1">Content from conref_niv_1, followed by nested conref from niv 2: <ph conref="conref_niv_2.dita#conref_niv_2/id_conref_niv_2"/></ph> </body> </topic> conref_niv_2.dita <?xml version="1.0" encoding="UTF-8"?> <!DOCTYPE topic PUBLIC "-//OASIS//DTD DITA Topic//EN" "topic.dtd"> <topic id="conref_niv_2"> <title>conref niv 2</title> <body> <ph id="id_conref_niv_2">Content from conref_niv_2 </ph> </body> </topic> www.sdl.com SDL PLC confidential, all rights reserved. If you are not the intended recipient of this mail SDL requests and requires that you delete it without acting upon or copying any of its contents, and we further request that you advise us. SDL PLC is a public limited company registered in England and Wales. Registered number: 02675207. Registered address: SDL PLC, New Globe House, Vanwall Business Park, Vanwall Road, Maidenhead, SL6 4UB, U.K.

2 1

Oxygen 17.1: Availability of escapeTextValue in XMLUtilAccess
by Pascal Beutels 21 Feb '18

21 Feb '18

Hi, Is there a similar function available in Oxgyen 17.1 as there is from Oxygen 18+ to XML escape text (XMLUtilAccess -> escapeTextValue). Regards, Pascal www.sdl.com SDL PLC confidential, all rights reserved. If you are not the intended recipient of this mail SDL requests and requires that you delete it without acting upon or copying any of its contents, and we further request that you advise us. SDL PLC is a public limited company registered in England and Wales. Registered number: 02675207. Registered address: SDL PLC, New Globe House, Vanwall Business Park, Vanwall Road, Maidenhead, SL6 4UB, U.K.

2 1

Re: [oXygen-sdk] Check out a resource during Replace All
by Jeroen Laridon 20 Feb '18

20 Feb '18

Hi Radu, The problem is solved for batch "Replace All" operations (Find/Replace in Files...) by overriding the function "getOutputStream". But, when using "Find/Replace..." on a single file, the file is not checked out, and when clicking the button "Replace All", a message "One match replaced" is shown, while nothing changes in the document itself. The read-only flag is set on the file, and the whole content is disabled. When trying to change the document by entering some text, a notification "Read-only content" is shown. How can we check out the document before it is changed by the "Replace All" operation? Or, if it is not possible, can the notification/message "Read-only content" be shown instead of "One match replaced", when the content is read-only? Kind regards, Jeroen www.sdl.com SDL PLC confidential, all rights reserved. If you are not the intended recipient of this mail SDL requests and requires that you delete it without acting upon or copying any of its contents, and we further request that you advise us. SDL PLC is a public limited company registered in England and Wales. Registered number: 02675207. Registered address: SDL PLC, New Globe House, Vanwall Business Park, Vanwall Road, Maidenhead, SL6 4UB, U.K. -----Original Message----- From: oXygen-sdk [mailto:oxygen-sdk-bounces@oxygenxml.com] On Behalf Of oxygen-sdk-request(a)oxygenxml.com Sent: maandag 12 februari 2018 19:00 To: oxygen-sdk(a)oxygenxml.com Subject: oXygen-sdk Digest, Vol 51, Issue 5 Send oXygen-sdk mailing list submissions to oxygen-sdk(a)oxygenxml.com To subscribe or unsubscribe via the World Wide Web, visit https://www.oxygenxml.com/mailman/listinfo/oxygen-sdk or, via email, send a message with subject or body 'help' to oxygen-sdk-request(a)oxygenxml.com You can reach the person managing the list at oxygen-sdk-owner(a)oxygenxml.com When replying, please edit your Subject line so it is more specific than "Re: Contents of oXygen-sdk digest..." Today's Topics: 1. Re: Check out a resource during Replace All (Oxygen XML Editor Support (Radu Coravu) ) ---------------------------------------------------------------------- Message: 1 Date: Mon, 12 Feb 2018 09:53:58 +0200 From: "Oxygen XML Editor Support (Radu Coravu) " <support(a)oxygenxml.com> To: oxygen-sdk(a)oxygenxml.com Subject: Re: [oXygen-sdk] Check out a resource during Replace All Message-ID: <b845966d-0486-27bd-f754-d2e24e21ba1d(a)oxygenxml.com> Content-Type: text/plain; charset=utf-8; format=flowed Hi Jeroen, I agree with your findings, indeed somehow I wanted to give this callback before Oxygen actually starts to read the URL's contents, but before Oxygen starts reading the URL's contents it does not know if it will make changes to the contents so right now although the callback is named "aboutToModifyResource(BatchOperationInfo, URL)" we give it for each resource. So this is definitely not OK. I will add an issue on our side. Maybe for now you could detect when Oxygen calls your URL handler's "getOutputStream()" method. This means Oxygen is about to write to the file. If before "getOutputStream()" is called you also had a call of "aboutToModifyResource(BatchOperationInfo, URL)" for the same URL, this means that you need to check out the file (on the "getOutputStream()" method). So you should move the file checkout from "aboutToModifyResource" to "getOutputStream()". Regards, Radu Radu Coravu <oXygen/> XML Editor, Schema Editor and XSLT Editor/Debugger http://www.oxygenxml.com On 2/9/2018 4:04 PM, Jeroen Laridon wrote: > Hi, > > > > We use "aboutToModifyResource" in "TrisoftBatchOperationsListener" to > check out a topic in a map before it is modified. > > But "aboutToModifyResource" is triggered on all topics in the map, not > only topics that will be modified. > > That way all topics and the map are checked out, while only a few are > changed. > > Expected is that only resources that will change are checked out. > > > > Is there a way to find out up front if a resource will be changed or not? > > > > Kind regards, > > > > Jeroen > > *www.sdl.com* <http://www.sdl.com/> > > SDL PLC confidential, all rights reserved. If you are not the intended > recipient of this mail SDL requests and requires that you delete it > without acting upon or copying any of its contents, and we further > request that you advise us. > SDL PLC is a public limited company registered in England and Wales. > Registered number: 02675207. > Registered address: SDL PLC, New Globe House, Vanwall Business Park, > Vanwall Road, Maidenhead, SL6 4UB, U.K. > > > > > _______________________________________________ > oXygen-sdk mailing list > oXygen-sdk(a)oxygenxml.com > https://www.oxygenxml.com/mailman/listinfo/oxygen-sdk > ------------------------------ Subject: Digest Footer _______________________________________________ oXygen-sdk mailing list oXygen-sdk(a)oxygenxml.com https://www.oxygenxml.com/mailman/listinfo/oxygen-sdk ------------------------------ End of oXygen-sdk Digest, Vol 51, Issue 5 *****************************************

2 1

Check out a resource during Replace All
by Jeroen Laridon 12 Feb '18

12 Feb '18

Hi, We use "aboutToModifyResource" in "TrisoftBatchOperationsListener" to check out a topic in a map before it is modified. But "aboutToModifyResource" is triggered on all topics in the map, not only topics that will be modified. That way all topics and the map are checked out, while only a few are changed. Expected is that only resources that will change are checked out. Is there a way to find out up front if a resource will be changed or not? Kind regards, Jeroen www.sdl.com SDL PLC confidential, all rights reserved. If you are not the intended recipient of this mail SDL requests and requires that you delete it without acting upon or copying any of its contents, and we further request that you advise us. SDL PLC is a public limited company registered in England and Wales. Registered number: 02675207. Registered address: SDL PLC, New Globe House, Vanwall Business Park, Vanwall Road, Maidenhead, SL6 4UB, U.K.

2 1

Re: [oXygen-sdk] oXygen-sdk Digest, Vol 51, Issue 2
by Pascal Beutels 08 Feb '18

08 Feb '18

Hi, That is what we do now. Attached two screenshots: Out-of-the-box Oxygen behavior (dita file not from our repository, but from the file system) -> attached file: non_repository_conrefed_file_not_found.png Behavior for a dita document from our repository, handled through our custom plug-in (which is a FileNotFound) -> attached file: from_repository_conrefed_file_not_found.png If possible we would like to see the same [Target file not found] error and the details when hoovering over the error icon. getCanonicalFileFromFileUrl is indeed in our CustomProtocolHandler. I think we get the file not found error because it is raised at the time Oxygen wants to open the file to get the conrefed content. But I think we need to validate somewhere earlier in the process if the conrefed document exists and throw the correct exception there? -Pascal www.sdl.com SDL PLC confidential, all rights reserved. If you are not the intended recipient of this mail SDL requests and requires that you delete it without acting upon or copying any of its contents, and we further request that you advise us. SDL PLC is a public limited company registered in England and Wales. Registered number: 02675207. Registered address: SDL PLC, New Globe House, Vanwall Business Park, Vanwall Road, Maidenhead, SL6 4UB, U.K. -----Original Message----- From: oXygen-sdk [mailto:oxygen-sdk-bounces@oxygenxml.com] On Behalf Of oxygen-sdk-request(a)oxygenxml.com Sent: Wednesday, February 7, 2018 7:00 PM To: oxygen-sdk(a)oxygenxml.com Subject: oXygen-sdk Digest, Vol 51, Issue 2 Send oXygen-sdk mailing list submissions to oxygen-sdk(a)oxygenxml.com To subscribe or unsubscribe via the World Wide Web, visit https://www.oxygenxml.com/mailman/listinfo/oxygen-sdk or, via email, send a message with subject or body 'help' to oxygen-sdk-request(a)oxygenxml.com You can reach the person managing the list at oxygen-sdk-owner(a)oxygenxml.com When replying, please edit your Subject line so it is more specific than "Re: Contents of oXygen-sdk digest..." Today's Topics: 1. Re: Handle 'Target file not found' in our custom plugin/dita framework (Radu Coravu) ---------------------------------------------------------------------- Message: 1 Date: Tue, 6 Feb 2018 20:00:22 +0200 From: Radu Coravu <support(a)oxygenxml.com> To: oxygen-sdk(a)oxygenxml.com Subject: Re: [oXygen-sdk] Handle 'Target file not found' in our custom plugin/dita framework Message-ID: <354e568b-bb2c-96cc-ae07-cb383a186c6c(a)oxygenxml.com> Content-Type: text/plain; charset="utf-8"; Format="flowed" Hi Pascal, Maybe when your URLConnection.getInputStream() is called for an URL to a non existing resource you could throw a " FileNotFoundException" which extends IOException. About your remark: > For the moment we return a new File(tothenonexistingpath) in > getCanonicalFileFromFileUrl where in the code is that? In your custom url connection handler? Can you give me more details? Regards, Radu On 2/6/18 5:01 PM, Pascal Beutels wrote: > > Hi, > > When handling conrefs to objects that no longer exist in our CMS, we > would like to handle this the same way as regular dita files with the > same issue. > > E.g > > <noteid="GUID-364D534C-E105-4CA7-81B5-FA910387D630"conref="./Jenkins/n > onexistingfile.dita"> > > Results in a ‘[Target file not found]’ error with more details when > you hover over. > > For the moment we return a new File(tothenonexistingpath) in > getCanonicalFileFromFileUrl, which results in the erro: > > xxx\GUID-C2F39B76-FDC6-4E7C-80E1-36E7BC635FBA (The system cannot find > the file specified) > > Is there a way we can raise the same error from our custom code? > > Kind regards, > > Pascal > > *www.sdl.com* <http://www.sdl.com/> > > SDL PLC confidential, all rights reserved. If you are not the intended > recipient of this mail SDL requests and requires that you delete it > without acting upon or copying any of its contents, and we further > request that you advise us. > SDL PLC is a public limited company registered in England and Wales. > Registered number: 02675207. > Registered address: SDL PLC, New Globe House, Vanwall Business Park, > Vanwall Road, Maidenhead, SL6 4UB, U.K. > > > > _______________________________________________ > oXygen-sdk mailing list > oXygen-sdk(a)oxygenxml.com > https://www.oxygenxml.com/mailman/listinfo/oxygen-sdk -- Radu Coravu Oxygen XML Editor

1 0

Handle 'Target file not found' in our custom plugin/dita framework
by Pascal Beutels 06 Feb '18

06 Feb '18

Hi, When handling conrefs to objects that no longer exist in our CMS, we would like to handle this the same way as regular dita files with the same issue. E.g <note id="GUID-364D534C-E105-4CA7-81B5-FA910387D630" conref="./Jenkins/nonexistingfile.dita"> Results in a '[Target file not found]' error with more details when you hover over. For the moment we return a new File(tothenonexistingpath) in getCanonicalFileFromFileUrl, which results in the erro: xxx\GUID-C2F39B76-FDC6-4E7C-80E1-36E7BC635FBA (The system cannot find the file specified) Is there a way we can raise the same error from our custom code? Kind regards, Pascal www.sdl.com SDL PLC confidential, all rights reserved. If you are not the intended recipient of this mail SDL requests and requires that you delete it without acting upon or copying any of its contents, and we further request that you advise us. SDL PLC is a public limited company registered in England and Wales. Registered number: 02675207. Registered address: SDL PLC, New Globe House, Vanwall Business Park, Vanwall Road, Maidenhead, SL6 4UB, U.K.

2 1