Skip to content

Commit

Permalink
Related: tdf#146971 rename %PRODUCTNAME Macros to Application Macros
Browse files Browse the repository at this point in the history
Change-Id: I83393ec16732482deade1694c6a1a8e2b92f3944
Reviewed-on: https://gerrit.libreoffice.org/c/help/+/128916
Tested-by: Jenkins
Reviewed-by: Caolán McNamara <caolanm@redhat.com>
  • Loading branch information
Caolán McNamara committed Jan 25, 2022
1 parent 798fa0b commit e1da23a
Show file tree
Hide file tree
Showing 10 changed files with 22 additions and 22 deletions.
2 changes: 1 addition & 1 deletion source/text/sbasic/guide/sample_code.xhp
Expand Up @@ -59,7 +59,7 @@
<paragraph role="bascode" id="par_id3153876" xml-lang="en-US" localize="false"> LoadDialog() = oRuntimeDialog</paragraph>
<paragraph role="bascode" id="par_id3156286" xml-lang="en-US" localize="false">End Function</paragraph>
</bascode>
<paragraph role="paragraph" id="par_id3153032" xml-lang="en-US"><literal>LoadDialog</literal> function is stored in <literal>Tools.ModuleControls</literal> available from %PRODUCTNAME Macros and Dialogs.</paragraph>
<paragraph role="paragraph" id="par_id3153032" xml-lang="en-US"><literal>LoadDialog</literal> function is stored in <literal>Tools.ModuleControls</literal> available from Application Macros and Dialogs.</paragraph>
<paragraph role="heading" id="hd_id3149412" xml-lang="en-US" level="3">Displaying a Dialog</paragraph>
<bascode>
<paragraph role="bascode" id="par_id3145801" xml-lang="en-US">REM global definition of variables</paragraph>
Expand Down
2 changes: 1 addition & 1 deletion source/text/sbasic/python/main0000.xhp
Expand Up @@ -30,7 +30,7 @@
<paragraph role="paragraph" id="N0102">You can execute Python scripts choosing <menuitem>Tools - Macros - Run Macro</menuitem>. Editing scripts can be done with your preferred text editor. Python scripts are present in various locations detailed hereafter. You can refer to Programming examples for macros illustrating how to run the Python interactive console from %PRODUCTNAME.</paragraph>
<switch select="sys">
<case select="UNIX">
<warning id="par_id131568902936659">The %PRODUCTNAME scripting framework for Python is optional on some GNU/Linux distributions. If it is installed, selecting <menuitem>Tools - Macros - Run Macro</menuitem> and checking <literal>%PRODUCTNAME Macros</literal> for the presence of <literal>HelloWorld – HelloWorldPython</literal> macro is sufficient. If absent, please refer to your distribution documentation in order to install the %PRODUCTNAME scripting framework for Python.</warning>
<warning id="par_id131568902936659">The %PRODUCTNAME scripting framework for Python is optional on some GNU/Linux distributions. If it is installed, selecting <menuitem>Tools - Macros - Run Macro</menuitem> and checking <literal>Application Macros</literal> for the presence of <literal>HelloWorld – HelloWorldPython</literal> macro is sufficient. If absent, please refer to your distribution documentation in order to install the %PRODUCTNAME scripting framework for Python.</warning>
</case>
</switch>
<embed href="text/shared/guide/scripting.xhp#scripting"/>
Expand Down
4 changes: 2 additions & 2 deletions source/text/sbasic/python/python_dialogs.xhp
Expand Up @@ -23,8 +23,8 @@
<section id="pythondialog1">
<h1 id="N0336"><variable id="pythondialog"><link href="text/sbasic/python/python_dialogs.xhp" name="command_name">Opening a Dialog with Python</link></variable></h1>
</section>
<paragraph role="paragraph" id="N0337">%PRODUCTNAME static dialogs are created with the <link href="text/sbasic/guide/create_dialog.xhp" name="dialog editor">Dialog editor</link> and are stored in varying places according to their personal (My Macros), shared (%PRODUCTNAME Macros) or document-embedded nature. In reverse, dynamic dialogs are constructed at runtime, from Basic or Python scripts, or using any other <link href="text/shared/guide/scripting.xhp">%PRODUCTNAME supported language</link> for that matter. Opening static dialogs with Python is illustrated herewith. Exception handling and internationalization are omitted for clarity.</paragraph>
<h2 id="N0338">My Macros or %PRODUCTNAME Macros dialogs</h2>
<paragraph role="paragraph" id="N0337">%PRODUCTNAME static dialogs are created with the <link href="text/sbasic/guide/create_dialog.xhp" name="dialog editor">Dialog editor</link> and are stored in varying places according to their personal (My Macros), shared (Application Macros) or document-embedded nature. In reverse, dynamic dialogs are constructed at runtime, from Basic or Python scripts, or using any other <link href="text/shared/guide/scripting.xhp">%PRODUCTNAME supported language</link> for that matter. Opening static dialogs with Python is illustrated herewith. Exception handling and internationalization are omitted for clarity.</paragraph>
<h2 id="N0338">My Macros or Application Macros dialogs</h2>
<paragraph role="paragraph" id="N0339">The examples below open <literal>Access2Base Trace</literal> console or the imported <literal>TutorialsDialog</literal> dialog with <menuitem>Tools - Macros - Run Macro</menuitem> menu:</paragraph>
<pycode>
<paragraph role="pycode" id="N0340" localize="false"># -*- coding: utf-8 -*-</paragraph>
Expand Down
4 changes: 2 additions & 2 deletions source/text/sbasic/python/python_locations.xhp
Expand Up @@ -29,7 +29,7 @@
<paragraph id="par_id321636114854594" role="listitem"><emph>My Macros:</emph> personal macros available for the %PRODUCTNAME user</paragraph>
</listitem>
<listitem>
<paragraph id="par_id471636114847530" role="listitem"><emph>%PRODUCTNAME Macros:</emph> system macros distributed with LibreOffice for every computer user</paragraph>
<paragraph id="par_id471636114847530" role="listitem"><emph>Application Macros:</emph> system macros distributed with LibreOffice for every computer user</paragraph>
</listitem>
<listitem>
<paragraph id="par_id191636114858218" role="listitem"><emph>Document macros:</emph> every document can contain macro libraries available in that document for all users</paragraph>
Expand All @@ -38,7 +38,7 @@
</section>
<h2 id="hd_id911544049584458">Python Script Locations</h2>
<paragraph id="par_id121551089455774" role="paragraph" xml-lang="en-US">Refer to <link href="text/sbasic/python/python_session.xhp" name="Getting Session Information">Getting Session Information</link> in order to get programmatic access to Python script locations.</paragraph>
<h3 id="hd_id591544049572647">%PRODUCTNAME Macros</h3>
<h3 id="hd_id591544049572647">Application Macros</h3>
<paragraph role="paragraph" id="par_id261544049064421">Existing macros in this location (container) were copied by the installation program and are available to every computer user, and any open document can access macros stored the container. You need administrative rights to store or edit macros here.</paragraph>
<paragraph role="paragraph" id="par_id861544210028670">The %PRODUCTNAME Macros container location in the file system depends on the operating system:</paragraph>
<list type="unordered">
Expand Down
4 changes: 2 additions & 2 deletions source/text/sbasic/shared/00000003.xhp
Expand Up @@ -175,7 +175,7 @@
<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>
<section id="basiclibhowtoget">
<paragraph role="paragraph" id="par_id631529000528928" xml-lang="en-US">Open <item type="menuitem">Tools - Macros - %PRODUCTNAME Basic - Edit</item> and select <item type="menuitem">%PRODUCTNAME Macros</item> container.</paragraph>
<paragraph role="paragraph" id="par_id631529000528928" xml-lang="en-US">Open <item type="menuitem">Tools - Macros - %PRODUCTNAME Basic - Edit</item> and select <item type="menuitem">Application Macros</item> container.</paragraph>
</section>
<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>
Expand Down Expand Up @@ -349,4 +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>
8 changes: 4 additions & 4 deletions source/text/sbasic/shared/01030400.xhp
Expand Up @@ -43,7 +43,7 @@
<paragraph role="paragraph" id="par_id961574080563824">%PRODUCTNAME Basic libraries can be stored in 3 different containers:</paragraph>
<list type="unordered">
<listitem>
<paragraph id="par_id571574079618609" role="listitem"><emph>%PRODUCTNAME Macros</emph>: libraries stored in this container are available for all users of the computer and are managed by the computer administrator. The container is located in the %PRODUCTNAME installation directory.</paragraph>
<paragraph id="par_id571574079618609" role="listitem"><emph>Application Macros</emph>: libraries stored in this container are available for all users of the computer and are managed by the computer administrator. The container is located in the %PRODUCTNAME installation directory.</paragraph>
</listitem>
<listitem>
<paragraph id="par_id151574079741214" role="listitem"><emph>My Macros</emph>: libraries stored in this container are available to all documents of your user. The container is located in the user profile area and is not accessible by another user.</paragraph>
Expand All @@ -52,7 +52,7 @@
<paragraph id="par_id581574080384335" role="listitem"><emph>Document</emph>: libraries stored in the document container are only available for the document and are accessible only when the document is open. You cannot access macros of a document from another document.</paragraph>
</listitem>
</list>
<paragraph role="paragraph" id="par_id881574081445896">To access macros stored in libraries of <emph>%PRODUCTNAME Macros</emph> or <emph>My Macros</emph> from another container, including the document container, use the <link href="text/sbasic/shared/03131900.xhp" name="GlobalScope">GlobalScope specifier</link>.</paragraph>
<paragraph role="paragraph" id="par_id881574081445896">To access macros stored in libraries of <emph>Application Macros</emph> or <emph>My Macros</emph> from another container, including the document container, use the <link href="text/sbasic/shared/03131900.xhp" name="GlobalScope">GlobalScope specifier</link>.</paragraph>
<h2 id="hd_id3150868">Organizing Libraries</h2>
<h3 id="hd_id3125864">Creating a New Library</h3>
<list type="ordered">
Expand All @@ -63,7 +63,7 @@
<paragraph role="listitem" id="par_id3153726" xml-lang="en-US">Click the <emph>Libraries</emph> tab.</paragraph>
</listitem>
<listitem>
<paragraph role="listitem" id="par_id3149664" xml-lang="en-US">Select to where you want to attach the library in the <emph>Location</emph> list. If you select %PRODUCTNAME Macros &amp; Dialogs, the library will belong to the $[officename] application and will be available for all documents. If you select a document the library will be attached to this document and only available from there.</paragraph>
<paragraph role="listitem" id="par_id3149664" xml-lang="en-US">Select to where you want to attach the library in the <emph>Location</emph> list. If you select Application Macros &amp; Dialogs, the library will belong to the $[officename] application and will be available for all documents. If you select a document the library will be attached to this document and only available from there.</paragraph>
</listitem>
<listitem>
<paragraph role="listitem" id="par_id3153365" xml-lang="en-US">Click <emph>New</emph> and insert a name to create a new library.</paragraph>
Expand All @@ -78,7 +78,7 @@
<paragraph role="listitem" id="par_id3146972" xml-lang="en-US">Click the <emph>Libraries</emph> tab.</paragraph>
</listitem>
<listitem>
<paragraph role="listitem" id="par_id3145640" xml-lang="en-US">Select to where you want to import the library in the <emph>Location</emph> list. If you select %PRODUCTNAME Macros &amp; Dialogs, the library will belong to the $[officename] application and will be available for all documents. If you select a document the library will be imported to this document and only available from there.</paragraph>
<paragraph role="listitem" id="par_id3145640" xml-lang="en-US">Select to where you want to import the library in the <emph>Location</emph> list. If you select Application Macros &amp; Dialogs, the library will belong to the $[officename] application and will be available for all documents. If you select a document the library will be imported to this document and only available from there.</paragraph>
</listitem>
<listitem>
<paragraph role="listitem" id="par_id3154253" xml-lang="en-US">Click <emph>Import...</emph> and select an external library to import.</paragraph>
Expand Down
4 changes: 2 additions & 2 deletions source/text/sbasic/shared/03131900.xhp
Expand Up @@ -40,7 +40,7 @@
<bookmark_value>DialogLibraries; library container</bookmark_value>
</bookmark>
<h1 id="hd_id3150682"><variable id="GlobalScope_h1"><link href="text/sbasic/shared/03131900.xhp" name="GlobalScope">GlobalScope specifier</link></variable></h1>
<paragraph role="paragraph" id="par_id991572457387308">To manage personal or shared library containers (<emph>%PRODUCTNAME Macros</emph> or <emph>My Macros</emph>) from within a document, use the <literal>GlobalScope</literal> specifier.</paragraph>
<paragraph role="paragraph" id="par_id991572457387308">To manage personal or shared library containers (<emph>Application Macros</emph> or <emph>My Macros</emph>) from within a document, use the <literal>GlobalScope</literal> specifier.</paragraph>
</section>
<section id="basicdialogs">
<paragraph role="paragraph" id="par_id3153345" xml-lang="en-US">Basic source code and dialogs are organized in library containers. Libraries can contain modules and dialogs.</paragraph>
Expand All @@ -49,7 +49,7 @@
<paragraph role="paragraph" id="par_id3153061" xml-lang="en-US">Basic libraries and modules can be managed with the <literal>BasicLibraries</literal> object. Libraries can be searched, explored and loaded on request. <link href="text/sbasic/python/python_document_events.xhp" name="Monitoring document events">Monitoring Documents Events</link> illustrates %PRODUCTNAME library loading.</paragraph>
<h2 id="hd_id3154346">In dialogs:</h2>
<paragraph role="paragraph" id="par_id3148663" xml-lang="en-US">Dialog libraries and dialogs can be managed with the <literal>DialogLibraries</literal> object. <link href="text/sbasic/guide/show_dialog.xhp" name="Opening a Dialog">Opening a Dialog With Basic</link> illustrates how to display %PRODUCTNAME shared dialogs.</paragraph>
<paragraph role="paragraph" id="par_id3150543" xml-lang="en-US"><literal>BasicLibraries</literal> and <literal>DialogLibraries</literal> containers exist at application level and within every document. Document's library containers do not need the <literal>GlobalScope</literal> specifier to be managed. If you want to call a global library container (located in <emph>%PRODUCTNAME Macros</emph> or <emph>My Macros</emph>) from within a document, you must use the <literal>GlobalScope</literal> specifier.</paragraph>
<paragraph role="paragraph" id="par_id3150543" xml-lang="en-US"><literal>BasicLibraries</literal> and <literal>DialogLibraries</literal> containers exist at application level and within every document. Document's library containers do not need the <literal>GlobalScope</literal> specifier to be managed. If you want to call a global library container (located in <emph>Application Macros</emph> or <emph>My Macros</emph>) from within a document, you must use the <literal>GlobalScope</literal> specifier.</paragraph>
<embed href="text/sbasic/shared/00000003.xhp#functsyntax"/>
<paragraph role="code" localize="false" id="par_id3149203" xml-lang="en-US">GlobalScope specifier</paragraph>
<embed href="text/sbasic/shared/00000003.xhp#functexample"/>
Expand Down
2 changes: 1 addition & 1 deletion source/text/shared/01/06130030.xhp
Expand Up @@ -43,7 +43,7 @@
<bookmark xml-lang="en-US" branch="hid/cui/ui/scriptorganizer/ScriptOrganizerDialog" id="bm_id7982421" localize="false"/>
<bookmark xml-lang="en-US" branch="hid/cui/ui/scriptorganizer/@@nowidget@@" id="bm_id7982421" localize="false"/>
<h2 id="par_idN109BE">Macros</h2>
<paragraph role="paragraph" id="par_idN109C2" xml-lang="en-US"><ahelp hid="cui/ui/scriptorganizer/ScriptOrganizerDialog">Select a macro or script from <emph>My Macros</emph>, <emph>%PRODUCTNAME Macros</emph>, or an open document. To view the available macros or scripts, double-click an entry.</ahelp></paragraph>
<paragraph role="paragraph" id="par_idN109C2" xml-lang="en-US"><ahelp hid="cui/ui/scriptorganizer/ScriptOrganizerDialog">Select a macro or script from <emph>My Macros</emph>, <emph>Application Macros</emph>, or an open document. To view the available macros or scripts, double-click an entry.</ahelp></paragraph>
<bookmark xml-lang="en-US" branch="hid/cui/ui/scriptorganizer/run" id="bm_id8628498" localize="false"/>
<h3 id="par_idN109CD">Run</h3>
<paragraph role="paragraph" id="par_idN109D1" xml-lang="en-US"><ahelp hid="cui/ui/scriptorganizer/run">To run a script, select a script in the list, and then click <emph>Run</emph>.</ahelp></paragraph>
Expand Down

0 comments on commit e1da23a

Please sign in to comment.