Link viewer that lists incoming and outgoing links

Are you missing a feature? Request it's implementation here.
debi
Posts: 1
Joined: Wed Aug 05, 2020 2:51 am

Link viewer that lists incoming and outgoing links

Post by debi » Wed Aug 05, 2020 3:57 am

I would like to have a viewer that clearly shows the following in three separate panes that are all visible at the same time:
* All docs/maps that include the current topic - this would tell me what deliverables include my topic
* All incoming links TO the current topic (other topic files that link TO this topic)
* All outgoing links FROM the focus topic (other topic files that this topic links to)
I'm used to having this in other tools and I use it constantly.
I think the Resources/Dependencies Manager View attempts to do something like this, but in separate panes that you can't view all at the same time. I'm having trouble deciphering the help for this view because I'm a new user and the help uses an immense about of jargon without defining what the terms mean.

sorin_carbunaru
Posts: 325
Joined: Mon May 09, 2016 9:37 am

Re: Link viewer that lists incoming and outgoing links

Post by sorin_carbunaru » Thu Aug 06, 2020 3:56 pm

Hello,

There is no way of seeing all these at the same time in Oxygen right now. As you have noticed, the Hierarchy/Dependencies View does something similar, but not exactly what you want. By the way, I tried to explain the terms "hierarchy" and "dependencies" in a comment at https://www.oxygenxml.com/doc/versions/ ... -view.html.

Also, we have an add-on that presents all the outgoing references for the current opened editor (https://www.oxygenxml.com/doc/versions/ ... addon.html), but only the first level (i.e. it doesn't show the outgoing references of the outgoing references). We have an issue to show the incoming references too (https://github.com/oxygenxml/oxygen-dit ... /issues/28), and I added your vote to it.

In your work you may also be interested in using the "Search references" action that is available in the contextual menu of the topic references from the DITA Maps Manager (look for "Search References" in the topic from https://www.oxygenxml.com/doc/versions/ ... nager.html).

Best wishes,
Sorin Carbunaru
Oxygen XML Editor

chrispitude
Posts: 223
Joined: Thu May 02, 2019 2:32 pm

Re: Link viewer that lists incoming and outgoing links

Post by chrispitude » Sat Aug 22, 2020 3:51 pm

Hi Sorin,

I've been meaning to add all of our maps to the Master Files list so that Search References can find references across all books.

However, we have ~20,000 DITA topic files and ~100 bookmap files. What's the upper limit for the Master Files feature to track before there is a performance impact?

sorin_carbunaru
Posts: 325
Joined: Mon May 09, 2016 9:37 am

Re: Link viewer that lists incoming and outgoing links

Post by sorin_carbunaru » Mon Aug 24, 2020 10:55 am

Hello Chris,

I honestly don't know what to say. I guess you will have to do some experiments and decide when the performance is unsatisfactory.

I added a +1 to an issue that is related to improving the performance of Master Files operations, but that's no trivial task...

chrispitude
Posts: 223
Joined: Thu May 02, 2019 2:32 pm

Re: Link viewer that lists incoming and outgoing links

Post by chrispitude » Mon Sep 07, 2020 11:20 pm

Thanks Sorin, I'll do some experiments with Master Files performance.

Back to the OP's request, my writers have been asking for the same things as the OP. They want all information needed to understand the big-picture context of a topic in a collaborative context, so they understand the ramifications and requirements for any content changes in that topic.

Here is what they're asking for:
  • The <author> information from the topic prolog/metadata
  • All deliverables that include the current topic, and the profiling conditions for each instance
  • All incoming links TO the current topic
  • All outgoing links FROM the current topic
The deliverable references would require Oxygen to know the difference between a top-level deliverable and an intermediate submap. One way to describe these would be a DITA-OT project file, which is something I'm hoping to explore soon.

We aren't using submaps yet, but when we do, there would be value in showing the mapref lineage for each deliverable reference:

Code: Select all

deliverableA.ditamap -> shared_submap123.ditamap -> myfeature.dita
deliverableB.ditamap -> shared_submap123.ditamap -> myfeature.dita
appnote.ditamap -> myfeature.dita

sorin_carbunaru
Posts: 325
Joined: Mon May 09, 2016 9:37 am

Re: Link viewer that lists incoming and outgoing links

Post by sorin_carbunaru » Tue Sep 08, 2020 2:02 pm

Hi Chris,

I added your feedback to our issue management system. As always, we'll let you know when we have any updates.

By the way, should the component(s) that show these details work with the currently selected editor, or perhaps you would want us to allow you to also browse for another topic and check these details? And what do your writers think about the Resource Hierarchy/Dependencies side-view or the Outgoing DITA References add-on? Do they find the side-views useful, but perhaps not the complete solution that they dream about?

Best wishes,
Sorin Carbunaru
Oxygen XML Editor

Post Reply