Problems with author actions in framework extension script

[OliverG]

Hi,
we are extending the ediarum.BASE.edit framework with an respective extension script file (see end of this post).
But I'm experiencing an extremely shaky integration of added author actions. It seems to me almost unpredictable what oxygen does, when adding custom author actions within custom toolbars or for content completion. Sometimes the addition of one author action leads to all custom toolbars not showing up. Sometimes toolbars do show up, but certain defined actions are missing. Same with the actions added for content completion.

Just one arbitrary example from the extension script:
When giving

Code: Select all

 <contentCompletion>
      <authorActions>
        <addAction id="insert.xinclude" inCCWindow="true" displayOnlyWhenElementAllowed="true" inElementsView="true"/>
        </authorActions>
    </contentCompletion>

then this action is showing nicely in the code completion assistant as well as in the elements view.
BUT, when adding just this "choice" action:

Code: Select all

<contentCompletion>
      <authorActions>
        <addAction id="insert.xinclude" inCCWindow="true" displayOnlyWhenElementAllowed="true" inElementsView="true"/>
        <addAction id="choice" inCCWindow="true" displayOnlyWhenElementAllowed="true" inElementsView="true"/>
        </authorActions>
    </contentCompletion>

then both disappear from element view.

Same goes for toolbars. The actual script (see end of post) has these custom toolbars:

toolbar1.JPG (13.31 KiB) Viewed 1769 times

But if you just add, for example, "<addAction id="deletion"/>" to

Code: Select all

 <toolbar name="hi-del">
        <addAction id="toggle-hi[#i]"/>
        <addAction id="toggle-[hi#spaced]"/>
        <addAction id="toggle-superscript"/>
        <addAction id="toggle-subscript"/>
        <addAction id="toggle-[hi#halfTone]"/>
        <addAction id="deletion"/>
      </toolbar>

then the new action is shown, while two of the other custom toolbars are gone completely:

toolbar2.JPG (9.25 KiB) Viewed 1769 times

I checked the xml files of the self-defined author actions multiple times and can't find any error within those. Here is, for example, the mentioned action "deletion":

Code: Select all

<?xml version="1.0" encoding="UTF-8"?>
<a:authorAction id="deletion" 
  xmlns:a="http://www.oxygenxml.com/ns/author/external-action" 
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xsi:schemaLocation="http://www.oxygenxml.com/ns/author/external-action http://www.oxygenxml.com/ns/author/external-action/authorAction.xsd">
  <a:name>*Tilgung</a:name>
  <a:description>Tilgung kennzeichnen</a:description>
  <a:operations>
    <a:operation id="ToggleSurroundWithElementOperation">
      <a:arguments>
        <a:argument name="element"><del xmlns="http://www.tei-c.org/ns/1.0"/></a:argument>
      </a:arguments>
    </a:operation>
  </a:operations>
  <a:accelerator></a:accelerator>
  <a:enabledInReadOnlyContext>false</a:enabledInReadOnlyContext>
</a:authorAction>

As said earlier, it seems unpredictable, what oxygen is doing, when adding custom actions, toolbars or code completion stuff within the extension script. I tried every so other way to solve this, but without success.

I wonder if these are known issues - or if my extension script has flaws that I just cannot identify.

Help is very much appreciated!
Kind regards

And here the complete extension script:

Code: Select all

<?xml version="1.0" encoding="UTF-8"?>
<!-- 

The file must be saved inside a framework directory, the same place where a *.framework file should sit.

