summaryrefslogtreecommitdiffstats
path: root/source/text/swriter/01/04090005.xhp
blob: 97f01c910d4034c870f8f260db338a3f67180971 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
<?xml version="1.0" encoding="UTF-8"?>
<helpdocument version="1.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 .
 -->

<meta>
<topic id="textswriter0104090005xml" indexer="include">
<title id="tit" xml-lang="en-US">Variables (fields)</title>
<filename>/text/swriter/01/04090005.xhp</filename>
</topic>
</meta>
<body>
<section id="variablen">
<bookmark xml-lang="en-US" branch="index" id="bm_id8526261"><bookmark_value>user-defined fields, restriction</bookmark_value>
</bookmark>
<bookmark xml-lang="en-US" branch="hid/modules/swriter/ui/fldvarpage/@@nowidget@@" id="bm_@@nowidget@@" localize="false"/>
<bookmark xml-lang="en-US" branch="hid/modules/swriter/ui/fldvarpage/FldVarPage" id="bm_id3151266" localize="false"/>
<h1 id="hd_id3153716" xml-lang="en-US"><link href="text/swriter/01/04090005.xhp" name="Variables">Variables</link></h1>
<paragraph role="paragraph" id="par_id3150764" xml-lang="en-US"><ahelp hid=".">Variable fields let you add dynamic content to your document. For example, you can use a variable to reset the page numbering.</ahelp></paragraph>
</section>
<section id="howtoget">
<embed href="text/swriter/00/00000404.xhp#feldvariablen"/>
</section>

<bookmark xml-lang="en-US" branch="hid/modules/swriter/ui/fldvarpage/type" id="bm_id3154692" localize="false"/>
<paragraph role="paragraph" id="par_id0903200802243625" xml-lang="en-US"><ahelp hid="." visibility="hidden">Lists the available field types. To add a field to your document, click a field type, click a field in the <emph>Select </emph>list, and then click <emph>Insert</emph>.</ahelp></paragraph>

