summaryrefslogtreecommitdiffstats
path: root/helpcontent2/source/text/swriter/01/04120250.xhp
blob: 9ba60bb2b0e95c676d88e21bee1185687c1fc5ec (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
<?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="textswriter0104120250xml" indexer="include" status="PUBLISH">
    <title id="tit" xml-lang="en-US">Edit Concordance File</title>
    <filename>/text/swriter/01/04120250.xhp</filename>
  </topic>
</meta>

<body>

<bookmark xml-lang="en-US" branch="index" id="bm_id3148768">
  <bookmark_value>editing; concordance files</bookmark_value>
  <bookmark_value>concordance files; definition</bookmark_value>
</bookmark>

<bookmark xml-lang="en-US" branch="hid/modules/swriter/ui/createautomarkdialog/CreateAutomarkDialog" id="bm_id3147169" localize="false"/>
<bookmark xml-lang="en-US" branch="hid/modules/swriter/ui/createautomarkdialog/@@nowidget@@" id="bm_@@nowidget@@" localize="false"/>

<h1 id="hd_id3148768">Edit Concordance File</h1>
<paragraph id="par_id3151180" role="paragraph" xml-lang="en-US"><ahelp hid="modules/swriter/ui/createautomarkdialog/CreateAutomarkDialog">Create or edit a list of words to include in an Alphabetical Index.</ahelp> A concordance file lists words that should be referenced in an alphabetical index, together with the page number(s) where they appear in the document.</paragraph>
<paragraph id="par_id837427" role="paragraph" xml-lang="en-US">You can use the Find All button on the Find &amp; Replace dialog to highlight all places where a word appears, then open the Insert Index Entry dialog to add that word and places to the alphabetical index. However, if you need the same set of alphabetical indexes in multiple documents, the concordance file allows you to enter every word just once, then use the list many times.<comment>i61650</comment></paragraph>

<note id="par_id771599006446118">The default filter for creating or opening concordance files is <literal>*.sdi</literal>. However, the file format of the concordance file is plain text.</note>

<h2 id="hd_id3154645">To access the Edit Concordance File dialog:</h2>

<list type="ordered">
  <listitem>
    <paragraph id="par_id3149292" role="listitem" xml-lang="en-US">Choose <emph>Insert - Table of Contents and Index - Table of Contents, Index or Bibliography - Type</emph>.</paragraph>
  </listitem>
  <listitem>
    <paragraph id="par_id3145420" role="listitem" xml-lang="en-US">In the <emph>Type </emph>box, select "Alphabetical Index".</paragraph>
  </listitem>
  <listitem>
    <paragraph id="par_id3154107" role="listitem" xml-lang="en-US">In the <emph>Options </emph>area, select the <emph>Concordance file</emph> check box.</paragraph>
  </listitem>
  <listitem>
    <paragraph id="par_id3153668" role="listitem" xml-lang="en-US">Click the <emph>File</emph> button, and then choose <emph>New</emph> or <emph>Edit</emph>.</paragraph>
  </listitem>
</list>
<paragraph id="par_id3154470" role="paragraph" xml-lang="en-US">A concordance file contains the following fields:</paragraph>
<table id="tab_id131599005949274">
    <tablerow>
        <tablecell>
            <paragraph id="par_id91599005949275" role="tablehead" xml-lang="en-US">Term</paragraph>
        </tablecell>
        <tablecell>
            <paragraph id="par_id461599005949276" role="tablehead" xml-lang="en-US">Meaning</paragraph>
        </tablecell>
    </tablerow>
    <tablerow>
        <tablecell>
            <paragraph id="par_id291599005949278" role="paragraph" xml-lang="en-US">Search term</paragraph>
        </tablecell>
        <tablecell>
            <paragraph id="par_id3152953" role="tablecontent" xml-lang="en-US">"Search term" refers to the index entry that you want to mark in the document.</paragraph>
        </tablecell>
    </tablerow>
    <tablerow>
        <tablecell>
            <paragraph id="par_id811599006053151" role="tablecontent" xml-lang="en-US" >Alternative entry</paragraph>
        </tablecell>
        <tablecell>
            <paragraph id="par_id3155896" role="tablecontent" xml-lang="en-US">"Alternative entry" refers to the index entry that you want to appear in the index.</paragraph>
        </tablecell>
    </tablerow>
    <tablerow>
        <tablecell>
            <paragraph id="par_id661599006090921" role="tablecontent" xml-lang="en-US" >1st and 2nd Keys</paragraph>
        </tablecell>
        <tablecell>
            <paragraph id="par_id3154194" role="tablecontent" xml-lang="en-US">The 1st and 2nd Keys are parent index entries. The "Search term" or the "Alternative entry" appears as a subentry under the 1st and 2nd Keys.</paragraph>
        </tablecell>
    </tablerow>
    <tablerow>
        <tablecell>
            <paragraph id="par_id521599007507727" role="tablecontent" xml-lang="en-US" >Comment</paragraph>
        </tablecell>
        <tablecell>
            <paragraph id="par_id981599007507728" role="tablecontent" xml-lang="en-US" >Add a comment line above the entry. Commented lines start with #.</paragraph>
        </tablecell>
    </tablerow>
    <tablerow>
        <tablecell>
            <paragraph id="par_id441599006128506" role="tablecontent" xml-lang="en-US" >Match case</paragraph>
        </tablecell>
        <tablecell>
            <paragraph id="par_id3155184" role="tablecontent" xml-lang="en-US">"Match case" means that uppercase and lowercase letters are considered.</paragraph>
        </tablecell>
    </tablerow>
    <tablerow>
        <tablecell>
            <paragraph id="par_id361599006161460" role="tablecontent" xml-lang="en-US" >Word only</paragraph>
        </tablecell>
        <tablecell>
            <paragraph id="par_id3143282" role="tablecontent" xml-lang="en-US">"Word only" searches for the term as a single word.</paragraph>
        </tablecell>
    </tablerow>
</table>

<note id="par_id3147220">To enable the "Match case" or "Word only" options, click in the corresponding cell, and then select the check box.</note>

<h2 id="hd_id3153629">To create a concordance file without the Edit Concordance File dialog:</h2>
<paragraph id="par_id3153644" role="paragraph" xml-lang="en-US">Use the following format guidelines when you create a concordance file:</paragraph>

<list type="unordered">
  <listitem>
    <paragraph id="par_id3152770" role="listitem" xml-lang="en-US">Each entry in the concordance file is on a separate line.</paragraph>
  </listitem>
  <listitem>
    <paragraph id="par_id3155142" role="listitem" xml-lang="en-US">Commented lines start with #.</paragraph>
  </listitem>
  <listitem>
    <paragraph id="par_id3153354" role="listitem" xml-lang="en-US">Use the following format for the entries:</paragraph>
  </listitem></list>
  <paragraph id="par_id3149172" role="paragraph" xml-lang="en-US"><literal>Search term;Alternative entry;1st key;2nd key;Match case;Word only</literal></paragraph>
<paragraph id="par_id3156270" role="paragraph" xml-lang="en-US">The entries "Match case" and "Word only" are interpreted as "No" or FALSE if they are empty or zero (0). All other contents are interpreted as "Yes" or TRUE.</paragraph>

<h3 id="hd_id3145778">Example</h3>
<paragraph id="par_id3155907" role="paragraph" xml-lang="en-US">For example, to include the word "Boston" in your alphabetical index under the "Cities" entry, enter the following line in the concordance file:</paragraph>
<paragraph id="par_id3151370" role="paragraph" xml-lang="en-US"><literal>Boston;Boston;Cities;;0;0</literal> <comment>UFI: translate this with same name as in par_id3155907. Pay attention to the following paras also</comment></paragraph>
<paragraph id="par_id3151383" role="paragraph" xml-lang="en-US">This also finds "Boston" if it is written in lowercase letters.</paragraph>
<paragraph id="par_id3155866" role="paragraph" xml-lang="en-US">To include the "Beacon Hill" district in Boston under the "Cities" entry, enter the following line:</paragraph>
<paragraph id="par_id3150116" role="paragraph" xml-lang="en-US"><literal>Beacon Hill;Boston;Cities;</literal></paragraph>
</body>

</helpdocument>