xref: /help/source/text/swriter/01/04090002.xhp (revision 2f5820d7)
1<?xml version="1.0" encoding="UTF-8"?>
2
3<!--
4 ***********************************************************************
5 *
6 *  OpenOffice.org - a multi-platform office productivity suite
7 *
8 *  $RCSfile: 04090002.xhp,v $fileonly,v $
9 *
10 *  $Revision: 1.8 $
11 *
12 *  last change: $Author: rt $ $Date: 2008-02-20 01:23:04 $
13 *
14 *  The Contents of this file are made available subject to
15 *  the terms of GNU Lesser General Public License Version 2.1.
16 *
17 *
18 *    GNU Lesser General Public License Version 2.1
19 *    =============================================
20 *    Copyright 2005 by Sun Microsystems, Inc.
21 *    901 San Antonio Road, Palo Alto, CA 94303, USA
22 *
23 *    This library is free software; you can redistribute it and/or
24 *    modify it under the terms of the GNU Lesser General Public
25 *    License version 2.1, as published by the Free Software Foundation.
26 *
27 *    This library is distributed in the hope that it will be useful,
28 *    but WITHOUT ANY WARRANTY; without even the implied warranty of
29 *    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
30 *    Lesser General Public License for more details.
31 *
32 *    You should have received a copy of the GNU Lesser General Public
33 *    License along with this library; if not, write to the Free Software
34 *    Foundation, Inc., 59 Temple Place, Suite 330, Boston,
35 *    MA  02111-1307  USA
36 *
37 ************************************************************************
38 -->
39
40
41		<helpdocument version="1.0">
42<meta>
43<topic id="textswriter0104090002xml" indexer="include" status="PUBLISH">
44<title id="tit" xml-lang="en-US">Cross-references</title>
45<filename>/text/swriter/01/04090002.xhp</filename>
46</topic>
47</meta>
48<body>
49<section id="referenzen">
50<bookmark xml-lang="en-US" branch="hid/FN_INSERT_REF_FIELD" id="bm_id8981346" localize="false"/>
51<bookmark xml-lang="en-US" branch="hid/.uno:InsertReferenceField" id="bm_id3149038" localize="false"/>
52<bookmark xml-lang="en-US" branch="hid/HID_FLD_REF" id="bm_id3149042" localize="false"/><paragraph role="heading" id="hd_id3153641" xml-lang="en-US" level="1" l10n="CHG" oldref="1"><link href="text/swriter/01/04090002.xhp" name="Cross-references">Cross-references</link></paragraph>
53<paragraph role="paragraph" id="par_id3155142" xml-lang="en-US" l10n="CHG" oldref="2"><variable id="reftext"><ahelp hid=".">This is where you insert the references or referenced fields into the current document. References are referenced fields within the same document or within sub-documents of a master document.</ahelp>
54</variable></paragraph>
55<paragraph role="paragraph" id="par_id3159197" xml-lang="en-US" l10n="U" oldref="19">The advantage of entering a cross-reference as a field is that you do not have to adjust the references manually every time you change the document. Just update the fields with F9 and the references in the document are updated too.</paragraph>
56</section>
57<section id="howtoget">
58  <embed href="text/swriter/00/00000404.xhp#feldreferenzen"/>
59</section>
60<embed href="text/swriter/guide/references.xhp#references"/>
61<bookmark xml-lang="en-US" branch="hid/SW:LISTBOX:TP_FLD_REF:LB_REFTYPE" id="bm_id3145772" localize="false"/><comment>replaced embed tags by contents, see i58762</comment><paragraph role="heading" id="hd_id4333628" xml-lang="en-US" level="2" l10n="NEW">Type</paragraph>
62<paragraph role="paragraph" id="par_id4516129" xml-lang="en-US" l10n="NEW"><ahelp hid=".">Lists the available field types. To add a field to your document, click a field type, click a field in the Selection list, and then click Insert.</ahelp> The following fields are available:</paragraph>
63<table id="tbl_id3145784">
64<tablerow>
65<tablecell colspan="" rowspan="">
66<paragraph role="tablehead" id="par_id3151380" xml-lang="en-US" l10n="U" oldref="3">Type</paragraph>
67</tablecell>
68<tablecell colspan="" rowspan="">
69<paragraph role="tablehead" id="par_id3150700" xml-lang="en-US" l10n="U" oldref="4">Meaning</paragraph>
70</tablecell>
71</tablerow>
72<tablerow>
73<tablecell colspan="" rowspan="">
74<paragraph role="tablecontent" id="par_id3155862" xml-lang="en-US" l10n="U" oldref="5">Set Reference</paragraph>
75</tablecell>
76<tablecell colspan="" rowspan="">
77<paragraph role="tablecontent" id="par_id3147422" xml-lang="en-US" l10n="U" oldref="6">Set target for a referenced field. Under <emph>Name</emph>, enter a name for the reference. When inserting the reference, the name will then appear as an identification in the list box <emph>Selection</emph>.</paragraph>
78<paragraph role="tablecontent" id="par_id3149556" xml-lang="en-US" l10n="U" oldref="7">In an HTML document, reference fields entered this way will be ignored. For the target in HTML documents, you have to <link href="text/swriter/01/04040000.xhp" name="insert a bookmark">insert a bookmark</link>.</paragraph>
79</tablecell>
80</tablerow>
81<tablerow>
82<tablecell colspan="" rowspan="">
83<paragraph role="tablecontent" id="par_id3150548" xml-lang="en-US" l10n="U" oldref="8">Insert Reference</paragraph>
84</tablecell>
85<tablecell colspan="" rowspan="">
86<paragraph role="tablecontent" id="par_id3147746" xml-lang="en-US" l10n="U" oldref="9">Inserting a reference to another position in the document. The corresponding text position has to be defined with "Set Reference" first. Otherwise, inserting a reference by choosing a field name under <emph>Selection</emph> is not possible.</paragraph>
87<paragraph role="tablecontent" id="par_id3146344" xml-lang="en-US" l10n="U" oldref="16">In master documents, you can also reference from one sub-document to another. Note that the reference name will not appear in the selection field and has to be entered "by hand".</paragraph>
88<paragraph role="tablecontent" id="par_id3149847" xml-lang="en-US" l10n="U" oldref="10">In an HTML document, reference fields entered this way will be ignored. For referenced fields in HTML documents, you have to <link href="text/shared/01/05020400.xhp" name="insert a hyperlink">insert a hyperlink</link>.</paragraph>
89</tablecell>
90</tablerow>
91<tablerow>
92<tablecell colspan="" rowspan="">
93<paragraph role="tablecontent" id="par_id2408825" xml-lang="en-US" l10n="NEW">Headings</paragraph>
94</tablecell>
95<tablecell colspan="" rowspan="">
96<paragraph role="tablecontent" id="par_id9988402" xml-lang="en-US" l10n="NEW">The Selection box shows a list of all headings in the order of their appearance in the document.</paragraph>
97</tablecell>
98</tablerow>
99<tablerow>
100<tablecell colspan="" rowspan="">
101<paragraph role="tablecontent" id="par_id6401257" xml-lang="en-US" l10n="NEW">Numbered Paragraphs</paragraph>
102</tablecell>
103<tablecell colspan="" rowspan="">
104<paragraph role="tablecontent" id="par_id5841242" xml-lang="en-US" l10n="NEW">The Selection box shows a list of all numbered headings and numbered paragraphs in the order of their appearance in the document.</paragraph>
105</tablecell>
106</tablerow>
107<tablerow>
108<tablecell colspan="" rowspan="">
109<paragraph role="tablecontent" id="par_id306711" xml-lang="en-US" l10n="NEW">Bookmarks</paragraph>
110</tablecell>
111<tablecell colspan="" rowspan="">
112<paragraph role="tablecontent" id="par_id3150907" xml-lang="en-US" l10n="U" oldref="11">After inserting a bookmark in the document with <emph>Insert - Bookmark</emph>, the bookmarks entry on the <emph>References</emph> tab becomes usable. Bookmarks are used to mark certain text passages in a document. In a text document, you can use the bookmarks, for example, to jump from one passage in the document to another.</paragraph>
113<paragraph role="tablecontent" id="par_id3155080" xml-lang="en-US" l10n="U" oldref="12">In an HTML document, these bookmarks become anchors &lt;A name&gt;, which determine the target of hyperlinks for example.</paragraph>
114</tablecell>
115</tablerow>
116<tablerow>
117<tablecell colspan="" rowspan="">
118<paragraph role="tablecontent" id="par_id6794030" xml-lang="en-US" l10n="NEW">(Inserted objects with captions)</paragraph>
119</tablecell>
120<tablecell colspan="" rowspan="">
121<paragraph role="tablecontent" id="par_id7096774" xml-lang="en-US" l10n="NEW">You can set references to objects that have captions applied. For example, insert a picture, right-click the picture, choose Caption. Now the object shows up as a numbered "Illustration" in the list.</paragraph>
122</tablecell>
123</tablerow>
124</table>
125<paragraph role="tip" id="par_id3154772" xml-lang="en-US" l10n="U" oldref="18">References are fields. To remove a reference, delete the field. If you set a longer text as a reference and you do not want to reenter it after deleting the reference, select the text and copy it to the clipboard. You can then reinsert it as "unformatted text" at the same position using the command <emph>Edit - Paste special</emph>. The text remains intact while the reference is deleted.</paragraph>
126<bookmark xml-lang="en-US" branch="hid/SW:LISTBOX:TP_FLD_REF:LB_REFSELECTION" id="bm_id3146957" localize="false"/>
127<bookmark xml-lang="en-US" branch="hid/HID_REFSELECTION_TOOLTIP" id="bm_id1661427" localize="false"/><paragraph role="heading" id="hd_id5824152" xml-lang="en-US" level="2" l10n="NEW">Selection<comment>on "Document" and "DocInformation" tab page this is called "Select", on the other tab pages "Selection"</comment></paragraph>
128<paragraph role="paragraph" id="par_id7374187" xml-lang="en-US" l10n="CHG"><ahelp hid="SW:LISTBOX:TP_FLD_DOK:LB_DOKSELECTION">Lists the available fields for the field type selected in the <emph>Type </emph>list. To insert a field, click the field, select a format in the "Insert reference to" list, and then click <emph>Insert</emph>.</ahelp></paragraph>
129<paragraph role="tip" id="par_id7729728" xml-lang="en-US" l10n="NEW">To quickly insert a field from the list, hold down <switchinline select="sys"><caseinline select="MAC">Command
130</caseinline><defaultinline>Ctrl</defaultinline></switchinline> and double-click the field.</paragraph>
131<section id="format">
132<paragraph role="paragraph" id="par_id2171086" xml-lang="en-US" l10n="CHG">In the <emph>Insert reference to</emph> list, click the format that you want to use.</paragraph>
133<bookmark xml-lang="en-US" branch="hid/SW:LISTBOX:TP_FLD_REF:LB_REFFORMAT" id="bm_id3154344" localize="false"/><paragraph role="heading" id="hd_id3154333" xml-lang="en-US" level="2" l10n="CHG" oldref="21">Insert reference to</paragraph>
134<paragraph role="paragraph" id="par_id3148786" xml-lang="en-US" l10n="U" oldref="22"><ahelp hid="SW:LISTBOX:TP_FLD_REF:LB_REFFORMAT">Select the format that you want to use for the selected reference field.</ahelp> The following formats are available:</paragraph>
135<table id="tbl_id3150090">
136<tablerow>
137<tablecell colspan="" rowspan="">
138<paragraph role="tablehead" id="par_id7576525" xml-lang="en-US" l10n="NEW">Format</paragraph>
139</tablecell>
140<tablecell colspan="" rowspan="">
141<paragraph role="tablehead" id="par_id641193" xml-lang="en-US" l10n="NEW">Meaning</paragraph>
142</tablecell>
143</tablerow>
144<tablerow>
145<tablecell colspan="" rowspan="">
146<paragraph role="tablecontent" id="par_id3150039" xml-lang="en-US" l10n="U" oldref="23">Page</paragraph>
147</tablecell>
148<tablecell colspan="" rowspan="">
149<paragraph role="tablecontent" id="par_id3153134" xml-lang="en-US" l10n="U" oldref="24">Inserts the number of the page containing the reference target.</paragraph>
150</tablecell>
151</tablerow>
152<tablerow>
153<tablecell colspan="" rowspan="">
154<paragraph role="tablecontent" id="par_id3150681" xml-lang="en-US" l10n="U" oldref="27">Reference</paragraph>
155</tablecell>
156<tablecell colspan="" rowspan="">
157<paragraph role="tablecontent" id="par_id3154040" xml-lang="en-US" l10n="U" oldref="28">Inserts the complete reference target text.</paragraph>
158</tablecell>
159</tablerow>
160<tablerow>
161<tablecell colspan="" rowspan="">
162<paragraph role="tablecontent" id="par_id3149972" xml-lang="en-US" l10n="U" oldref="29">Above/Below</paragraph>
163</tablecell>
164<tablecell colspan="" rowspan="">
165<paragraph role="tablecontent" id="par_id3149619" xml-lang="en-US" l10n="U" oldref="30">Inserts "above" or "below", depending on the location of the reference target relative to the position of the reference field.</paragraph>
166</tablecell>
167</tablerow>
168<tablerow>
169<tablecell colspan="" rowspan="">
170<paragraph role="tablecontent" id="par_id3148705" xml-lang="en-US" l10n="U" oldref="31">As Page Style</paragraph>
171</tablecell>
172<tablecell colspan="" rowspan="">
173<paragraph role="tablecontent" id="par_id3148728" xml-lang="en-US" l10n="U" oldref="32">Inserts the number of the page containing the reference target using the format specified in the page style.</paragraph>
174</tablecell>
175</tablerow>
176<tablerow>
177<tablecell colspan="" rowspan="">
178<paragraph role="tablecontent" id="par_id5699942" xml-lang="en-US" l10n="NEW">Number</paragraph>
179</tablecell>
180<tablecell colspan="" rowspan="">
181<paragraph role="tablecontent" id="par_id6420484" xml-lang="en-US" l10n="NEW">Inserts the number of the heading or numbered paragraph, including superior levels depending on the context. See note below this table for more information.</paragraph>
182</tablecell>
183</tablerow>
184<tablerow>
185<tablecell colspan="" rowspan="">
186<paragraph role="tablecontent" id="par_id6986602" xml-lang="en-US" l10n="NEW">Number (no context)</paragraph>
187</tablecell>
188<tablecell colspan="" rowspan="">
189<paragraph role="tablecontent" id="par_id616779" xml-lang="en-US" l10n="NEW">Inserts only the number of the heading or numbered paragraph.</paragraph>
190</tablecell>
191</tablerow>
192<tablerow>
193<tablecell colspan="" rowspan="">
194<paragraph role="tablecontent" id="par_id791039" xml-lang="en-US" l10n="NEW">Number (full context)</paragraph>
195</tablecell>
196<tablecell colspan="" rowspan="">
197<paragraph role="tablecontent" id="par_id1953489" xml-lang="en-US" l10n="NEW">Inserts the number of the heading or numbered paragraph, including all superior levels.</paragraph>
198</tablecell>
199</tablerow>
200<tablerow>
201<tablecell colspan="" rowspan="">
202<paragraph role="tablecontent" id="par_id3154635" xml-lang="en-US" l10n="U" oldref="25">Chapter</paragraph>
203</tablecell>
204<tablecell colspan="" rowspan="">
205<paragraph role="tablecontent" id="par_id3149646" xml-lang="en-US" l10n="U" oldref="26">Inserts the number of the chapter containing the reference target.</paragraph>
206</tablecell>
207</tablerow>
208<tablerow>
209<tablecell colspan="" rowspan="">
210<paragraph role="tablecontent" id="par_id3155553" xml-lang="en-US" l10n="U" oldref="33">Category and Number</paragraph>
211</tablecell>
212<tablecell colspan="" rowspan="">
213<paragraph role="tablecontent" id="par_id3155356" xml-lang="en-US" l10n="U" oldref="34">Inserts the category (caption type) and the number of the reference target. This option is only available when the reference target is an object with a caption.</paragraph>
214</tablecell>
215</tablerow>
216<tablerow>
217<tablecell colspan="" rowspan="">
218<paragraph role="tablecontent" id="par_id3154224" xml-lang="en-US" l10n="U" oldref="35">Caption Text</paragraph>
219</tablecell>
220<tablecell colspan="" rowspan="">
221<paragraph role="tablecontent" id="par_id3145105" xml-lang="en-US" l10n="U" oldref="36">Inserts the caption label of the reference target. This option is only available when the reference target is an object with a caption.</paragraph>
222</tablecell>
223</tablerow>
224<tablerow>
225<tablecell colspan="" rowspan="">
226<paragraph role="tablecontent" id="par_id3149587" xml-lang="en-US" l10n="U" oldref="37">Numbering</paragraph>
227</tablecell>
228<tablecell colspan="" rowspan="">
229<paragraph role="tablecontent" id="par_id3146883" xml-lang="en-US" l10n="U" oldref="38">Inserts the caption number of the reference target. This option is only available when the reference target is an object with a caption.</paragraph>
230</tablecell>
231</tablerow>
232</table>
233<paragraph role="paragraph" id="par_id757469" xml-lang="en-US" l10n="NEW">The "Number" format inserts the number of the heading or numbered paragraph. The superior levels are included depending on the context, as necessary. </paragraph>
234<paragraph role="paragraph" id="par_id5189062" xml-lang="en-US" l10n="NEW">For example, when you are in a chapter 1, subchapter 2, subpart 5, this may be numbered as 1.2.5. When you insert here a reference to text in the previous subpart "1.2.4" and you apply the "Number" format, then the reference will be shown as "4". If in this example the numbering is set to show more sublevels, the same reference will be shown as "2.4" or "1.2.4", depending on the setting. If you use the "Number (full context)" format, you will always see "1.2.4", no matter how the numbered paragraph is formatted. You can see illustrated explanations (and information on migration from and to previous software versions) in the <link href="http://specs.openoffice.org/writer/numbering/Direct_Cross_References_to_Headings_and_Numberings.odt">specification document</link>.</paragraph>
235</section>
236<section id="name">
237<bookmark xml-lang="en-US" branch="hid/SW:EDIT:TP_FLD_REF:ED_REFNAME" id="bm_id3156253" localize="false"/><paragraph role="heading" id="hd_id3156242" xml-lang="en-US" level="2" l10n="U" oldref="13">Name</paragraph>
238<paragraph role="paragraph" id="par_id3156259" xml-lang="en-US" l10n="U" oldref="14"><ahelp hid="SW:EDIT:TP_FLD_REF:ED_REFNAME">Type the name of the user-defined field that you want to create.</ahelp> To set a target, click "Set Reference" in the <emph>Type</emph> list, type a name in this box, and then click <emph>Insert</emph>. To reference the new target, click the target name in the <emph>Selection</emph> list.</paragraph>
239</section>
240<paragraph role="paragraph" id="par_id3156032" xml-lang="en-US" l10n="U" oldref="17">In a master document, targets that are in different sub-documents are not displayed in the<emph> Selection</emph> list. If you want to insert a reference to the target, you must type the path and the name in the <emph>Name </emph>box.</paragraph>
241<bookmark xml-lang="en-US" branch="hid/SW:EDIT:TP_FLD_REF:ED_REFVALUE" id="bm_id3159204" localize="false"/><embed href="text/swriter/01/04090001.xhp#wert"/>
242<paragraph role="paragraph" id="par_id3159216" xml-lang="en-US" l10n="U" oldref="15">If you select text in the document, and then insert a reference, the selected text becomes the contents of the field that you insert.</paragraph><comment>Value box (always disabled)</comment>
243<bookmark xml-lang="en-US" branch="hid/sw:Edit:TP_FLD_REF:ED_REFVALUE" id="bm_id5684377" localize="false"/><paragraph role="paragraph" id="par_id6501968" xml-lang="en-US" l10n="NEW"><ahelp hid="." visibility="hidden">Edit the value.</ahelp></paragraph>
244</body>
245</helpdocument>
246