Getting Started with a Custom Framework

[hlapin]

I recently created a local, external copy of the TEI framework, so that I could modify it, leaving the original untouched.

When I try to run a transformation using that framework, I receive two error messages (I am assuming the second is a consequence of the first).

Message 1:
System ID: zip:file:/C:/Users/hlapin/Documents/Research/Mishnah XML project/HamburgBMCh1--Template.docx!/word/document.xml
Scenario: TEI P5 DOCX
Build file: C:/Users/hlapin/Documents/Research/Mishnah XML project/CustomFrameworks/tei/xml/tei/stylesheet/docx/build-to.xml
Document type: TEI P5
Engine name: ANT
Severity: fatal
Description: Could not run ANT. Make sure it is installed properly.

Any advice on how to start ant? Does this happen within Oxygen, or within the version of Apache that is resident on my system?

If anyone can point me to a guide for how to do this I'd appreciate it.

[adrian]

Hello,

The problem is you're trying to transform a DOCX document with the TEI P5 DOCX scenario, which is meant to transform from TEI P5 to DOCX and not the other way around as you seem to expect it to. There is also a DOCX TEI P5 scenario which, I'm guessing, is the one you were looking for.

I see that in your configuration the DOCX document.xml is now seen by Oxygen as the TEI P5 document type, so that's why you're seeing the TEI P5 specific scenarios for this DOCX document. I'm guessing you've made changes to the association rules from the TEI P5 framework and now, probably, many more XML documents are considered TEI P5 (even though they are not). Please make sure the association rules are strict enough to avoid this.

Regards,
Adrian

[hlapin]

Actually, I don't see the "DOCX TEI P5" option in Oxygen 15 based on the most recent download of the TEI transformation files, either within the frameworks folder or when I designate a custom frameworks folder. (I do see them in 14.2, though.) The file does have the build-to.xml and build-from.xml

Is this a TEI problem? Should I stick with 14.2 for this?

Sorry to be a pest!

[hlapin]

I apologize. I was mistaken
The option of DOCX TEI P5 does appear among the options when selecting from the frameworks files in the oxygen frameworks folder. It does not appear when redirecting to a custom frameworks folder.

[adrian]

Hi,

The scenario DOCX TEI P5 is included in the OOXML framework, because it's applied to a DOCX (OOXML) document. So, if you've selected a custom frameworks folder and only have there a TEI P5 framework, that explains the lack of a DOCX scenario. If you want to have your custom frameworks folder self contained, you should also copy the OOXML framework folder.

If you're using v15.0, please note that you can now contribute additional framework directories in Options > Preferences > Document Type Association / Locations without dropping the default frameworks that Oxygen provides. Simply add your custom frameworks directory to the list of additional framework directories.

Regards,
Adrian

[hlapin]

Thanks for this help and the advice.

[shudson310]

If you're using v15.0, please note that you can now contribute additional framework directories in Options > Preferences > Document Type Association / Locations without dropping the default frameworks that Oxygen provides. Simply add your custom frameworks directory to the list of additional framework directories.

Is there a variable that will point to this custom_frameworks directory? I want to distribute my framework to our authors who are on a mix of Windows and Mac, so I need to build a relative path to the catalog, css, schematron, etc. based on this custom_frameworks directory location.

[shudson310]

If you're using v15.0, please note that you can now contribute additional framework directories in Options > Preferences > Document Type Association / Locations without dropping the default frameworks that Oxygen provides. Simply add your custom frameworks directory to the list of additional framework directories.

Is there a variable that will point to this custom_frameworks directory? I want to distribute my framework to our authors who are on a mix of Windows and Mac, so I need to build a relative path to the catalog, css, schematron, etc. based on this custom_frameworks directory location.

I should point out, the additional framework directory is external to the oXygen installation in an SVN folder that our organization uses. I need a variable that resolves to this external location.

[shudson310]

Found it in another forum thread:

Code: Select all

${frameworksDir}/dita-extension/company.css

Seems to be working now!

[Costin]

Hi,

There is the "${frameworksDir}" editor variable which basically points to the frameworks directory you have set in oXygen, so you could use that variable.

Regards,
Costin