source/auxiliary/sbasic.tree | 5 +++++ source/text/sbasic/python/main0000.xhp | 5 +++++ source/text/sbasic/python/python_screen.xhp | 7 +++---- 3 files changed, 13 insertions(+), 4 deletions(-)
New commits: commit 68e39672b4fdc9719f2e0a85e83f2d6fff6c180c Author: Alain Romedenne <[email protected]> AuthorDate: Thu Jun 16 07:59:21 2022 +0200 Commit: Alain Romedenne <[email protected]> CommitDate: Fri Jun 24 16:08:35 2022 +0200 Toc update to document Python resources Python modules deserve to be highlited: - scriptforge - uno - msgbox Change-Id: I6d0cad668527b17b1f3ca898d5001768cb30a318 Reviewed-on: https://gerrit.libreoffice.org/c/help/+/135947 Tested-by: Jenkins Reviewed-by: Alain Romedenne <[email protected]> diff --git a/source/auxiliary/sbasic.tree b/source/auxiliary/sbasic.tree index bca59567b..3cffcd46f 100644 --- a/source/auxiliary/sbasic.tree +++ b/source/auxiliary/sbasic.tree @@ -402,6 +402,11 @@ <topic id="sbasic/text/sbasic/python/python_examples.xhp">Python Programming Examples</topic> <topic id="sbasic/text/sbasic/python/python_2_basic.xhp">Calling Basic Macros from Python</topic> </node> + <node id="070203" title="Python Modules"> + <topic id="sbasic/text/sbasic/shared/03/lib_ScriptForge.xhp">scriptforge module</topic> + <topic id="sbasic/text/sbasic/python/python_programming.xhp">uno module</topic> + <topic id="sbasic/text/sbasic/python/python_screen.xhp">msgbox module</topic> + </node> </node> <node id="0703" title="Script Development Tools"> <topic id="shared/text/shared/guide/dev_tools.xhp">Object Inspector</topic> diff --git a/source/text/sbasic/python/main0000.xhp b/source/text/sbasic/python/main0000.xhp index e84d9b2d3..fe47d7502 100644 --- a/source/text/sbasic/python/main0000.xhp +++ b/source/text/sbasic/python/main0000.xhp @@ -40,6 +40,11 @@ <embed href="text/sbasic/python/python_programming.xhp#pythonprogrammingheading"/> <embed href="text/sbasic/python/python_examples.xhp#pythonexamples2"/> <embed href="text/sbasic/shared/03/sf_intro.xhp#title"/> + + <h2 id="hd_id901655365903313">%PRODUCTNAME Python Modules</h2> + <paragraph role="paragraph" id="par_id801655368030968"><link href="text/sbasic/shared/03/lib_ScriptForge.xhp" name="CHANGE ME"><literal>scriptforge</literal> module</link></paragraph> + <paragraph role="paragraph" id="par_id21655367848705"><link href="text/sbasic/python/python_screen.xhp" name="msgbox module"><literal>msgbox</literal> module</link></paragraph> + <embed href="text/swriter/main0000.xhp#helpabouthelp"/> </body> </helpdocument> diff --git a/source/text/sbasic/python/python_screen.xhp b/source/text/sbasic/python/python_screen.xhp index b88fa923a..a40c6bc79 100644 --- a/source/text/sbasic/python/python_screen.xhp +++ b/source/text/sbasic/python/python_screen.xhp @@ -24,7 +24,7 @@ </bookmark> <h1 id="N0434"><variable id="ioscreen"><link href="text/sbasic/python/python_screen.xhp" name="IO to screen">Input/Output to Screen</link></variable></h1> <paragraph role="paragraph" id="N0435">Python standard output file is not available when running Python macros from <menuitem>Tools – Macros - Run Macro</menuitem>... menu. Presenting the output of a module requires the Python interactive console. Features such as <literal>input()</literal>, <literal>print()</literal>, <literal>repr()</literal> and <literal>str()</literal> are available from the Python shell.</paragraph> - <paragraph role="tip" id="N0436">The <link href="https://extensions.libreoffice.org/extensions/apso-alternative-script-organizer-for-python"; name="apso">Alternative Python Script Organizer</link> (APSO) extension offers a msgbox() function out of its <literal>apso_utils</literal> module.</paragraph> + <tip id="msgbox_tip">%PRODUCTNAME <literal>msgbox</literal> Python module proposes a <literal>msgbox()</literal> method that is illustrated in <link href="text/sbasic/python/python_handler.xhp" name="msgbox example">Creating Event Listeners</link> and <link href="text/sbasic/python/python_handler.xhp" name="msgbox_example">Creating a dialog handler</link> example pages.</tip> <paragraph role="paragraph" id="N0437">%PRODUCTNAME Basic proposes <literal>InputBox()</literal>, <literal>Msgbox()</literal> and <literal>Print()</literal> screen I/O functions. Python alternatives exist relying either on %PRODUCTNAME API Abstract Windowing Toolkit, either on Python to Basic function calls. The latter proposes a syntax that is intentionally close to that of Basic, and uses a Python module next to a Basic module. The API Scripting Framework is used to perform Basic, BeanShell, JavaScript and Python inter-languages function calls.</paragraph> <h2 id="N0438">Python syntax:</h2> <paragraph role="code" id="N0439" localize="false">MsgBox(txt, buttons=0, title=None)<br/></paragraph> @@ -80,6 +80,7 @@ <paragraph role="pycode" localize="false" id="N0490"> xScript = scriptPro.getScript(scriptName)</paragraph> <paragraph role="pycode" localize="false" id="N0491"> return xScript</paragraph> </pycode> + <note id="par_id161655364816553"><literal>MsgBox</literal> and <literal>InputBox</literal> methods from the <link href="text/sbasic/shared/03/sf_basic.xhp" name="Basic service">Basic service</link> included in <link href="text/sbasic/shared/03/lib_ScriptForge.xhp" name="scriptforge module"> the ScriptForge libraries</link> call directly their native Basic counterparts.</note> <h3 id="N0492"><literal>uiScripts</literal> Basic module</h3> <bascode> <paragraph role="bascode" localize="false" id="N0493">Option Explicit</paragraph> @@ -95,10 +96,8 @@ <paragraph role="bascode" localize="false" id="N0503"> Print msg</paragraph> <paragraph role="bascode" localize="false" id="N0504">End Sub</paragraph> </bascode> + <tip id="tip_APSO">The <link href="https://extensions.libreoffice.org/extensions/apso-alternative-script-organizer-for-python"; name="apso">Alternative Python Script Organizer</link> (APSO) extension offers a msgbox() function out of its <literal>apso_utils</literal> module.</tip> <section id="relatedtopics"> - <!-- - <paragraph role="paragraph" id="N0505"><link href="text/sbasic/python/python_2_basic.xhp" name="Calling Basic macros from Python">Calling Basic macros from Python</link></paragraph> - --> <embed href="text/sbasic/shared/03010000.xhp#BasicScreenIO"/> <embed href="text/sbasic/python/python_examples.xhp#pythonexamples2"/> <embed href="text/sbasic/python/main0000.xhp#pythonscriptshelp"/>