To generate a *.framework file out of the script, you need to use the "Compile Framework Extension script" action 
from the contextual menu.
-->
<script xmlns="http://www.oxygenxml.com/ns/framework/extend"
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xsi:schemaLocation="http://www.oxygenxml.com/ns/framework/extend http://www.oxygenxml.com/ns/framework/extend/frameworkExtensionScript.xsd"
  base="ediarum.BASE.edit">
  <name>WOA.edit</name>
  <description>Die Basis für oXygen-Anpassungen zur Bearbeitung der Oßmannstedter Edition von Wielands Werken.</description>
  <associationRules inherit="none">
    <addRule attributeLocalName="doctype" attributeNamespace="*" attributeValue="woa*"/>
    <addRule attributeLocalName="doctype" attributeNamespace="http://www.telota.de"
      attributeValue="pagina*"/>
  </associationRules>
  <defaultSchema schemaType="rng" href="${framework}/schemata/woa.rng"/>
  <xmlCatalogs inherit="all">
    <addEntry path="${framework}/catalog.xml"/>
  </xmlCatalogs>
  <classpath inherit="all">
    <addEntry path="${framework}/resources" position="before"/>
  </classpath>
  <documentTemplates inherit="all">
    <addEntry path="${frameworkDir}/templates"/>
  </documentTemplates>
  <transformationScenarios>
    <addScenarios href="${frameworkDir}/transform/prepare-print-export.scenarios"/>
  </transformationScenarios>
  <priority>High</priority>

  <author>
    <!-- 
      Author Actions are loaded from these directories:
      {framework_directory}/externalAuthorActions
      {framework_directory}/{framework_file_name}_externalAuthorActions
      
      https://www.oxygenxml.com/doc/versions/22.1/ug-editor/topics/dg-create-custom-actions.html#dg-create-custom-actions__section_2
    -->

    <authorActions>
      <removeAction id="add"/>
      <removeAction id="del"/>
      <removeAction id="del_gap"/>
      <removeAction id="gap"/>
      <removeAction id="sic-corr[deleted]"/>
      <removeAction id="subst"/>
      <removeAction id="unclear"/>
      <removeAction id="Kommentar hinzufügen"/>
    </authorActions>

    <css selectMultipleAlternateCSS="true" mergeDocumentCSS="true">
      <removeCss path="${framework(ediarum.BASE.edit)}/css/text-critical.css"/>
      <removeCss path="${framework(ediarum.BASE.edit)}/css/text-comments.css"/>
      <removeCss path="${framework(ediarum.BASE.edit)}/css/standard.css"/>
      <removeCss path="${framework(ediarum.BASE.edit)}/css/links.css"/>
      <!--       <addCss path="${framework(ediarum.BASE.edit)}/css/standard.css" title="TEI-Standardansicht" alternate="true"/>  -->
      <addCss path="${framework}/styles/Wieland_neueFarben.css" title="WOA" alternate="true"/>
      <!--       <addCss path="${framework}/styles/woa.css"/>  -->
    </css>

    <toolbars>

      <toolbar name="Metadaten">
        <removeGroup name="Metadaten"/>
        <removeGroup name="Briefmetadaten"/>
      </toolbar>

      <toolbar name="Text">

        <removeGroup name="Zeilenumbruch"/>
        <removeGroup name="Folio- und Seitenwechsel"/>
        <removeGroup name="Korrekturen"/>
        <removeGroup name="Listen"/>
        <removeGroup name="Namen kennzeichnen"/>
        <removeGroup name="Tabelle"/>
        <removeGroup name="Textstellen indizieren"/>
        <removeGroup name="Sprache und Schriftart"/>
        <removeGroup name="Datum"/>
        <removeGroup name="Verweise"/>

        <removeAction id="ex"/>
        <removeAction id="figure"/>
        <removeAction id="hi[superscript]"/>
        <removeAction id="hi[underline]"/>
        <removeAction id="note"/>
<!-- 
        <removeAction id="add"/>
        <removeAction id="del"/>
        <removeAction id="del_gap"/>
        <removeAction id="sic-corr[deleted]"/> 
        <removeAction id="subst"/>
        <removeAction id="unclear"/>
