xref: /trunk/main/helpcontent2/source/text/swriter/guide/conditional_text.xhp (revision 94e6a959bb884dd32c625b65779c5dfef01f8dcd)
1cdf0e10cSrcweir<?xml version="1.0" encoding="UTF-8"?>
2cdf0e10cSrcweir<helpdocument version="1.0">
3cdf0e10cSrcweir
40e4b25e7SAndrew Rist<!--***********************************************************
5cdf0e10cSrcweir *
60e4b25e7SAndrew Rist * Licensed to the Apache Software Foundation (ASF) under one
70e4b25e7SAndrew Rist * or more contributor license agreements.  See the NOTICE file
80e4b25e7SAndrew Rist * distributed with this work for additional information
90e4b25e7SAndrew Rist * regarding copyright ownership.  The ASF licenses this file
100e4b25e7SAndrew Rist * to you under the Apache License, Version 2.0 (the
110e4b25e7SAndrew Rist * "License"); you may not use this file except in compliance
120e4b25e7SAndrew Rist * with the License.  You may obtain a copy of the License at
13cdf0e10cSrcweir *
140e4b25e7SAndrew Rist *   http://www.apache.org/licenses/LICENSE-2.0
15cdf0e10cSrcweir *
160e4b25e7SAndrew Rist * Unless required by applicable law or agreed to in writing,
170e4b25e7SAndrew Rist * software distributed under the License is distributed on an
180e4b25e7SAndrew Rist * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
190e4b25e7SAndrew Rist * KIND, either express or implied.  See the License for the
200e4b25e7SAndrew Rist * specific language governing permissions and limitations
210e4b25e7SAndrew Rist * under the License.
22cdf0e10cSrcweir *
230e4b25e7SAndrew Rist ***********************************************************-->
240e4b25e7SAndrew Rist
250e4b25e7SAndrew Rist
26cdf0e10cSrcweir
27cdf0e10cSrcweir
28cdf0e10cSrcweir<meta>
29cdf0e10cSrcweir      <topic id="textswriterguideconditional_textxml" indexer="include" status="PUBLISH">
30cdf0e10cSrcweir         <title xml-lang="en-US" id="tit">Conditional Text</title>
31cdf0e10cSrcweir         <filename>/text/swriter/guide/conditional_text.xhp</filename>
32cdf0e10cSrcweir      </topic>
33cdf0e10cSrcweir   </meta>
34cdf0e10cSrcweir   <body>
35cdf0e10cSrcweir<bookmark xml-lang="en-US" branch="index" id="bm_id3155619"><bookmark_value>matching conditional text in fields</bookmark_value>
36cdf0e10cSrcweir      <bookmark_value>if-then queries as fields</bookmark_value>
37cdf0e10cSrcweir      <bookmark_value>conditional text; setting up</bookmark_value>
38cdf0e10cSrcweir      <bookmark_value>text; conditional text</bookmark_value>
39cdf0e10cSrcweir      <bookmark_value>defining;conditions</bookmark_value>
40cdf0e10cSrcweir</bookmark>
41cdf0e10cSrcweir<paragraph xml-lang="en-US" id="hd_id3155619" role="heading" level="1" l10n="U" oldref="4"><variable id="conditional_text"><link href="text/swriter/guide/conditional_text.xhp" name="Conditional Text">Conditional Text</link>
42cdf0e10cSrcweir</variable></paragraph>
43cdf0e10cSrcweir      <paragraph xml-lang="en-US" id="par_id3155879" role="paragraph" l10n="U" oldref="5">You can set up fields in your document that display text when a condition that you define is met. For example, you can define the conditional text that is displayed in a series of reminder letters.</paragraph>
44cdf0e10cSrcweir      <paragraph xml-lang="en-US" id="par_id3155895" role="paragraph" l10n="U" oldref="6">Setting up conditional text in this example is a two-part process. First you create a variable, and then you create the condition.</paragraph>
45cdf0e10cSrcweir      <paragraph xml-lang="en-US" id="hd_id3153175" role="heading" level="2" l10n="U"
46cdf0e10cSrcweir                 oldref="61">To Define a Conditional Variable</paragraph>
47cdf0e10cSrcweir      <paragraph xml-lang="en-US" id="par_id3153185" role="paragraph" l10n="U" oldref="62">The first part of the example is to define a variable for the condition statement. </paragraph>
48cdf0e10cSrcweir      <list type="ordered">
49cdf0e10cSrcweir         <listitem>
50cdf0e10cSrcweir            <paragraph xml-lang="en-US" id="par_id3155566" role="listitem" l10n="U" oldref="8">Choose <item type="menuitem">Insert - Fields - Other</item>, and then click the <item type="menuitem">Variables</item> tab.</paragraph>
51cdf0e10cSrcweir         </listitem>
52cdf0e10cSrcweir         <listitem>
53*94e6a959SRegina Henschel            <paragraph xml-lang="en-US" id="par_id3147759" role="listitem" l10n="U" oldref="9">Click "Set variable" in the <item type="menuitem">Type</item> list.</paragraph>
54cdf0e10cSrcweir         </listitem>
55cdf0e10cSrcweir         <listitem>
56cdf0e10cSrcweir            <paragraph xml-lang="en-US" id="par_id3147784" role="listitem" l10n="U" oldref="10">Type a name for the variable in the <item type="menuitem">Name</item> box, for example <item type="literal">Reminder</item>.</paragraph>
57cdf0e10cSrcweir         </listitem>
58cdf0e10cSrcweir         <listitem>
59*94e6a959SRegina Henschel            <paragraph xml-lang="en-US" id="par_id3147810" role="listitem" l10n="U" oldref="57">Click "Text" in the <item type="menuitem">Format</item> list.</paragraph>
60cdf0e10cSrcweir         </listitem>
61cdf0e10cSrcweir         <listitem>
62cdf0e10cSrcweir            <paragraph xml-lang="en-US" id="par_id7748344" role="listitem" l10n="NEW">Enter <item type="literal">1</item> in the <item type="menuitem">Value</item> box, and then click <item type="menuitem">Insert</item>.<br/>The Format list now displays a "General" format.</paragraph>
63cdf0e10cSrcweir         </listitem>
64cdf0e10cSrcweir      </list>
65cdf0e10cSrcweir      <paragraph xml-lang="en-US" id="hd_id3145645" role="heading" level="2" l10n="U"
66cdf0e10cSrcweir                 oldref="63">To Define a Condition and the Conditional Text</paragraph>
67cdf0e10cSrcweir      <paragraph xml-lang="en-US" id="par_id3145659" role="paragraph" l10n="U" oldref="64">The second part of the example is to define the condition that must be met, and to insert a placeholder for displaying the conditional text in your document.</paragraph>
68cdf0e10cSrcweir      <list type="ordered">
69cdf0e10cSrcweir         <listitem>
70cdf0e10cSrcweir            <paragraph xml-lang="en-US" id="par_id3151193" role="listitem" l10n="U" oldref="12">Place the cursor where you want to insert the conditional text in your text.</paragraph>
71cdf0e10cSrcweir         </listitem>
72cdf0e10cSrcweir         <listitem>
73cdf0e10cSrcweir            <paragraph xml-lang="en-US" id="par_id3151212" role="listitem" l10n="U" oldref="65">Choose <item type="menuitem">Insert - Fields - Other</item>, and then click the <item type="menuitem">Functions</item> tab.</paragraph>
74cdf0e10cSrcweir         </listitem>
75cdf0e10cSrcweir         <listitem>
76*94e6a959SRegina Henschel            <paragraph xml-lang="en-US" id="par_id3151250" role="listitem" l10n="U" oldref="13">Click "Conditional text" in the <item type="menuitem">Type</item> list.</paragraph>
77cdf0e10cSrcweir         </listitem>
78cdf0e10cSrcweir         <listitem>
79*94e6a959SRegina Henschel            <paragraph xml-lang="en-US" id="par_id3155936" role="listitem" l10n="U" oldref="14">Type <item type="literal">Reminder EQ "3"</item> in the <item type="menuitem">Condition</item> box. In other words, the conditional text will be displayed when the variable in the field that you defined in the first part of this example is equal to three.</paragraph>
80cdf0e10cSrcweir            <paragraph xml-lang="en-US" id="par_id3155969" role="listitem" l10n="U" oldref="15">The quotation marks enclosing the "3" indicate that the variable that you defined in the first part of this example is a text string.</paragraph>
81cdf0e10cSrcweir         </listitem>
82cdf0e10cSrcweir      </list>
83cdf0e10cSrcweir      <list type="ordered" startwith="5">
84cdf0e10cSrcweir         <listitem>
85cdf0e10cSrcweir            <paragraph xml-lang="en-US" id="par_id3150446" role="listitem" l10n="U" oldref="16">Type the text that you want to display when the condition is met in the <emph>Then</emph> box. There is almost no limit to the length of the text that you can enter. You can paste a paragraph into this box.</paragraph>
86cdf0e10cSrcweir         </listitem>
87cdf0e10cSrcweir         <listitem>
88cdf0e10cSrcweir            <paragraph xml-lang="en-US" id="par_id3150473" role="listitem" l10n="U" oldref="17">Click <emph>Insert</emph>, and then click <emph>Close</emph>.</paragraph>
89cdf0e10cSrcweir         </listitem>
90cdf0e10cSrcweir      </list>
91cdf0e10cSrcweir      <paragraph xml-lang="en-US" id="hd_id3155073" role="heading" level="2" l10n="U"
92cdf0e10cSrcweir                 oldref="66">To Display the Conditional Text</paragraph>
93cdf0e10cSrcweir      <paragraph xml-lang="en-US" id="par_id3155086" role="paragraph" l10n="U" oldref="67">In this example, the conditional text is displayed when the value of the conditional variable is equal to 3.</paragraph>
94cdf0e10cSrcweir      <list type="ordered">
95cdf0e10cSrcweir         <listitem>
96cdf0e10cSrcweir            <paragraph xml-lang="en-US" id="par_id3155110" role="listitem" l10n="U" oldref="19">Place your cursor in front of the field that you defined in the first part of this example, and then choose <emph>Edit - Fields</emph>.</paragraph>
97cdf0e10cSrcweir         </listitem>
98cdf0e10cSrcweir         <listitem>
99*94e6a959SRegina Henschel            <paragraph xml-lang="en-US" id="par_id3155136" role="listitem" l10n="U" oldref="68">Replace the number in the <item type="menuitem">Value</item> box with 3, and then click <item type="menuitem">Close</item>.</paragraph>
100cdf0e10cSrcweir         </listitem>
101cdf0e10cSrcweir         <listitem>
102cdf0e10cSrcweir            <paragraph xml-lang="en-US" id="par_id3155168" role="listitem" l10n="U" oldref="20">If the field does not automatically update, press F9.</paragraph>
103cdf0e10cSrcweir         </listitem>
104cdf0e10cSrcweir      </list>
105cdf0e10cSrcweir      <section id="relatedtopics">
106cdf0e10cSrcweir         <embed href="text/swriter/guide/fields_userdata.xhp#fields_userdata"/>
107cdf0e10cSrcweir         <embed href="text/swriter/guide/conditional_text2.xhp#conditional_text2"/>
108cdf0e10cSrcweir         <embed href="text/swriter/01/04090200.xhp#defining_conditions"/>
109cdf0e10cSrcweir         <paragraph xml-lang="en-US" id="par_id3145714" role="paragraph" l10n="C"><link href="text/swriter/02/14020000.xhp" name="List of conditional operators">List of conditional operators</link></paragraph>
110cdf0e10cSrcweir      </section>
111cdf0e10cSrcweir   </body>
112cdf0e10cSrcweir</helpdocument>