merge the formfield patch from ooo-build
[ooovba.git] / helpcontent2 / source / text / swriter / guide / conditional_text.xhp
blob6490e9449562ae29fa2ee341c00b8284556d6f90
1 <?xml version="1.0" encoding="UTF-8"?>
2 <helpdocument version="1.0">
4 <!--
5 ***********************************************************************
7 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
8 *
9 * Copyright 2008 by Sun Microsystems, Inc.
11 * OpenOffice.org - a multi-platform office productivity suite
13 * $RCSfile: soffice2xmlhelp.xsl,v $
14 * $Revision: 1.10 $
16 * This file is part of OpenOffice.org.
18 * OpenOffice.org is free software: you can redistribute it and/or modify
19 * it under the terms of the GNU Lesser General Public License version 3
20 * only, as published by the Free Software Foundation.
22 * OpenOffice.org is distributed in the hope that it will be useful,
23 * but WITHOUT ANY WARRANTY; without even the implied warranty of
24 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
25 * GNU Lesser General Public License version 3 for more details
26 * (a copy is included in the LICENSE file that accompanied this code).
28 * You should have received a copy of the GNU Lesser General Public License
29 * version 3 along with OpenOffice.org. If not, see
30 * <http://www.openoffice.org/license.html>
31 * for a copy of the LGPLv3 License.
33 ************************************************************************
34 -->
37 <meta>
38 <topic id="textswriterguideconditional_textxml" indexer="include" status="PUBLISH">
39 <title xml-lang="en-US" id="tit">Conditional Text</title>
40 <filename>/text/swriter/guide/conditional_text.xhp</filename>
41 </topic>
42 </meta>
43 <body>
44 <bookmark xml-lang="en-US" branch="index" id="bm_id3155619"><bookmark_value>matching conditional text in fields</bookmark_value>
45 <bookmark_value>if-then queries as fields</bookmark_value>
46 <bookmark_value>conditional text; setting up</bookmark_value>
47 <bookmark_value>text; conditional text</bookmark_value>
48 <bookmark_value>defining;conditions</bookmark_value>
49 </bookmark>
50 <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>
51 </variable></paragraph>
52 <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>
53 <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>
54 <paragraph xml-lang="en-US" id="hd_id3153175" role="heading" level="2" l10n="U"
55 oldref="61">To Define a Conditional Variable</paragraph>
56 <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>
57 <list type="ordered">
58 <listitem>
59 <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>
60 </listitem>
61 <listitem>
62 <paragraph xml-lang="en-US" id="par_id3147759" role="listitem" l10n="U" oldref="9">Click "Set variable" in the <item type="menuitem">Type</item>
63 <emph/>list.</paragraph>
64 </listitem>
65 <listitem>
66 <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>
67 </listitem>
68 <listitem>
69 <paragraph xml-lang="en-US" id="par_id3147810" role="listitem" l10n="U" oldref="57">Click "Text" in the<emph/>
70 <item type="menuitem">Format</item> list.</paragraph>
71 </listitem>
72 <listitem>
73 <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>
74 </listitem>
75 </list>
76 <paragraph xml-lang="en-US" id="hd_id3145645" role="heading" level="2" l10n="U"
77 oldref="63">To Define a Condition and the Conditional Text</paragraph>
78 <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>
79 <list type="ordered">
80 <listitem>
81 <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>
82 </listitem>
83 <listitem>
84 <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>
85 </listitem>
86 <listitem>
87 <paragraph xml-lang="en-US" id="par_id3151250" role="listitem" l10n="U" oldref="13">Click "Conditional text" in the <item type="menuitem">Type</item>
88 <emph/>list.</paragraph>
89 </listitem>
90 <listitem>
91 <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>
92 <emph/>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>
93 <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>
94 </listitem>
95 </list>
96 <list type="ordered" startwith="5">
97 <listitem>
98 <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>
99 </listitem>
100 <listitem>
101 <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>
102 </listitem>
103 </list>
104 <paragraph xml-lang="en-US" id="hd_id3155073" role="heading" level="2" l10n="U"
105 oldref="66">To Display the Conditional Text</paragraph>
106 <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>
107 <list type="ordered">
108 <listitem>
109 <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>
110 </listitem>
111 <listitem>
112 <paragraph xml-lang="en-US" id="par_id3155136" role="listitem" l10n="U" oldref="68">Replace the number in the <item type="menuitem">Value</item>
113 <emph/>box with 3, and then click<emph/>
114 <item type="menuitem">Close</item>.</paragraph>
115 </listitem>
116 <listitem>
117 <paragraph xml-lang="en-US" id="par_id3155168" role="listitem" l10n="U" oldref="20">If the field does not automatically update, press F9.</paragraph>
118 </listitem>
119 </list>
120 <section id="relatedtopics">
121 <embed href="text/swriter/guide/fields_userdata.xhp#fields_userdata"/>
122 <embed href="text/swriter/guide/conditional_text2.xhp#conditional_text2"/>
123 <embed href="text/swriter/01/04090200.xhp#defining_conditions"/>
124 <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>
125 </section>
126 </body>
127 </helpdocument>