-->
        <removeAction id="supplied"/>
        <removeAction id="paragraph"/>
        <removeAction id="seg"/>

        <!-- modify existing groups -->
        <!--        
        <group name="Verweise" largeIconPath="${framework(ediarum.BASE.edit)}/icons/verweis.gif" smallIconPath="${framework(ediarum.BASE.edit)}/icons/verweis16.gif">
          <addAction id="ref[index]" position="before"/>
        </group>
        
        <group name="Zeilenumbruch" largeIconPath="${framework(ediarum.BASE.edit)}/icons/lb.gif" smallIconPath="${framework(ediarum.BASE.edit)}/icons/lb16.gif">
          <removeAction id="lb[break]"/>
        </group>
        
 -->
      </toolbar>

      <toolbar name="Sonderzeichen">

        <removeGroup name="Symbole"/>

        <!--         <addAction id="metrisches_Kreuz_klein" position="before"/>
        <addAction id="metrisches_Kreuz_klein_u" position="before"/>
        <separator/>
 -->
        <group name="Sonderzeichen">

          <addAction id="SonderzeichenAE_lig"/>
          <addAction id="SonderzeichenAEligKlein"/>
          <addAction id="SonderzeichenOELigGroß"/>
          <addAction id="SonderzeichenLigOKlein"/>

          <addAction id="SonderzeichenC"/>
          <addAction id="SonderzeichenFranzCKlein"/>
          <addAction id="SonderzeichenEMitZweiPunkten"/>
          <addAction id="Sonderzeichenë"/>
          <addAction id="SonderzeichenIPunkte"/>
          <addAction id="SonderzeichenIKleinPunkte"/>
          <addAction id="SonderzeichenKleinYPunkte"/>
          <addAction id="LATIN_SMALL_LETTER_D_WITH_STROKE"/>
          <!--       <addAction id="SonderzeichenS"/> -->

          <!--        <separator/> -->

          <addAction id="SonderzeichenKleinOStrich"/>
          <addAction id="SonderzeichenTildeN"/>
          <addAction id="SonderzeichenSDachGroß"/>
          <addAction id="SonderzeichenSDachKlein"/>

          <!--        <separator/> -->

          <!--         <addAction id="SonderzeichenErgänzungAutor"/>
        <addAction id="SonderzeichenÄnderungPfeil"/>
        <addAction id="SonderzeichenApostrophUnten"/>
        <addAction id="SonderzeichenApostroph"/>
        <addAction id="Sonderzeichen Anführungszeichen Unten"/>
        <addAction id="Sonderzeichen Anführung Oben"/>
        <addAction id="SonderzeichenDreiPunkt"/>
        <addAction id="SonderzeichenDivis"/>
        <addAction id="SonderzeichenHalbgeviertstrich"/>
 -->
          <addAction id="SonderzeichenDivision"/>
          <addAction id="SonderzeichenPlusMinus"/>
          <!--        <addAction id="SonderzeichenEinViertel"/>
        <addAction id="SonderzeichenEinHalb"/>
        <addAction id="SonderzeichenDreiViertel"/>
-->
          <addAction id="SonderzeichenArrowUp"/>
          <addAction id="SonderzeichenArrowDown"/>
          <addAction id="SonderzeichenArrowDiagonalUp"/>
          <!--         <addAction id="toggle-fremdtext"/>
        <addAction id="toggle-Trennzeichen"/>
        <addAction id="SonderzeichenVerserweiterung"/>
        <addAction id="SonderzeichenVerszusammenführung"/>
        <addAction id="SonderzeichenNeueSeite"/>
        <addAction id="SonderzeichenStreichung"/>

        <separator/>

        <addAction id="SonderzeichenSiglenKlammer"/>
        <addAction id="SonderzeichenZeilenX"/>
        <addAction id="SonderzeichenArrowZickDown"/>
        <addAction id="SonderzeichenArrowCircleUp"/>
        <addAction id="SonderzeichenArrowRightStop"/>
        <addAction id="SonderzeichenArrowLeftStop"/>
        <addAction id="SonderzeichenArrowUpStop"/>
        <addAction id="SonderzeichenArrowDownStop"/>
        <addAction id="Sonderzeichen Extrapaginal"/>
-->
          <addAction id="Verschleifung"/>
          <!--        <addAction id="SonderzeichenVerserweiterung"/>
        <addAction id="SonderzeichenVerszusammenführung"/>