<embed href="text/swriter/01/04090001.xhp#feldtyp"/>
<table id="tbl_id3145416">
<tablerow>
<tablecell>
<paragraph role="tablehead" id="par_id3150703" xml-lang="en-US">Type</paragraph>
</tablecell>
<tablecell>
<paragraph role="tablehead" id="par_id3154096" xml-lang="en-US">Description</paragraph>
</tablecell>
</tablerow>
<tablerow>
<tablecell>
<paragraph role="tablecontent" id="par_id3149803" xml-lang="en-US">Set Variable</paragraph>
</tablecell>
<tablecell>
<paragraph role="tablecontent" id="par_id3150996" xml-lang="en-US">Defines a variable and its value. You can change the value of a variable by clicking in front of the variable field, and then choosing <emph>Edit - Field</emph>.</paragraph>
</tablecell>
</tablerow>
<tablerow>
<tablecell>
<paragraph role="tablecontent" id="par_id3154571" xml-lang="en-US">Show Variable</paragraph>
</tablecell>
<tablecell>
<paragraph role="tablecontent" id="par_id3153669" xml-lang="en-US">Inserts the current value of the variable that you click in the <emph>Select</emph> list.</paragraph>
</tablecell>
</tablerow>
<tablerow>
<tablecell>
<paragraph role="tablecontent" id="par_id3147531" xml-lang="en-US">DDE field</paragraph>
</tablecell>
<tablecell>
<paragraph role="tablecontent" id="par_id3149684" xml-lang="en-US">Inserts a <link href="text/shared/00/00000005.xhp#dde" name="DDE">DDE</link> link into the document, that you can update as often as you want through the assigned name.</paragraph>
</tablecell>
</tablerow>
<tablerow>
<tablecell>
<paragraph role="tablecontent" id="par_id3159196" xml-lang="en-US">Insert Formula</paragraph>
</tablecell>
<tablecell>
<paragraph role="tablecontent" id="par_id3151322" xml-lang="en-US">Inserts a fixed number, or the result of a formula.</paragraph>
</tablecell>
</tablerow>
<tablerow>
<tablecell>
<paragraph role="tablecontent" id="par_id3149494" xml-lang="en-US">Input field</paragraph>
</tablecell>
<tablecell>
<paragraph role="tablecontent" id="par_id3154829" xml-lang="en-US">Inserts a new value for a variable or a User Field.</paragraph>
<paragraph role="tablecontent" id="par_id3149098" xml-lang="en-US">The value of a variable in an Input field is only valid from where the field is inserted and onwards. To change the value of the variable later in the document, insert another Input field of the same name, but with a different value. However, the value of a User Field is changed globally.</paragraph>
<paragraph role="tablecontent" id="par_id3151255" xml-lang="en-US">The variables are displayed in the <emph>Select</emph> field. When you click the <emph>Insert</emph> button, the dialog <link href="text/swriter/01/04090100.xhp" name="Input Field"><emph>Review Fields</emph></link> appears, where you can enter the new value or additional text as a remark.</paragraph>
</tablecell>
</tablerow>
<tablerow>
<tablecell>
<paragraph role="tablecontent" id="par_id3149034" xml-lang="en-US">Number range</paragraph>
</tablecell>
<tablecell>
<paragraph role="tablecontent" id="par_id3152772" xml-lang="en-US">Inserts automatic numbering for tables, graphics, or frames.</paragraph>
</tablecell>
</tablerow>
<tablerow>
<tablecell>
<paragraph role="tablecontent" id="par_id3147073" xml-lang="en-US">Set page variable</paragraph>
</tablecell>
<tablecell>
<paragraph role="tablecontent" id="par_id3154389" xml-lang="en-US">Inserts a reference point in the document, after which the page count restarts. Select "on" to enable the reference point, and "off" to disable it. You can also enter an offset to start the page count at a different number.</paragraph>
</tablecell>
</tablerow>
<tablerow>
<tablecell>
<paragraph role="tablecontent" id="par_id3156267" xml-lang="en-US">Show page variable</paragraph>
</tablecell>
<tablecell>
<paragraph role="tablecontent" id="par_id3150588" xml-lang="en-US">Displays the number of pages from the "Set page variable" reference point to this field.</paragraph>
</tablecell>
</tablerow>
<tablerow>
<tablecell>
<paragraph role="tablecontent" id="par_id3145779" xml-lang="en-US">User Field</paragraph>
</tablecell>
<tablecell>
<paragraph role="tablecontent" id="par_id3151377" xml-lang="en-US">Inserts a custom global variable. You can use the User Field to define a variable for a condition statement. When you change a User Field, all instances of the variable in the document are updated.</paragraph>
</tablecell>
</tablerow>
</table>
<section id="selecth2">
<bookmark xml-lang="en-US" branch="hid/modules/swriter/ui/fldvarpage/select" id="bm_id3150684" localize="false"/>
<h2 id="hd_id3888363" xml-lang="en-US">Select</h2><comment>on all tab pages this is called "Select", except for "Cross-References", which uses "Selection"</comment>
<paragraph role="paragraph" id="par_id7453535" xml-lang="en-US"><ahelp hid="modules/swriter/ui/fldvarpage/select"><variable id="selecthelp">Lists the available fields for the field type selected in the <emph>Type </emph>list.</variable> To insert a field, click the field, and then click <emph>Insert</emph>.</ahelp></paragraph>
</section>
<paragraph role="tip" id="par_id3326822" xml-lang="en-US">To quickly insert a field from the <emph>Select</emph> list, hold down <switchinline select="sys"><caseinline select="MAC">Command</caseinline><defaultinline>Ctrl</defaultinline></switchinline> and double-click the field.</paragraph>
<bookmark xml-lang="en-US" branch="hid/modules/swriter/ui/fldvarpage/numformat" id="bm_id3148875" localize="false"/>
<paragraph role="paragraph" id="par_id0903200802243892" xml-lang="en-US"><ahelp hid="." visibility="hidden">Click the format that you want to apply to the selected field, or click "Additional formats" to define a custom format.</ahelp></paragraph>
<embed href="text/swriter/01/04090001.xhp#format"/><comment>Provides Format header and explanation</comment>
<bookmark xml-lang="en-US" branch="hid/modules/swriter/ui/fldvarpage/name" id="bm_id3150108" localize="false"/>
<paragraph role="paragraph" id="par_id0903200802243880" xml-lang="en-US"><ahelp hid="." visibility="hidden">Type the name of the user-defined field that you want to create.</ahelp></paragraph>
<embed href="text/swriter/01/04090002.xhp#name2"/><comment>Provides Name header and explanation</comment>
<paragraph role="paragraph" id="par_id381583794664065"><embedvar href="text/swriter/01/04090002.xhp#FieldName"/> This option is available for "Set variable", "DDE field", "Number range" and "User Field" field types.</paragraph>
<warning id="par_id3149759" xml-lang="en-US">User-defined fields are only available in the current document.</warning>
<bookmark xml-lang="en-US" branch="hid/modules/swriter/ui/fldvarpage/value" id="bm_id3150119" localize="false"/>
<paragraph role="paragraph" id="par_id0903200802243951" xml-lang="en-US"><ahelp hid="." visibility="hidden">Enter the contents that you want to add to a user-defined field.</ahelp></paragraph>
<embed href="text/swriter/01/04090001.xhp#wert"/>
<bookmark xml-lang="en-US" branch="hid/modules/swriter/ui/fldvarpage/format" id="bm_id3155871" localize="false"/>
<paragraph role="paragraph" id="par_id3155860" xml-lang="en-US"><ahelp hid="modules/swriter/ui/fldvarpage/format">In the <emph>Format</emph> list, define if the value is inserted as text or a number.</ahelp></paragraph>
<embed href="text/swriter/01/04090001.xhp#hinweis"/><comment>Warns that following types depend on the selection in the Type list</comment>
<paragraph role="paragraph" id="par_id3150696" xml-lang="en-US">In an HTML document, two additional fields are available for the "Set variable" field type: HTML_ON and HTML_OFF. The text that you type in the <emph>Value </emph>box is converted to an opening HTML <link href="text/shared/00/00000002.xhp#tags" name="tag">tag</link> (&lt;Value&gt;) or to a closing HTML (&lt;/Value&gt;) tag when the file is saved as an HTML document, depending on the option that you select.</paragraph>
<h2 id="hd_id871583773320305">DDE Statement</h2>
<embed href="text/swriter/01/04020100.xhp#DDE_Statement"/><comment>taken from DDE in Section</comment>
<paragraph role="paragraph" id="par_id481583773333848">This option is only available if the "DDE field" field type is selected.</paragraph>
<h2 id="hd_id3155969" xml-lang="en-US">Formula</h2>
<paragraph role="paragraph" id="par_id3155982" xml-lang="en-US">This option is only available if the "Insert Formula" field type is selected.</paragraph>
<embed href="text/swriter/01/04090003.xhp#hinweis"/>
<embed href="text/swriter/01/04090001.xhp#korrektur"/>
<paragraph role="paragraph" id="par_id71583772995807">This option is only available if the "Set page variable" field type is selected.</paragraph>
<section id="unsichtbar">
<bookmark xml-lang="en-US" branch="hid/modules/swriter/ui/fldvarpage/invisible" id="bm_id3156226" localize="false"/>
<h2 id="hd_id3149229" xml-lang="en-US">Invisible</h2>
<paragraph role="paragraph" id="par_id3156233" xml-lang="en-US"><variable id="invisiblehelp"><ahelp hid="modules/swriter/ui/fldvarpage/invisible">Hides the field contents in the document.</ahelp> The field is inserted as a thin gray mark in the document.</variable> This option is only available for the "Set Variable" and "User Field" field types.</paragraph>
</section>
<h2 id="hd_id3146326" xml-lang="en-US">Numbering by Chapter</h2>
<paragraph role="paragraph" id="par_id3146340" xml-lang="en-US">Sets the options for resetting chapter numbers.</paragraph>
<bookmark xml-lang="en-US" branch="hid/modules/swriter/ui/fldvarpage/level" id="bm_id3149829" localize="false"/>
<h3 id="hd_id3147456" xml-lang="en-US">Level</h3>
<paragraph role="paragraph" id="par_id3149836" xml-lang="en-US"><ahelp hid="modules/swriter/ui/fldvarpage/level">Choose the heading or chapter level at which to restart numbering in the document.</ahelp></paragraph>
<bookmark xml-lang="en-US" branch="hid/modules/swriter/ui/fldvarpage/separator" id="bm_id3147605" localize="false"/>
<h3 id="hd_id3147594" xml-lang="en-US">Separator</h3>
<paragraph role="paragraph" id="par_id3148846" xml-lang="en-US"><ahelp hid="modules/swriter/ui/fldvarpage/separator">Type the character that you want to use as a separator between the heading or chapter levels.</ahelp></paragraph>
<note id="par_id941584040174795"><emph>Numbering by Chapter</emph>, <emph>Level</emph> and <emph>Separator</emph> are only available for the "Number range" field type.</note>
<section id="uebernehmen">
<bookmark xml-lang="en-US" branch="hid/modules/swriter/ui/fldvarpage/apply" id="bm_id3147069" localize="false"/>
<h2 id="hd_id3147057" xml-lang="en-US">Apply</h2>
<paragraph role="paragraph" id="par_id3155562" xml-lang="en-US"><ahelp hid="modules/swriter/ui/fldvarpage/apply">Adds the user-defined field to the <emph>Select</emph> list.</ahelp></paragraph>
<embed href="text/swriter/02/14040000.xhp#syuebernehmen"/>
</section>
<section id="loeschen">
<bookmark xml-lang="en-US" branch="hid/modules/swriter/ui/fldvarpage/delete" id="bm_id3151092" localize="false"/>
<paragraph role="heading" id="hd_id3151080" xml-lang="en-US" level="2">Delete</paragraph>
<paragraph role="paragraph" id="par_id3154769" xml-lang="en-US"><ahelp hid="modules/swriter/ui/fldvarpage/delete">Removes the user-defined field from the select list. You can only remove fields that are not used in the current document.</ahelp> To remove a field that is used in the current document from the list, first delete all instances of the field in the document, and then remove it from the list.</paragraph>
<table id="tbl_id3154080">
<tablerow>
<tablecell>
<paragraph role="paragraph" id="par_id3145318" xml-lang="en-US"><image id="img_id3153293" src="svx/res/nu02.png" width="0.423cm" height="0.423cm"><alt id="alt_id3153293" xml-lang="en-US">Icon</alt></image></paragraph>
</tablecell>
<tablecell>
<paragraph role="paragraph" id="par_id3150169" xml-lang="en-US">Delete</paragraph>
</tablecell>
</tablerow>
</table>
</section>
</body>
</helpdocument>