]> git.lyx.org Git - lyx.git/blobdiff - lib/doc/AdvancedSearch.lyx
Add to credit, sorry Edwin your 2c seem to be the only ones
[lyx.git] / lib / doc / AdvancedSearch.lyx
index 45e2f0a48f35d3649bf75ddc7696713c7d121ca9..d6d6ba4f5b2a845b44249b4c6d285f6616fecf75 100644 (file)
@@ -1,5 +1,5 @@
 #LyX 2.0.0svn created this file. For more info see http://www.lyx.org/
-\lyxformat 374
+\lyxformat 376
 \begin_document
 \begin_header
 \textclass amsart
@@ -9,6 +9,7 @@ theorems-ams
 eqs-within-sections
 figs-within-sections
 \end_modules
+\maintain_unincluded_children false
 \language english
 \inputencoding auto
 \fontencoding global
@@ -61,21 +62,6 @@ figs-within-sections
 
 \begin_layout Title
 Advanced Find&Replace
-\begin_inset Foot
-status collapsed
-
-\begin_layout Plain Layout
-This document is currently maintained by Tommaso Cucinotta, the main developer
- of this feature at the moment.
- For suggestions, comments or clarification requests regarding this document,
- as well as for notifying possible issues or bugs arising from the use of
- this feature, please use the standard support channels of LyX (i.e., bug
- tracking and mailing lists).
-\end_layout
-
-\end_inset
-
-
 \end_layout
 
 \begin_layout Author
@@ -87,8 +73,21 @@ Introduction
 \end_layout
 
 \begin_layout Standard
-The Advanced Find&Replace feature of LyX allows for searching of complex,
- format-sensitive text segments and mathematics contents within LyX documents.
+The Advanced Find&Replace feature
+\begin_inset Foot
+status collapsed
+
+\begin_layout Plain Layout
+For suggestions, comments or clarification requests regarding this document,
+ as well as for notifying possible issues or bugs arising from the use of
+ this feature, please use the standard support channels of LyX (i.e., bug
+ tracking and mailing lists).
+\end_layout
+
+\end_inset
+
+ of LyX allows for searching of complex, format-sensitive text segments
+ and mathematics contents within LyX documents.
  This constitutes an enhancement of the standard (quick) Find&Replace feature.
 \end_layout
 
@@ -132,7 +131,20 @@ search may be restricted so as to match only at word-boundaries;
 search may be format-insensitive, so that the searched text is found in
  any context/style (standard text, section headings, notes, and even mathematics
 ), or it may be format-sensitive, so that, for example, a word entered with
- a section heading will only be found within section headings.
+ a section heading will only be found within section headings;
+\end_layout
+
+\begin_layout Itemize
+search may be widened to a specific 
+\emph on
+scope
+\emph default
+, i.e., a set of files which may be all the children of the document being
+ edited, all the open files, or all the manuals available from the 
+\noun on
+Help
+\noun default
+ menu.
 \end_layout
 
 \begin_layout Standard
@@ -202,6 +214,56 @@ The advanced Find&Replace feature of LyX is activated through the [C-S-f]
 Edit->Find&Replace (Advanced)
 \noun default
  menĂ¹ item.
+ This causes the Advanced Find&Replace dialog to show up, as shown in Figure
+\begin_inset space ~
+\end_inset
+
+
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "fig:AdvancedFindReplaceDialog"
+
+\end_inset
+
+.
+\begin_inset Wrap figure
+lines 0
+placement O
+overhang 0in
+width "40col%"
+status open
+
+\begin_layout Plain Layout
+\begin_inset Graphics
+       filename clipart/AdvancedFindAndReplace.png
+       lyxscale 60
+
+\end_inset
+
+
+\end_layout
+
+\begin_layout Plain Layout
+\begin_inset Caption
+
+\begin_layout Plain Layout
+\begin_inset CommandInset label
+LatexCommand label
+name "fig:AdvancedFindReplaceDialog"
+
+\end_inset
+
+The Advanced Find&Replace Dialog.
+\end_layout
+
+\end_inset
+
+
+\end_layout
+
+\end_inset
+
+
 \end_layout
 
 \begin_layout Subsection
@@ -214,12 +276,12 @@ Enter into the
 Find...
 
 \noun default
- LyX mini-editor a simple word, and search for occurrences of it by pushing
- the 
+ LyX mini-editor a simple word, and search for occurrences of it by clicking
on the 
 \noun on
 Next
 \noun default
- button below it (or just pressing 
+ button below it (or just pressing the 
 \noun on
 [Return]
 \noun default
@@ -227,7 +289,7 @@ Next
 \noun on
 [Enter
 \noun default
-]).
+] keys).
  The entered word is found both in text mode and in math mode, and both
  in emphasized, bold or normal face, and both in section titles and in standard
  text.
@@ -243,6 +305,25 @@ Next
  searches for the entered text backwards.
 \end_layout
 
