To comment on the following update, log in, then open the issue:
http://www.openoffice.org/issues/show_bug.cgi?id=86469
                 Issue #|86469
                 Summary|IDL reference for old-style services should not be a t
                        |able, but a more readable form
               Component|tools
                 Version|OOo 2.3
                Platform|All
                     URL|
              OS/Version|All
                  Status|NEW
       Status whiteboard|
                Keywords|
              Resolution|
              Issue type|ENHANCEMENT
                Priority|P3
            Subcomponent|autodoc
             Assigned to|np
             Reported by|fs





------- Additional comments from [EMAIL PROTECTED] Tue Feb 26 12:28:03 +0000 
2008 -------
Look at http://api.openoffice.org/docs/common/ref/com/sun/star/ucb/Content.html,
the autodoc-generated IDL documentation for the css.ucb.Content class.

This text is difficult to read: nearly the complete left half of the screen is
wasted, the interesting information is on the right half, but partly off-screen
(using a 1280-resolution here, which is not sufficient to read the whole page).

The problem is the table layout, which is created for this kind of services:

  +------+----------------------+
  | XFoo | description for XFoo |
  |      | .                    |
  |      | .                    |
  |      | .                    |
  +------+----------------------+
  | XBar | description for XBar |
  |      | .                    |
  |      | .                    |
  |      | .                    |
  +------+----------------------+

So, the longer the descriptions become, the more unreadable will be the complete
page. Effectively, autodoc penalizes comprehensive API documentation here.

I suggest to use a layout which is more conform with layouts used by other
entity types. I suggest something like the following

  +--------------------------------+
  | Exported Interfaces' - Summary |
  +------+-------------------------+
  | XFoo | shortdesc for XFoo      |
  +------+-------------------------+
  | XBar | shortdesc for XBar      |
  +------+-------------------------+

  +--------------------------------+
  | Exported Interfaces' - Details |
  +--------------------------------+
  | XFoo                           |
  |   longdesc for XFoo            |
  +--------------------------------+
  | XFoo                           |
  |   longdesc for XBar            |
  +--------------------------------+

This would be consistent with e.g. how structs and other entities are
documented, and much more readable, IMO, as it wastes less screen space, and
allows to put all content onto the screen, without the need of horizontal 
scrolling.

---------------------------------------------------------------------
Please do not reply to this automatically generated notification from
Issue Tracker. Please log onto the website and enter your comments.
http://qa.openoffice.org/issue_handling/project_issues.html#notification

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


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

Reply via email to