-->
        </group>
      </toolbar>
      
      <toolbar name="include">
        <addAction id="insert.xinclude"/>
      </toolbar>
      
      <toolbar name="hi-del">
        <addAction id="toggle-hi[#i]"/>
        <addAction id="toggle-[hi#spaced]"/>
        <addAction id="toggle-superscript"/>
        <addAction id="toggle-subscript"/>
        <addAction id="toggle-[hi#halfTone]"/>
        <addAction id="deletion"/>
      </toolbar>

      <toolbar name="emendrdg">
        <addAction id="choice"/>
        <addAction id="surrApp"/>
      </toolbar>

      <toolbar name="specia">
        <addAction id="seg-commented"/>
        <addAction id="persName"/>
        
      </toolbar>

    </toolbars>

    <contextualMenu>
      <submenu name="Other actions">
        <addAction id="insert.note"/>
      </submenu>
    </contextualMenu>

    <menu name="ediarum">
      <removeSubmenu name="Herausgeberbearbeitung"/>
      <removeSubmenu name="Briefmetadaten"/>
      <submenu name="Textstruktur">
        <submenu name="Zeilenumbruch">
          <removeAction id="lb[break]"/>
        </submenu>
      </submenu>
      <submenu name="Autorbearbeitungen">
        <removeAction id="hi[underline]"/>
        <removeAction id="hi[superscript]"/>
        <addAction id="toggle-superscript"/>
        <addAction id="toggle-subscript"/>
      </submenu>
      <submenu name="Herausgeberbearbeitung">
        <removeAction id="sic-corr[deleted]"/>
      </submenu>
      <submenu name="Transkription gedruckter Texte">
        <removeAction id="hi[#i]"/>
        <addAction id="toggle-hi[#i]"/>
      </submenu>
    </menu>

    <contentCompletion>
      <authorActions>
        <addAction id="insert.xinclude" inCCWindow="true" displayOnlyWhenElementAllowed="true" inElementsView="true"/>
      </authorActions>
    </contentCompletion>
  </author>

<!--
    <addAction id="surrApp" inCCWindow="true" displayOnlyWhenElementAllowed="true" inElementsView="true"/> 
    <addAction id="choice" inCCWindow="true" displayOnlyWhenElementAllowed="true" inElementsView="true"/>
-->

</script>

toolbar1.JPG (13.31 KiB) Viewed 1769 times

toolbar2.JPG (9.25 KiB) Viewed 1769 times

[OliverG]

Forgot to say: I'm using Oxygen Editor 25.1 (newest build)

[alex_jitianu]

Hi,

I created some small samples starting from your example, but I didn't reproduce the issue. It is probably related with the base framework configuration as well. Is there any chance for me to obtain the full frameworks? The variant with exf files? Or at least the exf file for ediarum.BASE.edit ?

Best regards,
Alex

[OliverG]

Hi Alex,
thanks for your answer. Sorry it took me so long now to reply.
The base framework is here:
https://github.com/ediarum/ediarum.BASE ... work#L2548
It's free to download - and we did not change it in any way.
I also attached all our customized author actions, if this is of any help.

externalAuthorActions.zip

(73.99 KiB) Downloaded 181 times

Kind regards
Oliver

[alex_jitianu]

Hi,

Still no luck in reproducing it... If you delete the scenarios file, does still exhibit this behavior? I had to do this because I didn't have it.

Code: Select all

<transformationScenarios>
    <addScenarios href="${frameworkDir}/transform/prepare-print-export.scenarios"/>
  </transformationScenarios>

If you run Oxygen from the command line oxygen.bat launcher, do you see any error messages in the console?

Best regards,
Alex

[OliverG]

Hi,
I put the transformations scenarios in comment (even re-started), but that didn't help.

Code: Select all

<!--
  <transformationScenarios>
    <addScenarios href="${frameworkDir}/transform/prepare-print-export.scenarios"/>
  </transformationScenarios>
  <priority>High</priority>
-->

Running Oxygen from comand line gave me some warnings:

Code: Select all

