Accessing custom WebHelp responsive templates from custom framework
Post here questions and problems related to oXygen frameworks/document types.
-
- Posts: 9
- Joined: Thu Jun 16, 2016 9:01 pm
Accessing custom WebHelp responsive templates from custom framework
I am using oXygen 18.1.
I have a custom DITA framework:
Oxygen/frameworks/xyz_dita
The framework contains its own DITA-OT engine:
Oxygen/frameworks/xyz_dita/DITAOT
I use the following plugin:
Oxygen/frameworks/xyz_dita/DITAOT/plugins/com.xyz.webhelp-responsive
I would like to specify custom WebHelp responsive templates for the plugin, so, using the instructions in https://www.oxygenxml.com/doc/versions/ ... ation.html, I added the following folder:
Oxygen/frameworks/xyz_dita/DITAOT/plugins/com.oxygenxml.webhelp/templates/dita/myTemplate/
However, I cannot access the custom templates. It seems that oXygen does not see them in the DITA-OT engine for my framework. I have tried searching for them when I create a scenario in the Transformation tab of the document type association.
How can I access these templates from my custom framework and separate DITA-OT engine?
I have a custom DITA framework:
Oxygen/frameworks/xyz_dita
The framework contains its own DITA-OT engine:
Oxygen/frameworks/xyz_dita/DITAOT
I use the following plugin:
Oxygen/frameworks/xyz_dita/DITAOT/plugins/com.xyz.webhelp-responsive
I would like to specify custom WebHelp responsive templates for the plugin, so, using the instructions in https://www.oxygenxml.com/doc/versions/ ... ation.html, I added the following folder:
Oxygen/frameworks/xyz_dita/DITAOT/plugins/com.oxygenxml.webhelp/templates/dita/myTemplate/
However, I cannot access the custom templates. It seems that oXygen does not see them in the DITA-OT engine for my framework. I have tried searching for them when I create a scenario in the Transformation tab of the document type association.
How can I access these templates from my custom framework and separate DITA-OT engine?
-
- Site Admin
- Posts: 275
- Joined: Thu Dec 24, 2009 11:21 am
Re: Accessing custom WebHelp responsive templates from custom framework
Hello,
The templates presented in the WebHelp Responsive Scenario dialog are loaded from the following loacation:
{DITA_OT_DIR}/plugins/com.oxygenxml.webhelp/templates/dita
Please make sure that the DITA Open Toolkit option (from the Options > Preferences > DITA preferences page) points to your custom DITA-OT distribution (i.e.: Oxygen/frameworks/xyz_dita/DITAOT).
Also, the directories structure and the resources names under the template directory are very important and should look like this:
{template-name}/variants/{variant-name}/{skin-name}/skin.css
For example: myTemplate/variants/myVariant/mySkin/skin.css
In this case you should see a "mySkin" entry in the Templates Tab of the WebHelp Responsive Scenario dialog. To easily identify your skin in the scenario dialog you can add a "skin.png" preview image in the skin's directory.
See also: https://www.oxygenxml.com/doc/versions/ ... uyh_x33_kv
Regards,
Alin
The templates presented in the WebHelp Responsive Scenario dialog are loaded from the following loacation:
{DITA_OT_DIR}/plugins/com.oxygenxml.webhelp/templates/dita
Please make sure that the DITA Open Toolkit option (from the Options > Preferences > DITA preferences page) points to your custom DITA-OT distribution (i.e.: Oxygen/frameworks/xyz_dita/DITAOT).
Furthermore, please make sure that you do not change the name of the WebHelp plugin's directory (it should be com.oxygenxml.webhelp).jlowther wrote:I use the following plugin:
Oxygen/frameworks/xyz_dita/DITAOT/plugins/com.xyz.webhelp-responsive
Also, the directories structure and the resources names under the template directory are very important and should look like this:
{template-name}/variants/{variant-name}/{skin-name}/skin.css
For example: myTemplate/variants/myVariant/mySkin/skin.css
In this case you should see a "mySkin" entry in the Templates Tab of the WebHelp Responsive Scenario dialog. To easily identify your skin in the scenario dialog you can add a "skin.png" preview image in the skin's directory.
See also: https://www.oxygenxml.com/doc/versions/ ... uyh_x33_kv
Regards,
Alin
Alin Balasa
Software Developer
<oXygen/> XML Editor
http://www.oxygenxml.com
Software Developer
<oXygen/> XML Editor
http://www.oxygenxml.com
Return to “SDK-API, Frameworks - Document Types”
Jump to
- Oxygen XML Editor/Author/Developer
- ↳ Feature Request
- ↳ Common Problems
- ↳ DITA (Editing and Publishing DITA Content)
- ↳ SDK-API, Frameworks - Document Types
- ↳ DocBook
- ↳ TEI
- ↳ XHTML
- ↳ Other Issues
- Oxygen XML Web Author
- ↳ Feature Request
- ↳ Common Problems
- Oxygen Content Fusion
- ↳ Feature Request
- ↳ Common Problems
- Oxygen JSON Editor
- ↳ Feature Request
- ↳ Common Problems
- Oxygen PDF Chemistry
- ↳ Feature Request
- ↳ Common Problems
- Oxygen Feedback
- ↳ Feature Request
- ↳ Common Problems
- Oxygen XML WebHelp
- ↳ Feature Request
- ↳ Common Problems
- XML
- ↳ General XML Questions
- ↳ XSLT and FOP
- ↳ XML Schemas
- ↳ XQuery
- NVDL
- ↳ General NVDL Issues
- ↳ oNVDL Related Issues
- XML Services Market
- ↳ Offer a Service