Xref Functionality Like Full Map Editing For Approval Tasks plugin for Content Fusion

[dreifsnider]

Hi,

My team is using the Full Map Editing For Approval Tasks plugin in our Content Fusion instance and we're very happy with its functionality.

We especially like the xref functionality this plugin provides, in that when a user clicks on an xref they are navigated to the corresponding location of the xref target in the concatenated DITA Map view instead of opening the xref target in a separate browser tab.

We noticed that the Edit Topic Content (BETA) feature in Web Author performs a similar functionality of concatenating the DITA Map and its references in a single view. However, the xref functionality is not the same as Content Fusion's Full Map Editing For Approval Tasks plugin. For instance, in Web Author when clicking on an xref in the Edit Topic Content (BETA) view, a separate browser tab opens with the xref target instead of navigating to the corresponding location of the xref target in the concatenated DITA Map view.

Is is possible for Web Author's Edit Topic Content (BETA) feature to perform a similar functionality for xrefs as Content Fusion's Full Map Editing For Approval Tasks plugin?

Thank you!

Daniel

[cosminef]

Hello,

To simulate similar behavior on Web Author as well, you need to modify the plugin.js file (found in \content-fusion-full-map-approvals\web\plugin.js) as follows:
Instead of

Code: Select all

const shouldOpenFullMap = window.parent.document.title.includes('[APPROVAL]')

you must chage it to:

Code: Select all

  const shouldOpenFullMap = true;

And also, you can try adding:

Code: Select all

  workspace.listen(sync.api.Workspace.EventType.EDITOR_LOADED, function(e) {
    e.editor.listen(sync.api.Editor.EventTypes.LINK_OPENED, e => {
	  e.linkTarget = sync.api.Editor.LinkOpenedEvent.Target.SELF;
	});
  });

preferably after the code block of the first 'if' in the code.

After making the modification, install the plugin in Web Author, restart the server, and test it.
You can try this approach and let us know what you think.

Best,
Cosmin

[dreifsnider]

Hi Cosmin,

Thank you very much for your reply. I made the changes you recommended and it works as expected.

One thing I would to note though is that it only worked with Cristian's original code in the plugin.js. I got unexpected behaviors when using the latest plugin.js code from Bogdan.

While this does achieve what we want, we don't want to always enforce the DITA Map view in the editor. We would like our Web Author users to also be able to view individual topics in the editor as well.

Therefore, is it possible to activate this plugin only when the DITA Map is loaded in the editor, and specifically when Edit Topic Contents (BETA) / editReferencesInPlace is enabled?

Something like:

Code: Select all

  const queryString = window.location.search;
  const urlParams = new URLSearchParams(queryString);
  if (!urlParams.has('url')) {
    return;
  }
  const urlParameter = urlParams.get('url');
  const shouldOpenFullMap = urlParameter.endsWith('.ditamap') && urlParams.has('editReferencesInPlace');
  if (!shouldOpenFullMap) {
    return;
  }

(I tried the above but the plugin never seemed to activate or have an affect. I suspect it's because shouldOpenFullMap never resolved to true.)

Any help or assistance on this would be greatly appreciated.

Thanks,

Daniel

[cosminef]

Hello,

Thank you for your feedback.

One thing I would to note though is that it only worked with Cristian's original code in the plugin.js. I got unexpected behaviors when using the latest plugin.js code from Bogdan.

Can you elaborate on this observation? We would like to clarify these aspects before continuing to offer you proposals related to custom customizations

Thank you for your understanding.

Best,
Cosmin

[dreifsnider]

Hi Cosmin,

Thank you for your reply about this.

The plugin code on the master branch causes the entire editor to reload before scrolling to the correct location when every link is clicked, whether from the DITA Map side-view or from an xref. The plugin code from commit 42011490 does not do this and the editor scrolls to the corresponding topic in the editor without refreshing the entire editor.

The only difference I can tell from master and commit 42011490 is in the BEFORE_EDITOR_LOADED listener so this is what I replaced in the plugin code.

I hope this helps and thanks,

Daniel

[cosminef]

Hello,

Thank you for your reply.

I put together a short video showing this behavior:
https://sie.box.com/s/zg4s9q0ulfd38y8i23jpv9a0miq9kkzg

Unfortunately, that video is no longer accessible; we receive the error: "This shared file or folder link has been removed or is unavailable to you."
We would like to be able to view it so we can understand exactly what is happening.

Best,
Cosmin

[dreifsnider]

Hi Cosmin,

Sorry, I had to remove the video because it showed some proprietary information. I will work on recreating another video to demonstrate this behavior.

[cosminef]

Hello,

You can upload your demonstration video on our support form as well [1].

[1] https://www.oxygenxml.com/techSupport.html

Best,
Cosmin

[dreifsnider]

Hi Cosmin,

Thank you for letting me know that. I submitted a ticket with my previous video attached. Ticket ID is: OXYGEN-TS-6250

Please let me know if you have any issues or questions about the video.

Thanks!

Daniel

[cosminef]

Hello,

We have received the demo video, and we will continue the discussion via email.

Best,
Cosmin