How to know which schema file is declaring a global object in the documentation

This should cover W3C XML Schema, Relax NG and DTD related problems.
pierat
Posts: 9
Location: Paris, France

How to know which schema file is declaring a global object in the documentation

Tue Mar 26, 2013 12:06 am

Hi,

In the schema documentation generated by Oxygen, I want to know, for each global object, in which schema file the object is documented.

Looking at the tmp documentation file generated, I don't see any possibilities for doing that.

Does any one found a solution for this question ? Are there some planes to provide the information ?

Regards, Pierre
adrian
Posts: 2337

Re: How to know which schema file is declaring a global object in the documentation

Tue Mar 26, 2013 3:24 pm

Hello,

There is a setting that provides this information. In the XML Schema Documentation generation dialog look under the Settings tab in the subsection Included component details and enable the Location option.

Regards,
Adrian
Adrian Buza
<oXygen/> XML Editor, Schema Editor and XSLT Editor/Debugger
http://www.oxygenxml.com
pierat
Posts: 9
Location: Paris, France

Re: How to know which schema file is declaring a global object in the documentation

Tue Mar 26, 2013 4:29 pm

Adrian,

Thanks for the answer but this is not my use case.

What I want is a sole file but with each object, an indication of the file it comes from.

Looking at the tmp files it should be something like :

Code: Select all

...
<element id="metaCommunes">
<qname>metaCommunes</qname>
<namespace>http://modeles.fr/modeles/reference</namespace>
<schemaFile>whatever.xsd</schemaFile>
<schemaFileId>A0341</schemaFileId>
<diagram width="511" height="272">
<location>img/metaCommunes_xsd_Element_metaCommunes.jpeg</location>
<map name="metaCommunes_xsd_Element_metaCommunes">
...

schemaFile and optionnally schemaFileId are the information I need.

Pierre
adrian
Posts: 2337

Re: How to know which schema file is declaring a global object in the documentation

Tue Mar 26, 2013 6:51 pm

Well, a first step is to enable that option. Oxygen will then generate in the temporary file for each element an additional schemaLocation element that contains the absolute URL to that schema. e.g.

Code: Select all

<element id="personnel">
<qname>p:personnel</qname>
<namespace>http://www.oxygenxml.com/ns/samples/personal</namespace>
<schemaLocation>file:/D:/projects/eXml/samples/personal.xsd</schemaLocation>
<diagram width="425" height="521">
<location>img/personal_xsd_Element_p_personnel.png</location>
...
So you can then use the URL specified by schemaLocation. Unfortunately there is no schema file ID there.

Note that there is schema for this generated temporary file: Oxygen/frameworks/schema_documentation/xsdDocSchema.xsd
This could be helpful in better understanding the content of the temporary file.

I'm guessing you already know about the Custom output format which allows you to pick a Custom XSL under the Options button in the XML Schema Documentation dialog.
A copy of the stylesheets that Oxygen uses to publish the output is located in Oxygen/frameworks/schema_documentation/xsl: xsdDocDocbook.xsl and xsdDocHtml.xsl. For PDF the DocBook result is then processed with the regular DocBook transformation to PDF.

Regards,
Adrian
Adrian Buza
<oXygen/> XML Editor, Schema Editor and XSLT Editor/Debugger
http://www.oxygenxml.com
pierat
Posts: 9
Location: Paris, France

[SOLVED] How to know which schema file is declaring a global object in the documentation

Wed Mar 27, 2013 10:37 am

Sorry for everything, my problem is solved : I did not saw that by default the "location" setting parameter was the only one not selected.

In the same idea, I did not understood your first answer.

Thanks for taking time ...

Return to “XML Schemas”

Who is online

Users browsing this forum: No registered users and 1 guest