OASIS Mailing List ArchivesView the OASIS mailing list archive below
or browse/search using MarkMail.


Help: OASIS Mailing Lists Help | MarkMail Help

docbook-apps message

[Date Prev] | [Thread Prev] | [Thread Next] | [Date Next] -- [Date Index] | [Thread Index] | [List Home]

Subject: Re: [docbook-apps] WYSIWYG Editor for docbook

Hi Johan,

You are using Docbook 5 (as you were mentioning xml:ids).

If it is Relax NG or XML Schema based:

Basically in order to propose you the entire list of IDREFs Oxygen needs to validate the master document (which xi:includes all modules) instead of the module which is opened. So when working on the module (chapter) you can create a validation scenario which validates the master XML document with the default engine.
This should be enough for the content completion to propose you all IDs.

But if you are using Docbook 5 DTD-based (and you probably are):
Oxygen uses Xerces for validation and when parsing XML files with associated DTD schemas Xerces will parse and validate the XML document before the xi:include's are resolved. Because of this the gathered IDs will also be incomplete, even if the master file is validated instead. So this is probably your case, you had to add validation units for each of the module in order to parse them all and gather IDs. We know about this limitation and we'll try to remove it in a future version.

Bu the way, good new, in Oxygen 14.1 the actions for inserting xrefs and links in the Author page will be more evolved, they will show a dialog which will allow you to quick find a reference ID. Please see the attached image. And yes, if you choose to insert from the master file, all IDs from all xi:includes will be collected and presented for intertion.


Radu Coravu
<oXygen/>  XML Editor, Schema Editor and XSLT Editor/Debugger

On 8/15/2012 8:24 AM, Johan Persson wrote:
(This is a bit off-topic but I'm staying in thread since it might be of
interest to the docbook community)

Now I'm curious :-)

If you create a master document which (x)includes a bunch of files, say
chapters, in Oxygen it will
work in the Author view, i.e. showing the complete document allowing you
to navigate around.

However, the problem is that if you are in say, "Chapter 1"  then the
auto-completion (in the
attribute view) for say "xlink:href" will not (at least not for
me) populate the dropdown list  in the
attribute view with "xml:id" that has been defined outside the current
file, say in "Chapter 2".

The only way I found to fix this is to add all files in the project as
files in the validation configuration then
the autocompletiong will find all defined "xml:id"'s in all files.


On 2012-08-13 22:38, Ron Catterall wrote:

I don't understand this xinclude problem with oxygen.  Oxygen has been
handling my xincludes, and nested xincludes, seamlessly from versions
around 7 or 8 at least.  There was a base problem with the earlier
versions (back to v.2 in my experience) - see this list about 5 or 6
years ago which gave trouble with xinclude nesting, but as far as I know
that has been sorted out.  I don't use any 'tricks'.  I just loaded v.14
on a new machine and it all worked straight out of the box on nested

On 13/08/2012 12:42, Johan Persson wrote:
Kind of. If you like me use a master file with XInclude:s it takes a
"trick" to get Oxygens to resolve all references and then it works
really well. This "trick" has been available for quite some
time/versions - but it is not obvious. You have to add all includes
as files in the validation schema. Then assign the validation schema
to all included modules. Having done that it will be possible to
handle XML includes as expected, all ref:s in all moduels can be
resolved by auto-completion. Unfortunately the recenet addition of
master file in Oxygen (which I thought would handle this) does not
seem to work this way for plain XML files (at least I didn't get it
to work). It works fine for XSLT stylesheets though. In regards to
the comments about price for Oxygen I would say that it is very
reasonable priced given its capabilities and the speed up it will
make in the writing of XML (and XSLT stylesheets). It would be very
easy to motivate its cost in a business setting. Of course, for a
hobbyist it would be harder but I believe Oxygen also has a very
cheap "hobbyist not-for-profit" license that is less than US $100
Just my 2c /J On 2012-08-13 19:11, Warren Young wrote:
On 8/12/2012 4:41 PM, Richard Hamilton wrote:
There are a bunch of very good visual editors out there that will
handle DocBook. The one I know best is Oxygen
(http://www.oxygenxml.com/), which works very well with DocBook.
The last time I tried opening one of my DocBook manuals with it
(version 9, maybe?) it didn't handle XML Includes gracefully. I like
to have a top-level document that simply includes all the chapter
files, which lets me edit the chapters individually. This keeps file
sizes reasonable and (much more important) localizes VCS comments to
the relevant section of the document. As I recall, oXygen sort of
kind of attempted to open the top-level document, but didn't give me
the seamless WYSIWYG view I expected: an editable version of the
final PDF output. If instead I opened an individual chapter file, it
got confused by the cross-references, since it didn't understand
that it was looking at a tree in a forest. Have they fixed this
limitation, or does it still push you toward putting the entire
document in a single file?
--------------------------------------------------------------------- To
unsubscribe, e-mail:docbook-apps-unsubscribe@lists.oasis-open.org
docbook-apps-unsubscribe@lists.oasis-open.org> For additional
commands, e-mail:docbook-apps-help@lists.oasis-open.org
-- ron@catterall.net  <mailto:ron@catterall.net>

Attachment: insertCrossRef.png
Description: PNG image

[Date Prev] | [Thread Prev] | [Thread Next] | [Date Next] -- [Date Index] | [Thread Index] | [List Home]