merge the formfield patch from ooo-build
[ooovba.git] / helpcontent2 / source / text / shared / guide / macro_recording.xhp
blobc5485e5adfad6c52c18fe95898f7626dd6c7ca74
1 <?xml version="1.0" encoding="UTF-8"?>
5 <!--
6 ***********************************************************************
8 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
9 *
10 * Copyright 2008 by Sun Microsystems, Inc.
12 * OpenOffice.org - a multi-platform office productivity suite
14 * $RCSfile: macro_recording.xhp,v $
15 * $Revision: 1.11 $
17 * This file is part of OpenOffice.org.
19 * OpenOffice.org is free software: you can redistribute it and/or modify
20 * it under the terms of the GNU Lesser General Public License version 3
21 * only, as published by the Free Software Foundation.
23 * OpenOffice.org is distributed in the hope that it will be useful,
24 * but WITHOUT ANY WARRANTY; without even the implied warranty of
25 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
26 * GNU Lesser General Public License version 3 for more details
27 * (a copy is included in the LICENSE file that accompanied this code).
29 * You should have received a copy of the GNU Lesser General Public License
30 * version 3 along with OpenOffice.org. If not, see
31 * <http://www.openoffice.org/license.html>
32 * for a copy of the LGPLv3 License.
34 ************************************************************************
35 -->
38 <helpdocument version="1.0">
39 <meta>
40 <topic id="textsharedguidemacro_recordingxml" indexer="include" status="PUBLISH">
41 <title id="tit" xml-lang="en-US">Recording a Macro</title>
42 <filename>/text/shared/guide/macro_recording.xhp</filename>
43 </topic>
44 </meta>
45 <body>
46 <bookmark xml-lang="en-US" branch="index" id="bm_id3093440"><bookmark_value>macros; recording</bookmark_value>
47 <bookmark_value>recording; macros</bookmark_value>
48 <bookmark_value>Basic; recording macros</bookmark_value>
49 </bookmark>
50 <paragraph role="heading" id="hd_id3093440" xml-lang="en-US" level="1" l10n="U" oldref="1"><variable id="macro_recording"><link href="text/shared/guide/macro_recording.xhp" name="Recording a Macro">Recording a Macro</link>
51 </variable></paragraph>
52 <switch select="appl">
53 <case select="WRITER"><section id="macrorecorder">
54 <list type="ordered">
55 <listitem>
56 <paragraph role="listitem" id="par_id3154749" xml-lang="en-US" l10n="U" oldref="4">Open the document for which you want to record a macro.</paragraph>
57 </listitem>
58 <listitem>
59 <paragraph role="listitem" id="par_id3149398" xml-lang="en-US" l10n="CHG" oldref="5">Choose <emph>Tools - Macros - Record Macro</emph>.</paragraph>
60 <paragraph role="listitem" id="par_id3150275" xml-lang="en-US" l10n="U" oldref="6">You see the small <emph>Recording</emph> dialog with just one button called <emph>Stop Recording</emph>.</paragraph>
61 </listitem>
62 <listitem>
63 <paragraph role="listitem" id="par_id3153087" xml-lang="en-US" l10n="U" oldref="7">Perform the actions you want to be recorded in the document.</paragraph>
64 <paragraph role="listitem" id="par_id3150504" xml-lang="en-US" l10n="U" oldref="15">Press the Escape key to deselect an object, as the macro recorder currently does not record this action by mouse click.</paragraph>
65 </listitem>
66 <listitem>
67 <paragraph role="listitem" id="par_id3148492" xml-lang="en-US" l10n="U" oldref="8">Click <emph>Stop Recording</emph>.</paragraph>
68 <paragraph role="listitem" id="par_id3148686" xml-lang="en-US" l10n="U" oldref="9">The <emph>Macro</emph> dialog appears, in which you can save and run the macro.</paragraph>
69 <paragraph role="listitem" id="par_id3159158" xml-lang="en-US" l10n="U" oldref="10">If you want to abort the recording without saving a macro, click the <emph>Close</emph> button of the <emph>Recording</emph> dialog.</paragraph>
70 </listitem>
71 <listitem>
72 <paragraph role="listitem" id="par_id3144510" xml-lang="en-US" l10n="U" oldref="11">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>
73 </listitem>
74 <listitem>
75 <paragraph role="listitem" id="par_id3148550" xml-lang="en-US" l10n="U" oldref="12">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>
76 </listitem>
77 <listitem>
78 <paragraph role="listitem" id="par_id3149456" xml-lang="en-US" l10n="CHG" oldref="13">Enter a name for the new macro in the <emph>Macro name</emph> text box. Do not use Basic keywords as a name.</paragraph>
79 </listitem>
80 <listitem>
81 <paragraph role="listitem" id="par_id3154138" xml-lang="en-US" l10n="U" oldref="14">Click <emph>Save</emph>.</paragraph>
82 </listitem>
83 </list>
84 <paragraph role="head2" id="hd_id2486342" xml-lang="en-US" l10n="NEW">Limitations of the macro recorder</paragraph>
85 <paragraph role="paragraph" id="par_id3608508" xml-lang="en-US" l10n="NEW">The following actions are <emph>not</emph> recorded:</paragraph>
86 <list type="unordered">
87 <listitem>
88 <paragraph role="paragraph" id="par_id921353" xml-lang="en-US" l10n="NEW">Opening of windows is not recorded.</paragraph>
89 </listitem>
90 <listitem>
91 <paragraph role="paragraph" id="par_id9296243" xml-lang="en-US" l10n="NEW">Actions carried out in another window than where the recorder was started are not recorded.</paragraph>
92 </listitem>
93 <listitem>
94 <paragraph role="paragraph" id="par_id4269234" xml-lang="en-US" l10n="NEW">Window switching is not recorded.</paragraph>
95 </listitem>
96 <listitem>
97 <paragraph role="paragraph" id="par_id8014465" xml-lang="en-US" l10n="NEW">Actions that are not related to the document contents are not recorded. For example, changes made in the Options dialog, macro organizer, customizing.</paragraph>
98 </listitem>
99 <listitem>
100 <paragraph role="paragraph" id="par_id2814416" xml-lang="en-US" l10n="NEW">Selections are recorded only if they are done by using the keyboard (cursor traveling), but not when the mouse is used.</paragraph>
101 </listitem>
102 <listitem>
103 <paragraph role="paragraph" id="par_id2522354" xml-lang="en-US" l10n="NEW">The macro recorder works only in Calc and Writer.</paragraph>
104 </listitem>
105 </list>
106 <embed href="text/shared/00/00000004.xhp#related"/>
107 <paragraph role="paragraph" id="par_id3156422" xml-lang="en-US" l10n="C"><link href="text/shared/01/06130000.xhp" name="Macro">Macro</link></paragraph>
108 <paragraph role="paragraph" id="par_id3147576" xml-lang="en-US" l10n="U" oldref="2"><link href="text/shared/main0600.xhp" name="macro programming in $[officename]">Programming in %PRODUCTNAME</link></paragraph><comment>how-to running a macro</comment><comment>how-to testing and debugging a macro</comment></section>
109 </case>
110 <case select="CALC"><embed href="text/shared/guide/macro_recording.xhp#macrorecorder"/>
111 </case>
112 <case select="BASIC"><embed href="text/shared/guide/macro_recording.xhp#macrorecorder"/>
113 </case>
114 <default>
115 <paragraph role="paragraph" id="par_id7797242" xml-lang="en-US" l10n="NEW">The macro recording functionality is only available for text documents in %PRODUCTNAME Writer and for spreadsheets in %PRODUCTNAME Calc.</paragraph>
116 </default>
117 </switch></body>
118 </helpdocument>