Fernand Vanrie wrote:
Wiki's are fine, but please put the information where it suppose to be: in the API, or in its documentation. Maybe XRAY and the OBJECT INSPECTOR are alsoo ideal places to store the stuff we alway need an never now where to look for.
Can Bernard and Dieter gives their opinions ?

Fernand

Yes, the information what to pass to com.sun.star.frame.XComponentLoader.loadComponentFromURL needs to be available in the UNOIDL documentation of that method (either in line or linked from there). (Note that this is already generally available, albeit broken: The UNOIDL docu of loadComponentFromURL points to MediaDescriptor, which describes FilterName and FilterName-relative FilterOptions. However, both are dead ends. For valid FilterNames, it points to TypeDetection, where I at least get lost. For valid FilterOptions, it states "Details must be documented by the filter"---wherever that is, so lost again.)

-Stephan

Juergen Schmidt schreef:
Cedric Bosdonnat wrote:
Hi all,

It's really hard to find informations on the options to give to the 'Text (encoded)' filter. I finally found out the information needed to import the file with the proper character set.

  1/ I created a snippet to explain the solution
2/ Could it be possible to complete the wiki with the list of the possible character sets, and the filter options details. ?

that is good point, we need a place where exactly this kind of implementation details can be described.

A further option from my point of view can be to specify a multiple inheritance interface and define for each implementation a new service. The service represents a special version or implemenation of this interface which can be instantiated. In the service documentation the possible values of the attributes or function parameters can be described specific for this filter.

There are probably more ways to document this. But it is independent where it is documented, important is that it is documented.

We have more places in the API where it is hard to find the possible values for example for the parameters. I would like to encourage all API designer to keep this in mind. Other people will use the APIs and need this information and it is important to find them easily.

With the OO wiki we have a good possibility to extend the IDL docu with links into the wiki where more and maybe changing docu can be found. The wiki is easy to change and for example a growing lists of possible parameter values can be easy adapted.

Juergen


Thanks,
Cedric

[...]

---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]

Reply via email to