+\begin_layout Standard
+While searching, the 
+\noun on
+case sensitive
+\noun default
+ option allows matches to occur only with the same case as entered in the
+\noun on
+Find...
+
+\noun default
+ box.
+ The 
+\noun on
+whole words
+\noun default
+ option allows matches to occur only at word boundaries.
+\end_layout
+
 \begin_layout Subsection
 Searching for mathematics
 \end_layout
@@ -346,6 +427,155 @@ finds only instances of the text within the same kind of mathematical environmen
 t.
 \end_layout
 
+\begin_layout Subsection
+Replace
+\end_layout
+
+\begin_layout Standard
+The text segments matching the text entered in the 
+\noun on
+Find...
+
+\noun default
+ LyX mini-editor may be replaced with the text segments entered in the 
+\noun on
+Replace...
+
+\noun default
+ LyX mini-editor.
+ In order to find the next occurrence and replace it, click on the 
+\noun on
+Next
+\noun default
+ and 
+\noun on
+Prev
+\noun default
+ buttons below the 
+\noun on
+Replace...
+
+\noun default
+ mini-editor.
+ Alternatively, you can use the [
+\noun on
+Enter
+\noun default
+] and [
+\noun on
+Shift+Enter
+\noun default
+] keys while in the 
+\noun on
+Replace...
+
+\noun default
+ LyX mini-editor.
+\end_layout
+
+\begin_layout Standard
+You can replace full-featured formatted LyX segments in place of the matching
+ text segments in your document.
+ Typical scenarios in which to use this capability may be (just to mention
+ a few):
+\end_layout
+
+\begin_layout Itemize
+replacing occurrences of a word with a customized formatted version of the
+ same word, for example replacing occurrences of a name like 
+\begin_inset Quotes eld
+\end_inset
+
+func()
+\begin_inset Quotes erd
+\end_inset
+
+ with its monospace version 
+\family typewriter
+
+\begin_inset Quotes eld
+\end_inset
+
+func()
+\begin_inset Quotes erd
+\end_inset
+
+;
+\end_layout
+
+\begin_layout Standard
+performing a notation rework of mathematical symbols, for example replacing
+ occurrences of 
+\begin_inset Quotes eld
+\end_inset
+
+
+\begin_inset Formula $R$
+\end_inset
+
+
+\begin_inset Quotes erd
+\end_inset
+
+ with 
+\begin_inset Quotes eld
+\end_inset
+
+
+\begin_inset Formula $\mathbb{R}$
+\end_inset
+
+
+\begin_inset Quotes erd
+\end_inset
+
+ (you may want to enable the 
+\noun on
+whole-words
+\noun default
+ and 
+\noun on
+case-sensitive
+\noun default
+ options and disable the 
+\family typewriter
+\noun on
+Ignore Format
+\family default
+\noun default
+ option in the 
+\family typewriter
+\noun on
+Advanced
+\family default
+\noun default
+ pane, in order to avoid replacing all 
+\begin_inset Quotes eld
+\end_inset
+
+R
+\begin_inset Quotes erd
+\end_inset
+
+ letters occurring in normal text), or occurrences of 
+\begin_inset Formula $x_{j}^{i}$
+\end_inset
+
+ with 
+\begin_inset Formula $x_{i,\, j}$
+\end_inset
+
+, or occurrences of 
+\begin_inset Formula $x[k]$
+\end_inset
+
+ with 
+\begin_inset Formula $x_{k}$
+\end_inset
+
+.
+\end_layout
+
 \begin_layout Section
 \begin_inset CommandInset label
 LatexCommand label
@@ -369,7 +599,7 @@ There is a regular expression based searching facility.
 \noun on
 [Match...]
 \noun default
- dropdown button or by typing [C-S-r].
+ dropdown button or by the [C-S-r] key sequence.
  Characters entered in the 
 \noun on
 Find...
@@ -405,20 +635,21 @@ Find...
 \begin_inset Formula $\frac{.*}{1+x^{2}}$
 \end_inset
 
-where the 
+ (where the 
 \begin_inset Formula $.*$
 \end_inset
 
  on the numerator is the match-everything regular expression that may be
- added by pressing the 
+ added by clicking on the 
 \noun on
 [Match...]->[Anything]
 \noun default
- button, or entering the regexp-mode through C-S-r and by typing 
+ button, or entering the regexp-mode through the [C-S-r] key sequence and
+ by typing 
 \begin_inset Formula $.*$
 \end_inset
 
-, finds all fractions with the given denominator.
+) finds all fractions with the given denominator.
 \end_layout
 
 \begin_layout Enumerate
@@ -490,5 +721,10 @@ Note that back references work both when occurring within the same regular
  in all entered regular expressions.
 \end_layout
 
+\begin_layout Standard
+Note that the use of back references in the replaced text is not (yet) implement
+ed.
+\end_layout
+
 \end_body
 \end_document