diff options
author | Olivier Hallot <olivier.hallot@libreoffice.org> | 2017-12-16 20:32:33 -0200 |
---|---|---|
committer | Olivier Hallot <olivier.hallot@libreoffice.org> | 2017-12-17 00:24:40 +0100 |
commit | 7e9c09733a3254c195b0bb6a3c1cb4e993337e55 (patch) | |
tree | 2527253115bf32337ae58c9d2b20bedbf2bfdb0a | |
parent | 953dc58e66b8b385945b75eaf5cc567827f93bf2 (diff) |
tdf#104171 Cleanup of Macro Help pages
Removed shared/main0600.xhp (obsolete)
Fixed links between help pages
Added entry to tree file (contents)
Change-Id: I2a954c328f214728d554bff2166f82b2c2b96f35
Reviewed-on: https://gerrit.libreoffice.org/46618
Reviewed-by: Olivier Hallot <olivier.hallot@libreoffice.org>
Tested-by: Olivier Hallot <olivier.hallot@libreoffice.org>
(cherry picked from commit 3114a84355a738b365d3c65c403a8062305ddaff)
Reviewed-on: https://gerrit.libreoffice.org/46621
-rw-r--r-- | AllLangHelp_shared.mk | 1 | ||||
-rw-r--r-- | source/auxiliary/sbasic.tree | 1 | ||||
-rw-r--r-- | source/text/shared/01/06130000.xhp | 11 | ||||
-rw-r--r-- | source/text/shared/01/06130010.xhp | 7 | ||||
-rw-r--r-- | source/text/shared/guide/macro_recording.xhp | 181 | ||||
-rw-r--r-- | source/text/shared/main0600.xhp | 47 |
6 files changed, 100 insertions, 148 deletions
diff --git a/AllLangHelp_shared.mk b/AllLangHelp_shared.mk index e1b0bfdca7..dc70121ba1 100644 --- a/AllLangHelp_shared.mk +++ b/AllLangHelp_shared.mk @@ -802,7 +802,6 @@ $(eval $(call gb_AllLangHelp_add_helpfiles,shared,\ helpcontent2/source/text/shared/main0227 \ helpcontent2/source/text/shared/main0400 \ helpcontent2/source/text/shared/main0500 \ - helpcontent2/source/text/shared/main0600 \ helpcontent2/source/text/shared/main0650 \ helpcontent2/source/text/shared/main0800 \ helpcontent2/source/text/shared/menu/insert_chart \ diff --git a/source/auxiliary/sbasic.tree b/source/auxiliary/sbasic.tree index 6a3e8aeb93..dc5ca57dfc 100644 --- a/source/auxiliary/sbasic.tree +++ b/source/auxiliary/sbasic.tree @@ -291,6 +291,7 @@ </node> </node> <node id="0703" title="Guides"> +<topic id="shared/text/shared/guide/macro_recording.xhp">Recording a Macro</topic> <topic id="sbasic/text/sbasic/guide/control_properties.xhp">Changing the Properties of Controls in the Dialog Editor</topic> <topic id="sbasic/text/sbasic/guide/insert_control.xhp">Creating Controls in the Dialog Editor</topic> <topic id="sbasic/text/sbasic/guide/sample_code.xhp">Programming Examples for Controls in the Dialog Editor</topic> diff --git a/source/text/shared/01/06130000.xhp b/source/text/shared/01/06130000.xhp index eb21ca8414..bae1e03710 100644 --- a/source/text/shared/01/06130000.xhp +++ b/source/text/shared/01/06130000.xhp @@ -1,6 +1,6 @@ <?xml version="1.0" encoding="UTF-8"?> <helpdocument version="1.0"> - + <!-- * This file is part of the LibreOffice project. * @@ -18,8 +18,8 @@ * 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="textshared0106130000xml" indexer="include"> <title id="tit" xml-lang="en-US">Macro</title> @@ -35,7 +35,6 @@ <section id="howtoget"> <embed href="text/shared/00/00000406.xhp#makro"/> </section> -<embed href="text/shared/guide/macro_recording.xhp#macro_recording"/> <bookmark xml-lang="en-US" branch="hid/modules/BasicIDE/ui/basicmacrodialog/macronameedit" id="bm_id3155351" localize="false"/> <paragraph role="heading" id="par_id3154863" xml-lang="en-US" level="2">Macro name</paragraph> <paragraph role="paragraph" id="par_id3150040" xml-lang="en-US"><ahelp hid="modules/BasicIDE/ui/basicmacrodialog/macronameedit">Displays the name of the selected macro. To create or to change the name of a macro, enter a name here.</ahelp></paragraph> @@ -112,7 +111,7 @@ <paragraph role="heading" id="hd_id3154693" xml-lang="en-US" level="3">Import<comment>changed in #i64102</comment></paragraph> <paragraph role="paragraph" id="par_id3147441" xml-lang="en-US"><ahelp hid="modules/BasicIDE/ui/libpage/import">Locate that $[officename] Basic library that you want to add to the current list, and then click Open.</ahelp></paragraph> <embed href="text/shared/00/00000001.xhp#loeschen"/> -<paragraph role="paragraph" id="par_idN10A39" xml-lang="en-US"><variable id="script">Scripts +<paragraph role="paragraph" id="par_idN10A39" xml-lang="en-US"><variable id="script">Scripts </variable></paragraph> <paragraph role="paragraph" id="par_idN109BB" xml-lang="en-US">To open the BeanShell Macros dialog box, choose Tools - Macros - Organize Macros - BeanShell. To open the JavaScript dialog box, choose Tools - Macros - Organize Macros - JavaScript.</paragraph> <paragraph role="heading" id="hd_id6963408" xml-lang="en-US" level="2">Export</paragraph> @@ -142,8 +141,8 @@ <paragraph role="heading" id="par_idN10B17" xml-lang="en-US" level="3">Macro name</paragraph> <paragraph role="paragraph" id="par_idN10B1B" xml-lang="en-US">Click a script, and then click a command button.</paragraph> <section id="relatedtopics"> -<paragraph role="paragraph" id="par_id3153138" xml-lang="en-US"><link href="text/shared/main0600.xhp" name="Macro programming in $[officename]">Macro programming in $[officename]</link></paragraph> <embed href="text/shared/guide/scripting.xhp#scripting"/> +<embed href="text/shared/guide/macro_recording.xhp#macro_recording"/> </section> </body> </helpdocument> diff --git a/source/text/shared/01/06130010.xhp b/source/text/shared/01/06130010.xhp index de95e8bd81..d0172cc807 100644 --- a/source/text/shared/01/06130010.xhp +++ b/source/text/shared/01/06130010.xhp @@ -1,6 +1,6 @@ <?xml version="1.0" encoding="UTF-8"?> <helpdocument version="1.0"> - + <!-- * This file is part of the LibreOffice project. * @@ -18,8 +18,8 @@ * 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="textshared0106130010xml" indexer="include"> <title id="tit" xml-lang="en-US">Record Macro</title> @@ -42,7 +42,6 @@ <paragraph role="paragraph" id="par_id3146067" xml-lang="en-US"><ahelp hid=".uno:StopRecording">Stops recording a macro.</ahelp></paragraph> <section id="relatedtopics"> <embed href="text/shared/guide/macro_recording.xhp#macro_recording"/> -<embed href="text/shared/main0600.xhp#programming"/> </section> </body> </helpdocument> diff --git a/source/text/shared/guide/macro_recording.xhp b/source/text/shared/guide/macro_recording.xhp index dc77467189..fe2c4ea56f 100644 --- a/source/text/shared/guide/macro_recording.xhp +++ b/source/text/shared/guide/macro_recording.xhp @@ -1,95 +1,96 @@ <?xml version="1.0" encoding="UTF-8"?> - - - <!-- - * This file is part of the LibreOffice project. - * - * This Source Code Form is subject to the terms of the Mozilla Public - * License, v. 2.0. If a copy of the MPL was not distributed with this - * file, You can obtain one at http://mozilla.org/MPL/2.0/. - * - * This file incorporates work covered by the following license notice: - * - * Licensed to the Apache Software Foundation (ASF) under one or more - * contributor license agreements. See the NOTICE file distributed - * with this work for additional information regarding copyright - * ownership. The ASF licenses this file to you under the Apache - * License, Version 2.0 (the "License"); you may not use this file - * except in compliance with the License. You may obtain a copy of - * the License at http://www.apache.org/licenses/LICENSE-2.0 . - --> - +* This file is part of the LibreOffice project. +* +* This Source Code Form is subject to the terms of the Mozilla Public +* License, v. 2.0. If a copy of the MPL was not distributed with this +* file, You can obtain one at http://mozilla.org/MPL/2.0/. +* +* This file incorporates work covered by the following license notice: +* +* Licensed to the Apache Software Foundation (ASF) under one or more +* contributor license agreements. See the NOTICE file distributed +* with this work for additional information regarding copyright +* ownership. The ASF licenses this file to you under the Apache +* License, Version 2.0 (the "License"); you may not use this file +* except in compliance with the License. You may obtain a copy of +* the License at http://www.apache.org/licenses/LICENSE-2.0 . +--> - <helpdocument version="1.0"> -<meta> -<topic id="textsharedguidemacro_recordingxml" indexer="include" status="PUBLISH"> -<title id="tit" xml-lang="en-US">Recording a Macro</title> -<filename>/text/shared/guide/macro_recording.xhp</filename> -</topic> -</meta> -<body> -<bookmark xml-lang="en-US" branch="index" id="bm_id3093440"><bookmark_value>macros; recording</bookmark_value> -<bookmark_value>recording; macros</bookmark_value> -<bookmark_value>Basic; recording macros</bookmark_value> -</bookmark> -<paragraph role="heading" id="hd_id3093440" xml-lang="en-US" level="1"><variable id="macro_recording"><link href="text/shared/guide/macro_recording.xhp" name="Recording a Macro">Recording a Macro</link> -</variable></paragraph> -<list type="ordered"> -<listitem> -<paragraph role="listitem" id="par_id3154749" xml-lang="en-US">Open the document for which you want to record a macro.</paragraph> -</listitem> -<listitem> -<paragraph role="listitem" id="par_id3149398" xml-lang="en-US">Choose <emph>Tools - Macros - Record Macro</emph>.</paragraph> -<paragraph role="note" id="par_id3149399" xml-lang="en-US">If <emph>Tools - Macros - Record Macro</emph> menu item is missing, make sure that macro recording feature is enabled in <switchinline select="sys"><caseinline select="MAC"><emph>%PRODUCTNAME - Preferences</emph></caseinline><defaultinline><emph>Tools - Options</emph></defaultinline></switchinline><emph> - %PRODUCTNAME - Advanced</emph>.</paragraph> -<paragraph role="listitem" id="par_id3150275" xml-lang="en-US">You see the small <emph>Recording</emph> dialog with just one button called <emph>Stop Recording</emph>.</paragraph> -</listitem> -<listitem> -<paragraph role="listitem" id="par_id3153087" xml-lang="en-US">Perform the actions you want to be recorded in the document.</paragraph> -<paragraph role="listitem" id="par_id3150504" xml-lang="en-US">Press the Escape key to deselect an object, as the macro recorder currently does not record this action by mouse click.</paragraph> -</listitem> -<listitem> -<paragraph role="listitem" id="par_id3148492" xml-lang="en-US">Click <emph>Stop Recording</emph>.</paragraph> -<paragraph role="listitem" id="par_id3148686" xml-lang="en-US">The <emph>Macro</emph> dialog appears, in which you can save and run the macro.</paragraph> -<paragraph role="listitem" id="par_id3159158" xml-lang="en-US">If you want to abort the recording without saving a macro, click the <emph>Close</emph> button of the <emph>Recording</emph> dialog.</paragraph> -</listitem> -<listitem> -<paragraph role="listitem" id="par_id3144510" xml-lang="en-US">To save the macro, first select the object where you want the macro to be saved in the <emph>Save macro in</emph> list box.</paragraph> -</listitem> -<listitem> -<paragraph role="listitem" id="par_id3148550" xml-lang="en-US">If you want the macro to be saved into a new library or module, click the <emph>New Library </emph>or <emph>New Module </emph>button and enter a name for the library or module.</paragraph> -</listitem> -<listitem> -<paragraph role="listitem" id="par_id3149456" xml-lang="en-US">Enter a name for the new macro in the <emph>Macro name</emph> text box. Do not use Basic keywords as a name.</paragraph> -</listitem> -<listitem> -<paragraph role="listitem" id="par_id3154138" xml-lang="en-US">Click <emph>Save</emph>.</paragraph> -</listitem> -</list> -<paragraph role="heading" level="2" id="hd_id2486342" xml-lang="en-US">Limitations of the macro recorder</paragraph> -<paragraph role="paragraph" id="par_id3608508" xml-lang="en-US">The following actions are <emph>not</emph> recorded:</paragraph> -<list type="unordered"> -<listitem> -<paragraph role="paragraph" id="par_id921353" xml-lang="en-US">Opening of windows is not recorded.</paragraph> -</listitem> -<listitem> -<paragraph role="paragraph" id="par_id9296243" xml-lang="en-US">Actions carried out in another window than where the recorder was started are not recorded.</paragraph> -</listitem> -<listitem> -<paragraph role="paragraph" id="par_id4269234" xml-lang="en-US">Window switching is not recorded.</paragraph> -</listitem> -<listitem> -<paragraph role="paragraph" id="par_id8014465" xml-lang="en-US">Actions that are not related to the document contents are not recorded. For example, changes made in the Options dialog, macro organizer, customizing.</paragraph> -</listitem> -<listitem> -<paragraph role="paragraph" id="par_id2814416" xml-lang="en-US">Selections are recorded only if they are done by using the keyboard (cursor traveling), but not when the mouse is used.</paragraph> -</listitem> -<listitem> -<paragraph role="paragraph" id="par_id2522354" xml-lang="en-US">The macro recorder works only in Calc and Writer.</paragraph> -</listitem> -</list> -<embed href="text/shared/00/00000004.xhp#related"/> -<paragraph role="paragraph" id="par_id3156422" xml-lang="en-US"><link href="text/shared/01/06130000.xhp" name="Macro">Macro</link></paragraph> -<paragraph role="paragraph" id="par_id3147576" xml-lang="en-US"><link href="text/shared/main0600.xhp" name="macro programming in $[officename]">Programming in %PRODUCTNAME</link></paragraph> +<helpdocument version="1.0"> + <meta> + <topic id="textsharedguidemacro_recordingxml" indexer="include" status="PUBLISH"> + <title id="tit" xml-lang="en-US">Recording a Macro</title> + <filename>/text/shared/guide/macro_recording.xhp</filename> + </topic> + </meta> + <body> + <bookmark xml-lang="en-US" branch="index" id="bm_id3093440"> + <bookmark_value>macros; recording</bookmark_value> + <bookmark_value>recording; macros</bookmark_value> + <bookmark_value>Basic; recording macros</bookmark_value> + </bookmark> + <paragraph role="heading" id="hd_id3093440" xml-lang="en-US" level="1"><variable id="macro_recording"><link href="text/shared/guide/macro_recording.xhp" name="Recording a Macro">Recording a Macro</link> + </variable></paragraph> + <paragraph xml-lang="en-US" id="par_id101513461219184" role="paragraph">%PRODUCTNAME can record commands executed with the keyboard and mouse in Writer and Calc</paragraph> + <list type="ordered"> + <listitem> + <paragraph role="listitem" id="par_id3154749" xml-lang="en-US">Open the document for which you want to record a macro.</paragraph> + </listitem> + <listitem> + <paragraph role="listitem" id="par_id3149398" xml-lang="en-US">Choose <emph>Tools - Macros - Record Macro</emph>.</paragraph> + <paragraph role="note" id="par_id3149399" xml-lang="en-US">If <emph>Tools - Macros - Record Macro</emph> menu item is missing, make sure that macro recording feature is enabled in <switchinline select="sys"><caseinline select="MAC"><emph>%PRODUCTNAME - Preferences</emph></caseinline><defaultinline><emph>Tools - Options</emph></defaultinline></switchinline><emph> - %PRODUCTNAME - Advanced</emph>.</paragraph> + <paragraph role="listitem" id="par_id3150275" xml-lang="en-US">You see the small <emph>Recording</emph> dialog with just one button called <emph>Stop Recording</emph>.</paragraph> + </listitem> + <listitem> + <paragraph role="listitem" id="par_id3153087" xml-lang="en-US">Perform the actions you want to be recorded in the document.</paragraph> + <paragraph role="listitem" id="par_id3150504" xml-lang="en-US">Press the Escape key to deselect an object, as the macro recorder currently does not record this action by mouse click.</paragraph> + </listitem> + <listitem> + <paragraph role="listitem" id="par_id3148492" xml-lang="en-US">Click <emph>Stop Recording</emph>.</paragraph> + <paragraph role="listitem" id="par_id3148686" xml-lang="en-US">The <emph>Macro</emph> dialog appears, in which you can save and run the macro.</paragraph> + <paragraph role="listitem" id="par_id3159158" xml-lang="en-US">If you want to abort the recording without saving a macro, click the <emph>Close</emph> button of the <emph>Recording</emph> dialog.</paragraph> + </listitem> + <listitem> + <paragraph role="listitem" id="par_id3144510" xml-lang="en-US">To save the macro, first select the object where you want the macro to be saved in the <emph>Save macro in</emph> list box.</paragraph> + </listitem> + <listitem> + <paragraph role="listitem" id="par_id3148550" xml-lang="en-US">If you want the macro to be saved into a new library or module, click the <emph>New Library </emph>or <emph>New Module </emph>button and enter a name for the library or module.</paragraph> + </listitem> + <listitem> + <paragraph role="listitem" id="par_id3149456" xml-lang="en-US">Enter a name for the new macro in the <emph>Macro name</emph> text box. Do not use Basic keywords as a name.</paragraph> + </listitem> + <listitem> + <paragraph role="listitem" id="par_id3154138" xml-lang="en-US">Click <emph>Save</emph>.</paragraph> + </listitem> + </list> + <bookmark xml-lang="en-US" branch="index" id="bm_id131513460596344"> + <bookmark_value>macro recording;limitations</bookmark_value> + </bookmark> + <paragraph role="heading" level="2" id="hd_id2486342" xml-lang="en-US">Limitations of the macro recorder</paragraph> + <paragraph role="paragraph" id="par_id3608508" xml-lang="en-US">The following actions are <emph>not</emph> recorded:</paragraph> + <list type="unordered"> + <listitem> + <paragraph role="paragraph" id="par_id921353" xml-lang="en-US">Opening of windows is not recorded.</paragraph> + </listitem> + <listitem> + <paragraph role="paragraph" id="par_id9296243" xml-lang="en-US">Actions carried out in another window than where the recorder was started are not recorded.</paragraph> + </listitem> + <listitem> + <paragraph role="paragraph" id="par_id4269234" xml-lang="en-US">Window switching is not recorded.</paragraph> + </listitem> + <listitem> + <paragraph role="paragraph" id="par_id8014465" xml-lang="en-US">Actions that are not related to the document contents are not recorded. For example, changes made in the Options dialog, macro organizer, customizing.</paragraph> + </listitem> + <listitem> + <paragraph role="paragraph" id="par_id2814416" xml-lang="en-US">Selections are recorded only if they are done by using the keyboard (cursor traveling), but not when the mouse is used.</paragraph> + </listitem> + <listitem> + <paragraph role="paragraph" id="par_id2522354" xml-lang="en-US">The macro recorder works only in Calc and Writer.</paragraph> + </listitem> + </list> + <section id="relatedtopics"> + <paragraph role="paragraph" id="par_id3156422" xml-lang="en-US"><link href="text/shared/01/06130000.xhp" name="Macro">Macro</link></paragraph> + </section> </body> </helpdocument> diff --git a/source/text/shared/main0600.xhp b/source/text/shared/main0600.xhp deleted file mode 100644 index 5372c17106..0000000000 --- a/source/text/shared/main0600.xhp +++ /dev/null @@ -1,47 +0,0 @@ -<?xml version="1.0" encoding="UTF-8"?> - - -<!-- - * This file is part of the LibreOffice project. - * - * This Source Code Form is subject to the terms of the Mozilla Public - * License, v. 2.0. If a copy of the MPL was not distributed with this - * file, You can obtain one at http://mozilla.org/MPL/2.0/. - * - * This file incorporates work covered by the following license notice: - * - * Licensed to the Apache Software Foundation (ASF) under one or more - * contributor license agreements. See the NOTICE file distributed - * with this work for additional information regarding copyright - * ownership. The ASF licenses this file to you under the Apache - * License, Version 2.0 (the "License"); you may not use this file - * except in compliance with the License. You may obtain a copy of - * the License at http://www.apache.org/licenses/LICENSE-2.0 . - --> - -<helpdocument version="1.0"> -<meta> -<topic id="textsharedmain0600xml" indexer="include" status="PUBLISH"> -<title id="tit" xml-lang="en-US">Programming $[officename]</title> -<filename>/text/shared/main0600.xhp</filename> -</topic> -<history> -<created date="2003-10-31T00:00:00">Sun Microsystems, Inc.</created> -</history> -</meta> -<body> -<bookmark xml-lang="en-US" branch="index" id="bm_id3154232"><bookmark_value>programming;$[officename]</bookmark_value> -<bookmark_value>Basic;programming</bookmark_value> -</bookmark> -<paragraph role="heading" id="hd_id3154232" xml-lang="en-US" level="1"><variable id="programming"><link href="text/shared/main0600.xhp" name="Programming $[officename]">Programming $[officename]</link> -</variable></paragraph> -<paragraph role="paragraph" id="par_id3149760" xml-lang="en-US"><variable id="basic">$[officename] can be controlled by using the $[officename] API. -</variable></paragraph> -<section id="basicalt"> -<paragraph role="warning" id="par_id3151111" xml-lang="en-US">$[officename] provides an Application Programming Interface (API) that enables you to control $[officename] components by using various programming languages. A $[officename] Software Development Kit is available for the programming interface.</paragraph> -<paragraph role="warning" id="par_id3156346" xml-lang="en-US">For more information about $[officename] API reference, please visit http://api.libreoffice.org/<comment>removed link; see i75345</comment></paragraph> -<paragraph role="warning" id="par_id3153825" xml-lang="en-US">Macros created with $[officename] Basic based on the old programming interface will no longer be supported by the current version.</paragraph> -</section> -<paragraph role="paragraph" id="par_id3149795" xml-lang="en-US">For more information on $[officename] Basic, select "$[officename] Basic" in the list box.</paragraph> -</body> -</helpdocument> |