[Winmerge-svn] SF.net SVN: winmerge:[5718] trunk/Docs/Users/Manual
Windows visual diff and merge for files and directories
Brought to you by:
christianlist,
grimmdp
Menu
▾
▴
[Winmerge-svn] SF.net SVN: winmerge:[5718] trunk/Docs/Users/Manual
|
From: <ki...@us...> - 2008-08-01 18:32:15
|
Revision: 5718
http://winmerge.svn.sourceforge.net/winmerge/?rev=5718&view=rev
Author: kimmov
Date: 2008-08-01 18:32:08 +0000 (Fri, 01 Aug 2008)
Log Message:
-----------
PATCH: [ 2032801 ] Update doc using GUI default window config
Submitted by Denis Bradford
Modified Paths:
--------------
trunk/Docs/Users/Manual/Compare_dirs.xml
trunk/Docs/Users/Manual/Intro_diffs.xml
trunk/Docs/Users/Manual/Quick_start.xml
trunk/Docs/Users/Manual/screenshots/filecomp1.png
trunk/Docs/Users/Manual/screenshots/filecomp_diffpane1.png
trunk/Docs/Users/Manual/screenshots/filemerged1.png
trunk/Docs/Users/Manual/screenshots/foldercomp1.png
trunk/Docs/Users/Manual/screenshots/missing_lines.png
Added Paths:
-----------
trunk/Docs/Users/Manual/screenshots/multifoldercomp1.png
trunk/Docs/Users/Manual/screenshots/multifoldercomp2.png
trunk/Docs/Users/Manual/screenshots/multifoldercomp3.png
trunk/Docs/Users/Manual/screenshots/restore_btn.png
Modified: trunk/Docs/Users/Manual/Compare_dirs.xml
===================================================================
--- trunk/Docs/Users/Manual/Compare_dirs.xml 2008-08-01 14:46:57 UTC (rev 5717)
+++ trunk/Docs/Users/Manual/Compare_dirs.xml 2008-08-01 18:32:08 UTC (rev 5718)
@@ -37,9 +37,9 @@
<listitem>
<para>Run <command>WinMergeU.exe</command>, which is in your WinMerge
install directory. In your command arguments, include the left and
- right folders to compare. By default, the compare is includes all
- files in the folders, and is nonrecursive. To change any of these
- options and for information about other command options, see <xref
+ right folders to compare. By default, the compare includes all files
+ in the folders, and is nonrecursive. To change any of these options
+ and for information about other command options, see <xref
linkend="CommandLine" />.</para>
</listitem>
</varlistentry>
@@ -134,7 +134,7 @@
<mediaobject>
<imageobject>
- <imagedata contentwidth="637" fileref="screenshots/foldercomp1.png"
+ <imagedata contentwidth="600" fileref="screenshots/foldercomp1.png"
format="PNG" />
</imageobject>
</mediaobject>
@@ -305,6 +305,80 @@
</section>
<section>
+ <title>Working with multiple Folder Compare windows</title>
+
+ <para>By default, the WinMerge window displays a single Folder Compare
+ window. That is, if you start another file comparison while a Folder Compare
+ window is currently open, the new Compare window replaces the current one.
+ If you prefer to work with multiple compare operations simultaneously,
+ consider setting (checking) the <guilabel>Enable multiple compare windows
+ for Folder compare</guilabel> option. </para>
+
+ <section>
+ <title>Using the Tab bar with maximized compare windows</title>
+
+ <para>If you open multiple Compare windows, they are displayed by default
+ as individually resizeable child windows within the WinMerge window, like
+ this:</para>
+
+ <mediaobject>
+ <imageobject>
+ <imagedata contentwidth="569"
+ fileref="screenshots/multifoldercomp1.png" format="PNG" />
+ </imageobject>
+
+ <caption><para>Multiple Folder Compare windows: default
+ display</para></caption>
+ </mediaobject>
+
+ <para>Often, it's convenient to maximize your Compare window (by clicking
+ its Maximixe button). The window then fills all the available space in the
+ WinMerge window. The screen shot below shows a maximized Compare
+ window.</para>
+
+ <mediaobject>
+ <imageobject>
+ <imagedata contentwidth="569"
+ fileref="screenshots/multifoldercomp2.png" format="PNG" />
+ </imageobject>
+
+ <caption><para>Multiple Comparison windows: maximized</para></caption>
+ </mediaobject>
+
+ <para>When you maximize one Compare window, any other Compare windows are
+ hidden, as shown in the preceding screen shot. To access those windows,
+ you could return to the default view by clicking the <inlinemediaobject>
+ <imageobject>
+ <imagedata contentwidth="15" fileref="screenshots/restore_btn.png" />
+ </imageobject>
+
+ <textobject>
+ <phrase>Restore button</phrase>
+ </textobject>
+ </inlinemediaobject> Restore button. A better solution is to enable tabs
+ by setting (checking) <menuchoice>
+ <guimenu>View</guimenu>
+
+ <guimenuitem>Tab Bar</guimenuitem>
+ </menuchoice>.</para>
+
+ <para>When you display the Tab bar, each Compare window has a tab that
+ shows the filenames of the two compared files. Now, you can easily
+ identify and display any available Compare window, and the selected
+ Compare window remains maximized:</para>
+
+ <mediaobject>
+ <imageobject>
+ <imagedata contentwidth="569"
+ fileref="screenshots/multifoldercomp3.png" format="PNG" />
+ </imageobject>
+
+ <caption><para>Multiple Comparison windows: tabbed</para></caption>
+ </mediaobject>
+ </section>
+ </section>
+
+ <section>
<title>File operations in Folder Compare<indexterm>
<primary>file operations</primary>
@@ -760,8 +834,8 @@
<listitem>
<para>If you browse to a subfolder that exists only the left or
right side, WinMerge can create a new, matching folder on the other
- side. See <xref linkend="CompareDirs_browse_unique" /> for details.
- </para>
+ side. See <xref linkend="CompareDirs_browse_unique" /> for
+ details.</para>
</listitem>
</varlistentry>
</variablelist>
Modified: trunk/Docs/Users/Manual/Intro_diffs.xml
===================================================================
--- trunk/Docs/Users/Manual/Intro_diffs.xml 2008-08-01 14:46:57 UTC (rev 5717)
+++ trunk/Docs/Users/Manual/Intro_diffs.xml 2008-08-01 18:32:08 UTC (rev 5718)
@@ -19,21 +19,22 @@
difference/merging tools like WinMerge are designed make this work more
systematic and efficient.</para>
- <para>For example, a spell checker is a difference utility that most people
- have used: it can systematically step you through a document, highlight
- words that are different from those in its dictionary, and help you resolve
- each spelling problem. However, looking only at characters and words is not
- an effective way to do more complicated comparisons: many text utilities use
- lines as the basic unit of comparison instead.</para>
+ <para>A simple difference utility that most people have used is a spell
+ checker: it systematically steps you through a document, highlights words
+ that are different from those in its dictionary, and helps you resolve each
+ spelling problem. However, looking only at characters and words is not an
+ effective way to understand differences between multiple files. For this
+ reason, many difference utilities use lines as the basic unit of comparison
+ instead.</para>
<para>WinMerge also uses lines as its basic unit of difference. Words and
- spaces are not treated individually in comparing and merging operations. To
- illustrate, consider two files that are identical except for one line that
- is different. If the two versions of the line have four words that are
+ characters are not treated individually in comparing and merging operations.
+ To illustrate, consider two files that are identical except for one line
+ that is different. If the two versions of the line have four words that are
different and one version has an extra space, then we say that the file has
one difference, not five.</para>
- <para>If it's quicker to compare lines than characters, sometimes it's also
+ <para>If it's quicker to compare lines than words, sometimes it's also
useful to treat an entire block of lines as a single difference, instead of
comparing one line at a time. As we will see later, detecting multiple-line
differences makes merging more efficient too.</para>
@@ -53,8 +54,8 @@
<formalpara>
<title>Fle1:</title>
- <para><screen>It's hard to compare words
-and merge them. So instead
+ <para><screen>It's slow comparing words
+and characters. Instead,
WinMerge compares lines.
Believe it or else.</screen></para>
</formalpara>
@@ -62,7 +63,7 @@
<formalpara>
<title>File2:</title>
- <para><screen>It's hard to compare words.
+ <para><screen>It's slow comparing words.
WinMerge compares lines.
Believe it or not.</screen></para>
</formalpara>
@@ -85,11 +86,11 @@
<filename>File1</filename> as the <guilabel>Left</guilabel> file and
<filename>File2</filename> as the <guilabel>Right</guilabel> file,
then click <guibutton>OK</guibutton>. The File Compare window displays
- the two files in the left and right pane, like this:</para>
+ the two files in the left and right document pane, like this:</para>
<mediaobject>
<imageobject>
- <imagedata contentwidth="592"
+ <imagedata contentwidth="600"
fileref="screenshots/missing_lines.png" />
</imageobject>
@@ -118,7 +119,7 @@
<listitem>
<para>WinMerge marks differences with various background colors
(which you can configure in WinMerge options). The basic
- difference color is gold, by default. Within each line
+ difference color is dark yellow, by default. Within each line
difference, WinMerge marks words and characters that are
different with a lighter background color. Identical lines (like
the third line in the example) are unmarked: they have white
@@ -200,7 +201,7 @@
<mediaobject>
<imageobject>
- <imagedata contentwidth="573"
+ <imagedata contentwidth="588"
fileref="screenshots/filecomp_diffpane1.png" />
</imageobject>
@@ -360,7 +361,7 @@
<mediaobject>
<imageobject>
- <imagedata contentwidth="592"
+ <imagedata contentwidth="600"
fileref="screenshots/filemerged1.png" format="PNG" />
</imageobject>
</mediaobject>
@@ -381,15 +382,19 @@
</keycombo> to save your changes.</para>
</listitem>
</orderedlist>
+
+ <para>While very simple, this example demonstrates a basic methodology
+ that you can use to step through a comparison of any length, merging each
+ difference one by one until you have the result that you want.</para>
</section>
<section>
<title>Choosing a merge result file</title>
- <para>You control where your merge result is preserved. The WinMerge
- Compare window does not have a separate result pane, unlike some merge
- tools. So the simplest strategy is to save your changes in one or both
- source files. Press <keycombo>
+ <para>You control where your merge result is preserved. The WinMerge File
+ Compare window does not have a separate result pane, as some merge tools
+ do. So the simplest strategy is to save your changes to one or both source
+ files. Press <keycombo>
<keycap>Ctrl</keycap>
<keycap>S</keycap>
Modified: trunk/Docs/Users/Manual/Quick_start.xml
===================================================================
--- trunk/Docs/Users/Manual/Quick_start.xml 2008-08-01 14:46:57 UTC (rev 5717)
+++ trunk/Docs/Users/Manual/Quick_start.xml 2008-08-01 18:32:08 UTC (rev 5718)
@@ -304,9 +304,16 @@
<secondary>basic usage</secondary>
</indexterm>Comparing folders</title>
+ <para>If you selected two folders in the Open dialog, the Folder Compare
+ window is opened. The Folder Compare window is a tabular list of items found
+ in the compared folders. Each row displays information about a found file,
+ with the file name in the left column and additional information in the
+ other columns:</para>
+
<mediaobject>
<imageobject>
- <imagedata fileref="screenshots/foldercomp1.png" format="PNG" />
+ <imagedata contentwidth="600" fileref="screenshots/foldercomp1.png"
+ format="PNG" />
</imageobject>
<textobject>
@@ -314,20 +321,14 @@
</textobject>
</mediaobject>
- <para>If you selected two folders in the Open dialog, the Folder Compare
- window is opened. The Folder Compare window is a tabular list of items found
- in the compared folders. Each row displays information about a found file,
- with the file name in the left column and additional information in the
- other columns.</para>
-
<para>WinMerge does not have a concept of <wordasword>original</wordasword>
and <wordasword>changed</wordasword> sides. Instead, it simply shows what is
different between two selected folders. For example, a file or folder that
is found only on one side is simply shown as a unique item on that side. It
- is not shown as added or removed. In the preceding figure, notice that the
- <guilabel>Comparison result </guilabel>column lists
- <filename>Merge.aps</filename> and <filename>Merge.rc.bak</filename> as
- found only in the left comparison folder.</para>
+ is not shown as added or removed. For example, in the <guilabel>Comparison
+ result </guilabel>column of the preceding figure,
+ <filename>Merge.aps</filename> and <filename>Merge.rc.bak</filename> are
+ each found in only one of the compared folders.</para>
<para>You can manage files and folders in many ways using the
<guimenu>Merge</guimenu> menu, toolbar buttons, or context (right-click)
@@ -372,10 +373,10 @@
</textobject>
</inlinemediaobject> up arrow at the top of the Filename column.</para>
- <para>If you compare a file, WinMerge opens File Compare window with a new
- tab, as shown in the figure in the next section. Then, if you make changes
- in the File Compare window, the file's data is updated in the Folder Compare
- window.</para>
+ <para>If you compare a file, WinMerge opens the File Compare window,
+ described in the next section. If you change a file in the File Compare
+ window, and then return to the Folder Compare window, you will see the
+ file's data is updated there.</para>
</section>
<section id="QuickStart_comparingfiles">
@@ -391,7 +392,8 @@
<mediaobject>
<imageobject>
- <imagedata fileref="screenshots/filecomp1.png" format="PNG" />
+ <imagedata contentwidth="600" fileref="screenshots/filecomp1.png"
+ format="PNG" />
</imageobject>
<textobject>
@@ -399,11 +401,12 @@
</textobject>
</mediaobject>
- <para>The File Compare window shows the two versions of the selected files
- side by side. Different lines are highlighted with a background color. One
- or more consecutive different lines form one difference (or
- <glossterm>diff</glossterm>). WinMerge mainly works with these differences,
- not separate lines.</para>
+ <para>The File Compare window shows the two selected files side by side, in
+ separate document panes. Different lines are highlighted with a background
+ color. One or more consecutive different lines form one difference (or
+ <glossterm>diff</glossterm>). In the preceding example, a single difference
+ is selected in the document panes, which displays it in the Diff Pane.
+ WinMerge mainly works with these differences, not separate lines.</para>
<para><important>
<para>Notice how WinMerge fills missing lines, so that similar lines are
Property changes on: trunk/Docs/Users/Manual/screenshots/multifoldercomp1.png
___________________________________________________________________
Added: svn:mime-type
+ application/octet-stream
Property changes on: trunk/Docs/Users/Manual/screenshots/multifoldercomp2.png
___________________________________________________________________
Added: svn:mime-type
+ application/octet-stream
Property changes on: trunk/Docs/Users/Manual/screenshots/multifoldercomp3.png
___________________________________________________________________
Added: svn:mime-type
+ application/octet-stream
Property changes on: trunk/Docs/Users/Manual/screenshots/restore_btn.png
___________________________________________________________________
Added: svn:mime-type
+ application/octet-stream
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
|