[Libreoffice-bugs] [Bug 150547] Unusable documentation for scripting
https://bugs.documentfoundation.org/show_bug.cgi?id=150547 Olivier Hallot changed: What|Removed |Added Status|UNCONFIRMED |RESOLVED Resolution|--- |INVALID -- You are receiving this mail because: You are the assignee for the bug.
[Libreoffice-bugs] [Bug 150547] Unusable documentation for scripting
https://bugs.documentfoundation.org/show_bug.cgi?id=150547
--- Comment #5 from Frank Schafer ---
Hello Guys,
thanks for the links you provided :)
I'm learning from an odt-document which seems to be a copy of this:
https://wiki.openoffice.org/w/images/c/c1/BasicGuide_OOo3.2.0.pdf
I have upgraded my OS by a the new LTS meanwhile and use Libreoffice 7.4 now
Here things look better :)
Even the code-completion feature is in a rudimental state :) ... this makes the
thing much more attractive for new users (once working).
There is an "Additional Information" now in the 7.4 online help (this was
absent in the 6.4) which leads to the underlying API.
@Rafael: you are right - writing documentation is a daunting task. Things are
going here too :)
>From the document I mentioned above:
ThisDocument.Sheets(0) or
ThisDocument.getSheets.getByName("Sheet_1")
for instance works on 7.4 ... if failed on 6.4 with "ThisDocument has no
property or method of X"
I was not able to find the methods in the API yet. The code completion doesn't
find them neither - well it's experimental ;)
... but they are there - otherwise they could not work :D
For now I will use the link to the "Ask the Gurus" and the book mentioned
above.
BTW: I have a wonderful use-case for a spreadsheet-application (and thus for a
tutorial).
Once I have it I will come back to you via "Ask the Gurus" to find a place to
share it.
Thanks once more
--
You are receiving this mail because:
You are the assignee for the bug.
[Libreoffice-bugs] [Bug 150547] Unusable documentation for scripting
https://bugs.documentfoundation.org/show_bug.cgi?id=150547 --- Comment #4 from Rafael Lima --- I was working on some documentation of simple Basic scripting in LO Calc, focusing on things like accessing Sheets and reading/writing data. I wrote a few pages using Markdown and published them in GitHub. I was planning to upload them as Help pages as well, so they can be translated. Reading Values from Single Cells: https://github.com/rafaelhlima/basic_calc_tutorial/blob/main/topics/Reading_Data_Single_Cell.md Dealing with Cell Types https://github.com/rafaelhlima/basic_calc_tutorial/blob/main/topics/Cell_Types.md Reading Data from Multiple Cells https://github.com/rafaelhlima/basic_calc_tutorial/blob/main/topics/Reading_Data_Multiple_Cells.md The problem with how this bug reported is that it complains about the documentation of everything. The way it is stated now, it is unfixable because it is huge. Maybe we could focus on writing help pages about basic Calc scripting, which is something doable. -- You are receiving this mail because: You are the assignee for the bug.
[Libreoffice-bugs] [Bug 150547] Unusable documentation for scripting
https://bugs.documentfoundation.org/show_bug.cgi?id=150547 --- Comment #3 from Mike Kaganski --- Anything can be documented. But any complaint like "your documentation is unusable" is just useless. There is a good source of information at https://wiki.documentfoundation.org/Macros. There is a new "Development Tools" feature [1] (indeed, too new for 6.4.7.2 as set in the report's metadata), that allows one to discover all the available methods of any object, including those of current document (that is represented by 'thisComponent' in Basic). There's also a Watch feature that has always been in Basic IDE, that allows you to inspect 'thisComponent', including complete type information under its 'Types' node, which is indeed not easy to scan, but contain every interface it implements, and every method it exposes; and also under its 'SupportedServiceNames', where one can see a few services, which can then be looked up in the API documentation, to have somewhat narrower understanding of what this object is. And the documentation for OpenOffice mostly is applicable (and being gradually adopted, like Developer Guide, that lately found new home in our wiki [2]). And finally, there are always ways to ask questions, as Rafael mentioned, and then take an effort to suggest own improvements to the topics that were difficult to oneself, as the contribution to the project. By the way, thisComponent (of Calc) *definitely* has Sheets property. So the problem here is something done wrong by OP in the macro, that needs discussion e.g. at Ask LibreOffice, together with the macro code itself, to figure that. Any software, no matter who and how creates its documentation, has lots of discussion everywhere over the net, e.g. on StackOverflow, because it's impossible to cover any problem of any (new or experienced) developer involving this software. [1] https://wiki.documentfoundation.org/ReleaseNotes/7.2#Core_.2F_General [2] https://wiki.documentfoundation.org/Documentation/DevGuide/LibreOffice_Developers_Guide -- You are receiving this mail because: You are the assignee for the bug.
[Libreoffice-bugs] [Bug 150547] Unusable documentation for scripting
https://bugs.documentfoundation.org/show_bug.cgi?id=150547 Roman Kuznetsov <79045_79...@mail.ru> changed: What|Removed |Added Severity|normal |enhancement CC||79045_79...@mail.ru, ||andreas.heini...@yahoo.de, ||mikekagan...@hotmail.com, ||olivier.hallot@libreoffice. ||org Component|BASIC |Documentation --- Comment #2 from Roman Kuznetsov <79045_79...@mail.ru> --- Mike, Andreas what do you think about this? I mean - should it be documented? -- You are receiving this mail because: You are the assignee for the bug.
[Libreoffice-bugs] [Bug 150547] Unusable documentation for scripting
https://bugs.documentfoundation.org/show_bug.cgi?id=150547 --- Comment #1 from Rafael Lima --- Documentation about scripting in Basic/Python has improved significantly in recent years, but still documenting the entire API is a daunting task. TBH it's unrealistic that we'll have help pages and examples for every method available in the API. If you want to write scripts using Basic, I recommend you check out Pitonyak's book, which is a wonderful learning resource. https://www.pitonyak.org/oo.php If you want to write Calc scripts, I also recommend checking out the Calc service of the ScriptForge library (which is thoroughly documented): https://help.libreoffice.org/latest/en-US/text/sbasic/shared/03/sf_calc.html Finally, if you run into issues to which you cannot find an answer, post a question at: https://ask.libreoffice.org/ There are a lot of knowledgeable people willing to help with scripting questions. -- You are receiving this mail because: You are the assignee for the bug.
