> If no one objects, i'll commit this to
> src/documentation/content/xdocs/dev/guide-embedding.xml.

Objection your Honor! :-)

I read the guide-embedding and if I imagine someone writing a XMLRPC-guide,
half of the content would be copy/pasted.  It smells refactoring, even in the
documentation -> idea of merging into one document.  This would also prevent
10'000 files floating everywhere...  Why not integrating this into a remodeled
developer guide?  I thought of maybe something like that:

- introduction
     * how access the Xindice? (XML-RPC, Embed)
     * why would you do that? (integration into another product)

- Using XML-RPC
     * introduce the method
     * describe the messages
     * present an example

- Using the Embed version
     * introduce the method
     * present an example
     * required jars

Remember, the developer guide does not present what is Xindice (that's in the
user guide) but only presents working examples.

Another -1 is the lack of compilable source code.  I would like to see in the
example folder (java/example) the code used for the documentation.  This will
be very helpful to check if everything is still working.  And I hate when I
copy/paste the example of a book and it doesn't even compile.

The steps I propose:
1) write the code for the example
2) integrate the document into the already existing developer-guide

-Vladimir

--
Vladimir R. Bossicard
Apache Xindice - http://xml.apache.org/xindice

Reply via email to