improve xqdoc documentation

Bug #867338 reported by Sorin Marian Nasoi
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
Zorba
Invalid
Medium
Sorin Marian Nasoi

Bug Description

We should have a method similar to the \include option provided by doxygen
in order to include files/tests into the xqdoc documentation.

Details:
- in Doxygen if you made sure that in the doc/zorba/doxy.config.in you set the:
EXAMPLE_PATH at line 501 and EXAMPLE_PATTERNS at line 510 in the doxy
documentation you could use

\include file.xml and get the content of the file.xml

the result of the XHTML code was a DIV and PRE containers that were
added to the actual code in the file, see for example
http://www.zorba-xquery.com/doc/zorba-latest/zorba/html/converters.html
the test shown after the text "The following XQuery (taken from John
Snelson's article mentioned above) demonstrates the usage of the parse
function."

There you see that <div class="fragment"><pre class="fragment"> are
added before the content of the actual file \included. Off course
class="fragment" should be implemented in the CSS, but that is besides
the point.

A simpler solution, for starters would be to add some links like this:
<a href="file:///file.xml" target="_blank">file.xml</a> and then you
put the file.xml in a path recognized by xqdoc (I think the same thing
is done the links to the actual modules pages, in xhtml/index.html,
right?)
In this case I think the question is in which folder should we store the file.xml.

Revision history for this message
Sorin Marian Nasoi (sorin.marian.nasoi) wrote :

We already have this in Zorba.

Changed in zorba:
status: Unknown → Triaged
status: Triaged → Invalid
assignee: Matthias Brantner (matthias-brantner) → Sorin Marian Nasoi (sorin.marian.nasoi)
To post a comment you must log in.
This report contains Public information  
Everyone can see this information.

Other bug subscribers

Remote bug watches

Bug watches keep track of this bug in other bug trackers.