Outline on custom frameworks

Johann
Posts: 126
Joined: Wed Jun 17, 2015 12:46 pm

Outline on custom frameworks

Post by Johann » Fri Jul 09, 2021 5:24 pm

Hello everyone,

I have difficulties to activate / display "Outline" pane in a custom framework.

I followed the different ways of doing described in this link https://www.oxygenxml.com/doc/versions/ ... -pane.html.

I tried to add the webAuthorOutlineConfig.xml in a folder "outline". I keep the docbook one even if I have a custom framework.

Code: Select all

<outline>
  <structureMode editable="yes" default="no">
    <preferredAttributes names="id xml:id"/>
  </structureMode>
  <tocMode editable="yes" default="yes">
    <elements names="section sect1 sect2 sect3 sect4 sect5 simplesect article book"/>
  </tocMode>
</outline>
The "outline" folder has been added to the classpath of the framework.

Code: Select all

<field name="classpath">
						<String-array>
...
                <String>${framework}/outline/</String>
...
						</String-array>
					</field>

I also tried the outlineConfigurationProvider:

Code: Select all

goog.events.listen(workspace,sync.api.Workspace.EventType.BEFORE_EDITOR_LOADED,function(e)
 {
    e.options.outlineConfigurationProvider = function(callback) {
        callback("{\n" + 
    "    \"structureMode\": {\n" + 
    "        \"editable\": \"yes\",\n" + 
    "        \"defaultMode\": \"no\",\n" + 
    "        \"preferredAttributes\": {\"names\": \"id xml:id\"}\n" + 
    "    },\n" + 
    "    \"tocMode\": {\n" + 
    "        \"editable\": \"yes\",\n" + 
    "        \"defaultMode\": \"yes\",\n" + 
    "        \"elements\": {\"names\": \"topic\"}\n" + 
    "    }\n" + 
    "}");
    }
I do not see any error and no "Outline" pane is displayed.

What did I miss ?

Thanks,


Johann

cristi_talau
Posts: 358
Joined: Thu Sep 04, 2014 4:22 pm

Re: Outline on custom frameworks

Post by cristi_talau » Fri Jul 09, 2021 6:02 pm

Hello,

The outline is implemented as an editor plugin (which is included by default). Can you check if you have the "Outline" plugin installed?

Also, after you added the "webAuthorOutlineConfig.xml" file and configured the framework, you should restart the server.

If these possible causes are not related to your problem, you can send us the framework and a sample file (e.g. a template) using our support form (https://www.oxygenxml.com/techSupport.html) so that we can troubleshoot the problem.

Best,
Cristian

Johann
Posts: 126
Joined: Wed Jun 17, 2015 12:46 pm

Re: Outline on custom frameworks

Post by Johann » Fri Jul 09, 2021 7:13 pm

Where can I find the "Outline" plugin ?

Johann

mihai_coanda
Posts: 52
Joined: Wed Jul 20, 2016 8:22 am

Re: Outline on custom frameworks

Post by mihai_coanda » Mon Jul 12, 2021 1:11 pm

Hello,

You can download the Outline plugin from here https://www.oxygenxml.com/maven/com/oxy ... ne-plugin/
Michael

https://www.oxygenxml.com

Johann
Posts: 126
Joined: Wed Jun 17, 2015 12:46 pm

Re: Outline on custom frameworks

Post by Johann » Thu Jul 15, 2021 11:16 am

Hello,

Thanks, it works now ! I do not know if I missed something but I didn't see the need to install the "Outline" plugin in the documentation. :/


Johann

NicoAMP
Posts: 61
Joined: Tue Mar 06, 2018 2:07 pm
Contact:

Re: Outline on custom frameworks

Post by NicoAMP » Fri Oct 15, 2021 12:20 pm

Hello Mickael and Christian,

I have a custom framework that extends NCX one and I would like to display outline view on Oxygen Web Author.

I'm using the following webAuthorOutlineConfig.xml that is referenced in framework classpath:

Code: Select all

<?xml version="1.0" encoding="UTF-8"?>
<outline> 
    <structureMode editable="yes" default="no">
        <preferredAttributes names="id xml:id"/> 
    </structureMode> 
    <tocMode editable="yes" default="yes">
        <elements names="content navLabel navPoint navMap ncx"/> 
    </tocMode> 
</outline>
I use addon "Web Author Server" to test my framework locally.
For CSS part it works, but I can't see Outline Pane.

Do you know why? Maybe I have to enable "Outline plugin" for "Web Author Server" (if yes how can I do that)?

Thanks a lot for your help.

cristi_talau
Posts: 358
Joined: Thu Sep 04, 2014 4:22 pm

Re: Outline on custom frameworks

Post by cristi_talau » Fri Oct 15, 2021 1:03 pm

Hello,

Yes, the outline plugin is not installed by default when using the add-on.

Please follow these steps:
  • In Oxygen XML Editor, go to "Options" > "Preferences" > "Plugins" and select the Web Author Test Server Add-on in the right panel.
  • Note the file path listed unde "Location" and open it in a file browser
  • Go to the "plugins" sub-folder and unzip the Outline plugin here
Best,
Cristian

Post Reply