[Libreoffice-commits] help.git: source/text
Alain Romedenne (via logerrit)
logerrit at kemper.freedesktop.org
Wed Sep 8 15:38:33 UTC 2021
source/text/sbasic/shared/00000003.xhp | 29 +------------------------
source/text/sbasic/shared/03/avail_release.xhp | 8 +-----
source/text/sbasic/shared/03/sf_exception.xhp | 28 ++++++++++++++++++++++--
3 files changed, 30 insertions(+), 35 deletions(-)
New commits:
commit ab28d2cbdffe0e5c9a966fa5f7659a455a042663
Author: Alain Romedenne <alain.romedenne at libreoffice.org>
AuthorDate: Thu Sep 2 15:37:05 2021 +0200
Commit: Rafael Lima <rafael.palma.lima at gmail.com>
CommitDate: Wed Sep 8 17:38:13 2021 +0200
sf-exception.PythonPrint new method
Change-Id: I11402201ef509816fc38665eae8d057e1761274a
Reviewed-on: https://gerrit.libreoffice.org/c/help/+/121469
Tested-by: Jenkins
Reviewed-by: Rafael Lima <rafael.palma.lima at gmail.com>
diff --git a/source/text/sbasic/shared/00000003.xhp b/source/text/sbasic/shared/00000003.xhp
index 5c2b7fb2b..04e6b540c 100644
--- a/source/text/sbasic/shared/00000003.xhp
+++ b/source/text/sbasic/shared/00000003.xhp
@@ -17,28 +17,21 @@
* except in compliance with the License. You may obtain a copy of
* the License at http://www.apache.org/licenses/LICENSE-2.0 .
-->
-
<meta>
<topic id="textsbasicshared00000003xml" indexer="exclude" status="PUBLISH">
<title id="tit" xml-lang="en-US">Information</title>
<filename>/text/sbasic/shared/00000003.xhp</filename>
</topic>
</meta>
-
<body>
-
-
<h1 id="hd_id3148550">Information</h1>
-
<section id="languageformat">
<paragraph id="par_id3153381" role="paragraph" xml-lang="en-US">You can set the locale used for controlling the formatting numbers, dates and currencies in $[officename] Basic in <switchinline select="sys"><caseinline select="MAC"><emph>%PRODUCTNAME - Preferences</emph>
</caseinline><defaultinline><emph>Tools - Options</emph></defaultinline></switchinline><emph> - Language Settings - Languages</emph>. In Basic format codes, the decimal point (<emph>.</emph>) is always used as <emph>placeholder</emph> for the decimal separator defined in your locale and will be replaced by the corresponding character.</paragraph>
<paragraph id="par_id3150870" role="paragraph" xml-lang="en-US">The same applies to the locale settings for date, time and currency formats. The Basic format code will be interpreted and displayed according to your locale setting.</paragraph>
</section>
-
<section id="colorcodes">
<paragraph id="par_id3156424" role="paragraph" xml-lang="en-US">The color values of the 16 basic colors are as follows:</paragraph>
-
<table id="tbl_id3147434">
<tablerow>
<tablecell>
@@ -178,7 +171,6 @@
</tablerow>
</table>
</section>
-
<section id="dialoglibhowtoget">
<paragraph role="paragraph" id="par_id631529990528928" xml-lang="en-US">Open <item type="menuitem">Tools - Macros - Organize Dialogs</item> and select <item type="menuitem">%PRODUCTNAME Dialogs</item> container.</paragraph>
</section>
@@ -188,67 +180,51 @@
<section id="basiclibwarning">
<paragraph role="paragraph" id="par_id971529072633266" xml-lang="en-US"><variable id="basiclibrarynote">This library must be loaded before execution. Execute the following statement before running any macro that uses this library:</variable></paragraph>
</section>
-
<section id="vbasupport">
<warning id="par_id051920171018124524">This constant, function or object is enabled with the statement <link href="text/sbasic/shared/03103350.xhp" name="optionvbasupport"><literal>Option VBASupport 1</literal></link> placed before the executable program code in a module.</warning>
</section>
<section id="beforeexecutable">
<warning id="par_id3145172">This statement must be added before the executable program code in a module.</warning>
</section>
-
<section id="functsyntax">
<h2 id="hd_id061420171139089682"><variable id="functsyntax">Syntax:</variable></h2>
</section>
-
<section id="functvalue">
<h2 id="hd_id061420171139087480"><variable id="functvalue">Return value:</variable></h2>
</section>
-
<section id="functparameters">
<h2 id="hd_id061420171139084157"><variable id="functparameters">Parameters:</variable></h2>
</section>
-
<section id="functexample">
<h2 id="hd_id061420171139088233"><variable id="functexample">Example:</variable></h2>
</section>
-
<section id="In_Basic">
<h4 id="hd_id191620312698501">In Basic</h4>
</section>
-
<section id="In_Python">
<h4 id="hd_id831620312769993">In Python</h4>
</section>
-
<section id="Basic_Only">
<note id="par_id701621038131185">This method is only available for <emph>Basic</emph> scripts.</note>
</section>
-
<section id="Python_Only">
<note id="par_id701621038131336">This method is only available for <emph>Python</emph> scripts.</note>
</section>
-
<section id="Requires_APSO">
-<warning id="par_id81621427048241">This method requires the installation of the <link href="https://extensions.libreoffice.org/en/extensions/show/apso-alternative-script-organizer-for-python" name="APSO Link">APSO (Alternative Script Organizer for Python)</link> extension. If it is not installed, an error will occur.</warning>
+<warning id="par_id81621427048241">This method requires the installation of the <link href="https://extensions.libreoffice.org/en/extensions/show/apso-alternative-script-organizer-for-python" name="APSO Link">APSO (Alternative Script Organizer for Python)</link> extension. In turn APSO requires the presence of %PRODUCTNAME Python scripting framework. If APSO or Python are missing, an error occurs.</warning>
</section>
-
<section id="Python_Support">
<note id="par_id21624295605301">This service is fully supported in both Basic and Python languages. All examples are expressed using the Basic programming language and can be easily converted to Python.</note>
</section>
-
<paragraph role="paragraph" id="par_id161599082457466"><variable id="stringfunctions"><link href="text/sbasic/shared/03120300.xhp" name="string functions">String functions</link></variable></paragraph>
-
-
<paragraph id="par_id06142017015837916" role="paragraph" xml-lang="en-US"><variable id="VBA-Financial"><link href="text/sbasic/shared/special_vba_func.xhp#VBAFinancial">VBA financial functions</link></variable></paragraph>
<paragraph id="par_id06142017016837917" role="paragraph" xml-lang="en-US"><variable id="VBATimeAndDate"><link href="text/sbasic/shared/special_vba_func.xhp#VBADateTime">VBA Time and Date functions</link></variable></paragraph>
<paragraph id="par_id06142017016837918" role="paragraph" xml-lang="en-US"><variable id="VBAIO"><link href="text/sbasic/shared/special_vba_func.xhp#VBAIO">VBA I/O functions</link></variable></paragraph>
<paragraph id="par_id06142017016837919" role="paragraph" xml-lang="en-US"><variable id="VBAMath"><link href="text/sbasic/shared/special_vba_func.xhp#VBAMath">VBA Mathematical functions</link></variable></paragraph>
<paragraph id="par_id06142017016837920" role="paragraph" xml-lang="en-US"><variable id="VBAObject"><link href="text/sbasic/shared/special_vba_func.xhp#VBAObject">VBA Object functions</link></variable></paragraph>
-
<section id="errorcode">
<h2 id="hd_id3152869"><variable id="errorcode">Error codes:</variable></h2>
</section>
-
<section id="allerrors">
<paragraph id="par_id315509599" role="paragraph" xml-lang="en-US"><variable id="err1">1 An exception occurred</variable></paragraph>
<paragraph id="par_id3155095" role="paragraph" xml-lang="en-US"><variable id="err2">2 Syntax error</variable></paragraph>
@@ -373,5 +349,4 @@
<paragraph id="par_id31455986" role="paragraph" xml-lang="en-US"><variable id="err1006">1006 Unable to determine property</variable></paragraph>
</section>
</body>
-
-</helpdocument>
+</helpdocument>
\ No newline at end of file
diff --git a/source/text/sbasic/shared/03/avail_release.xhp b/source/text/sbasic/shared/03/avail_release.xhp
index addcd426c..f33c4e3aa 100644
--- a/source/text/sbasic/shared/03/avail_release.xhp
+++ b/source/text/sbasic/shared/03/avail_release.xhp
@@ -8,26 +8,23 @@
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*
-->
-
<meta>
<topic id="availablerelease" indexer="include" status="PUBLISH">
<title id="tit" xml-lang="en-US">(Un)Available since release</title>
<filename>/text/sbasic/shared/03/avail_release.xhp</filename>
</topic>
</meta>
-
<body>
<section id="UnAvailBasicMethod"><note id="not_BasMeth">This method is not available in Basic.</note></section>
<section id="UnAvailBasicProperty"><note id="not_BasProp">This property is not available in Basic.</note></section>
<section id="UnAvailPythonMethod"><note id="not_PycMeth">This method is not available in Python.</note></section>
<section id="UnAvailPythonProperty"><note id="not_PycProp">This property is not available in Python.</note></section>
-
<comment> Tags for LibreOffice 7.3 </comment>
<section id="7.3.method">
<note id="par_id291613654389793">This method is available from %PRODUCTNAME 7.3 onwards.</note>
</section>
<section id="7.3.property">
- <note id="par_id201613654593537">This property is available from %PRODUCTNAME 7.3 onwards.</note>
+ <note id="par_id201613654395537">This property is available from %PRODUCTNAME 7.3 onwards.</note>
</section>
<comment> Tags for LibreOffice 7.2 </comment>
<section id="7.2.service">
@@ -48,6 +45,5 @@
<section id="7.2.property">
<note id="par_id201613654395537">This property is available from %PRODUCTNAME 7.2 onwards.</note>
</section>
-
</body>
-</helpdocument>
+</helpdocument>
\ No newline at end of file
diff --git a/source/text/sbasic/shared/03/sf_exception.xhp b/source/text/sbasic/shared/03/sf_exception.xhp
index 75a688dc9..e29e19dea 100644
--- a/source/text/sbasic/shared/03/sf_exception.xhp
+++ b/source/text/sbasic/shared/03/sf_exception.xhp
@@ -142,11 +142,12 @@
<paragraph role="tablecontent" id="par_id871608132025242" localize="false">
<link href="text/sbasic/shared/03/sf_exception.xhp#ConsoleToFile" name="ConsoleToFile method">ConsoleToFile</link><br/>
<link href="text/sbasic/shared/03/sf_exception.xhp#DebugDisplay" name="DebugDisplay method">DebugDisplay</link><br/>
- <link href="text/sbasic/shared/03/sf_exception.xhp#DebugPrint" name="DebugPrint method">DebugPrint</link><br/>
+ <link href="text/sbasic/shared/03/sf_exception.xhp#DebugPrint" name="DebugPrint method">DebugPrint</link><br/><br/>
</paragraph>
</tablecell>
<tablecell>
<paragraph role="tablecontent" id="par_id831608132069033" localize="false">
+ <link href="text/sbasic/shared/03/sf_exception.xhp#PythonPrint" name="PythonPrint method">PythonPrint</link><br/>
<link href="text/sbasic/shared/03/sf_exception.xhp#PythonShell" name="PythonShell method">PythonShell</link><br/>
<link href="text/sbasic/shared/03/sf_exception.xhp#Raise" name="Raise method">Raise</link><br/>
<link href="text/sbasic/shared/03/sf_exception.xhp#RaiseWarning" name="RaiseWarning method">RaiseWarning</link><br/>
@@ -312,6 +313,30 @@
</pycode>
</section>
+<section id="PythonPrint">
+ <comment> PythonPrint -------------------------------------------------------------------------------------------------------------------------- </comment>
+ <bookmark xml-lang="en-US" localize="false" branch="index" id="bm_id301587219428104">
+ <bookmark_value>Exception service;PythonPrint</bookmark_value>
+ </bookmark>
+ <h2 id="hd_id5515879128204789" localize="false">PythonPrint</h2>
+ <paragraph role="paragraph" id="par_id111621624672183">Displays the list of arguments in a readable form in the Python shell (APSO) console. Arguments are separated by a TAB character (simulated by spaces).</paragraph>
+ <paragraph role="paragraph" id="par_id841621426229467">The same string is added to the ScriptForge debug console.</paragraph>
+ <embed href="text/sbasic/shared/00000003.xhp#Basic_Only"/>
+ <embed href="text/sbasic/shared/avail_release.xhp#7.3.method"/>
+ <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/>
+ <bascode>
+ <paragraph role="bascode" localize="false" id="bas_id81630591881423">exc.PythonPrint(arg0: any, [arg1: any, ...])</paragraph>
+ </bascode>
+ <embed href="text/sbasic/shared/00000003.xhp#Requires_APSO"/>
+ <embed href="text/sbasic/shared/00000003.xhp#functparameters"/>
+ <paragraph role="paragraph" id="par_id391126449167833"><emph>arg0[, arg1, ...]</emph>: Any number of arguments of any type. The maximum length of each individual argument is 1024 characters.</paragraph>
+ <embed href="text/sbasic/shared/00000003.xhp#functexample"/>
+ <bascode>
+ <paragraph role="bascode" localize="false" id="pyc_id451621479450230">exc.PythonPrint(a, Array(1, 2, 3), , "line1" & Chr(10) & "Line2", DateSerial(2020, 04, 09))</paragraph>
+ </bascode>
+ <note id="par_id261123015276160">In python use simply the builtin print() statement.</note>
+</section>
+
<section id="PythonShell">
<comment> PythonShell -------------------------------------------------------------------------------------------------------------------------- </comment>
<bookmark xml-lang="en-US" localize="false" branch="index" id="bm_id301587219824104">
@@ -321,7 +346,6 @@
<paragraph role="paragraph" id="par_id111621426672183">Opens an APSO Python shell as a non-modal window. The Python script keeps running after the shell is opened. The output from <literal>print</literal> statements inside the script are shown in the shell.</paragraph>
<paragraph role="paragraph" id="par_id841621426922467">Only a single instance of the APSO Python shell can be opened at any time. Hence, if a Python shell is already open, then calling this method will have no effect.</paragraph>
<embed href="text/sbasic/shared/00000003.xhp#Requires_APSO"/>
- <embed href="text/sbasic/shared/00000003.xhp#Python_Only"/>
<embed href="text/sbasic/shared/00000003.xhp#functsyntax"/>
<paragraph role="paragraph" localize="false" id="par_id411621625580764">
<input>exc.PythonShell(variables: dict)</input>
More information about the Libreoffice-commits
mailing list