DocBook WebHelp Transformation
Posted: Wed Sep 19, 2012 8:28 pm
Hi,
We recently started using Oxygen to author our help files for our product and converted our custom XML schema documentation to the DocBook schema. We're running into some issues though when trying to transform this to the DocBook WebHelp format.
The issues we're seeing are:
1. When transforming, none of our pictures are included. This is likely due to how we've setup our folder structure for our DocBook Oxygen project, so I'm wondering what the recommended folder structure setup is for a DocBook project in Oxygen. We currently have something like:
Our root folder contains the index.xml for the DocBook book, as well as some of our generic help files, things like contact us, etc.
Each of our topic folders contains all the help files for that topic. Some of our topic folders also contain sub-topic folders for any sub-topics, etc. Each of our (sub)topics folder has it's own images folder to store all the images for that particular (sub)topic.
These are all physical folders, not virtual ones.
2. When doing the transformation, the entire text of all of our (sub)topics turns into a link, except for the last page, which displays normally.
I'm suspecting this has something to do with us missing something somewhere, or how our index.xml is setup.
Our (test) index.xml contains the following:
Any help in resolving these issues would be appreciated.
We recently started using Oxygen to author our help files for our product and converted our custom XML schema documentation to the DocBook schema. We're running into some issues though when trying to transform this to the DocBook WebHelp format.
The issues we're seeing are:
1. When transforming, none of our pictures are included. This is likely due to how we've setup our folder structure for our DocBook Oxygen project, so I'm wondering what the recommended folder structure setup is for a DocBook project in Oxygen. We currently have something like:
Code: Select all
root
images
topic 1
images
subtopic 1
images
subtopic 2
images
topic 2
images
topic 3
images
Each of our topic folders contains all the help files for that topic. Some of our topic folders also contain sub-topic folders for any sub-topics, etc. Each of our (sub)topics folder has it's own images folder to store all the images for that particular (sub)topic.
These are all physical folders, not virtual ones.
2. When doing the transformation, the entire text of all of our (sub)topics turns into a link, except for the last page, which displays normally.
I'm suspecting this has something to do with us missing something somewhere, or how our index.xml is setup.
Our (test) index.xml contains the following:
Code: Select all
<?xml version="1.0" encoding="UTF-8"?>
<?xml-model href="http://www.oasis-open.org/docbook/xml/5.0/rng/docbook.rng" schematypens="http://relaxng.org/ns/structure/1.0"?>
<article xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0">
<title>SkedFlex User Help</title>
<xi:include href="Topic1/topic1.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
<xi:include href="Topic2/topic2.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
</article>