NOTE: Picked up JDK_JAVA_OPTIONS: --add-opens=java.base/java.lang=ALL-UNNAMED --add-opens=java.base/java.net=ALL-UNNAMED --add-opens=java.base/java.util=ALL-UNNAMED --add-opens=java.base/java.util.regex=ALL-UNNAMED --add-opens=java.base/sun.net.util=ALL-UNNAMED --add-opens=java.base/sun.net.www.protocol.http=ALL-UNNAMED --add-opens=java.base/sun.net.www.protocol.https=ALL-UNNAMED --add-opens=java.desktop/java.awt=ALL-UNNAMED --add-opens=java.desktop/java.awt.dnd=ALL-UNNAMED --add-opens=java.desktop/javax.swing=ALL-UNNAMED --add-opens=java.desktop/javax.swing.text=ALL-UNNAMED --add-opens=java.desktop/javax.swing.plaf.basic=ALL-UNNAMED --add-opens=java.desktop/com.sun.java.swing.plaf.windows=ALL-UNNAMED --add-opens=java.xml/com.sun.org.apache.xerces.internal.xni=ALL-UNNAMED --add-opens=javafx.graphics/com.sun.javafx.tk=ALL-UNNAMED --add-opens=javafx.web/javafx.scene.web=ALL-UNNAMED --add-opens=javafx.web/com.sun.javafx.webkit=ALL-UNNAMED
WARNING: A terminally deprecated method in java.lang.System has been called
WARNING: System::setSecurityManager has been called by ro.sync.security.manager.SandboxSecurityManagerInstaller (file:/C:/Program%20Files/Oxygen%20XML%20Editor%2025/lib/oxygen-sandbox.jar)
WARNING: Please consider reporting this to the maintainers of ro.sync.security.manager.SandboxSecurityManagerInstaller
WARNING: System::setSecurityManager will be removed in a future release

Some hints there?

Kind regards
Oliver

[alex_jitianu]

Hi Oliver,

I don't see anything useful in the log. Please write an email on support@oxygenxml.com. I want to send you a sample project to see if it behaves similarly on your system. I also want to ask you to open the exf file and from the contextual menu to select Compile Framework Extension Script and send me the resulting *.framework file in that email. Please delete *.framework afterwards, because Oxygen will always prefer to load that one and will not compile on the file the *.exf file.

Best regards,
Alex

[OliverG]

Just sent the requested email and file.
Kind regards
Oliver

[OliverG]

I want to send you a sample project to see if it behaves similarly on your system.

By the way, it behaves this way not just on my system, but also on the system of my colleagues at pagina. There has to be some flaw within our Oxygen/Project/Framework setup.

[kai_weber]

Hi Alex,

Oliver asked me to try help reproduce our problem based on your minimal setup. I've been able to reproduce it somehow, though I'm not clear about where exactly the setup broke. Here's what I changed:

1. Added a second framework ("woa.apparate"), derived from "woa.edit", thereby introducing a transitive derivation relationship between the three frameworks
2. Added a schema file and an OASIS catalog definition relating to that schema to the "woa.edit" framework. Also added the schema file as the frameworks default schema to ed.exf
3. Opened a large XML file with xi:include relationships over two transitive stages. (The base XML file is "woa_5_1_1.xml", the included files are in the folder "woa_96.I")

The file is too large to be attached here directly; please find the zip archive with my modifications and additions here: https://cloud.pagina.gmbh/index.php/s/pXeiMS1g3sfDd7V

Best regards,
Kai

[OliverG]

Hi Alex,
I would like to add, that unfortunately we are under a bit of pressure here, because we were asked to deliver the project setup for our customer early in September. That is to say, we are thankful for all debugging activities on your side.

In addition to Kai's manipulating your minimal setup, I recently sent you the whole of our project (by wetransfer). With those two projects we hope you are able to finally reproduce the buggy behaviour (like toolbars not showing at start or disappearing when making changes in the exf).

I'm aware that your time is precious, so thanks again.

Kind regards
Oliver

[alex_jitianu]

Hi Oliver,

