Bug 97447 - make the ServiceDocumenter singleton available as a global in Python and StarBasic
Summary: make the ServiceDocumenter singleton available as a global in Python and Star...
Status: NEW
Alias: None
Product: LibreOffice
Classification: Unclassified
Component: LibreOffice (show other bugs)
Version:
(earliest affected)
4.0.0.3 release
Hardware: All All
: medium normal
Assignee: Not Assigned
URL:
Whiteboard:
Keywords: difficultyMedium, easyHack, skillPython, skillUno
Depends on:
Blocks: Dev-related
  Show dependency tree / graph
 
Reported: 2016-01-30 10:40 UTC by Björn Michaelsen
Modified: 2023-11-01 17:22 UTC (History)
5 users (show)

See Also:
Crash report or crash signature:

Attachments
Add an attachment (proposed patch, testcase, etc.)

Note You need to log in before you can comment on or make changes to this bug.
Description Björn Michaelsen 2016-01-30 10:40:26 UTC 
The com.sun.star.util.theServiceDocumenter has been introduced in LibreOffice 5.1. It helps users of the UNO API to get the documentation for the services they are using:

 https://www.youtube.com/watch?v=WBNG6bVZPzw

However, it is rather cumbersome to get in common scripting languages, e.g. StarBasic:
 TheServiceDocumenter = GetDefaultContext.getValueByName('/singletons/com.sun.star.util.theServiceDocumenter')

It would be great to have this shortcutted by having it directly available in the scripting APIs:

For Basic: basic/source/classes/sb.cxx and GetUNOConstant
For Python: pyuno/ module
Comment 1 Robinson Tryon (qubit) 2016-02-18 14:51:48 UTC Comment hidden (obsolete)
Comment 2 Quintin Frerichs 2016-11-08 05:38:13 UTC 
I'd like to take this bug, but I don't understand exactly what it means. What should I do to get started?
Comment 3 jani 2016-11-08 06:55:32 UTC 
(In reply to Quintin Frerichs from comment #2)
> I'd like to take this bug, but I don't understand exactly what it means.
> What should I do to get started?

You need to extent the Basic and Python API, as described in comment 1.

However if you do not understand what it means, you probably have not worked with the UNO API before, and then the bug is quite complicated.

Have a look at 
https://wiki.documentfoundation.org/Development/GetInvolved

there are many easyhacks defined, it is easier for you to choose one, where you know how it works.

If you want to solve this bug, then of course you are welcome to do so, but please assign it to you.
Comment 4 Zev Spitz 2017-08-30 09:38:50 UTC 
What about the Automation and CLI bindings? Shouldn't this be added to them as well?