Page 1 of 1

Duplication of Transformation Scenario leads to Errors

Posted: Sun Nov 22, 2015 3:21 pm
by fsteimke
Hi,
i have made my own document type called "einzelabruf" as a framework at the global level. There is a directory called "einzelabruf" in the OXYGEN_HOME/frameworks directory. My framework is an extension of the DocBook 5 framework. Everything is fine so far. (By the way, extension of existing frameworks is an awesome feature).

There is also a project file in the framework directory for the purpose of administration, development and documentation of the new framework. My documentation is written in DocBook, i'd like to generate WebHelp from the Manual. When i apply the Standard WebHelp Transformation for DocBook 5, everything is fine. But i'd like to customize it.

So i've made a Copy of the WebHelp Scenario at the project level ("Scenarios / Duplicate"). When i try to apply the fresh copy to my manual, it will stop immediately whit the following message:

Code: Select all

System-ID: C:\Program Files (x86)\Oxygen XML Editor 17\frameworks\einzelabruf\manual\db5\manual-db5.xml
Umwandlung: DocBook WebHelp - Kopie
Build-Datei: C:\Program Files (x86)\Oxygen XML Editor 17\frameworks/docbook/xsl/com.oxygenxml.webhelp/build_docbook.xml
Programmname: ANT
Fehlerlevel: fatal
Beschreibung: Cannot run program "c:\program files (x86)\oxygen xml editor 17\jre/bin/java" (in directory "C:\Program Files (x86)\Oxygen XML Editor 17\frameworks\einzelabruf\C:\Program Files (x86)\Oxygen XML Editor 17\frameworks\einzelabruf\manual\db5"): CreateProcess error=267, Der Verzeichnisname ist ungültig
The german message means something like there is no such directory.

Further investigation shows that there is a problem with the parameters of the transformation scenario which have an explicit given value. For example, the value of admon.graphics is 0 in the original scenario (DocBook).

The same parameter in my copy of this scenario is ${frameworksDir}/einzelabruf/0. Every Parameter gets this ${frameworksDir}/einzelabruf prefix when copied from the original webhelp Transformation Scenario from the ${baseFramework}.

As a workaround, i'v made a copy of my project file and removed manually the unwanted prefix. The duplicated scenarion seems to work when applied within this Project file.

Sincerely,
Frank Steimke

Re: Duplication of Transformation Scenario leads to Errors

Posted: Mon Nov 23, 2015 6:06 pm
by Costin
Hello,

I have just created a "DocBook 5 - Extension" extension framework in oXygen on our side and tried to reproduce the issue, but was unsuccessful so far.
What I have tried more exactly, was to create the extension framework based on the DocBook 5 existing one, tried both approaches by saving the new document type both as internal or as external (in a sub-directory of the "frameworks" folder from oXygen's installation directory from Program Files) storage.
Then I duplicated the "DocBook WebHelp" transformation scenario from the extension document type I have created at the previous step and looked for the "admon.graphics" parameter value - which I found it was the correct one ("0").

Is there anything I missed in the process?

Could you check to see if you have administrative rights (write access) to the oXygen installation directory? I am asking this as because you specified you have the "einzelabruf" framework extension saved in the oXygen's "frameworks" folder.

If possible, it could help us investigate if you could send us an archive containing your framework extension (altogether with the contained project file) and the transformation scenario you are trying to apply. To export the transformation scenario to a file, you should go into the "Configure Transformation Scenario(s)" dialog, right click your scenario and click "Export Selected Scenario(s)".

To send us the archive, you could use the online technical support form.

Regards,
Costin

Re: Duplication of Transformation Scenario leads to Errors

Posted: Tue Nov 24, 2015 9:17 am
by fsteimke
Hi Costin,

i have full access rights for the framework directory.

When i tried to reproduce the bug (after reading your reply) i was not allways successfull. It was strange. Is it possible that it makes a difference whether i start Oxygen with a projekt (which reproduced the error) or start with another project and load the suspicious project afterwards (whch did not allways lead to an error)?

However, is was able to reproduce the bug and send my archive to your technical support team. It contains the project file which includes the definition of my copy of the webhelp transformation scenario. This project file contains the following setting for the admon.graphic paramater:

Code: Select all

<antParameter>
<field name="name">
<String>admon.graphics</String>
</field>
<field name="description">
<String>If value is 1 use Docbook admon graphics. If value is 0 do not use Docbook admon graphics.</String>
</field>
<field name="value">
<String>${frameworksDir}/einzelabruf/0</String>
</field>
<field name="defaultValue">
<null/>
</field>
... etc ...
</antParameter>
The bug shows up in the value line: <String>${frameworksDir}/einzelabruf/0</String>.

Maybe it's because of the use of the ${baseFramework variable in my framework?

Sincerely,
Frank Steimke

Re: Duplication of Transformation Scenario leads to Errors

Posted: Tue Nov 24, 2015 12:58 pm
by Radu
Dear Frank,

I looked a little bit with Costin over your samples. We cannot reproduce the issue and also we do not quite understand your entire workflow.
Please see some questions/remarks below:

1) The master file "manual.xml" does not seem to match your document type extension because it has a particular @version attribute value. Is this on purpose?

2) Usually a framework should not contain the XML content which gets published. So ideally the "manual.xml" should be kept outside of the framework folder. So ideally you would have a project folder containing the XPR and XML content and a separate framework folder.

3) You do not need to copy your framework folder in the Oxygen installation folder. You can have an external located frameworks folder in which you can place your custom framework folder and in the Oxygen Preferences->Document Type Association / Locations in the Additional frameworks list you can refer to that external frameworks folder.

4) Your framework extension does not seem to have the Docbook WebHelp scenario defined in it. You probably manually removed it because it was defined in the base framework.

Regards,
Radu

Re: Duplication of Transformation Scenario leads to Errors

Posted: Sat Nov 28, 2015 11:53 am
by fsteimke
Hi Radu

sorry for the delay, i was away from my equipment for some days.

I do admit that my project and my framework is cluttered. I will read your hints and advices carefully to clean it up. It started as a project, and became a framework afterwards.

On the other hand, there is kind of a bug with the duplication of transformation scenarios (maybe under rare and strange circumstances). So it tried to boil it down. These are the steps to reproduce:
  • Create a new Project File in Oxygen. Call it p1, stored in p1.xpr at a random place outside Oxygen (c:/tmp).

    Create a new Framework as an Extension of the DocBook 5 Framework at projekt level. Call it BugReport. Storage is external, in a file called [OXYGEN_HOME]/bugreport/bugreport.framework. Close Oxygen.

    Copy the project file p1.xpr into the directory for the new framework.

    Restart Oxygen by double-click on (OXYGEN_HOME]/bugreport/p1.xpr. Confirm that this will change application appearence.

    Create or open a random docbook file. Again. the only reason is to configure a transformation scenario. Choose "DocBook Webhelp" and duplicate. Have a look at the admon.graphics parameter. At my installation i see ${frameworksDir}/0 as its value, which is clearly wrong. Should by 0.
Hope this helps,

Environment is Oxygen 17.1 Windows 64.

Frank

Re: Duplication of Transformation Scenario leads to Errors

Posted: Mon Nov 30, 2015 10:13 am
by Radu
Hi Frank,

I could not reproduce the behavior following your steps but I will also tell our QA team to test more with it.

About the proper way I would suggest to distribute a project which also has a framework in it:
In an older Oxygen XML Blog post I discussed about how you can create a framework extension and how you can share that framework folder along with your project:

http://blog.oxygenxml.com/2015/08/docum ... aring.html

Regards,
Radu