source/text/sbasic/shared/03/sf_session.xhp | 94 ++++++++++++++--------------
1 file changed, 47 insertions(+), 47 deletions(-)
New commits:
commit faec730e559a925e7b48132a91f3b0faa1775953
Author: Alain Romedenne <alain.romede...@libreoffice.org>
AuthorDate: Mon Dec 9 13:52:30 2024 +0100
Commit: Alain Romedenne <alain.romede...@libreoffice.org>
CommitDate: Tue Dec 10 16:35:39 2024 +0100
Precision in ScriptForge.Session.RunApplication() method
Change-Id: Iade10670dedb638dd36e1b32529b856b44676afe
Reviewed-on: https://gerrit.libreoffice.org/c/help/+/178144
Reviewed-by: Jean-Pierre Ledure <j...@ledure.be>
Tested-by: Jenkins
diff --git a/source/text/sbasic/shared/03/sf_session.xhp
b/source/text/sbasic/shared/03/sf_session.xhp
index 2c491b3a87..741734e3d6 100644
--- a/source/text/sbasic/shared/03/sf_session.xhp
+++ b/source/text/sbasic/shared/03/sf_session.xhp
@@ -11,16 +11,16 @@
<meta>
<topic id="SF_Session" indexer="include" status="PUBLISH">
- <title id="tit" xml-lang="en-US">ScriptForge.Session service</title>
+ <title id="tit">ScriptForge.Session service</title>
<filename>/text/sbasic/shared/03/sf_session.xhp</filename>
</topic>
</meta>
<body>
<section id="abstract">
- <bookmark xml-lang="en-US" localize="false" branch="index"
id="bm_id661582814720399">
+ <bookmark localize="false" branch="index" id="bm_id661582814720399">
<bookmark_value>Session service</bookmark_value>
</bookmark>
- <h1 id="hd_id901582814720985" xml-lang="en-US"><variable
id="SessionService"><link
href="text/sbasic/shared/03/sf_session.xhp"><literal>ScriptForge.Session</literal>
service</link></variable></h1>
+ <h1 id="hd_id901582814720985"><variable id="SessionService"><link
href="text/sbasic/shared/03/sf_session.xhp"><literal>ScriptForge.Session</literal>
service</link></variable></h1>
<paragraph role="paragraph" id="par_id861582814720987"
xml-lang="en-US">The <literal>Session</literal> service gathers various
general-purpose methods about:</paragraph>
<list type = "unordered">
<listitem>
@@ -35,7 +35,7 @@
</list>
</section>
- <h2 id="hd_id91582814720116" xml-lang="en-US">Service invocation</h2>
+ <h2 id="hd_id91582814720116">Service invocation</h2>
<paragraph role="paragraph" id="par_id141609955500101">Before using the
<literal>Session</literal> service the <literal>ScriptForge</literal> library
needs to be loaded or imported:</paragraph>
<embed href="text/sbasic/shared/03/lib_ScriptForge.xhp#importLibs"/>
@@ -56,114 +56,114 @@
<table id="tab_id291582814720160">
<tablerow>
<tablecell>
- <paragraph id="par_id381582814720870" role="tablehead"
xml-lang="en-US" localize="false">CONSTANT</paragraph>
+ <paragraph id="par_id381582814720870" role="tablehead"
localize="false">CONSTANT</paragraph>
</tablecell>
<tablecell>
- <paragraph id="par_id9158281472045" role="tablehead"
xml-lang="en-US">Value</paragraph>
+ <paragraph id="par_id9158281472045" role="tablehead">Value</paragraph>
</tablecell>
<tablecell>
- <paragraph id="par_id241582814720636" role="tablehead"
xml-lang="en-US">Where to find the library?</paragraph>
+ <paragraph id="par_id241582814720636" role="tablehead">Where to find
the library?</paragraph>
</tablecell>
<tablecell>
- <paragraph id="par_id361582814720116" role="tablehead"
xml-lang="en-US">Applicable</paragraph>
+ <paragraph id="par_id361582814720116"
role="tablehead">Applicable</paragraph>
</tablecell>
</tablerow>
<tablerow>
<tablecell>
- <paragraph id="par_id821582814720218" role="tablecontent"
xml-lang="en-US" localize="false">SCRIPTISEMBEDDED</paragraph>
+ <paragraph id="par_id821582814720218" role="tablecontent"
localize="false">SCRIPTISEMBEDDED</paragraph>
</tablecell>
<tablecell>
- <paragraph id="par_id401582814720597" role="tablecontent"
xml-lang="en-US" localize="false">"document"</paragraph>
+ <paragraph id="par_id401582814720597" role="tablecontent"
localize="false">"document"</paragraph>
</tablecell>
<tablecell>
<paragraph id="par_id451582814720105" role="tablecontent"
xml-lang="en-US">in the document</paragraph>
</tablecell>
<tablecell>
- <paragraph id="par_id421582814720733" role="tablecontent"
xml-lang="en-US" localize="false">Basic + Python</paragraph>
+ <paragraph id="par_id421582814720733" role="tablecontent"
localize="false">Basic + Python</paragraph>
</tablecell>
</tablerow>
<tablerow>
<tablecell>
- <paragraph id="par_id191582814720876" role="tablecontent"
xml-lang="en-US" localize="false">SCRIPTISAPPLICATION</paragraph>
+ <paragraph id="par_id191582814720876" role="tablecontent"
localize="false">SCRIPTISAPPLICATION</paragraph>
</tablecell>
<tablecell>
- <paragraph id="par_id601582814720388" role="tablecontent"
xml-lang="en-US" localize="false">"application"</paragraph>
+ <paragraph id="par_id601582814720388" role="tablecontent"
localize="false">"application"</paragraph>
</tablecell>
<tablecell>
<paragraph id="par_id73158281472032" role="tablecontent"
xml-lang="en-US">in any shared library</paragraph>
</tablecell>
<tablecell>
- <paragraph id="par_id291582814720233" role="tablecontent"
xml-lang="en-US" localize="false">Basic</paragraph>
+ <paragraph id="par_id291582814720233" role="tablecontent"
localize="false">Basic</paragraph>
</tablecell>
</tablerow>
<tablerow>
<tablecell>
- <paragraph id="par_id571582814720667" role="tablecontent"
xml-lang="en-US" localize="false">SCRIPTISPERSONAL</paragraph>
+ <paragraph id="par_id571582814720667" role="tablecontent"
localize="false">SCRIPTISPERSONAL</paragraph>
</tablecell>
<tablecell>
- <paragraph id="par_id4158281472033" role="tablecontent"
xml-lang="en-US" localize="false">"user"</paragraph>
+ <paragraph id="par_id4158281472033" role="tablecontent"
localize="false">"user"</paragraph>
</tablecell>
<tablecell>
<paragraph id="par_id391582814720487" role="tablecontent"
xml-lang="en-US">in <emph>My Macros</emph></paragraph>
</tablecell>
<tablecell>
- <paragraph id="par_id701582814720517" role="tablecontent"
xml-lang="en-US" localize="false">Python</paragraph>
+ <paragraph id="par_id701582814720517" role="tablecontent"
localize="false">Python</paragraph>
</tablecell>
</tablerow>
<tablerow>
<tablecell>
- <paragraph id="par_id691582814720670" role="tablecontent"
xml-lang="en-US" localize="false">SCRIPTISPERSOXT</paragraph>
+ <paragraph id="par_id691582814720670" role="tablecontent"
localize="false">SCRIPTISPERSOXT</paragraph>
</tablecell>
<tablecell>
- <paragraph id="par_id401582814720356" role="tablecontent"
xml-lang="en-US" localize="false">"user:uno_packages"</paragraph>
+ <paragraph id="par_id401582814720356" role="tablecontent"
localize="false">"user:uno_packages"</paragraph>
</tablecell>
<tablecell>
<paragraph id="par_id56158281472073" role="tablecontent"
xml-lang="en-US">in an extension installed for the current user</paragraph>
</tablecell>
<tablecell>
- <paragraph id="par_id611582814720723" role="tablecontent"
xml-lang="en-US" localize="false">Python</paragraph>
+ <paragraph id="par_id611582814720723" role="tablecontent"
localize="false">Python</paragraph>
</tablecell>
</tablerow>
<tablerow>
<tablecell>
- <paragraph id="par_id781582814720282" role="tablecontent"
xml-lang="en-US" localize="false">SCRIPTISSHARED</paragraph>
+ <paragraph id="par_id781582814720282" role="tablecontent"
localize="false">SCRIPTISSHARED</paragraph>
</tablecell>
<tablecell>
- <paragraph id="par_id991582814720953" role="tablecontent"
xml-lang="en-US" localize="false">"share"</paragraph>
+ <paragraph id="par_id991582814720953" role="tablecontent"
localize="false">"share"</paragraph>
</tablecell>
<tablecell>
<paragraph id="par_id21582814720997" role="tablecontent"
xml-lang="en-US">in <emph>Application Macros</emph></paragraph>
</tablecell>
<tablecell>
- <paragraph id="par_id491582814720794" role="tablecontent"
xml-lang="en-US" localize="false">Python</paragraph>
+ <paragraph id="par_id491582814720794" role="tablecontent"
localize="false">Python</paragraph>
</tablecell>
</tablerow>
<tablerow>
<tablecell>
- <paragraph id="par_id371582814720280" role="tablecontent"
xml-lang="en-US" localize="false">SCRIPTISSHAROXT</paragraph>
+ <paragraph id="par_id371582814720280" role="tablecontent"
localize="false">SCRIPTISSHAROXT</paragraph>
</tablecell>
<tablecell>
- <paragraph id="par_id51582814720754" role="tablecontent"
xml-lang="en-US" localize="false">"share:uno_packages"</paragraph>
+ <paragraph id="par_id51582814720754" role="tablecontent"
localize="false">"share:uno_packages"</paragraph>
</tablecell>
<tablecell>
<paragraph id="par_id981582814720125" role="tablecontent"
xml-lang="en-US">in an extension installed for all users</paragraph>
</tablecell>
<tablecell>
- <paragraph id="par_id66158281472037" role="tablecontent"
xml-lang="en-US" localize="false">Python</paragraph>
+ <paragraph id="par_id66158281472037" role="tablecontent"
localize="false">Python</paragraph>
</tablecell>
</tablerow>
<tablerow>
<tablecell>
- <paragraph id="par_id71582814720886" role="tablecontent"
xml-lang="en-US" localize="false">SCRIPTISOXT</paragraph>
+ <paragraph id="par_id71582814720886" role="tablecontent"
localize="false">SCRIPTISOXT</paragraph>
</tablecell>
<tablecell>
- <paragraph id="par_id51582814720584" role="tablecontent"
xml-lang="en-US" localize="false">"uno_packages"</paragraph>
+ <paragraph id="par_id51582814720584" role="tablecontent"
localize="false">"uno_packages"</paragraph>
</tablecell>
<tablecell>
<paragraph id="par_id93158281472047" role="tablecontent"
xml-lang="en-US">in an extension but the installation parameters are
unknown</paragraph>
</tablecell>
<tablecell>
- <paragraph id="par_id601582814720689" role="tablecontent"
xml-lang="en-US" localize="false">Python</paragraph>
+ <paragraph id="par_id601582814720689" role="tablecontent"
localize="false">Python</paragraph>
</tablecell>
</tablerow>
</table>
@@ -173,7 +173,7 @@
<table id="tab_id501611613601554">
<tablerow>
<tablecell colspan="3">
- <paragraph id="par_id891611613601554" role="tablehead"
xml-lang="en-US">List of Methods in the Session Service</paragraph>
+ <paragraph id="par_id891611613601554" role="tablehead">List of Methods
in the Session Service</paragraph>
</tablecell>
</tablerow>
<tablerow>
@@ -214,7 +214,7 @@
<section id="ExecuteBasicScript">
<comment> ExecuteBasicScript
-------------------------------------------------------------------------------------
</comment>
- <bookmark xml-lang="en-US" localize="false" branch="index"
id="bm_id41582815407230">
+ <bookmark localize="false" branch="index" id="bm_id41582815407230">
<bookmark_value>Session service;ExecuteBasicScript</bookmark_value>
</bookmark>
<h2 id="hd_id281582815407230" localize="false">ExecuteBasicScript</h2>
@@ -272,7 +272,7 @@
<section id="ExecuteCalcFunction">
<comment> ExecuteCalcFunction
------------------------------------------------------------------------------------
</comment>
- <bookmark xml-lang="en-US" localize="false" branch="index"
id="bm_id571582816585180">
+ <bookmark localize="false" branch="index" id="bm_id571582816585180">
<bookmark_value>Session service;ExecuteCalcFunction</bookmark_value>
</bookmark>
<h2 id="hd_id551582816585181" localize="false">ExecuteCalcFunction</h2>
@@ -303,7 +303,7 @@
<section id="ExecutePythonScript">
<comment> ExecutePythonScript
------------------------------------------------------------------------------------
</comment>
- <bookmark xml-lang="en-US" localize="false" branch="index"
id="bm_id671582818023244">
+ <bookmark localize="false" branch="index" id="bm_id671582818023244">
<bookmark_value>Session service;ExecutePythonScript</bookmark_value>
</bookmark>
<h2 id="hd_id741582818023244" localize="false">ExecutePythonScript</h2>
@@ -353,7 +353,7 @@
<section id="GetPDFExportOptions">
<comment> GetPDFExportOptions
------------------------------------------------------------------------------------
</comment>
- <bookmark xml-lang="en-US" localize="false" branch="index"
id="bm_id571582816536250">
+ <bookmark localize="false" branch="index" id="bm_id571582816536250">
<bookmark_value>Session service;GetPDFExportOptions</bookmark_value>
</bookmark>
<h2 id="hd_id551582816589871" localize="false">GetPDFExportOptions</h2>
@@ -385,7 +385,7 @@
<section id="HasUnoMethod">
<comment> HasUnoMethod
-------------------------------------------------------------------------------------------
</comment>
- <bookmark xml-lang="en-US" localize="false" branch="index"
id="bm_id901587477335292">
+ <bookmark localize="false" branch="index" id="bm_id901587477335292">
<bookmark_value>Session service;HasUnoMethod</bookmark_value>
</bookmark>
<h2 id="hd_id58158747733586" localize="false">HasUnoMethod</h2>
@@ -415,7 +415,7 @@
<section id="HasUnoProperty">
<comment> HasUnoProperty
-----------------------------------------------------------------------------------------
</comment>
- <bookmark xml-lang="en-US" localize="false" branch="index"
id="bm_id511587477832348">
+ <bookmark localize="false" branch="index" id="bm_id511587477832348">
<bookmark_value>Session service;HasUnoProperty</bookmark_value>
</bookmark>
<h2 id="hd_id521587477832241" localize="false">HasUnoProperty</h2>
@@ -445,7 +445,7 @@
<section id="OpenURLInBrowser">
<comment> OpenURLInBrowser
---------------------------------------------------------------------------------------
</comment>
- <bookmark xml-lang="en-US" localize="false" branch="index"
id="bm_id321601129640799">
+ <bookmark localize="false" branch="index" id="bm_id321601129640799">
<bookmark_value>Session service;OpenURLInBrowser</bookmark_value>
</bookmark>
<h2 id="hd_id971601129640909" localize="false">OpenURLInBrowser</h2>
@@ -469,7 +469,7 @@
<section id="RunApplication">
<comment> RunApplication
----------------------------------------------------------------------------------------
</comment>
- <bookmark xml-lang="en-US" localize="false" branch="index"
id="bm_id121582819697896">
+ <bookmark localize="false" branch="index" id="bm_id121582819697896">
<bookmark_value>Session service;RunApplication</bookmark_value>
</bookmark>
<h2 id="hd_id511582819697896" localize="false">RunApplication</h2>
@@ -479,26 +479,26 @@
<input>session.RunApplication(command: str, parameters: str): bool</input>
</paragraph>
<embed href="text/sbasic/shared/00000003.xhp#functparameters"/>
- <paragraph role="paragraph" id="par_id461582819697898"><emph>command</emph>:
The command to execute. This may be an executable file or a document which is
registered with an application so that the system knows what application to
launch for that document. The command must be expressed in the current
<literal>SF_FileSystem.FileNaming</literal> notation.</paragraph>
+ <paragraph role="paragraph" id="par_id461582819697898"><emph>command</emph>:
The command to execute. This may be an executable file or a document which is
registered with an application so that the system knows what application to
launch for that document. This method equally starts .bat or shell scripts.The
command must be expressed in the current
<literal>SF_FileSystem.FileNaming</literal> notation.</paragraph>
<paragraph role="paragraph"
id="par_id611582819697899"><emph>parameters</emph>: A list of space separated
parameters as a single string. The method does not validate the given
parameters, but only passes them to the specified command.</paragraph>
<embed href="text/sbasic/shared/00000003.xhp#functexample"/>
<embed href="text/sbasic/shared/00000003.xhp#In_Basic"/>
<bascode>
<paragraph role="bascode" localize="false"
id="bas_id111582819697900">session.RunApplication("Notepad.exe")</paragraph>
- <paragraph role="bascode" localize="false"
id="bas_id851582819697900">session.RunApplication("C:\myFolder\myDocument.odt")</paragraph>
+ <paragraph role="bascode" localize="false"
id="bas_id851582819697900">session.RunApplication("C:\myFolder\myDocument.odt")</paragraph>
<paragraph role="bascode" localize="false"
id="bas_id641582819697901">session.RunApplication("kate",
"/home/user/install.txt") ' GNU/Linux</paragraph>
</bascode>
<embed href="text/sbasic/shared/00000003.xhp#In_Python"/>
<pycode>
<paragraph role="pycode" localize="false"
id="pyc_id381626819384936">session.RunApplication("Notepad.exe")</paragraph>
- <paragraph role="pycode" localize="false"
id="pyc_id601626819385217">session.RunApplication(r"C:\myFolder\myDocument.odt")</paragraph>
+ <paragraph role="pycode" localize="false"
id="pyc_id601626819385217">session.RunApplication(r"C:\myFolder\myDocument.odt")</paragraph>
<paragraph role="pycode" localize="false"
id="pyc_id211626819385376">session.RunApplication("kate",
"/home/user/install.txt") # GNU/Linux</paragraph>
</pycode>
</section>
<section id="SendMail">
<comment> SendMail
------------------------------------------------------------------------------------------------
</comment>
- <bookmark xml-lang="en-US" localize="false" branch="index"
id="bm_id601601030349204">
+ <bookmark localize="false" branch="index" id="bm_id601601030349204">
<bookmark_value>Session service;SendMail</bookmark_value>
</bookmark>
<h2 id="hd_id561601030349199" localize="false">SendMail</h2>
@@ -532,7 +532,7 @@
<section id="SetPDFExportOptions">
<comment> SetPDFExportOptions
------------------------------------------------------------------------------------
</comment>
- <bookmark xml-lang="en-US" localize="false" branch="index"
id="bm_id571582816563070">
+ <bookmark localize="false" branch="index" id="bm_id571582816563070">
<bookmark_value>Session service;SetPDFExportOptions</bookmark_value>
</bookmark>
<h2 id="hd_id551582816583371" localize="false">SetPDFExportOptions</h2>
@@ -563,7 +563,7 @@
<section id="UnoMethods">
<comment> UnoMethods
---------------------------------------------------------------------------------------------
</comment>
- <bookmark xml-lang="en-US" localize="false" branch="index"
id="bm_id701587478024358">
+ <bookmark localize="false" branch="index" id="bm_id701587478024358">
<bookmark_value>Session service;UnoMethods</bookmark_value>
</bookmark>
<h2 id="hd_id861587478024365" localize="false">UnoMethods</h2>
@@ -597,7 +597,7 @@
<section id="UnoProperties">
<comment> UnoProperties
-------------------------------------------------------------------------------------------
</comment>
- <bookmark xml-lang="en-US" localize="false" branch="index"
id="bm_id57158747834361">
+ <bookmark localize="false" branch="index" id="bm_id57158747834361">
<bookmark_value>Session service;UnoProperties</bookmark_value>
</bookmark>
<h2 id="hd_id101587478343870" localize="false">UnoProperties</h2>
@@ -627,7 +627,7 @@
<section id="UnoObjectType">
<comment> UnoObjectType
------------------------------------------------------------------------------------------
</comment>
- <bookmark xml-lang="en-US" localize="false" branch="index"
id="bm_id221582820251346">
+ <bookmark localize="false" branch="index" id="bm_id221582820251346">
<bookmark_value>Session service;UnoObjectType</bookmark_value>
</bookmark>
<h2 id="hd_id751582820251347" localize="false">UnoObjectType</h2>
@@ -659,7 +659,7 @@
<section id="WebService">
<comment> WebService
----------------------------------------------------------------------------------------------
</comment>
- <bookmark xml-lang="en-US" localize="false" branch="index"
id="bm_id561582821057372">
+ <bookmark localize="false" branch="index" id="bm_id561582821057372">
<bookmark_value>Session service;WebService</bookmark_value>
</bookmark>
<h2 id="hd_id101582821057372" localize="false">WebService</h2>
