Questions Regarding Outline Side-View

Are you missing a feature? Request its implementation here.
dreifsnider
Posts: 147
Joined: Thu Aug 30, 2018 10:06 pm

Questions Regarding Outline Side-View

Post by dreifsnider »

Hi,

My team is interested in investigating how we can better use the Outline side-view in Web Author, specifically when viewing a DITA Map. However, we have the following questions regarding the Outline side-view in Web Author:
  1. Is it possible to modify the contextual menu items in the Outline side-view for a DITA Map?
    Specifically, we would like to promote or expose the options to Append/Insert a Topic Reference and Append/Insert a Topic Reference (New Topic)
    image.png
    image.png (257.07 KiB) Viewed 586 times
  2. Is it possible to have items in the Outline side-view have text decorations, for example, strikethrough and underline?
    Specifically, we would like the Outline side-view to mirror the tracked changes styling for items that are moved/added/deleted.
    image.png
    image.png (226.86 KiB) Viewed 586 times
  3. Is it possible to adjust the indentation of items in the Outline side-view?
    Specifically, we've noticed that items are not properly indented according to the structure of the DITA Map.
    For example, the following Outline structure based on the document:
    image.png
    image.png (306.87 KiB) Viewed 586 times
    Should actually look like:
    image.png
    image.png (30.3 KiB) Viewed 586 times
    As you can see, the nested topic references display at the same level as their parent in the current model.
We'd greatly appreciate any guidance you can provide about these items.

Thank you!

Daniel
cosminef
Site Admin
Posts: 197
Joined: Wed Aug 30, 2023 2:33 pm

Re: Questions Regarding Outline Side-View

Post by cosminef »

Hello,
Is it possible to modify the contextual menu items in the Outline side-view for a DITA Map?
Specifically, we would like to promote or expose the options to Append/Insert a Topic Reference and Append/Insert a Topic Reference (New Topic)
We have registered a feature request (WA-7925) in this regard and have added your vote to it. We will notify you when it becomes available.
Is it possible to have items in the Outline side-view have text decorations, for example, strikethrough and underline?
Specifically, we would like the Outline side-view to mirror the tracked changes styling for items that are moved/added/deleted.
In this case too, we have registered a feature request (WA-7926) to which I have added your vote so you can be notified when it is implemented.
s it possible to adjust the indentation of items in the Outline side-view?
Specifically, we've noticed that items are not properly indented according to the structure of the DITA Map.
Can you send us a sample DITA map with a similar structure where you are experiencing issues?

Thank you in advance.

Best,
Cosmin
Cosmin Eftenie
www.oxygenxml.com
dreifsnider
Posts: 147
Joined: Thu Aug 30, 2018 10:06 pm

Re: Questions Regarding Outline Side-View

Post by dreifsnider »

Hi Cosmin,

Thank you very much for your reply!

Regarding the third item about the indentation issue, I submitted support ticket OXYGEN-TS-6252 with a DITA Map attached.

Please let me know if you have any issues with the DITA Map or reproducing this issue.

Thank you!

Daniel
dreifsnider
Posts: 147
Joined: Thu Aug 30, 2018 10:06 pm

Re: Questions Regarding Outline Side-View

Post by dreifsnider »

Hi Cosmin,

When a DITA Map is loaded in the editor, is it possible to still show the DITA Map side-view as an option, but make the Outline side-view open on default?

For example, to have this be the initial view when a DITA Map is opened?
image.png
image.png (182.9 KiB) Viewed 359 times
The only way I can get the DITA Map side-view button to display for DITA Maps is to set

Code: Select all

  if (e.options.url.endsWith('.ditamap')) {
    e.options['showTopicTitles'] = 'true';
    e.options['stylesheet-titles'] = 'Basic,+ Inline insertion actions';
  }
in our loading options plugin, but this seems to always force the DITA Map side-view to display by default instead of the Outline view. We would like the Outline view to show by default, but still have the DITA Map side-view available, because many of our users prefer viewing the DITA Map in a visual tree style instead of as nested <topicref> elements.
cosminef
Site Admin
Posts: 197
Joined: Wed Aug 30, 2023 2:33 pm

Re: Questions Regarding Outline Side-View

Post by cosminef »

Hello,

You can use the showDitaMapView [1] URL parameter and when it is set to true, the DITA Map view will automatically be displayed.

[1] https://www.oxygenxml.com/doc/versions/ ... 20set%20to

Best,
Cosmin
Cosmin Eftenie
www.oxygenxml.com
dreifsnider
Posts: 147
Joined: Thu Aug 30, 2018 10:06 pm

Re: Questions Regarding Outline Side-View

Post by dreifsnider »

Hi Cosmin,

Thank you for your reply. Unfortunately, we want the DITA Map view to be available to be selected, but not be the default view that opens.

We want the Outline pane to be the default view that opens.

Setting showDitaMapView to true forces the DITA Map view to always be the default open view.
mihaela
Posts: 504
Joined: Wed May 20, 2009 2:40 pm

Re: Questions Regarding Outline Side-View

Post by mihaela »

Hello,

If you want the Outline view to be selected after opening your document you could listen on editor loaded event [1] and focus [2] the Outline view (its id is "outline-panel").

[1] https://www.oxygenxml.com/maven/com/oxy ... fydoc.html
[2] https://www.oxygenxml.com/maven/com/oxy ... ew__anchor

Best Regards,
Mihaela
Mihaela Calotescu
http://www.oxygenxml.com
dreifsnider
Posts: 147
Joined: Thu Aug 30, 2018 10:06 pm

Re: Questions Regarding Outline Side-View

Post by dreifsnider »

Hi Mihaela,

Thank you for your reply!

Unfortunately, that also doesn't appear to work when "showDitaMapView" is set to true.

I have this in my plugin code:

Code: Select all

goog.events.listen(workspace, sync.api.Workspace.EventType.BEFORE_EDITOR_LOADED, function(e) {
  let editor = e.editor;
  if (e.options.url.endsWith('.dita')) {
    // Open DITA Map View automatically
    e.options['showDitaMapView'] = 'true';
  }

  if (e.options.url.endsWith('.ditamap')) {
    // Open DITA Map View automatically and set view mode to show topic titles
    e.options['showDitaMapView'] = 'true';
    e.options['showTopicTitles'] = 'true';
  }
});

workspace.listen(sync.api.Workspace.EventType.EDITOR_LOADED, function(e) {
  workspace.getViewManager().focusView('outline-panel');
});
When showDitaMapView is set to true, it seems to always take precedence in the left-hand side.

Am I perhaps not implementing the listener or the method correctly?

Thanks!

Daniel
mihaela
Posts: 504
Joined: Wed May 20, 2009 2:40 pm

Re: Questions Regarding Outline Side-View

Post by mihaela »

Hello,

When you try to focus the view it is possible that it is not yet installed.
Try to use setTimeout to delay the focus call. We have an issue registered in our internal issues tracking system to add API to better control the order and selection of the side views and we have added your vote for it.

Best Regards,
Mihaela
Mihaela Calotescu
http://www.oxygenxml.com
Post Reply