I'm sorry, I was under the impression that you've found an workaround starting from the sample project I've sent, so I didn't consider this to be urgent. I will work on it today.
I downloaded Kai's samples and opened woa_5_1_1.xml and switch it to author mode. In the Elements view I see Inkludieren and Emendation. Which actions should appear where and they don't? Next step, I will look in the original project as well.

Best regards,
Alex

[alex_jitianu]

Hi Oliver,

To speed things up, in the dh-hs-woa-editor project, can you tell me which XML file to open and which actions do not appear on the toolbar/content completion?

Alex

[alex_jitianu]

Ok, I think I've got it. I've used the WOA.edit/text template. The Inkludieren doesn't appear in the Elements view. Commenting this part from woa-apparate makes it appear:

Code: Select all

    <contentCompletion>
      <authorActions>
        <addAction id="insert.note" replacedElement="note" inCCWindow="true"/> 
      </authorActions>
    </contentCompletion>

The good news is that the issue doesn't appear in the current development branch, so I just have to figure out what fixed it.
Alex

[alex_jitianu]

One thing I've noticed is that if I open woa-apparate.exf and I invoke Compile Framework Extension Script from the contextual menu (this will generate a *.framework version that will take precedence), the Inkludieren action begins to appear in the Elements view. Does it happen for you too? If it does, it could be a workaround: you compile the script before sending it to the client and they will have the actions. Until we figure it out how to properly fix it.

Alex

[kai_weber]

Hi Alex,
many thanks for looking into this so far. Up until now the appearing / disappearing of toolbar items after edits in the extension script looked rather random to us, we have not found a safe way to ensure that it's always appearing. However, we've probably not tested thoroughly, if compilation of the framework could help us. I'll try it out and let you know.

Best regards,
Kai

[kai_weber]

Hi Alex,

at first glance this framework compilation seems to work. Did I get it right, that the compiled framework file needs to replace the original extension script and the externalAuthorActions folder? So, we would need to keep the extension script file and the author actions in a separate folder, and then only push the compiled framework, together with catalog, css, and schema files, to our customer's system?

Best regards,
Kai

[alex_jitianu]

Hi Kai,

When we detect a *.framework file and a *.exf file with the same name we load only the *.framework file so you can just keep them both. Just remember to delete the *.framework file when you develop, otherwise Oxygen will never load the *.exf file and you will not see your changes in action. In a way, it is a plus to give to the client the compiled *.framework file because it loads faster. The all platforms distribution contains a script, scripts/compileFrameworkScript.bat that cand be used to automate this generation in a process that builds a delivery for the client (it requires no Oxygen license).

The externalAuthorActions folder is required either way, compiling a framework doesn't bundle the actions in the *.framework file. Although it might have been an idea...

Alex

[kai_weber]

Hi Alex,

thanks for the explanations. In that case my test didn't work: After compiling the framework, I did still see some "toolbar shifting" behaviour, when both, the .exf file and the .framework file, were present in the project folder. Only when I removed the .exf file and restarted oXygen, toolbars looked as expected... but then again, that might have been an effect of restarting oXygen rather than compiling the framework? It remains kind of mysterious, I fear...

Best regards,
Kai

[OliverG]

Commenting this part from woa-apparate makes it appear:

Code: Select all

    <contentCompletion>
      <authorActions>
        <addAction id="insert.note" replacedElement="note" inCCWindow="true"/> 
      </authorActions>
    </contentCompletion>

The good news is that the issue doesn't appear in the current development branch, so I just have to figure out what fixed it.
Alex

Hi Alex,
It seems you were on the right track with this. When deselecting the woa-apparate framework in *Document Type Association Preferences*, everything is working perfectly. So this extension is in fact our bad guy.
Good to know that the issue is gone with the actual dev branch. Please let us know if you found out what fixed it.

Kind regards
Oliver

[alex_jitianu]

Hi,

It would be good to know if compiling the *.exf file (let's say with removing the *.exf files) fixes the issues, in other words if it's a good workaround for you and you can ship the frameworks to the client. I haven't yet found the culprit, I hope to allocate some time today to further debug.

Best regards,
Alex