Thread: [Winmerge-svn] SF.net SVN: winmerge:[5659] trunk/Docs/Users/Manual
Windows visual diff and merge for files and directories
Brought to you by:
christianlist,
grimmdp
From: <ki...@us...> - 2008-07-23 12:04:51
|
Revision: 5659 http://winmerge.svn.sourceforge.net/winmerge/?rev=5659&view=rev Author: kimmov Date: 2008-07-23 12:04:48 +0000 (Wed, 23 Jul 2008) Log Message: ----------- PATCH: [ 2024587 ] Revised help topics Rewriting folder compare documentation. Submitted by Denis Bradford Modified Paths: -------------- trunk/Docs/Users/Manual/Compare_dirs.xml trunk/Docs/Users/Manual/Open_paths.xml trunk/Docs/Users/Manual/Quick_start.xml trunk/Docs/Users/Manual/screenshots/foldercomp1.png Added Paths: ----------- trunk/Docs/Users/Manual/screenshots/ctx_menu_copy1.png trunk/Docs/Users/Manual/screenshots/ctx_menu_simple2.png trunk/Docs/Users/Manual/screenshots/foldercmp_unique1.png trunk/Docs/Users/Manual/screenshots/foldercmp_unique2.png trunk/Docs/Users/Manual/screenshots/foldercomp_2same.png Modified: trunk/Docs/Users/Manual/Compare_dirs.xml =================================================================== --- trunk/Docs/Users/Manual/Compare_dirs.xml 2008-07-22 16:32:39 UTC (rev 5658) +++ trunk/Docs/Users/Manual/Compare_dirs.xml 2008-07-23 12:04:48 UTC (rev 5659) @@ -1,68 +1,215 @@ <?xml version="1.0" encoding="UTF-8"?> <article id="CompareDirs"> - <title>Comparing Folders</title> + <title>Comparing folders<indexterm> + <primary>comparing folders</primary> + </indexterm></title> - <para>The Folder compare window displays all of the files and subfolders - compared in a sortable list view. Files and subfolders may be synchronized - by copying or deleting, and actions may be performed on multiple items - simultaneously. The columns displayed may be changed and reordered.</para> + <para>This topic describes how to compare and merge folders using the Folder + Compare window.</para> - <mediaobject> - <imageobject> - <imagedata fileref="screenshots/foldercomp1.png" format="PNG" /> - </imageobject> - </mediaobject> + <section> + <title>Starting a folder compare operation</title> - <para>Folder comparison has two different modes. The mode is selected in the - Open dialog with the "<guilabel>Include - Subfolders</guilabel>"-checkbox.<itemizedlist> - <listitem> - <para>When subfolders are included, all subfolders and their contents - are compared. Files are displayed depending on the options on the - <guimenu>View</guimenu> menu (eg, <guimenuitem>Show Identical - Files</guimenuitem>). Common folders are never displayed (but all - files inside of them are). Folders only existing on one side are - displayed according to the <guimenu>View</guimenu> menu options (eg, - <guimenuitem>Show Left Unique Files</guimenuitem>).</para> + <para>You can begin a folder compare operation from either the WinMerge + window or a Command Prompt window.</para> - <para>This mode does not allow browsing folders and can be slow if - there are many subfolders and files. But it is easy to see and handle - different files in whole folder structure.</para> - </listitem> + <variablelist> + <varlistentry> + <term>From the WinMerge window</term> - <listitem> - <para>When subfolders are not included only files in selected folders - and names of subfolders are shown.</para> + <listitem> + <para>Click <menuchoice> + <guimenu>File</guimenu> - <para>This mode allows browsing folders by opening subfolders and - parent folders. This mode has the advantage of speed, as it may be - much faster when there are many subfolders that need not be examined. - Also the display may be easier to manage, showing only items in one - folder.</para> - </listitem> - </itemizedlist></para> + <guimenuitem>Open</guimenuitem> + </menuchoice>. Use the Select Files or Folders dialog to specify the + left and right folders to compare. By default, the compare includes + all files in the folders, and is nonrecursive (does not include + subfolders). To change any of these options and for more details about + the Select Files or Folder dialog, see <xref + linkend="OpenPaths" />.<!--This topic focuses mainly on the WinMerge window method.--></para> + </listitem> + </varlistentry> - <para>In WinMerge version 2.4 and later there is a <guilabel>Compare by - Quick Contents</guilabel> -compare method which makes possible to compare - big binary files. For more information about different compare methods see - <link linkend="Configuration">Options & configuration</link> -chapter. - In WinMerge version 2.4 and later all files bigger than 4 MB (megabytes) are - automatically compared with Compare by Quick Contents -method. Downsides for - this method are that linefilters do not work and there is no difference - counts information in folder compare UI. For most cases this should not - matter since so big files usually are binary files.</para> + <varlistentry> + <term>From a Command Prompt window</term> - <para>For advanced users: If that limit does not feel good (you have lots of - big text files) it can be changed via registry value: <screen>HKEY_CURRENT_USER\Software\Thingamahoochie\WinMerge\Settings\QuickMethodLimit</screen>. - As usual be careful when changing values directly to registry!</para> + <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 + linkend="CommandLine" />.</para> + </listitem> + </varlistentry> + </variablelist> + <tip> + <para>Recursive mode is useful for detecting and manipulating different + files in an entire folder structure. However, it can be slow if there are + many subfolders and files.</para> + + <para>Nonrecursive mode has the advantage of speed when there are many + subfolders that need not be examined. Also, the display can be easier to + manage because it shows items in only selected folders.</para> + </tip> + + <note> + <title>Compare by Quick Contents option</title> + + <para>WinMerge 2.4 introduced the <guilabel>Quick Contents</guilabel> + method for file comparison, described in <xref linkend="Configuration" />. + This method can be useful when you compare big binary files; and it is + automatically used to compare files bigger than 4 MB. Possible + disadvantages are that line filters do not work, and there is no + difference counts information in the Folder Compare window. This should + not matter In most cases, because such large files are usually + binary.</para> + + <para>To use this method, configure it before your compare operation: in + the Compare page of the WinMerge options, click the <guilabel>File Compare + method</guilabel> drop-down menu and choose <guimenuitem>Quick + Contents</guimenuitem>.</para> + </note> + + <note> + <title>For advanced users</title> + + <para>You can change the 4 MB file size limit of the <guilabel>Compare by + Quick Contents</guilabel>, for example if you have a lot of very big text + files. To do so, run the Windows <command>regedit</command> command, + navigate to this keyword, and modify its value: <screen>HKEY_CURRENT_USER\Software\Thingamahoochie\WinMerge\Settings\QuickMethodLimit</screen>As + usual, be careful when changing values directly in the registry!</para> + </note> + + <section> + <title>Folder Compare Progress window<indexterm> + <primary>Folder Compare Progress window</primary> + </indexterm></title> + + <para>When you start a folder compare operation, WinMerge displays this + status window:</para> + + <mediaobject> + <imageobject> + <imagedata fileref="screenshots/foldercmp_progress.png" format="PNG" /> + </imageobject> + + <textobject> + <phrase>Folder Compare Progress window</phrase> + </textobject> + </mediaobject> + + <para>If the compare operation is quick, you might not notice the Progress + window, which closes as soon as WinMerge displays the Folder Compare + result. The Progress window shows the number of files and folders to be + included in the operation, and the number compared so far. The progress + bar graphically represents the Items compared.</para> + + <note> + <para>Because the files compares are usually of different sizes, the + status data does not indicate the time used or remaining. For example, a + 50/100 ratio does not necessarily mean that half of the compare + operation time is expired.</para> + </note> + + <para>You can click <guibutton>Stop</guibutton> to terminate the operation + at any time before the compare operation finishes. The Folder Compare + window is displayed with the results calculated at that time, omitting any + uncompleted results.<!--I'm not able to reproduce the behavior documented in the earlier version of this topic: +I get the partial list, but no Abort indicator.--></para> + + <note> + <title>Note to users of previous WinMerge versions</title> + + <para>The new Progress window was one of most visible changes in + WinMerge Version 2.6. The new design is simpler, eliminating details + that were not useful for comparing. Also, the window is closed + automatically because the data is no longer needed: you can view + statistics for the current results by clicking <menuchoice> + <guimenu>View</guimenu> + + <guimenuitem>Compare Statistics</guimenuitem> + </menuchoice>.</para> + </note> + </section> + </section> + <section> - <title><indexterm> - <primary>Folder Compare Result</primary> - </indexterm>Compare Results</title> + <title>Folder Compare window<indexterm> + <primary>Folder Compare window</primary> + </indexterm></title> - <para>Files and folders are compared and divided into several categories. - Categories are easy to recognize from these icons:<simplelist> + <para>The Folder Compare window shows the result of a folder compare in a + tabular view. Each row lists a file, parent folder, or subfolder in the + result, and the columns show different types of data for each item. You can + customize the table by changing the sorting of rows or the types of column + data displayed. Here is an example of a folder compare result:</para> + + <mediaobject> + <imageobject> + <imagedata contentwidth="637" fileref="screenshots/foldercomp1.png" + format="PNG" /> + </imageobject> + </mediaobject> + + <section> + <title>Recursive and nonrecursive compare results<indexterm> + <primary>recursive folder compare</primary> + + <secondary>results view</secondary> + </indexterm><indexterm> + <primary>nonrecursive folder compare</primary> + + <secondary>results view</secondary> + </indexterm></title> + + <para>The Folder Compare window looks and behaves slightly differently for + recursive and nonrecursive compares:</para> + + <variablelist> + <varlistentry> + <term>Recursive folder compare</term> + + <listitem> + <para>The compare result includes all subfolders. You can control + the types of items displayed within the folders by choosing the + options in the <guimenu>View</guimenu> menu (for example, + <guimenuitem>Show Identical Items</guimenuitem>). The Folder column + is always empty: only the files within the folders are displayed. To + see an item's subfolder, look at its path in the Compare result + column. Folders that exist on only one side are displayed if one of + the <guimenu>View</guimenu> menu options, <guimenuitem>Show Left + Unique Files</guimenuitem> or <guimenuitem>Show Left Unique + Files</guimenuitem>, is enabled.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term>Nonrecursive folder compare</term> + + <listitem> + <para>The result includes only the files and subfolders at the top + level of the selected folders. However, you can browse to any + subfolder that you want to compare.</para> + </listitem> + </varlistentry> + </variablelist> + </section> + + <section> + <title>File and folder icons<indexterm> + <primary>icons</primary> + + <secondary>Folder Compare window</secondary> + </indexterm></title> + + <para>In the Compare Folders window, files and folders are compared and + divided into several categories. In each row, the category is clearly + identified in the left column with one of these icons :</para> + + <simplelist> <member><inlinemediaobject> <imageobject> <imagedata fileref="screenshots/equal.png" format="PNG" /> @@ -136,537 +283,872 @@ </imageobject> </inlinemediaobject> Aborted item. WinMerge did not finish comparing this item when compare was stopped. Result is unknown.</member> - </simplelist></para> + </simplelist> + </section> + + <section> + <title>Navigating the Folder Compare window</title> + + <para>You can use the mouse as well as keyboard and context menu shortcuts + to navigate the Folder Compare window. You can also use the toolbar + buttons. For example, the <inlinemediaobject> + <imageobject> + <imagedata contentdepth="15" fileref="screenshots/nextdiff_btn.png" /> + </imageobject> + + <textobject> + <phrase>Next Difference button</phrase> + </textobject> + </inlinemediaobject> <guimenuitem>Next Difference</guimenuitem> button + finds the next different file or folder and selects it.</para> + + <note> + <para>Unique files and folders are navigated in the same way as + different ones.</para> + </note> + + <para>You can select multiple files and folders. However, some operations + (like <command>Rename</command>) are not available with multiple + selections.</para> + + <para>Use the navigation buttons (<guibutton>Next Difference</guibutton>, + <guibutton>Previous Difference</guibutton>, and so on) to step through + differences in the compared files. Use WinMerge functions to merge + contents by copying, moving, or delete one or more files or + subfolders.</para> + </section> </section> <section> - <title>Folder Compare Status</title> + <title>File operations in Folder Compare<indexterm> + <primary>file operations</primary> - <para>During the folder comparison WinMerge shows status panel:</para> + <secondary>in Folder Compare window</secondary> + </indexterm></title> - <para><mediaobject> - <imageobject> - <imagedata fileref="screenshots/foldercmp_progress.png" format="PNG" /> - </imageobject> - </mediaobject></para> + <para>The Folder Compare window supports common operations on files, like + editing, copying, deleting, moving, and renaming (moving is equivalent to a + copy operation followed by a delete). You can use these file operations and + some special WinMerge functions to merge the contents of folders. You can + also open files using associated programs or external editors.</para> - <para>The panel shows approximate status and progress of the compare. - Status is shown as a number of items and a progressbar. Numbers show how - many items (files and folders) WinMerge has found to compare. Progressbar - shows same info graphically.</para> + <para>The most convenient way to perform most of these tasks is to + right-click one or more items and use the context menu, where all file + operations are available.</para> - <important> - <para>Progressbar is for item counts. As there usually are different - sized files in compare it does not directly map to time used/remaining. - So 50/100 items does not strictly mean compare is in half by time - used.</para> - </important> + <section> + <title>Copying files<indexterm> + <primary>copying files</primary> - <para>Folder compare can be stopped by selecting - <guibutton>Stop</guibutton>-button and results for files and folders - compared so far are shown. When compare is stopped before it finishes, - some files may be in middle of comparison. Those files are marked as - <guilabel>Aborted</guilabel> in comparison results. It means result is not - available for them.</para> + <secondary>in Folder Compare window</secondary> + </indexterm></title> - <para>When folder compare is ready status panel is closed and results are - shown.</para> + <para>The most common file operation in the Folder Compare window is + copying files from side to side. There are several forms of the WinMerge + copy function: all of them copy only files that are different, because + copying identical files is of no use in merging. The copy functions are + available in the context menu, in the WinMerge menu, and in the + toolbar:</para> - <note> - <para>This is one of most visible changes in WinMerge version 2.6. New - status panel may feel "just too simple" after using previous WinMerge - versions. The fact is most of the details in previous versions were - useless during the compare. So simplicity was choosen for new design. - Automatic closing may also feel weird at starters. But there is no - information visible that would be needed after the compare.</para> - </note> + <section> + <title>Context menu Copy shortcuts</title> - <para>Compare statistics are visible in separate dialog which can be - opened after compare from menu: <menuchoice> - <guimenu>View</guimenu> + <para>In the Folder Compare window's context menu, the + <guimenuitem>Copy</guimenuitem> item has a submenu with four + shortcuts:</para> - <guimenuitem>Compare Statistics</guimenuitem> - </menuchoice>.</para> - </section> + <mediaobject> + <imageobject> + <imagedata contentwidth="526" + fileref="screenshots/ctx_menu_copy1.png" format="PNG" /> + </imageobject> - <section> - <title>Selecting Items to Show</title> + <textobject> + <phrase>Folder Compare window Copy context menu</phrase> + </textobject> + </mediaobject> - <para>In "<guimenu>View</guimenu>" menu there are several choices for - selecting which categories to show / hide.</para> + <itemizedlist> + <listitem> + <para><guimenuitem>Left to Right</guimenuitem> and + <guimenuitem>Right to Left</guimenuitem> copy the selection (or just + the items in the selection that can be copied) from one side to the + other. In the example, the suffix <guilabel>(2 of 4)</guilabel> + indicates that only the two files that are different will be copied; + the identical files will not. These shortcuts available only if any + of the files you select is different: if you select only identical + files, the shortcuts are unavailable.</para> + </listitem> - <itemizedlist> - <listitem> - <simpara><guimenuitem>Show identical files</guimenuitem> : shows and - hides files detected as identical</simpara> - </listitem> + <listitem> + <para><guimenuitem>Left to...</guimenuitem> and <guimenuitem>Right + to...</guimenuitem> enable you to specify a copy target directory in + your system, instead of a compared folder. When the Browse for + Folder dialog opens, navigate to the target directory on your system + (or create a new target folder) and click + <guibutton>OK</guibutton>.</para> + </listitem> + </itemizedlist> + </section> - <listitem> - <simpara><guimenuitem>Show different files</guimenuitem> : shows and - hides files detected as different</simpara> - </listitem> + <section> + <title>Toolbar and menu Copy commands</title> - <listitem> - <simpara><guimenuitem>Show left unique files</guimenuitem> : shows and - hides files and directories present only in left side</simpara> - </listitem> + <para>In the Folder Compare toolbar, <inlinemediaobject> + <imageobject> + <imagedata contentwidth="17" + fileref="screenshots/copyr_button.png" /> + </imageobject> - <listitem> - <simpara><guimenuitem>Show right unique files</guimenuitem> : shows - and hides files and directories present only in right side</simpara> - </listitem> + <textobject> + <phrase>Copy Right button</phrase> + </textobject> + </inlinemediaobject> <guibutton>Copy Right</guibutton> and + <inlinemediaobject> + <imageobject> + <imagedata contentwidth="17" + fileref="screenshots/copyl_button.png" /> + </imageobject> - <listitem> - <simpara><guimenuitem>Show binary files</guimenuitem> : shows and - hides files detected as binaries</simpara> - </listitem> + <textobject> + <phrase>Copy Left button</phrase> + </textobject> + </inlinemediaobject> <guibutton>Copy Left</guibutton> accomplish the + same task as the <guimenuitem>Left to Right</guimenuitem> and + <guimenuitem>Right to Left</guimenuitem> context menu shortcuts: they + copy from side to side only files that are valid to copy. However, these + commands do not directly display the number of files to be copied; + instead, they display a confirmation dialog where you can check a list + of source and target file paths.</para> - <listitem> - <simpara><guimenuitem>Show skipped files</guimenuitem> : shows and - hides files and directories filtered out by file filters</simpara> - </listitem> - </itemizedlist> - </section> + <para>In the WinMerge menu, <menuchoice> + <guimenu>Merge</guimenu> - <section> - <title><indexterm> - <primary>Folder Compare Columns</primary> - </indexterm>Columns in Folder Compare</title> + <guimenuitem>Copy to Right</guimenuitem> + </menuchoice> and <menuchoice> + <guimenu>Merge</guimenu> - <para>By default these columns are visible:</para> + <guimenuitem>Copy to Left</guimenuitem> + </menuchoice> behave the same way as the toolbar Copy commands.</para> + </section> + </section> - <itemizedlist> - <listitem> - <simpara><guilabel>Filename</guilabel></simpara> - </listitem> + <section> + <title>Deleting files<indexterm> + <primary>deleting files</primary> - <listitem> - <simpara><guilabel>Folder</guilabel> : Relative folder name for - compare path. If subfolders are not included this is empty.</simpara> - </listitem> + <secondary>in Folder Compare window</secondary> + </indexterm></title> - <listitem> - <simpara><guilabel>Comparison result</guilabel> : Verbose comparison - result (see also <guilabel>Short Result</guilabel>)</simpara> - </listitem> + <para>You can use the <guimenuitem>Delete</guimenuitem> context menu item + to delete selected items in either or both sides. Like other file + operations, <guimenuitem>Delete</guimenuitem> has a submenu with + <guimenuitem>Left</guimenuitem>, <guimenuitem>Right</guimenuitem>, and + <guimenuitem>Both</guimenuitem> shortcuts.</para> - <listitem> - <simpara><guilabel>Left Date</guilabel> & <guilabel>Right - Date</guilabel>: Modification date of item. Note that newer date is - prefixed with asterisk "<guilabel>*</guilabel>".</simpara> - </listitem> + <warning> + <para>We highly recommend that you keep the <guilabel>Send deleted files + into Recycle Bin</guilabel> option enabled See <xref + linkend="Configuration" />), so that you can undo deletions in case of + accidents. In addition, you should keep Recycle Bin enabled: the + WinMerge option does not work if you disable the Recycle Bin in Windows. + Again, you cannot undo file or folder deletion unless you use both the + WinMerge <guilabel>Send deleted files into Recycle Bin</guilabel> option + and the Windows Recycle Bin!</para> + </warning> + </section> - <listitem> - <simpara><guilabel>Extension</guilabel> : File's extension, handy for - sorting</simpara> - </listitem> - </itemizedlist> + <section> + <title>Renaming files<indexterm> + <primary>renaming files</primary> - <para>Following columns are available through "<guimenuitem>Customize - Columns</guimenuitem>"-dialog:</para> + <secondary>in Folder Compare window</secondary> + </indexterm></title> - <itemizedlist> - <listitem> - <simpara><guilabel>Short Result</guilabel> : Result in shorter form - ("Right Only").</simpara> - </listitem> + <para>To rename a file or folder, choose <guimenuitem>Rename</guimenuitem> + in its context menu or press <keycap>F2</keycap>. Then change the name in + the edit box and press <keycap>Return</keycap>, or press + <keycap>Esc</keycap> to cancel. You can only rename a single file or + folder. Note that renaming changes items in both sides: it is not + currently possible to rename an item on just one side.</para> + </section> - <listitem> - <simpara><guilabel>Binary</guilabel> : Column contains an asterisk - "<guilabel>*</guilabel>" when the file is a binary file. This is handy - for sorting and to use with "<guilabel>Short - Result</guilabel>"-column.</simpara> - </listitem> + <section> + <title>Opening files<indexterm> + <primary>opening files</primary> - <listitem> - <simpara><guilabel>Left Attributes</guilabel> & <guilabel>Right - Attributes</guilabel> : Shows file attributes.</simpara> - </listitem> + <secondary>in Folder Compare window</secondary> + </indexterm></title> - <listitem> - <simpara><guilabel>Left Creation Time</guilabel> & <guilabel>Right - Creation Time</guilabel> : Item creation time.</simpara> - </listitem> + <para>In the context menu, you can use either <guimenuitem>Open + Left</guimenuitem> and <guimenuitem>Open Right</guimenuitem>, depending on + which side you want to operate on. Each <guimenuitem>Open</guimenuitem> + menu item has a submenu with these shortcuts:</para> - <listitem> - <simpara><guilabel>Left Encoding</guilabel> & <guilabel>Right - Encoding</guilabel> : File encoding. Shows codepage number for ANSI - files, and Unicode encoding for Unicode files.</simpara> - </listitem> + <variablelist> + <varlistentry> + <term><guimenuitem>with Registered Application</guimenuitem></term> - <listitem> - <simpara><guilabel>Left File Version</guilabel> & <guilabel>Right - File Version</guilabel> : Version number from file if present. Note - that this is read for only some binary file types known to usually - have a version resource.</simpara> - </listitem> + <listitem> + <para>Opens the file with the application (if any) that is + registered in Windows for the file's type.</para> - <listitem> - <simpara><guilabel>Left Size</guilabel> & <guilabel>Right - Size</guilabel> : File size in bytes.</simpara> - </listitem> + <tip> + <para>This shortcut usually opens a folder in a new Windows + Explorer.</para> + </tip> + </listitem> + </varlistentry> - <listitem> - <simpara><guilabel>Left Size (Short)</guilabel> & <guilabel>Right - Size (Short)</guilabel> : Shorter versions of file sizes, rounded to - kilo-, mega- or gigabytes.</simpara> - </listitem> + <varlistentry> + <term>with External Editor</term> - <listitem> - <simpara><guilabel>Newer File</guilabel> : Shows which side is - newer.</simpara> - </listitem> + <listitem> + <para>Opens the file with an external editor. The default editor is + Notepad, but you can configure a different one in WinMerge + options.</para> + </listitem> + </varlistentry> - <listitem> - <simpara><guilabel>Differences</guilabel> : Amount of differences - found between files, not including possibly ignored - differences.</simpara> - </listitem> + <varlistentry> + <term><guimenuitem>with...</guimenuitem></term> - <listitem> - <simpara><guilabel>Ignored Diff.</guilabel> : Amount of ignored - differences in files. These are differences ignored by line - filters.</simpara> - </listitem> + <listitem> + <para>Opens the <guilabel>Open With</guilabel> dialog, where you can + specify an application to open your file with.</para> + </listitem> + </varlistentry> + </variablelist> + </section> - <listitem> - <simpara><guilabel>Left EOL & Right EOL</guilabel> : Show EOL - style (linefeed style) of files.</simpara> - </listitem> - </itemizedlist> - </section> + <section> + <title>Copying pathnames or filenames<indexterm> + <primary>pathnames</primary> - <section> - <title>Browsing Folders</title> + <secondary>copying from Folder Compare window</secondary> + </indexterm><indexterm> + <primary>filenames</primary> - <para>Browsing folders is only possible when subfolders are not included - to compare (<guilabel>Include Subfolders</guilabel> checkbox is not - checked in <guilabel>Open</guilabel>-dialog). Parent folders - ("<guilabel>..</guilabel>"-item) and subfolders existing in both sides can - be compared by double-clicking with mouse over them or selecting them and - pressing <keycap>Enter</keycap>.</para> + <secondary>copying from Folder Compare window</secondary> + </indexterm></title> - <para>Sometimes parent folder cannot be opened (no access to it). These - two icons indicate if parent folder can be opened:</para> + <para>The context menu <guimenuitem>Copy Pathname</guimenuitem> and + <guimenuitem>Copy Filenames</guimenuitem> shortcuts copy the pathname or + filename of selected items to the Windows clipboard. You can then paste + the copied information into a file or application, for example to create a + list of changed files or a change log.</para> - <simplelist type="vert"> - <member><inlinemediaobject> - <imageobject> - <imagedata fileref="screenshots/folderup.png" format="PNG" /> - </imageobject> - </inlinemediaobject> Parent folder can be opened.</member> + <itemizedlist> + <listitem> + <para><guimenuitem>Copy Pathnames</guimenuitem> has a menu with three + shortcuts, similar to other file operations. It copies the full + pathnames of one or more selected items to the clipboard, one per + line.</para> + </listitem> - <member><inlinemediaobject> - <imageobject> - <imagedata fileref="screenshots/folderup_disable.png" format="PNG" /> - </imageobject> - </inlinemediaobject> Parent folder cannot be opened.</member> - </simplelist> + <listitem> + <para><guimenuitem>Copy Filenames</guimenuitem> copies only filenames + without paths.</para> + </listitem> + </itemizedlist> + </section> - <para>It is possible to browse both sides to the same folder (<filename - class="directory">C:\Work\</filename> and <filename - class="directory">C:\Work\</filename>). 2.6 and earlier versions of - WinMerge prevented this, but it restricted usage in some cases. In such - case both sides contain the exactly same files and folders.</para> + <section> + <title>Protecting files<indexterm> + <primary>Folder Compare window</primary> - <para>It is possible to select two different folders from the folder - compare and open them to different sides. First selected folder becomes - the left-side folder and second selected folder becomes the right-side - folder. This can be used in situation explained in previous paragraph when - there is same folder compared as both sides.</para> + <secondary>protecting files in</secondary> + </indexterm></title> - <section> - <title><indexterm> - <primary>Open Unique Folders</primary> - </indexterm>Unique Folders</title> + <para>To protect the files and folders on either side of a compare from + changes, enable the <menuchoice> + <guimenu>File</guimenu> - <para>WinMerge 2.6 and earlier could not open unique folders (folders - existing only in other side). An error message was shown about trying to - open unique folder. This restriction came from a fact that WinMerge - cannot compare existing folder to non-existing folder. If one wanted to - copy contents of unique folder, then whole folder structure must been - copied.</para> + <guimenuitem>Left Read-only</guimenuitem> + </menuchoice> or <menuchoice> + <guimenu>File</guimenu> - <para>Copying whole unique folder structure is many times not wanted. - WinMerge 2.8 allows creating the missing folder and browsing then into - that created folder. So that contents of original unique folder and - created empty folder can be compared. Now it is possible to copy just - one file (or subfolder) in unique folder.</para> + <guimenuitem>Right Read-only</guimenuitem> + </menuchoice> check box.</para> - <para>To navigate into unique folder, select the folder, and browse into - it as normally (press <keycap>Enter</keycap> -key, double-click over - foldername with mouse, or select - <guimenu>Merge</guimenu><guimenuitem>Compare</guimenuitem> from the - menu. WinMerge shows a message asking if the missing folder should be - created. Answer <guilabel>Yes</guilabel> to create the folder, or - <guilabel>No</guilabel> to cancel the action.</para> + <important> + <para>Setting the read-only option protects files and folders only in + the current compare view; it does not affect their Windows file + attributes.</para> + </important> + + <para>This protected status is inherited by files that you open in the + folder compare. For example, if you compare two folders, set one side + read-only, and open two files for comparing, the open file on the + protected side is write-protected. Similarly, you cannot copy a file from + the unprotected side to the protected side.</para> + + <para>The <guilabel>RO</guilabel> code in the left or right side's pane in + the status bar (near the bottom right of the window) indicates that the + side is currently read-only.</para> </section> - </section> - <section> - <title>Navigation in Folder Compare</title> + <section> + <title>Refreshing selected items in the view<indexterm> + <primary>refreshing view</primary> + </indexterm></title> - <para>In addition moving selection using mouse or keyboard, also - <guimenu>Merge</guimenu>-menu navigation commands, toolbar buttons and - shortcut keys can be used. For example "<guimenuitem>Next - diff</guimenuitem>" finds next different file and selects it.</para> + <para>A full refresh of large folders can take a long time. In WinMerge + 2.2 and earlier, you always had to do a full refresh to update files after + editing them outside WinMerge. Starting in Version 2.4, WinMerge can + refresh just selected items: choose <guimenuitem>Refresh</guimenuitem> + from the context menu or <menuchoice> + <guimenu>View</guimenu> - <note> - <para>Unique files and folders are considered as different ones.</para> - </note> + <guimenuitem>Refresh Selected</guimenuitem> + </menuchoice> from the main menu.</para> + </section> - <para>Multiple files/folders can be selected. However not all operations - are possible with multi-selection.</para> + <section> + <title>Archiving files<indexterm> + <primary>archiving files</primary> + + <secondary>in Folder Compare window</secondary> + </indexterm></title> + + <para>Use the context menu <guimenu>Zip</guimenu> menu item to create a + new archive file containing the items you select.</para> + + <note> + <para>Archive support requires that you have installed the WinMerge + 7-Zip plugin.</para> + </note> + + <para>The Zip menu item has a submenu with four shortcuts:</para> + + <variablelist> + <varlistentry> + <term>Left</term> + + <listitem> + <para>Adds left-side files and folders recursively to the archive + file</para> + </listitem> + </varlistentry> + + <varlistentry> + <term>Right</term> + + <listitem> + <para>Adds right-side files and folders recursively to the archive + file</para> + </listitem> + </varlistentry> + + <varlistentry> + <term>Both</term> + + <listitem> + <para>Adds files and folders recursively from both sides to the + archive file. Because the filenames are same, they are added to + different subfolders, named <filename + class="directory">Original</filename> and <filename + class="directory">Altered</filename>, inside the archive: left-side + files are put to <filename class="directory">Original</filename>, + and right-side files are put into <filename + class="directory">Altered</filename>.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term>Differences</term> + + <listitem> + <para>Like <guimenuitem>Both</guimenuitem>, but adds only different + files (including unique files) from both sides.</para> + </listitem> + </varlistentry> + </variablelist> + + <para>When you select one of the <guimenu>Zip</guimenu> shortcuts, the + Save As dialog prompts you for the archive filename and type. WinMerge + cannot add files to existing archive files: it always creates a new + archive file.</para> + + <!--Original: +WinMerge looks for subfolders Original/ and Altered/ in archive files. If archive file contains these +subfolders and same filename is given to both sides WinMerge compares contents of those two folders. + +If directory compare shows contents of archive files WinMerge updates changes done to files in file +compare into original archive file. But WinMerge does not update archive contents for files +added/deleted/copied. User can create a new archive file using above menuitems instead. +--> + + <tip> + <para>WinMerge can compare the contents of archive files that have the + same name on both sides: WinMerge looks for the <filename + class="directory">Original</filename> and <filename + class="directory">Altered</filename> subfolders, and compares the + contents of those two folders.</para> + </tip> + + <para>If a folder compare includes the contents of an archive file, any + changes made to the included files in WinMerge (for example, using an + <guimenuitem>Open</guimenuitem> file operation to edit the file) are saved + in the archive file. But you cannot update archive contents by using the + WinMerge <guimenuitem>Copy</guimenuitem>, <guimenuitem>Move</guimenuitem>, + or <guimenuitem>Delete</guimenuitem> file operations. Instead, create a + new archive file using one of the <guimenuitem>Zip</guimenuitem> + shortcuts.</para> + </section> </section> <section> - <title>File Operations in Folder Compare</title> + <title>Browsing folders in the Folder Compare window<indexterm> + <primary>folders</primary> + <secondary>browsing in Folder Compare window</secondary> + </indexterm></title> + + <para>This section discusses ways to browse folders that are listed in a + Compare Folder window. When you browse a folder, you perform a completely + new compare operation. Its result overwrites the current result in the + window.</para> + <section> - <title>Copying, moving and deleting</title> + <title>Browsing folders in a nonrecursive compare</title> - <para>Folder compare allows user to copy and delete files and folders. - File operations are available through context menu (right-click with - mouse). Also files can be opened to associated program or into external - editor.</para> + <para>Even though a nonrecursive folder compare does not include the + contents of subfolders, the subfolders themselves are listed as files in + the result. Similarly, the compared folder's parent folder is listed as a + file at the top of the table. By opening these folders directly in the + Folder Compare window, you can selectively browse a directory tree. This + approach — comparing just the subdirectories you are interested in — can + be more efficient than performing a recursive compare on the entire + directory tree.</para> - <para>In file operation menu, there are one or two numbers shown, - depending on files/folders selected. If there is one number shown, for - example "<guimenuitem>Copy/Left to... (5)</guimenuitem>" that means - there is 5 items selected, and all items can be copied. But if there is - two numbers shown, for example "<guimenuitem>Copy/Left to... (3 of - 5)</guimenuitem>", that means there are 5 items selected but only 3 - items can be copied.</para> + <variablelist> + <varlistentry> + <term>Browsing the parent folder</term> - <para>Most common operation is copying files from side to side. File can - be copied from side to side using <guimenu>Merge</guimenu>-menu items, - toolbar buttons and context menu. If multiple files are selected, or - file to overwrite is read-only, confirmation dialog is shown.</para> + <listitem> + <para>To compare the <inlinemediaobject> + <imageobject> + <imagedata fileref="screenshots/folderup.png" format="PNG" /> + </imageobject> + </inlinemediaobject> parent folder (the <guilabel>..</guilabel> + path at the top), double-click its row, or select the row and press + <keycap>Enter</keycap>.</para> - <para>Sometimes it is useful to copy certain files and/or folders to - another folder instead of another compared folder. This can be done - selecting "<guimenuitem>Copy/Left to...</guimenuitem>" or - "<guimenuitem>Copy/Right to...</guimenuitem>" items.</para> + <para>Sometimes the parent folder cannot be opened (for example if + you do not have permissions to access it). These two icons indicate + whether a parent folder can be opened:</para> - <para>Another file/folder operation is deleting. Items in another or - both sides can be deleted. There is "<guilabel>Send deleted files into - Recycle Bin</guilabel>" option in system options (See <link - linkend="Configuration">Options & Configuration</link> -chapter). It - is highly recommended to keep that option enabled so deletion can be - undone if accidents happen. Note however recycle bin does not help if - its disabled from Windows settings.</para> + <simplelist type="vert"> + <member><inlinemediaobject> + <imageobject> + <imagedata fileref="screenshots/folderup.png" format="PNG" /> + </imageobject> + </inlinemediaobject> Parent folder can be opened.</member> - <para>Moving is just a shortcut for copy + delete.</para> + <member><inlinemediaobject> + <imageobject> + <imagedata fileref="screenshots/folderup_disable.png" + format="PNG" /> + </imageobject> + </inlinemediaobject> Parent folder cannot be opened.</member> + </simplelist> + </listitem> + </varlistentry> + </variablelist> - <warning> - <para>File/folder deletion cannot be undone if <guilabel>Recycle - Bin</guilabel> is not used!</para> - </warning> + <variablelist> + <varlistentry> + <term>Browsing a single subfolder that exists on both sides</term> + + <listitem> + <para>To compare a single subfolder that exists on both sides, + double-click the folder in the folder compare window.</para> + </listitem> + </varlistentry> + </variablelist> + + <variablelist> + <varlistentry> + <term>Browsing a single subfolder that exists only one side</term> + + <listitem> + <para>If you browse to a subfolder that exists only the left or + right side, the new result has two sides with identical files and + folders. For example, browsing to <filename>C:\work\</filename> + opens <filename>C:\work\</filename> as the left file and and + <filename>C:\work\</filename> as the right file. (WinMerge 2.6 and + earlier versions prevented this usage).</para> + </listitem> + </varlistentry> + </variablelist> + + <variablelist> + <varlistentry> + <term>Browsing two different subfolders</term> + + <listitem> + <para>You cannot compare two subfolders (that is, selecting two + rows) where the subfolders on each side are different. Only if you + have previously compared identical folders (for example, by browsing + a single subfolder in a compare result) can you compare two + subfolders. First select the two folders in the Folder Compare + window, as shown in the following figure:</para> + + <mediaobject> + <imageobject> + <imagedata contentwidth="572" + fileref="screenshots/foldercomp_2same.png" + format="PNG" /> + </imageobject> + + <textobject> + <phrase>Folder Compare window, two folders selected</phrase> + </textobject> + </mediaobject> + + <para>The order of selection is significant: the folder you select + first is the left folder in the result; the second selected folder + becomes the right folder in the result.</para> + + <para>With the two folders selected, right-click and choose + <guimenuitem>Compare</guimenuitem> (or click <menuchoice> + <guimenu>Merge</guimenu> + + <guimenuitem>Compare</guimenuitem> + </menuchoice> in the menu).</para> + + <tip> + <para>Again, the <guimenuitem>Compare</guimenuitem> operation is + available only when the current left and right folder paths are + identical in the Folder Compare window, as shown in the preceding + screen shot. For example, it is not available if the current + window compares two different folders.</para> + </tip> + </listitem> + </varlistentry> + </variablelist> </section> <section> - <title>Renaming</title> + <title>Browsing unique folders<indexterm> + <primary>unique folders</primary> - <para>Renaming files and folders is available through context menu item - <guimenuitem>Rename</guimenuitem> or using <keycap>F2</keycap> -shortcut - key. Edit-box appears and allows editing of the name. Renaming can be - cancelled by pressing <keycap>Esc</keycap> -key. Note that items in both - sides are renamed. Renaming just other side is not currently - possible.</para> + <secondary>comparing</secondary> + </indexterm></title> + + <para>In WinMerge 2.6 and earlier, you could not browse to unique folders + (folders that exist only in one side of a compare result), because + WinMerge cannot compare an existing folder to a non-existing folder. To + copy anything from a unique folder in WinMerge, you had to first create a + copy of the entire folder structure.</para> + + <para>However, you might prefer not to copy the whole folder structure. + Starting in Version 2.8, WinMerge provides an alternate way to create a + new, empty folder instead. This enables you to copy just the elements you + want from the original, unique folder to the created empty folder. This + procedure demonstrates:</para> + + <orderedlist> + <listitem> + <para>Browse to the unique folder (select the folder and press + <keycap>Enter,</keycap> double-click it, or right-click it and choose + <guimenuitem>Compare</guimenuitem>). For example:</para> + + <mediaobject> + <imageobject> + <imagedata contentwidth="590" + fileref="screenshots/foldercmp_unique1.png" + format="PNG" /> + </imageobject> + + <textobject> + <phrase>Folder Compare window, comparing unique folder</phrase> + </textobject> + </mediaobject> + + <para>A WinMerge message informs you that the folder exists on only + one side and cannot be opened. The message then prompts you to confirm + whether you want to create a matching folder and open it as the other + side of the compare result.</para> + </listitem> + + <listitem> + <para>Click <guibutton>Yes</guibutton> to confirm + (<guibutton>No</guibutton> cancels the compare). In the new compare + result, the unique folder is opened on the left side, and the new + empty created folder is on the right:</para> + + <mediaobject> + <imageobject> + <imagedata contentwidth="590" + fileref="screenshots/foldercmp_unique2.png" + format="PNG" /> + </imageobject> + + <textobject> + <phrase>Folder Compare window after browsing to unique and created + folders</phrase> + </textobject> + </mediaobject> + + <para>In the compare result, you can copy or move items (for example, + using the right-click context menu) from the unique folder to the + created folder.</para> + </listitem> + </orderedlist> </section> + </section> + <section> + <title>Customizing the Folder Compare window<indexterm> + <primary>Folder Compare window</primary> + + <secondary>customizing</secondary> + </indexterm></title> + + <para>This section describes how to control the way Folder Compare window + displays results. You can customize the view by showing, hiding, and + reordering the table columns.</para> + <section> - <title>Opening files</title> + <title>Showing and hiding types of files<indexterm> + <primary>View menu</primary> - <para>There are three items in <guimenu>Open</guimenu>-menus:</para> + <secondary>Folder Compare window</secondary> + </indexterm></title> + <para>The <guimenu>View</guimenu> menu contains these shortcuts to show or + hide types of items. Enable (check) a menu option to show the item; + disable it to hide the item.</para> + <itemizedlist> <listitem> - <simpara><guimenuitem>With Registered Application</guimenuitem> : - Opens file with application registered for editing filetype for - Windows, if there is one.</simpara> + <para><guimenuitem>Show Identical Items</guimenuitem>: Files detected + as identical</para> </listitem> <listitem> - <simpara><guimenuitem>With External Editor</guimenuitem> : Open with - external editor. Default editor can be selected from options, - Notepad is used by default.</simpara> + <para><guimenuitem>Show Different Items</guimenuitem>: Files detected + as different</para> </listitem> <listitem> - <simpara><guimenuitem>With ...</guimenuitem> : Opens "<guilabel>Open - With...</guilabel>" dialog asking from user with which application - files should be opened.</simpara> + <para><guimenuitem>Show Left Unique Items</guimenuitem>: Files and + directories present only in left side</para> </listitem> + + <listitem> + <para><guimenuitem>Show Right Unique Items</guimenuitem>: Files and + directories present only in right side</para> + </listitem> + + <listitem> + <para><guimenuitem>Show Skipped Items</guimenuitem>: Files and + directories omitted by file filters</para> + </listitem> + + <listitem> + <para><guimenuitem>Show Binary Files</guimenuitem>: Files detected as + binaries</para> + </listitem> </itemizedlist> - - <tip> - <para>Selecting <guilabel>With Registered Application</guilabel> when - folder is selected usually opens that folder into new Explorer - window.</para> - </tip> </section> <section> - <title>Archiving</title> + <title>Changing column sorting</title> - <para><guimenu>Zip</guimenu>-menu in directory compare context menu - allows adding selected items to archive file.</para> + <para>The rows in the Folder Compare window are ordered according to the + sort order of a particular column. This sort column is indicated by a + small arrow in its heading. The arrow points up if the column is sorted in + ascending order, down if descending. The Folder Compare example at the top + of this topic is sorted by the Filename column, in ascending order.</para> - <note> - <para>Archive support requires that 7-Zip plugin is installed to - system.</para> - </note> + <para>To choose another order column, simply click in that column's + heading. The selected column is set to its default sort order and all the + rows are reordered by that column's sort order.</para> - <para>Zip-submenumenu has four items:</para> + <para>To change the sort direction of a column that is already the sort + column, click in its header again. That is, clicking in a sort column + header reverses its order (toggling between ascending and descending + order).</para> + </section> - <itemizedlist> + <section> + <title>Adding, removing, and reordering columns</title> + + <para>To modify the columns that are displayed in the Folder Compare + window:</para> + + <orderedlist> <listitem> - <simpara><guimenuitem>Left...</guimenuitem> : Adds left-side files - and folders (recursively) to the archive file</simpara> + <para>Right-click any column heading and choose <guimenuitem>Customize + Columns</guimenuitem>.</para> </listitem> <listitem> - <simpara><guimenuitem>Right...</guimenuitem> : Adds right-side files - and folders (recursively) to the archive file</simpara> + <para>The Display Columns dialog contains a list of all the available + column names, each with a check box. Configure the columns using any + combination of these actions:</para> + + <itemizedlist> + <listitem> + <para>Check the columns you want to display (note that selecting + the item in the list is not enough)</para> + </listitem> + + <listitem> + <para>Uncheck the columns you want to hide.</para> + </listitem> + + <listitem> + <para>To change the order of columns, select one or more items and + click <guibutton>Move Up</guibutton> or <guibutton>Move + Down</guibutton>.</para> + </listitem> + + <listitem> + <para>Click <guibutton>Defaults</guibutton> if you want to restore + the default WinMerge column configuration, overriding your custom + configuration.</para> + </listitem> + </itemizedlist> </listitem> <listitem> - <simpara><guimenuitem>Both...</guimenuitem> : Adds files and folders - (recursively) from both sides to the archive file. Because filenames - are same, files must be put to subfolders inside archive. Left-side - files are put to subfolder <filename - class="directory">Original/</filename> and right-side files are put - to subfolder <filename - class="directory">Altered/</filename>.</simpara> + <para>Click <guibutton>OK</guibutton>.</para> </listitem> + </orderedlist> + <para><indexterm> + <primary>Display Columns dialog</primary> + </indexterm>The following columns in the Display Columns dialog are + displayed by default in the Folder Compare window:</para> + + <itemizedlist> <listitem> - <simpara><guimenuitem>Differences...</guimenuitem> : This is like - above <guimenuitem>Both</guimenuitem>, but this item adds only - different files (including unique files) from both sides.</simpara> + <para><guilabel>Filename (default)</guilabel>: Name of compared item. + In a nonrecursive compare, this column includes both files and + folders; in a recursive compare, it does not include folders: instead, + folders are listed in the Folder column.</para> </listitem> - </itemizedlist> - <para>After selecting one of <guimenu>Zip</guimenu>-menu items dialog - pops up asking filename and archive type from user. WinMerge cannot add - files to existing archive files but it always creates new archive - file.</para> + <listitem> + <para><guilabel>Folder</guilabel>: Path of compared subfolder, + relative to the compared folder. For a nonrecursive compare this + column is always empty: folders are listed in the + <guilabel>Filename</guilabel> column instead.</para> + </listitem> - <tip> - <para>WinMerge looks for subfolders <filename - class="directory">Original/</filename> and <filename - class="directory">Altered/</filename> in archiv... [truncated message content] |
From: <ki...@us...> - 2008-07-23 14:17:28
|
Revision: 5661 http://winmerge.svn.sourceforge.net/winmerge/?rev=5661&view=rev Author: kimmov Date: 2008-07-23 14:17:25 +0000 (Wed, 23 Jul 2008) Log Message: ----------- PATCH: [ 2025762 ] replace links with xrefs Submitted by Denis Bradford Modified Paths: -------------- trunk/Docs/Users/Manual/About_Doc.xml trunk/Docs/Users/Manual/Command_line.xml trunk/Docs/Users/Manual/Compare_files.xml trunk/Docs/Users/Manual/Faq.xml trunk/Docs/Users/Manual/Install.xml trunk/Docs/Users/Manual/Intro_diffs.xml trunk/Docs/Users/Manual/Open_paths.xml trunk/Docs/Users/Manual/Plugins.xml trunk/Docs/Users/Manual/Quick_start.xml Modified: trunk/Docs/Users/Manual/About_Doc.xml =================================================================== --- trunk/Docs/Users/Manual/About_Doc.xml 2008-07-23 12:10:00 UTC (rev 5660) +++ trunk/Docs/Users/Manual/About_Doc.xml 2008-07-23 14:17:25 UTC (rev 5661) @@ -2,40 +2,47 @@ <article id="AboutDoc"> <title>About this document</title> - <para>This document is the user manual for WinMerge 2.8. It explains the capabilities and limitations of WinMerge. This manual is recommended reading for both new and experienced users.</para> + <para>This document is the user manual for WinMerge 2.8. It explains the + capabilities and limitations of WinMerge. This manual is recommended reading + for both new and experienced users.</para> - <para>To learn essential WinMerge basics, please read the following topics:</para> + <para>To learn essential WinMerge basics, please read the following + topics:</para> <variablelist> <varlistentry> - <term><link linkend="QuickStart">Quick start</link></term> + <term><xref linkend="QuickStart" /></term> <listitem> - <para>Gets you quickly started with WinMerge and shows its basic usage.</para> + <para>Gets you quickly started with WinMerge and shows its basic + usage.</para> </listitem> </varlistentry> <varlistentry> - <term><link linkend="CompareDirs">Comparing folders</link></term> + <term><xref linkend="CompareDirs" /></term> <listitem> - <para>Explains the folder comparison window, available operations, and customizing the results display.</para> + <para>Explains the folder comparison window, available operations, and + customizing the results display.</para> </listitem> </varlistentry> <varlistentry> - <term><link linkend="CompareFiles">Comparing files</link></term> + <term><xref linkend="CompareFiles" /></term> <listitem> - <para>Explains the file comparison/merge window, available operations, methods of navigation, and modes.</para> + <para>Explains the file comparison/merge window, available operations, + methods of navigation, and modes.</para> </listitem> </varlistentry> <varlistentry> - <term><link linkend="Configuration">Options and configuration</link></term> + <term><xref linkend="Configuration" /></term> <listitem> - <para>Explains how to customize WinMerge, including handling whitespace, colours, and text encoding.</para> + <para>Explains how to customize WinMerge, including handling whitespace, + colours, and text encoding.</para> </listitem> </varlistentry> </variablelist> @@ -44,44 +51,53 @@ <variablelist> <varlistentry> - <term><link linkend="OpenPaths">Opening files and folders</link></term> + <term><xref linkend="OpenPaths" /></term> <listitem> - <para>Introduces several ways to open files and folders in WinMerge - there are many! For example, do you know how to use the Shell Extension context menu in advanced mode?</para> + <para>Introduces several ways to open files and folders in WinMerge - + there are many! For example, do you know how to use the Shell Extension + context menu in advanced mode?</para> </listitem> </varlistentry> <varlistentry> - <term><link linkend="Plugins">Plugins</link></term> + <term><xref linkend="Plugins" /></term> <listitem> - <para>Describes the optional, extra features that you can add to WinMerge using its plugin mechanism.</para> + <para>Describes the optional, extra features that you can add to + WinMerge using its plugin mechanism.</para> </listitem> </varlistentry> <varlistentry> - <term><link linkend="Filters">Filters</link></term> + <term><xref linkend="Filters" /></term> <listitem> - <para>Explains how to control what is compared in the folder or file comparison window.</para> + <para>Explains how to control what is compared in the folder or file + comparison window.</para> </listitem> </varlistentry> <varlistentry> - <term><link linkend="CommandLine">Commandline</link></term> + <term><xref linkend="CommandLine" /></term> <listitem> - <para>Lists command-line parameters for using WinMerge with other tools or from a script.</para> + <para>Lists command-line parameters for using WinMerge with other tools + or from a script.</para> </listitem> </varlistentry> <varlistentry> - <term><link linkend="Faq">FAQ</link></term> + <term><xref linkend="Faq" /></term> <listitem> - <para>Contains answers to many common questions asked of developers.</para> + <para>Contains answers to many common questions asked of + developers.</para> - <para>Before submitting questions to <ulink url="http://sourceforge.net/projects/winmerge/">SourceForge.net</ulink>, please check the FAQ first to see if your question is answered there.</para> + <para>Before submitting questions to <ulink + url="http://sourceforge.net/projects/winmerge/">SourceForge.net</ulink>, + please check the FAQ first to see if your question is answered + there.</para> </listitem> </varlistentry> </variablelist> Modified: trunk/Docs/Users/Manual/Command_line.xml =================================================================== --- trunk/Docs/Users/Manual/Command_line.xml 2008-07-23 12:10:00 UTC (rev 5660) +++ trunk/Docs/Users/Manual/Command_line.xml 2008-07-23 14:17:25 UTC (rev 5661) @@ -5,8 +5,8 @@ </indexterm>Command Line</title> <para>WinMerge accepts several parameters from command line, in addition to - paths to compare. Most of these parameters are intended for using WinMerge - as an external compare application. Or for starting from batch files.</para> + paths to compare. Most of these parameters are intended for using WinMerge as + an external compare application. Or for starting from batch files.</para> <para>Syntax for the command line is:</para> @@ -63,13 +63,13 @@ </listitem> <listitem> - <simpara><option>/r</option> tells WinMerge to compare folders - recursively . Normally WinMerge does not compare subfolder contents but - does the "flat" compare showing the files in compared folders and - subfolders as separate items. Using /r tells WinMerge to compare all - files in all subfolders. When subfolders are included, only unique - subfolders are visible as separate items in compare results. Note that - including subfolders can increase compare time remarkably.</simpara> + <simpara><option>/r</option> tells WinMerge to compare folders recursively + . Normally WinMerge does not compare subfolder contents but does the + "flat" compare showing the files in compared folders and subfolders as + separate items. Using /r tells WinMerge to compare all files in all + subfolders. When subfolders are included, only unique subfolders are + visible as separate items in compare results. Note that including + subfolders can increase compare time remarkably.</simpara> </listitem> <listitem> @@ -81,55 +81,53 @@ <listitem> <simpara><option>/f</option> allows selecting filter used. Filter can be - filemask like "<filename>*.h *.cpp</filename>" or name of filefilter - like "<literal>XML/HTML Devel</literal>". Quotation marks must be used - if filter mask or name contains spaces.</simpara> + filemask like "<filename>*.h *.cpp</filename>" or name of filefilter like + "<literal>XML/HTML Devel</literal>". Quotation marks must be used if + filter mask or name contains spaces.</simpara> </listitem> <listitem> - <simpara><option>/x</option> closes WinMerge if opened files are - identical (after information dialog is shown). This parameter is useful - when WinMerge is used as an external compare application. It helps to - faster process and/or ignore files which don't have any differences. - Note that this option does not apply when files become identical when + <simpara><option>/x</option> closes WinMerge if opened files are identical + (after information dialog is shown). This parameter is useful when + WinMerge is used as an external compare application. It helps to faster + process and/or ignore files which don't have any differences. Note that + this option does not apply when files become identical when merging/editing them.</simpara> </listitem> <listitem> - <simpara><option>/s</option> enables single-instance behavior. If there - is already WinMerge running new compare is opened to that same instance. - Depending on other settings (if multiple windows are allowed) new - compare is opened to existing or new window.</simpara> + <simpara><option>/s</option> enables single-instance behavior. If there is + already WinMerge running new compare is opened to that same instance. + Depending on other settings (if multiple windows are allowed) new compare + is opened to existing or new window.</simpara> </listitem> <listitem> - <simpara><option>/ul</option> tells WinMerge to not add left path to - MRU. External applications should not add paths to Open-dialog's MRU + <simpara><option>/ul</option> tells WinMerge to not add left path to MRU. + External applications should not add paths to Open-dialog's MRU lists.</simpara> </listitem> <listitem> - <simpara><option>/ur</option> tells WinMerge to not add right path to - MRU. External applications should not add paths to Open-dialog's MRU + <simpara><option>/ur</option> tells WinMerge to not add right path to MRU. + External applications should not add paths to Open-dialog's MRU lists.</simpara> </listitem> <listitem> - <simpara><option>/ub</option> tells WinMerge to not add both paths to - MRU. External applications should not add paths to Open-dialog's MRU + <simpara><option>/ub</option> tells WinMerge to not add both paths to MRU. + External applications should not add paths to Open-dialog's MRU lists.</simpara> </listitem> <listitem> - <simpara><option>/wl</option> initially opens left side as read-only. - Use this when you don't want to change left-side items in - compare.</simpara> + <simpara><option>/wl</option> initially opens left side as read-only. Use + this when you don't want to change left-side items in compare.</simpara> </listitem> <listitem> - <simpara><option>/wr</option> initially opens right side as read-only. - Use this when you don't want to change right-side items in - compare.</simpara> + <simpara><option>/wr</option> initially opens right side as read-only. Use + this when you don't want to change right-side items in compare.</simpara> </listitem> <listitem> @@ -145,24 +143,24 @@ <listitem> <simpara><option>/dl</option> adds a description for left side shown - instead of folder / filename. This allows showing version number or - label for compared items. Like "Version 1.0" or "Work Copy".</simpara> + instead of folder / filename. This allows showing version number or label + for compared items. Like "Version 1.0" or "Work Copy".</simpara> </listitem> <listitem> <simpara><option>/dr</option> adds a description for right side shown - instead of folder / filename. This allows showing version number or - label for compared items. Like "Version 1.0" or "Work Copy".</simpara> + instead of folder / filename. This allows showing version number or label + for compared items. Like "Version 1.0" or "Work Copy".</simpara> </listitem> <listitem> - <simpara><replaceable>leftpath</replaceable> is the folder or filename - to open on the left side.</simpara> + <simpara><replaceable>leftpath</replaceable> is the folder or filename to + open on the left side.</simpara> </listitem> <listitem> - <simpara><replaceable>rightpath</replaceable> is the folder or filename - to open on the right side.</simpara> + <simpara><replaceable>rightpath</replaceable> is the folder or filename to + open on the right side.</simpara> </listitem> <listitem> @@ -183,29 +181,28 @@ <filename>File.txt</filename> WinMerge now compares files <filename>C:\Folder\File.txt</filename> and C:\Folder2\File.txt</para> </tip>Usually WinMerge requires that both path parameters - (<replaceable>leftpath</replaceable> and - <replaceable>rightpath</replaceable>) point to folders or files. It is not - possible to compare folder to file (except in case described in above note). - If WinMerge cannot find any of given paths, it opens Open-dialog.</para> + (<replaceable>leftpath</replaceable> and <replaceable>rightpath</replaceable>) + point to folders or files. It is not possible to compare folder to file + (except in case described in above note). If WinMerge cannot find any of given + paths, it opens Open-dialog.</para> <para>Third path given in command line is rarely needed when WinMerge is started from command line. It is meant to be used with many version control tools which use third path as a "<emphasis>result</emphasis>" file. WinMerge - always shows two files in file compare, the third path is a path where any - of these files gets saved into, leaving other two paths intact.</para> + always shows two files in file compare, the third path is a path where any of + these files gets saved into, leaving other two paths intact.</para> <para>Usually these tools use terms like "<emphasis>theirs</emphasis>", "<emphasis>mine</emphasis>" and "<emphasis>merged</emphasis> "/ " - <emphasis>resolved</emphasis>" about these three files. And those paths - should be given in that order for WinMerge.</para> + <emphasis>resolved</emphasis>" about these three files. And those paths should + be given in that order for WinMerge.</para> <section> <title>Conflict File</title> - <para>Conflict file can be given to command line as one path to the - conflict file. There cannot be second or third path with conflict file. - After WinMerge opens the given conflict file, it can be resolved like - described in <link linkend="ResolveConflictFiles">Resolving Conflict - Files</link>.</para> + <para>Conflict file can be given to command line as one path to the conflict + file. There cannot be second or third path with conflict file. After + WinMerge opens the given conflict file, it can be resolved like described in + <xref linkend="ResolveConflictFiles" />.</para> </section> </article> Modified: trunk/Docs/Users/Manual/Compare_files.xml =================================================================== --- trunk/Docs/Users/Manual/Compare_files.xml 2008-07-23 12:10:00 UTC (rev 5660) +++ trunk/Docs/Users/Manual/Compare_files.xml 2008-07-23 14:17:25 UTC (rev 5661) @@ -15,9 +15,8 @@ <caption><para>File Compare Window</para></caption> </mediaobject> - <para>WinMerge editor is not comparable to specialized editor programs, but - it has basic features like - <guilabel>Undo</guilabel>/<guilabel>Redo</guilabel>, + <para>WinMerge editor is not comparable to specialized editor programs, but it + has basic features like <guilabel>Undo</guilabel>/<guilabel>Redo</guilabel>, <guilabel>Find</guilabel>/<guilabel>Replace</guilabel> and <guilabel>Goto</guilabel> (to linenumber). The editor also has a syntax highlighting feature supporting several file formats (colors configurable). @@ -25,8 +24,8 @@ Syntax highlighting can be disabled from options.</para> <tip> - <para>If <guilabel>Automatic rescan</guilabel> is not enabled manual - refresh is recommended after editing.</para> + <para>If <guilabel>Automatic rescan</guilabel> is not enabled manual refresh + is recommended after editing.</para> </tip> <section> @@ -48,8 +47,7 @@ <guimenuitem>Tab Bar</guimenuitem> </menuchoice>. When the tab bar is shown it has one tab for every open - window. The tab contains last part of the folder names or file - names.</para> + window. The tab contains last part of the folder names or file names.</para> </section> <section> @@ -64,24 +62,24 @@ </imageobject> </inlinemediaobject></para> - <para>Headerbar shows full path to the open file. If the path is longer - than available space one part of the path is replaced with an ellipsis - (...). Headerbar also shows:<itemizedlist> + <para>Headerbar shows full path to the open file. If the path is longer than + available space one part of the path is replaced with an ellipsis (...). + Headerbar also shows:<itemizedlist> <listitem> - <simpara>the current active file with sunken border (like in the - above screenshot), the non-active file is shown with flat + <simpara>the current active file with sunken border (like in the above + screenshot), the non-active file is shown with flat headerbar.</simpara> </listitem> <listitem> - <simpara>if the file has been modified (has unsaved changes). This - is indicated by adding asterisk (<guilabel>*</guilabel>) before the + <simpara>if the file has been modified (has unsaved changes). This is + indicated by adding asterisk (<guilabel>*</guilabel>) before the filename, like in the screenshot.</simpara> </listitem> </itemizedlist></para> - <para>Headerbar has a context menu with items to copy full path or - filename to clipboard.</para> + <para>Headerbar has a context menu with items to copy full path or filename + to clipboard.</para> </section> <section> @@ -89,8 +87,7 @@ <para><inlinemediaobject> <imageobject> - <imagedata fileref="screenshots/filecomp_statusbar1.png" - format="PNG" /> + <imagedata fileref="screenshots/filecomp_statusbar1.png" format="PNG" /> </imageobject> </inlinemediaobject></para> @@ -135,8 +132,8 @@ </listitem> <listitem> - <simpara>encoding: this pane shows codepage number for ANSI files - and Unicode encoding type for Unicode files</simpara> + <simpara>encoding: this pane shows codepage number for ANSI files and + Unicode encoding type for Unicode files</simpara> </listitem> <listitem> @@ -169,8 +166,8 @@ <listitem> <simpara><guilabel>Difference X of Y</guilabel> : amount of - differences (<guilabel>Y</guilabel>) and number of selected - difference (<guilabel>X</guilabel>)</simpara> + differences (<guilabel>Y</guilabel>) and number of selected difference + (<guilabel>X</guilabel>)</simpara> </listitem> </itemizedlist></para> </section> @@ -178,8 +175,8 @@ <section> <title>Editor Margin</title> - <para>The editor panes (file panes) have optional gray margin area for - line numbers and some symbols. This margin can be shown/hidded from menu + <para>The editor panes (file panes) have optional gray margin area for line + numbers and some symbols. This margin can be shown/hidded from menu <menuchoice> <guimenu>View</guimenu> @@ -251,9 +248,9 @@ <section> <title>Selecting a difference</title> - <para>Before difference can be merged, it must be selected. Selecting - can happen by difference navigation keys/items (see below) or by - selecting wanted difference directly:</para> + <para>Before difference can be merged, it must be selected. Selecting can + happen by difference navigation keys/items (see below) or by selecting + wanted difference directly:</para> <itemizedlist> <listitem> @@ -273,8 +270,8 @@ <para><guimenu>Merge</guimenu>-menu has items for navigating to next/previous and first/last difference. Navigation is always done based on current cursor location. So <guimenuitem>Next - Difference</guimenuitem>-command selects next difference from cursor, - not from current selected difference.</para> + Difference</guimenuitem>-command selects next difference from cursor, not + from current selected difference.</para> <note> <para>When difference is selected with navigation commands cursor is @@ -305,15 +302,14 @@ <title>Go To line or difference</title> <para>Using <guimenuitem>Go To</guimenuitem> from - <guimenu>Edit</guimenu>-menu user can jump to certain line or - difference. Go To -dialog shows current line and side when - opened.</para> + <guimenu>Edit</guimenu>-menu user can jump to certain line or difference. + Go To -dialog shows current line and side when opened.</para> <tip> - <para>Go To line number is useful if there is need to merge same - change to several target files from one original file. Rather than - using <guimenuitem>Find</guimenuitem> or difference navigation it is - faster to jump to first line of difference.</para> + <para>Go To line number is useful if there is need to merge same change + to several target files from one original file. Rather than using + <guimenuitem>Find</guimenuitem> or difference navigation it is faster to + jump to first line of difference.</para> </tip> </section> </section> @@ -324,22 +320,20 @@ </indexterm>Merging Differences</title> <para>Merging commands are located in <guimenu>Merge</guimenu>-menu after - navigation commands. Basically there are only two types of merging - commands - copy difference from right to left and copy difference from - left to right. Additional commands make merging several differences - easier.</para> + navigation commands. Basically there are only two types of merging commands + - copy difference from right to left and copy difference from left to right. + Additional commands make merging several differences easier.</para> <para><guimenuitem>Copy to Right</guimenuitem> and <guimenuitem>Copy to - Left</guimenuitem> copy difference from side to side. At simplest this - means replacing text in destination difference with text in source - difference. But because difference can contain also removed lines, new - lines may be created or some lines removed. If there are several - differences selected, then all fully selected differences are merged with - one command. This makes merging many small differences a lot - faster.</para> + Left</guimenuitem> copy difference from side to side. At simplest this means + replacing text in destination difference with text in source difference. But + because difference can contain also removed lines, new lines may be created + or some lines removed. If there are several differences selected, then all + fully selected differences are merged with one command. This makes merging + many small differences a lot faster.</para> - <para>WinMerge rescans files after every merging operation. This is done - to ensure differences were copied correctly and all changes after last + <para>WinMerge rescans files after every merging operation. This is done to + ensure differences were copied correctly and all changes after last rescanning are taken care of. If <guilabel>Automatic rescan</guilabel>-option is not set, user may have edited files and differences may not have shown correctly before merging. If result of @@ -349,8 +343,8 @@ <para>It is strongly advised to run <guimenuitem>Rescan</guimenuitem> (<keycap>F5</keycap>) before merging differences if <guilabel>Automatic rescan</guilabel> is set off. Usually files get out of sync when editing - and merging differences may have unpredictable results. If merging - result looks incorrect try undoing (<menuchoice> + and merging differences may have unpredictable results. If merging result + looks incorrect try undoing (<menuchoice> <guimenu>Edit</guimenu> <guimenuitem>Undo</guimenuitem> @@ -362,8 +356,8 @@ </important> <para><guimenuitem>Copy to Right/Left and Advance</guimenuitem>-commands - merge current difference and then select next difference (if there is - one). Using these commands makes merging several differences easier and + merge current difference and then select next difference (if there is one). + Using these commands makes merging several differences easier and faster.</para> <para><guimenuitem>Copy All to Right/Left</guimenuitem>-commands sync two @@ -371,11 +365,10 @@ operation with one undo command.</para> <tip> - <para>Enable <guilabel>Automatically scroll to first - difference</guilabel> -option from general options. This saves you from - scrolling to first difference and selecting it. See <link - linkend="Configuration">Options & Configuration</link> -chapter for - more information.</para> + <para>Enable <guilabel>Automatically scroll to first difference</guilabel> + -option from general options. This saves you from scrolling to first + difference and selecting it. See <xref linkend="Configuration" /> for more + information.</para> </tip> </section> @@ -400,9 +393,9 @@ </listitem> </itemizedlist> - <para>Unlike the normal mode, in this schema the <keycap>Alt</keycap>-key - is not needed for these basic operations (which makes them quicker and - more convenient). Note that <keycombo> + <para>Unlike the normal mode, in this schema the <keycap>Alt</keycap>-key is + not needed for these basic operations (which makes them quicker and more + convenient). Note that <keycombo> <keycap>Shift</keycap> <keycap>Arrow</keycap> @@ -418,20 +411,20 @@ <keycap>Arrow</keycap> </keycombo> keys work in merge mode like in normal mode.</para> - <para>When merge mode is enabled <guilabel>Merge</guilabel> text is shown - in statusbar.</para> + <para>When merge mode is enabled <guilabel>Merge</guilabel> text is shown in + statusbar.</para> </section> <section> <title>Refreshing</title> - <para>Refreshing updates differences after changes are made to files. It - is important to do a refresh before merging changes between files.</para> + <para>Refreshing updates differences after changes are made to files. It is + important to do a refresh before merging changes between files.</para> <note> <para>Refresh does not reload file. That means, if another programs has - updated files etc, those changes are not seen. Refresh updates - differences according changes user has done.</para> + updated files etc, those changes are not seen. Refresh updates differences + according changes user has done.</para> </note> </section> @@ -452,8 +445,8 @@ <para>Normal editing features work in WinMerge editor. User can type and delete text, select text, copy, cut and paste text etc. There is some customisation because there can be removed lines in files (lines existing - only in other side). Anyway these customisations are not usually visible - to users otherwise that lines can sometimes "jump" when WinMerge has to + only in other side). Anyway these customisations are not usually visible to + users otherwise that lines can sometimes "jump" when WinMerge has to relocate matching/non-matching files.</para> </section> @@ -477,25 +470,23 @@ </menuchoice>.</para> <para>With default settings WinMerge uses whitespace characters (namely - spaces and tabulators) to separate words. WinMerge does not consider - commas or dots as word separators. That means WinMerge thinks "For - Example" is two words but "For,Example" is one word. More characters can - be included as word-separator characters from editor options (select from - menu <menuchoice> + spaces and tabulators) to separate words. WinMerge does not consider commas + or dots as word separators. That means WinMerge thinks "For Example" is two + words but "For,Example" is one word. More characters can be included as + word-separator characters from editor options (select from menu <menuchoice> <guimenu>Edit</guimenu> <guimenuitem>Options</guimenuitem> - </menuchoice> and <guilabel>Editor</guilabel> page). See <link - linkend="Configuration">Options & Configuration</link> -chapter for - more information.</para> + </menuchoice> and <guilabel>Editor</guilabel> page). See <xref + linkend="Configuration" /> for more information.</para> </section> <section> <title>Line Difference Selection</title> <para>Many times it is useful to see exact differences inside lines. - WinMerge can highlight different area between lines. This feature is - called <guilabel>Select Line Difference</guilabel>. It is available in + WinMerge can highlight different area between lines. This feature is called + <guilabel>Select Line Difference</guilabel>. It is available in <guimenu>Edit</guimenu>-menu, toolbar and shortcut key (<keycap>F4</keycap>). In screenshot below there is one difference highlighted</para> @@ -510,8 +501,8 @@ <section> <title>Location Pane</title> - <para>Location pane is a handy side-pane showing a overall (difference) - map of files compared.</para> + <para>Location pane is a handy side-pane showing a overall (difference) map + of files compared.</para> <para><inlinemediaobject> <imageobject> @@ -535,17 +526,17 @@ </listitem> <listitem> - <simpara>area visible in editor panes is shown with different - background color</simpara> + <simpara>area visible in editor panes is shown with different background + color</simpara> </listitem> </itemizedlist> - <para>Clicking with mouse in Location Pane moves cursor to place clicked - in file. Right-clicking with mouse opens the context menu with items to - select line to go to. And the visible area locator (area with different - background color) can be used like a scrollbar thumb - after pressing down - the left mouse button over it can be dragged upwards and downwards to - scroll the files.</para> + <para>Clicking with mouse in Location Pane moves cursor to place clicked in + file. Right-clicking with mouse opens the context menu with items to select + line to go to. And the visible area locator (area with different background + color) can be used like a scrollbar thumb - after pressing down the left + mouse button over it can be dragged upwards and downwards to scroll the + files.</para> </section> <section> @@ -560,9 +551,9 @@ </imageobject> </inlinemediaobject></para> - <para>Most of these items are familiar from Main menu. Worth noting is - last item <guimenuitem>Open</guimenuitem>. It allows to open file with - (system) registered application or with external editor. Also context menu + <para>Most of these items are familiar from Main menu. Worth noting is last + item <guimenuitem>Open</guimenuitem>. It allows to open file with (system) + registered application or with external editor. Also context menu merge-commands are not relative to active file. They always merge the selected difference.</para> </section> @@ -577,8 +568,7 @@ </menuchoice>. Due to limitations in the editor, only fixed width fonts are supported in WinMerge.</para> - <para>Font suggestions for use of WinMerge with East Asian - languages:</para> + <para>Font suggestions for use of WinMerge with East Asian languages:</para> <itemizedlist> <listitem> @@ -587,8 +577,8 @@ </listitem> <listitem> - <simpara>Traditional Chinese texts with the - <guilabel>MingLiU</guilabel> fixed-width font, or</simpara> + <simpara>Traditional Chinese texts with the <guilabel>MingLiU</guilabel> + fixed-width font, or</simpara> </listitem> <listitem> @@ -597,10 +587,10 @@ </listitem> <listitem> - <simpara>Korean texts with the <guilabel>GulimChe</guilabel> - fixed-width font (not Gulim as this variant uses proportional-spacing - glyphs that are not centered in grid cells and then poorly aligned in - fixed-width mode)</simpara> + <simpara>Korean texts with the <guilabel>GulimChe</guilabel> fixed-width + font (not Gulim as this variant uses proportional-spacing glyphs that + are not centered in grid cells and then poorly aligned in fixed-width + mode)</simpara> </listitem> </itemizedlist> </section> @@ -613,9 +603,9 @@ <para>WinMerge can resolve conflict files several version control systems produce when merging files. Conflict file is basically two different versions of files embedded into one file. WinMerge reads this file and - separates it into its original files, and shows those files in file - compare. So conflicted file can be resolved using normal WinMerge file - compare functionality.</para> + separates it into its original files, and shows those files in file compare. + So conflicted file can be resolved using normal WinMerge file compare + functionality.</para> <section> <title>Opening Conflict Files</title> @@ -625,13 +615,13 @@ <guimenuitem>Open Conflict File...</guimenuitem> </menuchoice>. Conflict file to resolve can be selected using file - selection dialog that opens. At the moment there are no other ways to - open conflict files.</para> + selection dialog that opens. At the moment there are no other ways to open + conflict files.</para> <warning> <para>WinMerge overwrites original conflict file. If original file is - wanted to save, it must be copied to another folder or another - filename before opening it into WinMerge.</para> + wanted to save, it must be copied to another folder or another filename + before opening it into WinMerge.</para> </warning> </section> @@ -639,16 +629,15 @@ <title>Conflict Resolving</title> <para>WinMerge opens conflict file into normal file compare (see above). - All normal WinMerge file compare features are in use. Files in two - panels are:</para> + All normal WinMerge file compare features are in use. Files in two panels + are:</para> <simplelist> <member><emphasis>Left panel</emphasis>: this file is called "<emphasis>theirs</emphasis>" file. It is usually the file that is in - version control system's repository. This file usually cannot be - edited. An as such, WinMerge opens left-side file as read-only. - Differences can be moved only from this file to the another - file.</member> + version control system's repository. This file usually cannot be edited. + An as such, WinMerge opens left-side file as read-only. Differences can + be moved only from this file to the another file.</member> <member><emphasis>Right panel</emphasis>: this file is called "<emphasis>mine</emphasis>" file. It is the user's working file @@ -657,22 +646,20 @@ </simplelist> <para>After the wanted resolved file is in right-side panel, it can be - saved like normal file. WinMerge saves the file over original - file.</para> + saved like normal file. WinMerge saves the file over original file.</para> - <para>Left side "<emphasis>mine</emphasis>" file is set to modified - after opening conflict file. This allows fast resolve by just saving the - file when user's file is the wanted end result. This also prevents - accidentally not resolving the files. As resolving only happens when - file is saved. If file is no saved, original conflict file is kept - unmodified.</para> + <para>Left side "<emphasis>mine</emphasis>" file is set to modified after + opening conflict file. This allows fast resolve by just saving the file + when user's file is the wanted end result. This also prevents accidentally + not resolving the files. As resolving only happens when file is saved. If + file is no saved, original conflict file is kept unmodified.</para> <para>Many version control tools allow configuring external merge tool. WinMerge accepts three filenames ("T<guilabel>heirs</guilabel>", "<guilabel>Mine</guilabel>" and "<guilabel>Resolved</guilabel>") as - command line parameters. See more info from <link - linkend="CommandLine">Command Line</link> -chapter. Single path to the - conflict file is also accepted in command line.</para> + command line parameters. See more info from <xref + linkend="CommandLine" />. Single path to the conflict file is also + accepted in command line.</para> </section> </section> </article> Modified: trunk/Docs/Users/Manual/Faq.xml =================================================================== --- trunk/Docs/Users/Manual/Faq.xml 2008-07-23 12:10:00 UTC (rev 5660) +++ trunk/Docs/Users/Manual/Faq.xml 2008-07-23 14:17:25 UTC (rev 5661) @@ -17,16 +17,15 @@ <itemizedlist> <listitem> <para><filename>WinMerge.exe</filename> is an ANSI (8-bit) - executable which works in all 32-bit Windows systems. It does - not have Unicode support.</para> + executable which works in all 32-bit Windows systems. It does not + have Unicode support.</para> <para>Internally, it stores only ANSI characters (256 - possibilities). If you open a Unicode file, the characters must - be converted to the ANSI codepage. As there are over 100,000 - Unicode characters, and only 256 can be represented in the ANSI - codepage, data loss may occur. Conversion may be approximative - (accents are lost), or impossible (characters appear as - "?").</para> + possibilities). If you open a Unicode file, the characters must be + converted to the ANSI codepage. As there are over 100,000 Unicode + characters, and only 256 can be represented in the ANSI codepage, + data loss may occur. Conversion may be approximative (accents are + lost), or impossible (characters appear as "?").</para> <para><filename>WinMerge.exe</filename> also can not open files with names outside the current ANSI codepage (e.g., WinMerge.exe @@ -71,11 +70,11 @@ <para>Browse to the folder you want to compare (folder contents is shown in the dialog). Do not select any of the files or subfolders, just select the <guibutton>Open</guibutton>-button when - "<guilabel>Folder Selection</guilabel>" is shown in filename - editbox. If you already selected any of the files or subfolders, - just write some nonsense to the filename editbox and select the - Open-button. When the filename editbox doesn't contain any existing - filename then WinMerge opens the folder.</para> + "<guilabel>Folder Selection</guilabel>" is shown in filename editbox. + If you already selected any of the files or subfolders, just write + some nonsense to the filename editbox and select the Open-button. When + the filename editbox doesn't contain any existing filename then + WinMerge opens the folder.</para> </answer> </qandaentry> @@ -90,9 +89,8 @@ <para>Unfortunately not. We acknowledge it would be good feature but have no plans to implement it in near future. This can be somewhat worked around by using two WinMerge instances. Or using third path - parameter given from command line. See <link - linkend="CommandLine">Command Line</link> -chapter for more - information.</para> + parameter given from command line. See <xref linkend="CommandLine" /> + for more information.</para> </answer> </qandaentry> @@ -105,8 +103,8 @@ <answer> <para>Not currently. If somebody wants to help/work with cross-platform support (using <ulink - url="http://www.wxwidgets.org/">wxWidgets</ulink> for example) we - are interested, of course.</para> + url="http://www.wxwidgets.org/">wxWidgets</ulink> for example) we are + interested, of course.</para> </answer> </qandaentry> @@ -117,10 +115,9 @@ <answer> <para>Which kind of CVS integration WinMerge should have? Adding CVS - client features to WinMerge is questionable since there are many - good CVS clients already. WinMerge can resolve conflict files, see - <link linkend="ResolveConflictFiles">Resolving Confilict - Files</link>.</para> + client features to WinMerge is questionable since there are many good + CVS clients already. WinMerge can resolve conflict files, see <xref + linkend="ResolveConflictFiles" />.</para> </answer> </qandaentry> @@ -130,8 +127,8 @@ </question> <answer> - <para>MRU is the abbreviation for "Most Recently Used", and means - the history lists in the Open-dialog which contain the 20 last used + <para>MRU is the abbreviation for "Most Recently Used", and means the + history lists in the Open-dialog which contain the 20 last used files/paths per side.</para> </answer> </qandaentry> @@ -156,17 +153,17 @@ <answer> <para>This is because WinMerge uses the "<guilabel>Quick - Compare</guilabel>" method for large files always. It allows - WinMerge to compare large files more efficiently. To test if this is - causing the behavior you're seeing, you could raise the limit for - the <guilabel>Quick Compare</guilabel> threshold for large files. It - is stored in the registry as:</para> + Compare</guilabel>" method for large files always. It allows WinMerge + to compare large files more efficiently. To test if this is causing + the behavior you're seeing, you could raise the limit for the + <guilabel>Quick Compare</guilabel> threshold for large files. It is + stored in the registry as:</para> <screen>HKEY_CURRENT_USER\Software\Thingamahoochie\WinMerge\Settings\QuickMethodLimit</screen> <para>You may consider raising this limit if you constantly compare - large text files. Be careful to not raise it too much "for just to - be sure". 100 MB is too much.</para> + large text files. Be careful to not raise it too much "for just to be + sure". 100 MB is too much.</para> <para>The default value for the limit is 4MB (0x400000).</para> </answer> @@ -174,9 +171,8 @@ <qandaentry> <question> - <para>WinMerge shows an error (or even crashes!) complaining it - cannot load CompareMSWordFiles.dll and/or - CompareMSExcelFiles.dll!</para> + <para>WinMerge shows an error (or even crashes!) complaining it cannot + load CompareMSWordFiles.dll and/or CompareMSExcelFiles.dll!</para> </question> <answer> @@ -194,11 +190,10 @@ <para>Download the Visual Basic 6.0 runtime distribution from <trademark class="registered">Microsoft</trademark>:<ulink url="http://support.microsoft.com/kb/290887">http://support.microsoft.com/kb/290887</ulink> - and install it. Or download just the one needed file from: - <ulink + and install it. Or download just the one needed file from: <ulink url="http://www.dll-files.com/dllindex/dll-files.shtml?msvbvm60">http://www.dll-files.com/dllindex/dll-files.shtml?msvbvm60</ulink> - and copy it to the <filename - class="directory">WinMerge</filename> folder.</para> + and copy it to the <filename class="directory">WinMerge</filename> + folder.</para> </listitem> </orderedlist> </answer> @@ -218,8 +213,8 @@ <answer> <para>When installing from archive (zip, 7z) file you need also - Runtimes-package, which contains those files. See the <link - linkend="InstallFromArchive">Install instructions</link>.</para> + Runtimes-package, which contains those files. See the <xref + linkend="InstallFromArchive" />.</para> </answer> </qandaentry> </qandaset> @@ -231,19 +226,18 @@ <qandaset> <qandaentry> <question> - <para>Why my files have all lines marked different (colored) even if - I know all lines are not different?</para> + <para>Why my files have all lines marked different (colored) even if I + know all lines are not different?</para> </question> <answer> - <para>Maybe your files have different line-ending styles (e.g. - Windows and Unix?). WinMerge by default compares also line-ending - styles, but you can disable it from <menuchoice> + <para>Maybe your files have different line-ending styles (e.g. Windows + and Unix?). WinMerge by default compares also line-ending styles, but + you can disable it from <menuchoice> <guimenu>Edit</guimenu> <guimenuitem>Options</guimenuitem> - </menuchoice> / Compare / Ignore carriage return - differences.</para> + </menuchoice> / Compare / Ignore carriage return differences.</para> </answer> </qandaentry> </qandaset> @@ -298,18 +292,17 @@ <qandaentry> <question> - <para>What is delaying of (automatic) rescan? Why it is - needed?</para> + <para>What is delaying of (automatic) rescan? Why it is needed?</para> </question> <answer> - <para>When <guilabel>Automatic Rescan</guilabel> is enabled, - WinMerge delays rescanning while user edits files. So there is no - rescanning happening when user types text but shortly after user has - finished typing. Without this delaying WinMerge would do rescan - after every typed letter and editing files would become slow. This - delaying especially improves editing of bigger files which can take - several seconds to rescan.</para> + <para>When <guilabel>Automatic Rescan</guilabel> is enabled, WinMerge + delays rescanning while user edits files. So there is no rescanning + happening when user types text but shortly after user has finished + typing. Without this delaying WinMerge would do rescan after every + typed letter and editing files would become slow. This delaying + especially improves editing of bigger files which can take several + seconds to rescan.</para> </answer> </qandaentry> @@ -330,14 +323,14 @@ <qandaentry> <question> - <para>Can I hide similar lines in editor (so that only different - lines are visible)?</para> + <para>Can I hide similar lines in editor (so that only different lines + are visible)?</para> </question> <answer> <para>No, you can't. Many users have requested this feature but we - don't have any plans to implement it. We don't believe it would - really improve usability.</para> + don't have any plans to implement it. We don't believe it would really + improve usability.</para> </answer> </qandaentry> </qandaset> @@ -378,8 +371,8 @@ <answer> <para>Tell your external program to invoke WinMerge with the - <option>/ub</option> option, which tells WinMerge to not add the - files to the MRU.</para> + <option>/ub</option> option, which tells WinMerge to not add the files + to the MRU.</para> </answer> </qandaentry> @@ -425,8 +418,8 @@ </answer> <answer> - <para>If the error is something like: "<emphasis>7-zip x.xx missing - / Plugin present</emphasis>", then you probably have installed 7-Zip + <para>If the error is something like: "<emphasis>7-zip x.xx missing / + Plugin present</emphasis>", then you probably have installed 7-Zip using MSI-installer. There are 7-Zip MSI installers that do not install all the files WinMerge needs (namely <filename>7zip_pad.xml</filename> in 7-Zip program folder). Download @@ -436,17 +429,16 @@ <qandaentry> <question> - <para>How can I open "Perry-style" patch files WinMerge developers - use when submitting patches?</para> + <para>How can I open "Perry-style" patch files WinMerge developers use + when submitting patches?</para> </question> <answer> <para>"Perry-style" patches are zip-files containing original and - changed files in different directories. WinMerge has internal - support (surprise?) for handling these files. Just select zip file - in question to left side and right side and WinMerge opens zip files - contents to folder compare comparing original and altered - files.</para> + changed files in different directories. WinMerge has internal support + (surprise?) for handling these files. Just select zip file in question + to left side and right side and WinMerge opens zip files contents to + folder compare comparing original and altered files.</para> </answer> </qandaentry> @@ -499,16 +491,16 @@ <guimenu>File</guimenu> <guimenuitem>Save As</guimenuitem> - </menuchoice>, and in the Save As dialog which appears, look at - the dropdown list at the very bottom, labelled + </menuchoice>, and in the Save As dialog which appears, look at the + dropdown list at the very bottom, labelled "<guilabel>Encoding</guilabel>".</para> <itemizedlist> <listitem> <para>If it says "<guilabel>ANSI</guilabel>", the file is (apparently) in the local windows codepage. If the file is - entirely in English and normal punctuation, then the file is - also in ASCII.</para> + entirely in English and normal punctuation, then the file is also + in ASCII.</para> </listitem> <listitem> @@ -518,14 +510,14 @@ </listitem> <listitem> - <para>If it says "<guilabel>UTF-8</guilabel>", the file is in - the cross-platform Unicode encoding "UTF-8".</para> + <para>If it says "<guilabel>UTF-8</guilabel>", the file is in the + cross-platform Unicode encoding "UTF-8".</para> </listitem> <listitem> <para>If it says "<guilabel>Unicode big endian</guilabel>", the - file is in a different Unicode encoding not much used or - supported under Windows, probably "UCS-2BE".</para> + file is in a different Unicode encoding not much used or supported + under Windows, probably "UCS-2BE".</para> </listitem> </itemizedlist> </answer> @@ -554,10 +546,10 @@ </listitem> <listitem> - <para>For WinMerge to read encodings specified in XML or HTML - (or Windows RC resource) files, the option checkbox - <guilabel>Detect codepage info for...</guilabel> in - <guilabel>Codepage</guilabel> options (<menuchoice> + <para>For WinMerge to read encodings specified in XML or HTML (or + Windows RC resource) files, the option checkbox <guilabel>Detect + codepage info for...</guilabel> in <guilabel>Codepage</guilabel> + options (<menuchoice> <guimenu>Edit</guimenu> <guimenuitem>Options</guimenuitem> @@ -568,9 +560,9 @@ <answer> <para>For all other cases, to instruct WinMerge to assume that all - documents are UTF-8, set the default WinMerge codepage to 65001 - (which is Microsoft's code for UTF-8) in - <guilabel>Codepage</guilabel> options (<menuchoice> + documents are UTF-8, set the default WinMerge codepage to 65001 (which + is Microsoft's code for UTF-8) in <guilabel>Codepage</guilabel> + options (<menuchoice> <guimenu>Edit</guimenu> <guimenuitem>Options</guimenuitem> @@ -587,16 +579,14 @@ <qandaset> <qandaentry> <question> - <para>Is there way to create patch files from the - commandline?</para> + <para>Is there way to create patch files from the commandline?</para> </question> <answer> - <para>No. It may be added in later versions but until then Win32 - port of diffutils can be used. The Win32 port of diffutils (and - patch) can be downloaded from <application>GnuWin32</application> - project from SourceForge: <ulink - url="http://sourceforge.net/projects/gnuwin32/"> + <para>No. It may be added in later versions but until then Win32 port + of diffutils can be used. The Win32 port of diffutils (and patch) can + be downloaded from <application>GnuWin32</application> project from + SourceForge: <ulink url="http://sourceforge.net/projects/gnuwin32/"> http://sourceforge.net/projects/gnuwin32</ulink></para> </answer> </qandaentry> @@ -608,8 +598,8 @@ <answer> <para>No. The patch tool from GnuWin32 project can be used for patch - applying since WinMerge produces GNU/diffutils compatible patch - files. See above question.</para> + applying since WinMerge produces GNU/diffutils compatible patch files. + See above question.</para> </answer> </qandaentry> </qandaset> Modified: trunk/Docs/Users/Manual/Install.xml =================================================================== --- trunk/Docs/Users/Manual/Install.xml 2008-07-23 12:10:00 UTC (rev 5660) +++ trunk/Docs/Users/Manual/Install.xml 2008-07-23 14:17:25 UTC (rev 5661) @@ -2,53 +2,83 @@ <article id="Installing"> <title>Getting and installing WinMerge</title> - <para>WinMerge can be installed using the installer or by unzipping files from an archive. Using the installer is the recommended method.</para> + <para>WinMerge can be installed using the installer or by unzipping files from + an archive. Using the installer is the recommended method.</para> <note> - <para>Currently the WinMerge installer works natively only for 32-bit Windows. There is no separate version of WinMerge for 64-bit Windows (WinXP/2003/Vista). 64-bit Windows versions can run the installer and WinMerge as 32-bit applications. For the shell Integration, the installer includes the 64-bit version of the extension.</para> + <para>Currently the WinMerge installer works natively only for 32-bit + Windows. There is no separate version of WinMerge for 64-bit Windows + (WinXP/2003/Vista). 64-bit Windows versions can run the installer and + WinMerge as 32-bit applications. For the shell Integration, the installer + includes the 64-bit version of the extension.</para> </note> <section> <title>Getting files</title> - <para>The latest release can be always downloaded from the WinMerge home page: <ulink url="http://winmerge.org/">WinMerge.org</ulink>. Note that delays can occur in updating home pages for the latest releases, but the project status page at <ulink url="https://sourceforge.net/projects/winmerge/">SourceForge.net</ulink> shows the latest files. There is also a mailing list for release announcements. Stable releases are also available in several file download sites.</para> + <para>The latest release can be always downloaded from the WinMerge home + page: <ulink url="http://winmerge.org/">WinMerge.org</ulink>. Note that + delays can occur in updating home pages for the latest releases, but the + project status page at <ulink + url="https://sourceforge.net/projects/winmerge/">SourceForge.net</ulink> + shows the latest files. There is also a mailing list for release + announcements. Stable releases are also available in several file download + sites.</para> </section> <section> <title>Using the installer (recommended)</title> <note> - <para>The installer requires Administrator user privileges in Windows NT4/2000/XP. If you don't have admin user privileges, you can install WinMerge by unzipping from an archive file (see <link linkend="InstallFromArchive">Installing from an archive</link>).</para> + <para>The installer requires Administrator user privileges in Windows + NT4/2000/XP. If you don't have admin user privileges, you can install + WinMerge by unzipping from an archive file (see <xref + linkend="InstallFromArchive" />).</para> </note> - <para>Using the installer is recommended for most users. The installer prompts for the location where WinMerge is installed. It then installs the files, configures the shell integration, and adds WinMerge to the Start menu. To install WinMerge:</para> + <para>Using the installer is recommended for most users. The installer + prompts for the location where WinMerge is installed. It then installs the + files, configures the shell integration, and adds WinMerge to the Start + menu. To install WinMerge:</para> <orderedlist> <listitem> - <simpara>Start the installer executable (usually named <filename>WinMerge-<replaceable>version</replaceable>-setup.exe</filename>).</simpara> + <simpara>Start the installer executable (usually named + <filename>WinMerge-<replaceable>version</replaceable>-setup.exe</filename>).</simpara> </listitem> <listitem> - <simpara>Click <guibutton>Next</guibutton> in the Welcome screen.</simpara> + <simpara>Click <guibutton>Next</guibutton> in the Welcome + screen.</simpara> </listitem> <listitem> - <simpara>Click <guibutton>Next</guibutton> in the License Agreement screen.</simpara> + <simpara>Click <guibutton>Next</guibutton> in the License Agreement + screen.</simpara> </listitem> <listitem> - <simpara>In the Select Destination Location page, accept the locat... [truncated message content] |
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. |
From: <ki...@us...> - 2008-08-09 15:05:43
|
Revision: 5776 http://winmerge.svn.sourceforge.net/winmerge/?rev=5776&view=rev Author: kimmov Date: 2008-08-09 15:05:38 +0000 (Sat, 09 Aug 2008) Log Message: ----------- PATCH: [ 2038924 ] Major edit Compare_files help topic Submitted by Denis Bradford Modified Paths: -------------- trunk/Docs/Users/Manual/Compare_dirs.xml trunk/Docs/Users/Manual/Compare_files.xml trunk/Docs/Users/Manual/Intro_diffs.xml trunk/Docs/Users/Manual/Open_paths.xml trunk/Docs/Users/Manual/Quick_start.xml trunk/Docs/Users/Manual/screenshots/filecomp_margin2.png trunk/Docs/Users/Manual/screenshots/linediff.png Added Paths: ----------- trunk/Docs/Users/Manual/screenshots/allleft_btn.png trunk/Docs/Users/Manual/screenshots/allright_btn.png trunk/Docs/Users/Manual/screenshots/copyl_adv_btn.png trunk/Docs/Users/Manual/screenshots/copyr_adv_btn.png trunk/Docs/Users/Manual/screenshots/diff_inline_btn.png trunk/Docs/Users/Manual/screenshots/lastdiff_btn.png trunk/Docs/Users/Manual/screenshots/locpane_currentdiff.png trunk/Docs/Users/Manual/screenshots/locpane_diffs.png trunk/Docs/Users/Manual/screenshots/locpane_moved_diffs.png trunk/Docs/Users/Manual/screenshots/locpane_viewbar.png trunk/Docs/Users/Manual/screenshots/multifilecomp1.png trunk/Docs/Users/Manual/screenshots/multifilecomp2.png trunk/Docs/Users/Manual/screenshots/multifilecomp3.png trunk/Docs/Users/Manual/screenshots/prevdiff_btn.png trunk/Docs/Users/Manual/screenshots/save_mod1.png trunk/Docs/Users/Manual/screenshots/undo_btn.png Modified: trunk/Docs/Users/Manual/Compare_dirs.xml =================================================================== --- trunk/Docs/Users/Manual/Compare_dirs.xml 2008-08-09 09:28:28 UTC (rev 5775) +++ trunk/Docs/Users/Manual/Compare_dirs.xml 2008-08-09 15:05:38 UTC (rev 5776) @@ -1,13 +1,13 @@ <?xml version="1.0" encoding="UTF-8"?> <article id="CompareDirs"> - <title>Comparing folders<indexterm> + <title>Comparing and merging folders<indexterm> <primary>comparing folders</primary> </indexterm></title> <para>This topic describes how to compare and merge folders using the Folder Compare window.</para> - <section> + <section id="Compare_dirs_starting"> <title>Starting a folder compare operation</title> <para>You can begin a folder compare operation from either the WinMerge @@ -121,7 +121,7 @@ </section> </section> - <section> + <section id="Compare_dirs_window"> <title>Folder Compare window<indexterm> <primary>Folder Compare window</primary> </indexterm></title> @@ -304,7 +304,7 @@ </section> </section> - <section> + <section id="Compare_dirs_multiwin"> <title>Working with multiple Folder Compare windows</title> <para>By default, the WinMerge window displays a single Folder Compare @@ -312,10 +312,10 @@ 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> + for Folder compare</guilabel> option.</para> <section> - <title>Using the Tab bar with maximized compare windows</title> + <title>Using tabs 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 @@ -327,8 +327,9 @@ fileref="screenshots/multifoldercomp1.png" format="PNG" /> </imageobject> - <caption><para>Multiple Folder Compare windows: default - display</para></caption> + <textobject> + <phrase>Multiple Folder Compare windows: default display</phrase> + </textobject> </mediaobject> <para>Often, it's convenient to maximize your Compare window (by clicking @@ -342,7 +343,9 @@ fileref="screenshots/multifoldercomp2.png" format="PNG" /> </imageobject> - <caption><para>Multiple Comparison windows: maximized</para></caption> + <textobject> + <phrase>Multiple Folder Compare windows: maximized</phrase> + </textobject> </mediaobject> <para>When you maximize one Compare window, any other Compare windows are @@ -373,12 +376,14 @@ fileref="screenshots/multifoldercomp3.png" format="PNG" /> </imageobject> - <caption><para>Multiple Comparison windows: tabbed</para></caption> + <textobject> + <phrase>Multiple Folder Compare windows: tabbed</phrase> + </textobject> </mediaobject> </section> </section> - <section> + <section id="Compare_dirs_fileops"> <title>File operations in Folder Compare<indexterm> <primary>file operations</primary> @@ -612,7 +617,7 @@ </itemizedlist> </section> - <section> + <section id="protectingfiles"> <title>Protecting files<indexterm> <primary>Folder Compare window</primary> @@ -757,7 +762,7 @@ </section> </section> - <section> + <section id="Compare_dirs_browsing"> <title>Browsing folders in the Folder Compare window<indexterm> <primary>folders</primary> @@ -957,7 +962,7 @@ </section> </section> - <section> + <section id="Compare_dirs_customizing"> <title>Customizing the Folder Compare window<indexterm> <primary>Folder Compare window</primary> Modified: trunk/Docs/Users/Manual/Compare_files.xml =================================================================== --- trunk/Docs/Users/Manual/Compare_files.xml 2008-08-09 09:28:28 UTC (rev 5775) +++ trunk/Docs/Users/Manual/Compare_files.xml 2008-08-09 15:05:38 UTC (rev 5776) @@ -1,665 +1,1563 @@ <?xml version="1.0" encoding="UTF-8"?> <article id="CompareFiles"> - <title>Comparing Files</title> + <title>Comparing and merging files<indexterm> + <primary>comparing files</primary> + </indexterm></title> - <para>File compare window is basically two files opened to editor into two - horizontal panes. The editor allows user to do a basic file editing inside - WinMerge without needing to open files to external editor program or - development environment.</para> + <para>This topic describes how to use the WinMerge File Compare window to + compare and merge files. To understand the basic concepts about differences + used here, we suggest you read read <xref linkend="IntroductDiffing" /> + first.</para> - <mediaobject> - <imageobject> - <imagedata fileref="screenshots/filecomp1.png" format="PNG" /> - </imageobject> + <section id="Compare_files_starting"> + <title>Starting a file compare operation</title> - <caption><para>File Compare Window</para></caption> - </mediaobject> + <para>You can start a file compare operation from either the WinMerge window + or a Command Prompt window.</para> - <para>WinMerge editor is not comparable to specialized editor programs, but it - has basic features like <guilabel>Undo</guilabel>/<guilabel>Redo</guilabel>, - <guilabel>Find</guilabel>/<guilabel>Replace</guilabel> and - <guilabel>Goto</guilabel> (to linenumber). The editor also has a syntax - highlighting feature supporting several file formats (colors configurable). - Note however WinMerge does not syntax highlight text inside differences. - Syntax highlighting can be disabled from options.</para> + <variablelist> + <varlistentry> + <term>From the WinMerge window</term> - <tip> - <para>If <guilabel>Automatic rescan</guilabel> is not enabled manual refresh - is recommended after editing.</para> - </tip> + <listitem> + <para>Click <menuchoice> + <guimenu>File</guimenu> - <section> - <title>Showing the Differences</title> + <guimenuitem>Open</guimenuitem> + </menuchoice>. Use the Select Files or Folders dialog to specify the + left and right source files to compare. For more details about the + Select Files or Folder dialog, see <xref + linkend="OpenPaths" />.</para> + </listitem> + </varlistentry> - <para>WinMerge uses different (user configurable) colors to highlight and - select differences. By default WinMerge shows different lines with yellow - background and missing lines with gray background. If user selects the - difference, it is shown with red background and missing lines with milder - red.</para> + <varlistentry> + <term>From a Command Prompt window</term> + + <listitem> + <para>Run <command>WinMergeU.exe</command>, which is in your WinMerge + install directory. In your command arguments, include the left and + right files to compare. For more information about using the command + line, see <xref linkend="CommandLine" />.</para> + </listitem> + </varlistentry> + </variablelist> </section> - <section> - <title>Tabs</title> + <section id="Compare_files_window"> + <title>File Compare window<indexterm> + <primary>File Compare window</primary> + </indexterm></title> - <para>WinMerge can show open windows in tab bar below toolbar. Tab bar can - be shown and hidden from menu <menuchoice> - <guimenu>View</guimenu> + <para>The File Compare window displays compared files in two File panes, + side by side. The WinMerge toolbar and context menu provides functions for + viewing, navigating, and merging differences. The screen shot below shows a + comparison of two versions of a file.</para> - <guimenuitem>Tab Bar</guimenuitem> - </menuchoice>. When the tab bar is shown it has one tab for every open - window. The tab contains last part of the folder names or file names.</para> - </section> + <mediaobject> + <imageobject> + <imagedata contentwidth="600" fileref="screenshots/filecomp1.png" + format="PNG" /> + </imageobject> - <section> - <title>File Headerbar</title> + <textobject> + <phrase>File Compare Window</phrase> + </textobject> + </mediaobject> - <para>The file headerbar has several functionalities. See screenshot - below:</para> + <section> + <title>File panes<indexterm> + <primary>File panes</primary> + </indexterm></title> - <para><inlinemediaobject> - <imageobject> - <imagedata fileref="screenshots/file_headerbar1.png" format="PNG" /> - </imageobject> - </inlinemediaobject></para> + <para>The left and right File panes show the text contents and differences + of the two files being compared. The File panes are the main area for + navigating and merging differences, and also allow you to edit the text + directly. This section describes the features that support these actions, + and ways that you can customize the File panes.</para> - <para>Headerbar shows full path to the open file. If the path is longer than - available space one part of the path is replaced with an ellipsis (...). - Headerbar also shows:<itemizedlist> - <listitem> - <simpara>the current active file with sunken border (like in the above - screenshot), the non-active file is shown with flat - headerbar.</simpara> - </listitem> + <section> + <title>File pane header</title> - <listitem> - <simpara>if the file has been modified (has unsaved changes). This is - indicated by adding asterisk (<guilabel>*</guilabel>) before the - filename, like in the screenshot.</simpara> - </listitem> - </itemizedlist></para> + <para>The header at the top of each File pane shows the full path of the + source file. The left and right file names are also identified in the + header of the Compare Window, above the File panes.</para> - <para>Headerbar has a context menu with items to copy full path or filename - to clipboard.</para> - </section> + <para>One of the File panes is always active (indicated by the dark + header background); the other is inactive and has a lighter header bar. + You can edit only in the active pane (as described in <xref + linkend="CompareFiles_editing" />). Click in either side to make it + active and make the other side inactive.</para> - <section> - <title>Statusbar</title> + <para>An asterisk (*) before the filename in the header indicates that + there are unsaved changes in the file.</para> - <para><inlinemediaobject> - <imageobject> - <imagedata fileref="screenshots/filecomp_statusbar1.png" format="PNG" /> - </imageobject> - </inlinemediaobject></para> + <para>The header bar's context menu has shortcuts that are useful for + copying and pasting file information:</para> - <para>Statusbar upper line shows information about current line. In first - pane:</para> + <variablelist> + <varlistentry> + <term>Copy Full Path<indexterm> + <primary>Copy Full Path function</primary> + </indexterm></term> - <itemizedlist> - <listitem> - <simpara><guilabel>Ln</guilabel> : current linenumber</simpara> - </listitem> + <listitem> + <para>Copies the full path of the source file into the system + clipboard.</para> + </listitem> + </varlistentry> - <listitem> - <simpara><guilabel>Col</guilabel>: current column for cursor and total - number of columns in line</simpara> - </listitem> + <varlistentry> + <term>Copy Filename<indexterm> + <primary>Copy Filename function</primary> + </indexterm></term> - <listitem> - <simpara><guilabel>Ch</guilabel> : current char for cursor and total - number of chars in line</simpara> - </listitem> + <listitem> + <para>Copies just the source filename into the system + clipboard.</para> + </listitem> + </varlistentry> + </variablelist> + </section> - <listitem> - <simpara><guilabel>EOL</guilabel> : current line EOL style (shown only - when <guilabel>Preserve original EOL chars</guilabel>-option is - enabled)</simpara> - </listitem> - </itemizedlist> + <section> + <title>Difference colors in File panes<indexterm> + <primary>difference colors</primary> - <note> - <para><guilabel>Col</guilabel> counts <keycap>TAB</keycap> as - <replaceable>X</replaceable> chars (as defined in editor options) and - <guilabel>Ch</guilabel> counts <keycap>TAB</keycap> as one - character.</para> - </note> + <secondary>in File panes</secondary> + </indexterm></title> - <para>Other three panes are:</para> + <para>Unless your files are identical, the content of the File panes + includes some differences. Difference blocks are marked with background + colors, which you can configure in WinMerge options. The basic + difference color is dark yellow, by default. When selected, the + difference color is red. Identical lines (like the second line in the + preceding screen shot) have white backgrounds.</para> - <para><itemizedlist> - <listitem> - <simpara>read-only: <guilabel>RO</guilabel> is shown in the pane if - the file is read-only / protected</simpara> - </listitem> + <para>WinMerge inserts one or more gray blank lines in one version of a + difference when the other version has more lines. These empty lines + (which change from gray to light red when the difference is selected) do + not represent blank lines in the source file; they are only placeholders + in the display. The purpose of placeholder lines is to keep the left and + right versions of differences vertically aligned.</para> - <listitem> - <simpara>encoding: this pane shows codepage number for ANSI files and - Unicode encoding type for Unicode files</simpara> - </listitem> + <para>By default, different words within difference lines are also + marked with a background color. You can disable this coloring, or (for + even more granular highlighting) add character-level difference + coloring. Both are controlled by the Line Difference Coloring settings + in the Editing page of WinMerge options. To change the various + difference colors used, edit the values in the Colors page of WinMerge + options.</para> + </section> - <listitem> - <simpara>EOL style: EOL style can be <guilabel>Win</guilabel> for - Windows/DOS files (CRLF), <guilabel>Unix</guilabel> (LF) or - <guilabel>Mac</guilabel> (CR)</simpara> - </listitem> - </itemizedlist>Note there are two different ways to show EOL style. When - per-line EOL style is not remembered, EOL style is shown on own pane in - statusbar. And when per-line EOL style is remembered line's EOL style is - shown after char number. When per-line EOL style is used there is no - file-wide EOL style.</para> + <section id="CompareFiles_editing"> + <title>File pane editing features<indexterm> + <primary>editing</primary> - <para>Difference between column and char is that column counts tabulator - character as so many (space) chars as it occupies (4 by default, can be - changed from options). But char count counts tabulator char as one - char.</para> + <secondary>features in File Compare window</secondary> + </indexterm></title> - <para>Lower line in statusbar shows current difference and amount of - differences. Text can be:<itemizedlist> + <para>Although WinMerge is a not a full-featured editor or IDE, it does + provide basic editing functions, like <guilabel>Undo</guilabel> and + <guilabel>Redo</guilabel>, <guilabel>Find</guilabel> and + <guilabel>Replace</guilabel>, and <guilabel>Goto</guilabel>. These basic + editing tasks are often needed during merging (for example, to change + text within differences). You can edit in the active File pane + (remember, click in a pane to make it active). Changes are not written + to a file until you save a pane to a result file.</para> + + <para>WinMerge editing features also include syntax highlighting. This + optional feature supports several file formats, and you can configure + the colors used. Note that syntax highlighting is not applied within + differences, as the preceding screen shot shows.</para> + + <tip> + <para>Make sure that <guilabel>Automatic rescan</guilabel> is enabled, + as described in <xref linkend="Compare_files_scan" />. If it is not, + manually refresh your view (press F5) before and after editing a file, + to ensure that WinMerge difference detection is up to date.</para> + </tip> + </section> + + <section> + <title>File pane fonts<indexterm> + <primary>fonts</primary> + + <secondary>choosing in File Compare window</secondary> + </indexterm></title> + + <para>You can choose fonts for the File pane by clicking <menuchoice> + <guimenu>View</guimenu> + + <guimenuitem>Select Font</guimenuitem> + </menuchoice>. WinMerge supports only fixed width fonts.</para> + + <para>Here are font suggestions for using WinMerge with East Asian + languages:</para> + + <itemizedlist> + <listitem> + <simpara>Simplified Chinese: <guilabel>SimSun</guilabel> or + <guilabel>SimHei</guilabel> fixed-width fonts</simpara> + </listitem> + + <listitem> + <simpara>Traditional Chinese: <guilabel>MingLiU</guilabel> + fixed-width font</simpara> + </listitem> + + <listitem> + <simpara>Japanese: <guilabel>MS Gothic</guilabel> or <guilabel>MS + Mincho</guilabel> fixed-width fonts</simpara> + </listitem> + + <listitem> + <simpara>Korean: <guilabel>GulimChe</guilabel> fixed-width font (not + <guilabel>Gulim</guilabel>, because this variant uses + proportional-spacing glyphs that are not centered in grid cells and + poorly aligned in fixed-width mode).</simpara> + </listitem> + </itemizedlist> + </section> + + <section> + <title>File pane margins<indexterm> + <primary>margins</primary> + + <secondary>in File panes</secondary> + </indexterm></title> + + <para>The File panes have optional gray margins that show line numbers + and some symbols. To show or hide the margins, clicking <menuchoice> + <guimenu>View</guimenu> + + <guimenuitem>View Margins</guimenuitem> + </menuchoice>. If you are using multiple File Compare windows, you can + control margins for each window independently. The margin can show any + or all of these features:<indexterm> + <primary>line numbers</primary> + + <secondary>in File panes</secondary> + </indexterm><indexterm> + <primary>bookmarks</primary> + </indexterm><indexterm> + <primary>word wrapping</primary> + + <secondary>in File panes</secondary> + </indexterm></para> + + <itemizedlist> + <listitem> + <para>Line numbers, if <menuchoice> + <guimenu>View</guimenu> + + <guimenuitem>View Line Numbers</guimenuitem> + </menuchoice> is enabled.</para> + </listitem> + + <listitem> + <para>Bookmarks, if <menuchoice> + <guimenu>Edit</guimenu> + + <guisubmenu>Bookmarks</guisubmenu> + </menuchoice> is enabled. A bookmark is a blue circle, in the + margin next to a line, that you can make WinMerge remember and + return to.</para> + + <itemizedlist> + <listitem> + <para>To set a bookmark on a line, double-click in its margin + (or press (<keycombo> + <keycap>Ctrl</keycap> + + <keycap>F2</keycap> + </keycombo>). The same action deletes an existing + bookmark.</para> + </listitem> + + <listitem> + <para>To navigate bookmarks, click <menuchoice> + <guimenu>Edit</guimenu> + + <guimenuitem>Bookmarks</guimenuitem> + </menuchoice> and choose <guimenuitem>Next</guimenuitem> or + <guimenuitem>Previous</guimenuitem>.</para> + </listitem> + + <listitem> + <para>Double-click a single bookmark to delete it (or press + (<keycombo> + <keycap>Ctrl</keycap> + + <keycap>F2</keycap> + </keycombo>).</para> + </listitem> + + <listitem> + <para>Click <menuchoice> + <guimenu>Edit</guimenu> + + <guimenuitem>Bookmarks</guimenuitem> + + <guimenuitem>Clear All Bookmarks</guimenuitem> + </menuchoice> to delete all bookmarks.</para> + </listitem> + </itemizedlist> + </listitem> + + <listitem> + <para>Word wrap arrow symbols, if <menuchoice> + <guimenu>View</guimenu> + + <guimenuitem>Wrap Lines</guimenuitem> + </menuchoice> is enabled.</para> + </listitem> + </itemizedlist> + + <para>The following screen shot shows a margin with bookmarks and word + wrap enabled. Without line numbers, the margin width is minimal.</para> + + <mediaobject> + <imageobject> + <imagedata contentwidth="384" + fileref="screenshots/filecomp_margin1.png" format="PNG" /> + </imageobject> + + <textobject> + <phrase>File Compare window margin with bookmark and word + wrap</phrase> + </textobject> + </mediaobject> + + <para>The next screen shot shows a margin with bookmarks and line + numbers enabled. Notice that the margin is wider. In fact, the margin is + wide enough for the largest line number. Thus, the margins for large + files with many lines can be quite wide.</para> + + <mediaobject> + <imageobject> + <imagedata contentdepth="77" contentwidth="384" + fileref="screenshots/filecomp_margin2.png" format="PNG" /> + </imageobject> + + <textobject> + <phrase>File Compare window margin with bookmark and line + numbers</phrase> + </textobject> + </mediaobject> + </section> + </section> + + <section id="Compare_files_functions"> + <title>Toolbar and menus<indexterm> + <primary>toolbar, with File Compare window</primary> + </indexterm><indexterm> + <primary>menus, with File Compare window</primary> + </indexterm></title> + + <para>The WinMerge toolbar and menus provide a range of functions to + navigate, select, and merge differences within files.</para> + + <note> + <para>WinMerge shortcuts have the same names and buttons whether you + open a Folder Compare or File Compare window. However, the functions + behave differently: with a File Compare window, the functions operate on + differences within files, not on differences within folders.</para> + </note> + + <para>The difference functions you can use depend on your context, which + often changes as you work. This means that a function is available only + when its operation is possible for a given location or other condition in + your WinMerge environment. For example, if you click in a line of text + within a difference, you might notice several navigation and merge buttons + become enabled in the toolbar. If you click in another area of text that + is not within a difference, these functions become unavailable. </para> + + <para>Difference functions are available in the WinMerge toolbar,and also + through these alternate mechanisms:</para> + + <itemizedlist> <listitem> - <simpara><guilabel>Identical</guilabel> : files are identical there - are no differences</simpara> + <para>WinMerge menus, especially <guimenu>Merge</guimenu></para> </listitem> <listitem> - <simpara><guilabel>X differences Found</guilabel> : amount of - differences, no difference is selected</simpara> + <para>Context menus within the File Compare window (when you + right-click in text)</para> </listitem> <listitem> - <simpara><guilabel>Difference X of Y</guilabel> : amount of - differences (<guilabel>Y</guilabel>) and number of selected difference - (<guilabel>X</guilabel>)</simpara> + <para>Keyboard shortcuts</para> </listitem> - </itemizedlist></para> - </section> + </itemizedlist> - <section> - <title>Editor Margin</title> + <para>Difference functions are described in <xref + linkend="Compare_files_nav" /> and <xref linkend="Compare_files_merge" />, + later in this topic. <xref linkend="QuickStart" /> and <xref + linkend="IntroductDiffing" /> provide examples of comparing and + merging.</para> - <para>The editor panes (file panes) have optional gray margin area for line - numbers and some symbols. This margin can be shown/hidded from menu - <menuchoice> - <guimenu>View</guimenu> + <section> + <title>Merge Mode<indexterm> + <primary>merge mode</primary> + </indexterm></title> - <guimenuitem>View Margins</guimenuitem> - </menuchoice>. The margin shows:</para> + <para><menuchoice> + <guimenu>File</guimenu> - <itemizedlist> - <listitem> - <simpara>Line numbers (from menu <menuchoice> - <guimenu>View</guimenu> + <guimenu>Merge Mode</guimenu> + </menuchoice> restores these WinMerge 1.7.1 single keyboard shortcuts + for difference merging and navigating functions:</para> - <guimenuitem>View Line Numbers</guimenuitem> - </menuchoice>)</simpara> - </listitem> + <itemizedlist> + <listitem> + <simpara><keycap>Up</keycap> and <keycap>Down</keycap> keys for the + <function>Previous Difference</function> and <function>Next + Difference</function> functions.</simpara> + </listitem> - <listitem> - <simpara>Bookmarks (menu <menuchoice> - <guimenu>Edit</guimenu> + <listitem> + <simpara><keycap>Left</keycap> and <keycap>Right</keycap> keys for + the <function>Copy Left</function> and <function>Copy + Right</function> functions.</simpara> + </listitem> + </itemizedlist> - <guisubmenu>Bookmarks</guisubmenu> - </menuchoice>)</simpara> - </listitem> + <para>Merge mode omits the <keycap>Alt</keycap> key for these common + operations (making them quicker to use than the normal mode). Note that + the <keycap>Shift</keycap> and <keycap>Alt</keycap> + <keycap>Arrow</keycap> key combinations work in merge mode in the same + way as normal mode.</para> - <listitem> - <simpara>Word wrap symbols, when word wrap is enabled</simpara> - </listitem> - </itemizedlist> + <para>Merge mode is indicated in the status bar by the text, + <guilabel>Merge</guilabel>.</para> + </section> + </section> - <para>When line numbers are not shown then margin is shown like screenshot - below.</para> + <section> + <title>Location pane<indexterm> + <primary>Location pane, File Compare window</primary> + </indexterm></title> - <para><inlinemediaobject> - <imageobject> - <imagedata fileref="screenshots/filecomp_margin1.png" format="PNG" /> - </imageobject> - </inlinemediaobject></para> + <para>The Location pane, to the left of the File panes, maps the entire + length of the compared files into two vertical bars (corresponding to the + left and right File panes). It is especially useful for working with files + that are too long to easily navigate in the File panes.</para> - <para>Blue circle is a Bookmark. And arrow marks word-wrapped line. Next - screenshot shows same lines without word-wrap and with linenumbers.</para> + <para>The Location pane shows several kinds of items:</para> - <para><inlinemediaobject> - <imageobject> - <imagedata fileref="screenshots/filecomp_margin2.png" format="PNG" /> - </imageobject> - </inlinemediaobject></para> + <variablelist> + <varlistentry> + <term><inlinemediaobject> + <imageobject> + <imagedata contentdepth="15" + fileref="screenshots/locpane_diffs.png" /> + </imageobject> - <para>If linenubmers are not visible it takes pretty minimal width. Note - that with linenumbers the margin width is set so that the longest line - number fits into it. So with large files with lots of lines it needs space - for several numbers.</para> - </section> + <textobject> + <phrase>Location pane diff lines</phrase> + </textobject> + </inlinemediaobject> Difference blocks</term> - <section> - <title><indexterm> - <primary>Difference Navigation</primary> + <listitem> + <para>Each difference block in the File panes is indicated in the + Location pane by a horizontal line across each vertical bar. The + thickness, color , and locations of these lines are clues about of + the size (number of lines), types and distribution of all + differences in the files. For example, the color of a line is the + same as the color of the corresponding difference block. The + Location pane in the preceding screen shot shows many basic + differences (gold) and some empty difference blocks (gray).</para> + </listitem> + </varlistentry> - <secondary>File Compare</secondary> - </indexterm>Difference Navigation</title> + <varlistentry> + <term><inlinemediaobject> + <imageobject> + <imagedata contentdepth="15" + fileref="screenshots/locpane_currentdiff.png" /> + </imageobject> - <para>Difference navigation commands are in <guimenu>Merge</guimenu> - menu:</para> + <textobject> + <phrase>Location pane current diff pointer</phrase> + </textobject> + </inlinemediaobject> Current difference</term> - <para><inlinemediaobject> - <imageobject> - <imagedata fileref="screenshots/merge_menu.png" format="PNG" /> - </imageobject> - </inlinemediaobject></para> + <listitem> + <para>If you have selected a difference, the Location pane marks the + current difference line with a pair of small triangles on either + side of the vertical bars. If you navigate to another difference, + the pointer moves up or down with the location. Scrolling the File + pane does not change the location of the difference pointer (or any + of the difference lines) in the location pane.</para> + </listitem> + </varlistentry> - <section> - <title>Selecting a difference</title> + <varlistentry> + <term><inlinemediaobject> + <imageobject> + <imagedata contentdepth="15" + fileref="screenshots/locpane_viewbar.png" /> + </imageobject> - <para>Before difference can be merged, it must be selected. Selecting can - happen by difference navigation keys/items (see below) or by selecting - wanted difference directly:</para> + <textobject> + <phrase>Location pane view area bar</phrase> + </textobject> + </inlinemediaobject> View area</term> + <listitem> + <para>The area of the files currently visible in the File panes is + indicated by a shaded (translucent) view bar over the Location pane. + The area bar's height and location correspond to the portion of the + files that is visible in the scroll region. For example, you might + see the bar expand or shrink if you change the height of your File + panes. This synchronization of the Location pane view bar and File + panes enables quick navigation, and some useful actions:</para> + + <itemizedlist> + <listitem> + <para>When you scroll the File panes, the view area in the + Location pane moves with it.</para> + </listitem> + + <listitem> + <para>Conversely, you can drag the view area bar in the Location + pane up or down to scroll the File panes. This scrollbar thumb + action is very handy for navigating long files.</para> + </listitem> + + <listitem> + <para>Click anywhere in the Location pane to jump to the + corresponding location in the File panes.</para> + </listitem> + </itemizedlist> + </listitem> + </varlistentry> + + <varlistentry> + <term>Moved differences<indexterm> + <primary>moved differences, in File Compare window</primary> + </indexterm></term> + + <listitem> + <para>The Location pane can indicate difference blocks that are + moved. Moved blocks are two sides of a difference that are in + different locations. Moved blocks are indicated by the + <guilabel>Moved</guilabel> and <guilabel>Selected Moved</guilabel> + difference colors (configurable in WinMerge Options) and by lines + connecting their locations in the left and right location bars. For + example:</para> + + <mediaobject> + <imageobject> + <imagedata contentwidth="576" + fileref="screenshots/locpane_moved_diffs.png" + format="PNG" /> + </imageobject> + + <textobject> + <phrase>Location pane with moved diff</phrase> + </textobject> + </mediaobject> + + <para>Showing moved blocks can make it easier to visualize changes + in files. However, if there are too many moved lines it can appear + cluttered. Use your own judgement!</para> + </listitem> + </varlistentry> + </variablelist> + + <para>The Location pane's context menu contains these shortcuts:<indexterm> + <primary>context menu</primary> + + <secondary>Location pane</secondary> + </indexterm><indexterm> + <primary>Moved Blocks functions</primary> + </indexterm></para> + <itemizedlist> <listitem> - <simpara>Double-click over difference with mouse</simpara> + <para><guimenuitem>Goto Line 1</guimenuitem>: Moves the cursor to the + top of the file.</para> </listitem> <listitem> - <simpara>Move cursor inside difference and select it with - <guimenuitem>Current Difference</guimenuitem>.</simpara> + <para><guimenuitem>Goto</guimenuitem>: Moves the cursor to a line you + specify (described in <xref + linkend="Compare_files_nav_functions" />).</para> </listitem> + + <listitem> + <para><guimenuitem>No Moved Blocks</guimenuitem>: Turns off moved + difference color for moved blocks.</para> + </listitem> + + <listitem> + <para><guimenuitem>All Moved Blocks</guimenuitem>: Turns on moved + difference color for all moved blocks.</para> + </listitem> + + <listitem> + <para><guimenuitem>Moved Block for Current Diff</guimenuitem>: Turns + on moved difference color only for current selected moved + difference.</para> + </listitem> </itemizedlist> </section> <section> - <title>Navigating differences</title> + <title>Diff pane<indexterm> + <primary>Diff pane, File Compare window</primary> + </indexterm></title> - <para><guimenu>Merge</guimenu>-menu has items for navigating to - next/previous and first/last difference. Navigation is always done based - on current cursor location. So <guimenuitem>Next - Difference</guimenuitem>-command selects next difference from cursor, not - from current selected difference.</para> + <para>The Diff pane shows the contents of the two sides of a selected + difference.</para> - <note> - <para>When difference is selected with navigation commands cursor is - moved to begin of first line of difference. In both files.</para> - </note> + <para>When you select a difference, the two versions are loaded in the + upper and lower sides of the Diff pane. In this way, the Diff pane + confirms which lines are included in a difference, and lets you examine + them in isolation from the rest of the file.</para> + + <para>You can merge differences directly in the Diff pane by + right-clicking in either the top or bottom side and choosing + <function><guimenuitem>Copy to Right</guimenuitem></function> or + <guimenuitem>Copy to Left</guimenuitem>.</para> </section> <section> - <title><guimenuitem>Current Difference</guimenuitem>-command</title> + <title>Status bars<indexterm> + <primary>status bars</primary> - <para>This command has two important functions:<itemizedlist> + <secondary>for File Compare window</secondary> + </indexterm><indexterm> + <primary>tab</primary> + + <secondary>character encoding</secondary> + </indexterm></title> + + <para>Each File pane contains a status bar at the bottom. The status bar + contains several panes with different types of information about the + document and your location in it:</para> + + <variablelist> + <varlistentry> + <term>Line status</term> + <listitem> - <simpara>When there is no difference selected and cursor is inside - difference, it selects this difference. This is very handy way to - select difference from keyboard.</simpara> + <itemizedlist> + <listitem> + <para><guilabel>Ln</guilabel>: Line number in the source + file.</para> + </listitem> + + <listitem> + <para><guilabel>Col</guilabel>: Column location of the cursor + and the total number of columns in the line.</para> + + <para><guilabel>Col</guilabel> counts tabs as + <replaceable>n</replaceable> spaces, where + <replaceable>n</replaceable> is the number of characters defined + as the <guilabel>Tab size</guilabel> in the Editor page of + WinMerge options (4 by default). </para> + </listitem> + + <listitem> + <para><guilabel>Ch</guilabel>: Character location of cursor and + the total number of chars in the line.</para> + + <para><guilabel>Ch</guilabel> counts tabs as single tab + characters.</para> + </listitem> + + <listitem> + <para><guilabel>EOL</guilabel>: Linefeed style of the current + line (shown only when the <guilabel>Preserve original EOL + chars</guilabel> option is enabled in the Editor page of + WinMerge options).</para> + </listitem> + </itemizedlist> </listitem> + </varlistentry> + <varlistentry> + <term>Read-only status</term> + <listitem> - <simpara>When there is selected difference, it scrolls to selected - difference. This is handy if user has scrolled selected difference - out of screen. So this allows user to scroll files to see other - contents and quickly return back to selected difference.</simpara> + <para><guilabel>RO</guilabel> is shown in the pane if the file is + set to read-only (as described in <xref + linkend="protectingfiles" />). Otherwise the pane is empty.</para> </listitem> + </varlistentry> + + <varlistentry> + <term>File encoding </term> + + <listitem> + <para>Codepage number for ANSI files, Unicode encoding type for + Unicode files.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term>EOL style</term> + + <listitem> + <para>EOL style of the file: <guilabel>Win</guilabel> for + Windows/DOS files (CRLF), <guilabel>Unix</guilabel> (LF), + <guilabel>Mac</guilabel> (CR), or Mixed.</para> + + <note> + <para>When the per-line EOL style is used, the file EOL style is + not shown (this pane is blank).</para> + </note> + </listitem> + </varlistentry> + </variablelist> + + <para>When a File Compare window is open, the WinMerge window status bar + shows one of these messages about the compared files:<itemizedlist> + <listitem> + <para><guilabel>Identical</guilabel>: The files contain no + differences</para> + </listitem> + + <listitem> + <para><guilabel><replaceable>n</replaceable> Differences + Found</guilabel>: The number of differences detected, displayed only + when no difference is selected.</para> + </listitem> + + <listitem> + <para><guilabel>Difference <replaceable>x</replaceable> of + <replaceable>n</replaceable></guilabel>: The selected difference's + sequence number in the total number of differences, starting with + 1.</para> + </listitem> </itemizedlist></para> </section> - <section> - <title>Go To line or difference</title> + <section id="Compare_files_multiwin"> + <title>Working with multiple File Compare windows<indexterm> + <primary>File Compare window</primary> - <para>Using <guimenuitem>Go To</guimenuitem> from - <guimenu>Edit</guimenu>-menu user can jump to certain line or difference. - Go To -dialog shows current line and side when opened.</para> + <secondary>multiple</secondary> + </indexterm></title> - <tip> - <para>Go To line number is useful if there is need to merge same change - to several target files from one original file. Rather than using - <guimenuitem>Find</guimenuitem> or difference navigation it is faster to - jump to first line of difference.</para> - </tip> + <para>By default, the WinMerge window displays a single File Compare + window. If you start another file comparison (by clicking <menuchoice> + <guimenu>File</guimenu> + + <guimenuitem>Open</guimenuitem> + </menuchoice> and selecting another pair of files) while a File Compare + window is currently open, the current File Compare window is closed, + unless WinMerge detects unsaved changes in the left or right file. If you + have modified either file, WinMerge prompts you to save or discard your + changes before opening a new File Compare window.</para> + + <!--We don't say that the old window is closed, even though most of the time that's what happens. +If you click Cancel in the Save dialog, WinMerge does NOT close the current window, and you end up +with multiple File Compare windows. The reasons why this behavior has not been fixed is discussed in +https://sourceforge.net/forum/forum.php?thread_id=2001747&forum_id=41637--> + + <para>For example, in the next screen shot WinMerge gives you a chance to + save changes detected in the right side file:</para> + + <mediaobject> + <imageobject> + <imagedata contentwidth="400" fileref="screenshots/save_mod1.png" + format="PNG" /> + </imageobject> + + <textobject> + <phrase>Save modifed files? dialog</phrase> + </textobject> + </mediaobject> + + <para>If you plan to work with multiple compare operations simultaneously, + consider setting (checking) the <guilabel>Enable multiple compare windows + for File compare</guilabel> option, which is disabled by default. With + this option enabled, you can open multiple File Compare windows without + the intervening Save step.</para> </section> - </section> - <section> - <title><indexterm> - <primary>Merging Differences</primary> - </indexterm>Merging Differences</title> + <section> + <title>Using tabs with maximized Compare windows<indexterm> + <primary>File Compare window</primary> - <para>Merging commands are located in <guimenu>Merge</guimenu>-menu after - navigation commands. Basically there are only two types of merging commands - - copy difference from right to left and copy difference from left to right. - Additional commands make merging several differences easier.</para> + <secondary>using tabs when maximizing</secondary> + </indexterm></title> - <para><guimenuitem>Copy to Right</guimenuitem> and <guimenuitem>Copy to - Left</guimenuitem> copy difference from side to side. At simplest this means - replacing text in destination difference with text in source difference. But - because difference can contain also removed lines, new lines may be created - or some lines removed. If there are several differences selected, then all - fully selected differences are merged with one command. This makes merging - many small differences a lot faster.</para> + <para>By default, Compare windows are displayed as individually resizeable + child windows within the WinMerge window, like this:</para> - <para>WinMerge rescans files after every merging operation. This is done to - ensure differences were copied correctly and all changes after last - rescanning are taken care of. If <guilabel>Automatic - rescan</guilabel>-option is not set, user may have edited files and - differences may not have shown correctly before merging. If result of - merging is not what were wanted, user can undo merging operation.</para> + <mediaobject> + <imageobject> + <imagedata contentwidth="569" fileref="screenshots/multifilecomp1.png" + format="PNG" /> + </imageobject> - <important> - <para>It is strongly advised to run <guimenuitem>Rescan</guimenuitem> - (<keycap>F5</keycap>) before merging differences if <guilabel>Automatic - rescan</guilabel> is set off. Usually files get out of sync when editing - and merging differences may have unpredictable results. If merging result - looks incorrect try undoing (<menuchoice> - <guimenu>Edit</guimenu> + <textobject> + <phrase>Multiple File Compare windows: default display</phrase> + </textobject> + </mediaobject> - <guimenuitem>Undo</guimenuitem> - </menuchoice> from menu or <keycombo> - <keycap>Ctrl</keycap> + <para>If you maximize your Compare window (by clicking its Maximixe + button), the window fills all the available space in the WinMerge window, + giving you the most room possible to work in. However, if you are working + with multiple Compare windows, only one one maximized window is visible: + any others are hidden. The screen shot below shows the header area of a + maximized Compare window:</para> - <keycap>Z</keycap> - </keycombo>) it and rescanning files. And then merging again.</para> - </important> + <mediaobject> + <imageobject> + <imagedata contentwidth="569" fileref="screenshots/multifilecomp2.png" + format="PNG" /> + </imageobject> - <para><guimenuitem>Copy to Right/Left and Advance</guimenuitem>-commands - merge current difference and then select next difference (if there is one). - Using these commands makes merging several differences easier and - faster.</para> + <textobject> + <phrase>Multiple File Compare windows: maximized</phrase> + </textobject> + </mediaobject> - <para><guimenuitem>Copy All to Right/Left</guimenuitem>-commands sync two - open files by merging all differences. Note that you can undo this whole - operation with one undo command.</para> + <para>To access other Compare 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. But 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 the available Compare windows. To open any of them, just click + its tab:</para> + + <mediaobject> + <imageobject> + <imagedata contentwidth="569" fileref="screenshots/multifilecomp3.png" + format="PNG" /> + </imageobject> + + <textobject> + <phrase>Multiple File Compare windows: tabbed</phrase> + </textobject> + </mediaobject> + </section> + </section> + + <section id="Compare_files_nav"> + <title>Navigating differences<indexterm> + <primary>difference navigation</primary> + + <secondary>File Compare window</secondary> + </indexterm></title> + + <para>This section describes how to navigate and select differences in the + File Compare window. Note that when you select a difference, it is always + selected in both File panes.</para> + <tip> - <para>Enable <guilabel>Automatically scroll to first difference</guilabel> - -option from general options. This saves you from scrolling to first - difference and selecting it. See <xref linkend="Configuration" /> for more - information.</para> + <para>To save time, enable <guilabel>Automatically scroll to first + difference</guilabel> in the General page of WinMerge options. Then you + don't have to manually navigate to the first difference and select + it.</para> </tip> - </section> - <section> - <title><indexterm> - <primary>Merge Mode</primary> - </indexterm>Merge Mode</title> + <section id="Compare_files_nav_functions"> + <title>Navigation functions<indexterm> + <primary>WinMerge functions</primary> - <para>Merge mode can be enabled from the <guimenu>File</guimenu>-menu. It - restores the WinMerge 1.7.1 single keys for difference merging and - navigating:</para> + <secondary>difference navigation in File Compare window</secondary> + </indexterm></title> - <itemizedlist> - <listitem> - <simpara><keycap>Up-</keycap> and <keycap>Down arrow</keycap> keys - select previous and next difference</simpara> - </listitem> + <para>Here are the functions for navigating differences in the File + Compare window, and their shortcuts in the toolbar and menus:</para> - <listitem> - <simpara><keycap>Left-</keycap> and <keycap>Right arrow</keycap> keys - merge difference to left side or right side.</simpara> - </listitem> - </itemizedlist> + <variablelist> + <varlistentry> + <term>Difference in the Current Line/Select Line Difference<indexterm> + <primary>Difference in the Current LIne function</primary> + </indexterm><indexterm> + <primary>Select Line Difference function</primary> + </indexterm></term> - <para>Unlike the normal mode, in this schema the <keycap>Alt</keycap>-key is - not needed for these basic operations (which makes them quicker and more - convenient). Note that <keycombo> - <keycap>Shift</keycap> + <listitem> + <para>Shortcuts: <inlinemediaobject> + <imageobject> + <imagedata contentdepth="15" + fileref="screenshots/diff_inline_btn.png" /> + </imageobject> - <keycap>Arrow</keycap> - </keycombo>, <keycombo> - <keycap>Alt</keycap> + <textobject> + <phrase>Difference in the Current Line button</phrase> + </textobject> + </inlinemediaobject> button, <menuchoice> + <guimenu>Edit</guimenu> - <keycap>Arrow</keycap> - </keycombo> and <keycombo> - <keycap>Ctrl</keycap> + <guimenuitem>Select Line Difference</guimenuitem> + </menuchoice>, <keycap>F4</keycap>, context menu in File pane + within a difference.</para> - <keycap>Alt</keycap> + <para>Enabled if you have clicked in (or selected) text within a + difference in a File pane. Selects the word differences within the + line. For example:</para> - <keycap>Arrow</keycap> - </keycombo> keys work in merge mode like in normal mode.</para> + <mediaobject> + <imageobject> + <imagedata contentwidth="562" fileref="screenshots/linediff.png" + format="PNG" /> + </imageobject> - <para>When merge mode is enabled <guilabel>Merge</guilabel> text is shown in - statusbar.</para> - </section> + <textobject> + <phrase>Select Line Difference example</phrase> + </textobject> + </mediaobject> - <section> - <title>Refreshing</title> + <para>If you want to select the difference block itself, use + <command>Current Difference</command> instead.</para> + </listitem> + </varlistentry> - <para>Refreshing updates differences after changes are made to files. It is - important to do a refresh before merging changes between files.</para> + <varlistentry> + <term>Next Difference<indexterm> + <primary>Next Difference function</primary> - <note> - <para>Refresh does not reload file. That means, if another programs has - updated files etc, those changes are not seen. Refresh updates differences - according changes user has done.</para> - </note> - </section> + <secondary>with Compare Files</secondary> + </indexterm></term> - <section> - <title>View Whitespaces</title> + <listitem> + <para>Shortcuts: <inlinemediaobject> + <imageobject> + <imagedata contentdepth="15" + fileref="screenshots/nextdiff_btn.png" /> + </imageobject> - <para>When enabled from <guimenu>View</guimenu> menu <guimenuitem>View - Whitespace</guimenuitem> feature shows all whitespace characters (spaces, - tabulators, line ends). This is very useful for example when there are - spaces in other file and tabulators in other. Also, if <guilabel>Preserve - original EOL chars</guilabel> is enabled, WinMerge shows type of EOL - (<guilabel>Windows</guilabel>/<guilabel>Unix</guilabel>/<guilabel>Mac</guilabel>).</para> - </section> + <textobject> + <phrase>Next Difference button</phrase> + </textobject> + </inlinemediaobject> button, <menuchoice> + <guimenu>Merge</guimenu> - <section> - <title>Editing Files</title> + <guimenuitem>Next Difference</guimenuitem> + </menuchoice>, <keycombo> + <keycap>Alt</keycap> - <para>Normal editing features work in WinMerge editor. User can type and - delete text, select text, copy, cut and paste text etc. There is some - customisation because there can be removed lines in files (lines existing - only in other side). Anyway these customisations are not usually visible to - users otherwise that lines can sometimes "jump" when WinMerge has to - relocate matching/non-matching files.</para> - </section> + <keycap>Down</keycap> + </keycombo> (or <keycap>Down</keycap> in merge mode).</para> - <section> - <title>Line Difference Highlight</title> + <para>Selects the next difference below your current cursor location + in the document (not necessarily relative... [truncated message content] |
From: <ki...@us...> - 2008-08-10 08:09:43
|
Revision: 5780 http://winmerge.svn.sourceforge.net/winmerge/?rev=5780&view=rev Author: kimmov Date: 2008-08-10 08:09:36 +0000 (Sun, 10 Aug 2008) Log Message: ----------- PATCH: [ 2038924 ] Major edit Compare_files help topic Minor, misc doc changes Submitted by Denis Bradford Modified Paths: -------------- trunk/Docs/Users/Manual/About_Doc.xml trunk/Docs/Users/Manual/Compare_dirs.xml trunk/Docs/Users/Manual/Compare_files.xml trunk/Docs/Users/Manual/Install.xml trunk/Docs/Users/Manual/Introduction.xml trunk/Docs/Users/Manual/Open_paths.xml trunk/Docs/Users/Manual/Quick_start.xml Added Paths: ----------- trunk/Docs/Users/Manual/screenshots/options_btn.png Modified: trunk/Docs/Users/Manual/About_Doc.xml =================================================================== --- trunk/Docs/Users/Manual/About_Doc.xml 2008-08-10 04:21:06 UTC (rev 5779) +++ trunk/Docs/Users/Manual/About_Doc.xml 2008-08-10 08:09:36 UTC (rev 5780) @@ -2,9 +2,11 @@ <article id="AboutDoc"> <title>About this document</title> - <para>This document is the user manual for WinMerge 2.8. It explains the - capabilities and limitations of WinMerge. This manual is recommended reading - for both new and experienced users.</para> + <para>This document is the user manual for WinMerge <xi:include + href="replaceables.xml" xmlns:xi="http://www.w3.org/2001/XInclude" + xpointer="element(version)" />. It explains the capabilities and limitations + of WinMerge. This manual is recommended reading for both new and experienced + users.</para> <para>To learn essential WinMerge basics, please read the following topics:</para> @@ -101,4 +103,4 @@ </listitem> </varlistentry> </variablelist> -</article> +</article> \ No newline at end of file Modified: trunk/Docs/Users/Manual/Compare_dirs.xml =================================================================== --- trunk/Docs/Users/Manual/Compare_dirs.xml 2008-08-10 04:21:06 UTC (rev 5779) +++ trunk/Docs/Users/Manual/Compare_dirs.xml 2008-08-10 08:09:36 UTC (rev 5780) @@ -124,6 +124,8 @@ <section id="Compare_dirs_window"> <title>Folder Compare window<indexterm> <primary>Folder Compare window</primary> + + <seealso>Compare windows</seealso> </indexterm></title> <para>The Folder Compare window shows the result of a folder compare in a @@ -591,7 +593,7 @@ <secondary>copying from Folder Compare window</secondary> </indexterm><indexterm> - <primary>filenames</primary> + <primary>file names</primary> <secondary>copying from Folder Compare window</secondary> </indexterm></title> @@ -1213,4 +1215,4 @@ </tip> </section> </section> -</article> +</article> \ No newline at end of file Modified: trunk/Docs/Users/Manual/Compare_files.xml =================================================================== --- trunk/Docs/Users/Manual/Compare_files.xml 2008-08-10 04:21:06 UTC (rev 5779) +++ trunk/Docs/Users/Manual/Compare_files.xml 2008-08-10 08:09:36 UTC (rev 5780) @@ -47,6 +47,8 @@ <section id="Compare_files_window"> <title>File Compare window<indexterm> <primary>File Compare window</primary> + + <seealso>Compare windows</seealso> </indexterm></title> <para>The File Compare window displays compared files in two File panes, @@ -536,7 +538,9 @@ <varlistentry> <term>Moved differences<indexterm> - <primary>moved differences, in File Compare window</primary> + <primary>moved differences</primary> + + <secondary>in File Compare window</secondary> </indexterm></term> <listitem> @@ -630,7 +634,7 @@ <secondary>for File Compare window</secondary> </indexterm><indexterm> - <primary>tab</primary> + <primary>tabs</primary> <secondary>character encoding</secondary> </indexterm></title> @@ -690,7 +694,7 @@ </varlistentry> <varlistentry> - <term>File encoding </term> + <term>File encoding</term> <listitem> <para>Codepage number for ANSI files, Unicode encoding type for @@ -884,7 +888,7 @@ <variablelist> <varlistentry> <term>Difference in the Current Line/Select Line Difference<indexterm> - <primary>Difference in the Current LIne function</primary> + <primary>Difference in the Current Line function</primary> </indexterm><indexterm> <primary>Select Line Difference function</primary> </indexterm></term> @@ -1161,7 +1165,7 @@ </indexterm></title> <para>Merging differences amounts to copying them from one File pane to the - other — either left to right, or right to left. This is different from + other: either left to right, or right to left. This is different from directly editing text using WinMerge's editing functions (described earlier in this topic).</para> Modified: trunk/Docs/Users/Manual/Install.xml =================================================================== --- trunk/Docs/Users/Manual/Install.xml 2008-08-10 04:21:06 UTC (rev 5779) +++ trunk/Docs/Users/Manual/Install.xml 2008-08-10 08:09:36 UTC (rev 5780) @@ -282,7 +282,7 @@ </section> </section> - <section> + <section id="Installing_archive_support"> <title><indexterm> <primary>installing archive support</primary> </indexterm>7-Zip and archive support</title> @@ -423,4 +423,4 @@ </orderedlist></para> </section> </section> -</article> +</article> \ No newline at end of file Modified: trunk/Docs/Users/Manual/Introduction.xml =================================================================== --- trunk/Docs/Users/Manual/Introduction.xml 2008-08-10 04:21:06 UTC (rev 5779) +++ trunk/Docs/Users/Manual/Introduction.xml 2008-08-10 08:09:36 UTC (rev 5780) @@ -2,29 +2,55 @@ <article id="Introduction"> <title>Introduction to WinMerge</title> - <para>WinMerge is an <ulink url="http://www.opensource.org/">Open Source</ulink> differencing and merging tool for Windows. WinMerge can compare both folders and files, presenting differences in a visual text format that is easy to understand and handle.</para> + <para>WinMerge is an <ulink url="http://www.opensource.org/">Open + Source</ulink> differencing and merging tool for Windows. WinMerge can compare + both folders and files, presenting differences in a visual text format that is + easy to understand and handle.</para> - <para>WinMerge is highly useful for determining what has changed between project versions, and then merging changes between versions. WinMerge can be used as an external differencing/merging tool or as a standalone application.</para> + <para>WinMerge is highly useful for determining what has changed between + project versions, and then merging changes between versions. WinMerge can be + used as an external differencing/merging tool or as a standalone + application.</para> - <para>In addition, WinMerge has many helpful supporting features that make comparing, synchronising, and merging as easy and useful as possible. Several programming languages and other file formats are syntax-highlighted.</para> + <para>In addition, WinMerge has many helpful supporting features that make + comparing, synchronising, and merging as easy and useful as possible. Several + programming languages and other file formats are syntax-highlighted.</para> - <para>WinMerge is not a hex editor. WinMerge can show binary files contents and differences between them. But the information is meant for viewing only: editing binary files with WinMerge can break the files.</para> + <para>WinMerge is not a hex editor. WinMerge can show binary files contents + and differences between them. But the information is meant for viewing only: + editing binary files with WinMerge can break the files.</para> - <para>The goal of WinMerge development is to make comparing, synchronizing, and merging folders and files easy and fast, while maintaining maximum reliability. Ease of use is of key importance for reducing errors. The latest 2.8 version is considered a stable and reliable program to use.</para> + <para>The goal of WinMerge development is to make comparing, synchronizing, + and merging folders and files easy and fast, while maintaining maximum + reliability. Ease of use is of key importance for reducing errors. The latest + version, <xi:include href="replaceables.xml" + xmlns:xi="http://www.w3.org/2001/XInclude" xpointer="element(version)" /> is + considered a stable and reliable program to use.</para> - <para>Please note that WinMerge is not freeware (as many sites on the Web have stated): it is <ulink url="http://www.gnu.org/licenses/gpl-2.0.html">GPL</ulink> licensed. We provide you with a good tool for free, so please honor your license agreement and submit improvements to us. We are happy to get help improving WinMerge, to the advantage of all WinMerge users.</para> + <para>Please note that WinMerge is not freeware (as many sites on the Web have + stated): it is <ulink + url="http://www.gnu.org/licenses/gpl-2.0.html">GPL</ulink> licensed. We + provide you with a good tool for free, so please honor your license agreement + and submit improvements to us. We are happy to get help improving WinMerge, to + the advantage of all WinMerge users.</para> <section> <title>WinMerge versions</title> - <para>There are three kind of versions available in the <ulink url="https://sourceforge.net/project/showfiles.php?group_id=13216">downloads</ulink> page.</para> + <para>There are three kind of versions available in the <ulink + url="https://sourceforge.net/project/showfiles.php?group_id=13216">downloads</ulink> + page.</para> <section> <title><indexterm> <primary>Stable versions</primary> </indexterm>Stable versions</title> - <para><ulink url="http://sourceforge.net/project/showfiles.php?group_id=13216&package_id=11248">Stable versions</ulink> are recommended for most users. If you are unsure about what version to use, use the latest stable version. Stable versions have an even second number, for example, 2.4, 2.6 and 2.8.</para> + <para><ulink + url="http://sourceforge.net/project/showfiles.php?group_id=13216&package_id=11248">Stable + versions</ulink> are recommended for most users. If you are unsure about + what version to use, use the latest stable version. Stable versions have + an even second number, for example, 2.4, 2.6 and 2.8.</para> </section> <section> @@ -32,7 +58,17 @@ <primary>Beta versions</primary> </indexterm>Beta versions</title> - <para><ulink url="http://sourceforge.net/project/showfiles.php?group_id=13216&package_id=29158">Beta versions</ulink> are for people who want to test latest features and improvements made after last stable version. Beta versions are not tested as extensively as stable versions and probably have some bugs. Beta versions have an odd second number, for example 2.5 and 2.7. Beta versions can be used in production, because they are not expected to have major bugs. But there is always a risk with using beta-level releases, so consider it carefully. We have tried to release a new stable series once a year, so it may be worth waiting for few months for the next stable release...</para> + <para><ulink + url="http://sourceforge.net/project/showfiles.php?group_id=13216&package_id=29158">Beta + versions</ulink> are for people who want to test latest features and + improvements made after last stable version. Beta versions are not tested + as extensively as stable versions and probably have some bugs. Beta + versions have an odd second number, for example 2.5 and 2.7. Beta versions + can be used in production, because they are not expected to have major + bugs. But there is always a risk with using beta-level releases, so + consider it carefully. We have tried to release a new stable series once a + year, so it may be worth waiting for few months for the next stable + release...</para> </section> <section> @@ -40,31 +76,70 @@ <primary>Experimental versions</primary> </indexterm>Experimental versions</title> - <para><ulink url="http://sourceforge.net/project/showfiles.php?group_id=13216&package_id=92246">Experimental versions</ulink> are snapshot releases from our version control system (Subversion). They have all the latest features and improvements. Some features may still be buggy or incomplete. These releases are made available to allow users to try out the current code without needing to compile, and to participate in development discussions concerning new and changing features. We also appreciate any help testing the current code. Use experimental versions with care and enable backups! And please <ulink url="http://sourceforge.net/tracker/?group_id=13216&atid=113216">report bugs</ulink> that you find while using these builds: it really helps with WinMerge development!</para> + <para><ulink + url="http://sourceforge.net/project/showfiles.php?group_id=13216&package_id=92246">Experimental + versions</ulink> are snapshot releases from our version control system + (Subversion). They have all the latest features and improvements. Some + features may still be buggy or incomplete. These releases are made + available to allow users to try out the current code without needing to + compile, and to participate in development discussions concerning new and + changing features. We also appreciate any help testing the current code. + Use experimental versions with care and enable backups! And please <ulink + url="http://sourceforge.net/tracker/?group_id=13216&atid=113216">report + bugs</ulink> that you find while using these builds: it really helps with + WinMerge development!</para> </section> <section> <title>Version tree</title> - <para>All this talk about different versions might be confusing if you never have worked with this kind of model. Lets illustrate with a picture:</para> + <para>All this talk about different versions might be confusing if you + never have worked with this kind of model. Lets illustrate with a + picture:</para> <para><mediaobject> <imageobject> <imagedata fileref="art/WinMerge_versions.png" format="PNG" /> </imageobject> - <caption><para> WinMerge stable and development versions</para></caption> - </mediaobject>The preceding diagram shows the relationships between different releases and versions. Development always happens within experimental and beta development versions. At the appropriate points we create new branches for stable releases. In the diagram, the arrows for 2.4.x and 2.6.x versions are two current stable branches. (The diagram is a snapshot; it is not updated to show the current stable branch).</para> + <caption><para> WinMerge stable and development + versions</para></caption> + </mediaobject>The preceding diagram shows the relationships between + different releases and versions. Development always happens within + experimental and beta development versions. At the appropriate points we + create new branches for stable releases. In the diagram, the arrows for + 2.4.x and 2.6.x versions are two current stable branches. (The diagram is + a snapshot; it is not updated to show the current stable branch).</para> <important> - <para>A branch always indicates a separate development effort. There is no any automation to copy improvements or fixes from development versions to stable versions, or in the opposite direction. Changes are always selected by hand and then merged (using WinMerge, of course).</para> + <para>A branch always indicates a separate development effort. There is + no any automation to copy improvements or fixes from development + versions to stable versions, or in the opposite direction. Changes are + always selected by hand and then merged (using WinMerge, of + course).</para> </important> - <para>After a branch is created, we try to keep the code in it as stable as possible. Usually this means that we copy only tested bug fixes from development versions to stable versions. Unfortunately this is not always an easy task, and errors can occur. New bugs can also appear in stable versions: this is real-life software development. However, in general, quality increases in branches. For example, 2.6.14 was a better release than 2.4.0. So we always recommend using the latest stable branch release.</para> + <para>After a branch is created, we try to keep the code in it as stable + as possible. Usually this means that we copy only tested bug fixes from + development versions to stable versions. Unfortunately this is not always + an easy task, and errors can occur. New bugs can also appear in stable + versions: this is real-life software development. However, in general, + quality increases in branches. For example, 2.6.14 was a better release + than 2.4.0. So we always recommend using the latest stable branch + release.</para> - <para>This branching also means that stable versions don't get many new features after a branch is created. Stable versions 2.6.0 and 2.6.14 had pretty similar features. After the 2.6 stable branch, we created a new stable branch, 2.8, where we added many improvements and fixes.</para> + <para>This branching also means that stable versions don't get many new + features after a branch is created. Stable versions 2.6.0 and 2.6.14 had + pretty similar features. After the 2.6 stable branch, we created a new + stable branch, 2.8, where we added many improvements and fixes.</para> - <para>Many software vendors always increase their version numbers and advise people to use the version with the biggest number. If WinMerge were developed as proprietary software, users would see only versions from stable branches. But because WinMerge is an open source software project, we want to keep our development as open as possible and to release many development versions. The latest development version can have version number 2.9.1.0 and the latest stable version can be version 2.6.14.</para> + <para>Many software vendors always increase their version numbers and + advise people to use the version with the biggest number. If WinMerge were + developed as proprietary software, users would see only versions from + stable branches. But because WinMerge is an open source software project, + we want to keep our development as open as possible and to release many + development versions. The latest development version can have version + number 2.9.1.0 and the latest stable version can be version 2.6.14.</para> </section> </section> @@ -75,23 +150,40 @@ <secondary>reporting bugs</secondary> </indexterm>Getting support and reporting bugs</title> - <para>The <ulink url="http://sourceforge.net/forum/forum.php?forum_id=41637">Open Discussion forum</ulink> is the fastest way to get help. Please be patient, it may take some time for somebody to answer.</para> + <para>The <ulink + url="http://sourceforge.net/forum/forum.php?forum_id=41637">Open Discussion + forum</ulink> is the fastest way to get help. Please be patient, it may take + some time for somebody to answer.</para> - <para>If you find a bug, please submit it as a <ulink url="http://sourceforge.net/tracker/?group_id=13216&atid=113216">bug report</ulink>. Please attach as much information as you can: at a minimum, the version number of WinMerge that you are using. If you can, also attach a configuration log which, you can display by clicking <menuchoice> + <para>If you find a bug, please submit it as a <ulink + url="http://sourceforge.net/tracker/?group_id=13216&atid=113216">bug + report</ulink>. Please attach as much information as you can: at a minimum, + the version number of WinMerge that you are using. If you can, also attach a + configuration log which, you can display by clicking <menuchoice> <guimenu>Help</guimenu> <guimenuitem>Configuration</guimenuitem> - </menuchoice> in the WinMerge window. Good information in a bug report makes it more likely that your bug will be fixed quickly.</para> + </menuchoice> in the WinMerge window. Good information in a bug report + makes it more likely that your bug will be fixed quickly.</para> <important> - <para>Include the version number in bug reports. You can check the version number by clicking <menuchoice> + <para>Include the version number in bug reports. You can check the version + number by clicking <menuchoice> <guimenu>Help</guimenu> <guimenuitem>About WinMerge</guimenuitem> </menuchoice>.</para> </important> - <para>We prefer that you <ulink url="https://sourceforge.net/account/registration/">register</ulink> with <ulink url="http://sourceforge.net/">SourceForge.net</ulink> before posting a bug report (registration is public and free), so that you receive email notifications if we post follow-up questions to your bug. Registration is not currently required for you to post a bug report. However, we generally give less priority to unregistered bug reports, because it has been our experience that unregistered posters often do not return to answer follow-up questions.</para> + <para>We prefer that you <ulink + url="https://sourceforge.net/account/registration/">register</ulink> with + <ulink url="http://sourceforge.net/">SourceForge.net</ulink> before posting + a bug report (registration is public and free), so that you receive email + notifications if we post follow-up questions to your bug. Registration is + not currently required for you to post a bug report. However, we generally + give less priority to unregistered bug reports, because it has been our + experience that unregistered posters often do not return to answer follow-up + questions.</para> </section> <section> @@ -99,18 +191,49 @@ <primary>WinMerge development</primary> </indexterm>WinMerge source code and development</title> - <para>WinMerge source code is available in the <ulink url="https://sourceforge.net/project/showfiles.php?group_id=13216">downloads</ulink> page and from the <ulink url="https://sourceforge.net/cvs/?group_id=13216">public Subversion server</ulink>. Anyone can download the sources, study them, and alter them. If you find (and fix) bugs, improve something, and so on, please submit your changes to us as <ulink url="http://sourceforge.net/tracker/?group_id=13216&atid=313216">patches</ulink> and help improve this product! If you publish your altered version, you are required to publish the changes to source code too. This is what the <ulink url="http://www.gnu.org/licenses/gpl-2.0.html">GPL</ulink> license is about: please respect it.</para> + <para>WinMerge source code is available in the <ulink + url="https://sourceforge.net/project/showfiles.php?group_id=13216">downloads</ulink> + page and from the <ulink + url="https://sourceforge.net/cvs/?group_id=13216">public Subversion + server</ulink>. Anyone can download the sources, study them, and alter them. + If you find (and fix) bugs, improve something, and so on, please submit your + changes to us as <ulink + url="http://sourceforge.net/tracker/?group_id=13216&atid=313216">patches</ulink> + and help improve this product! If you publish your altered version, you are + required to publish the changes to source code too. This is what the <ulink + url="http://www.gnu.org/licenses/gpl-2.0.html">GPL</ulink> license is about: + please respect it.</para> - <para>While WinMerge development has been fast in the last couple of years, all this work is done by people in their spare time. Nobody gets paid for improving WinMerge. We try to fix bugs as we find them or when somebody reports them to us. We really try â we use WinMerge too. But there are absolutely no promises for new features. We always appreciate any help with WinMerge, be it testing, documenting, translating, or coding.</para> + <para>While WinMerge development has been fast in the last couple of years, + all this work is done by people in their spare time. Nobody gets paid for + improving WinMerge. We try to fix bugs as we find them or when somebody + reports them to us. We really try â we use WinMerge too. But there are + absolutely no promises for new features. We always appreciate any help with + WinMerge, be it testing, documenting, translating, or coding.</para> <section> <title>Participating in WinMerge development</title> - <para>As mentioned above, we look for help in many areas, not just coding. Translation, documentation, and testing are important too.</para> + <para>As mentioned above, we look for help in many areas, not just coding. + Translation, documentation, and testing are important too.</para> - <para>The <ulink url="http://wiki.winmerge.org/">Development Wiki</ulink> is a good source of information if you want to help with WinMerge development. The <ulink url="http://winmerge.org/Wiki/Help_Needed">Help Needed</ulink> page in the wiki has more information about how to help with WinMerge development.</para> + <para>The <ulink url="http://wiki.winmerge.org/">Development Wiki</ulink> + is a good source of information if you want to help with WinMerge + development. The <ulink url="http://winmerge.org/Wiki/Help_Needed">Help + Needed</ulink> page in the wiki has more information about how to help + with WinMerge development.</para> - <para>The <ulink url="http://winmerge.org/support/mailing-lists.php">development-mailing</ulink> list is the preferred place for development discussions. Another place is in the <ulink url="http://sourceforge.net/forum/forum.php?forum_id=41639">developers-forum</ulink>. If you are interested in helping with WinMerge development, let us know. If you want to fix one of our <ulink url="http://sourceforge.net/tracker/?group_id=13216&atid=113216" userlevel="">bugs</ulink> or implement a <ulink url="http://sourceforge.net/tracker/?group_id=13216&atid=363216">new feature</ulink>, let us know.</para> + <para>The <ulink + url="http://winmerge.org/support/mailing-lists.php">development-mailing</ulink> + list is the preferred place for development discussions. Another place is + in the <ulink + url="http://sourceforge.net/forum/forum.php?forum_id=41639">developers-forum</ulink>. + If you are interested in helping with WinMerge development, let us know. + If you want to fix one of our <ulink + url="http://sourceforge.net/tracker/?group_id=13216&atid=113216" + userlevel="">bugs</ulink> or implement a <ulink + url="http://sourceforge.net/tracker/?group_id=13216&atid=363216">new + feature</ulink>, let us know.</para> </section> </section> -</article> +</article> \ No newline at end of file Modified: trunk/Docs/Users/Manual/Open_paths.xml =================================================================== --- trunk/Docs/Users/Manual/Open_paths.xml 2008-08-10 04:21:06 UTC (rev 5779) +++ trunk/Docs/Users/Manual/Open_paths.xml 2008-08-10 08:09:36 UTC (rev 5780) @@ -193,7 +193,11 @@ <listitem> <para>Designates the selected path as the first - (<guilabel>Left</guilabel>) path in the comparison.</para> + (<guilabel>Left</guilabel>) path in the comparison. The path is + loaded in memory; meanwhile WinMerge waits for you select the second + path in Windows Explorer, using the + <guimenuitem>Compare</guimenuitem> shortcut (described next). + </para> </listitem> </varlistentry> @@ -242,10 +246,13 @@ </varlistentry> </variablelist> - <para>The shell integration paths that you map are stored in memory only - until you use them to open WinMerge. They are discarded after a compare - operation. This means that you cannot select one <guimenuitem>Compare - To</guimenuitem> path and compare it against several paths.</para> + <para>The shell integration paths that you map are stored in memory until + you use them to open WinMerge. As a result, you don't need to select both + files at the same time or even using the same Windows Explorer view: you + can choose one, open a different directory, and choose the other one. + Both paths are discarded from memory after a compare operation. This means that you cannot select one + <guimenuitem>Compare To</guimenuitem> path and compare it against several + paths.</para> <para>Here is a simple method of using the advanced integration נthere are other scenarios, of course. In Windows Explorer:</para> @@ -483,4 +490,4 @@ example, <left></left> or <left/></literal>).</para> </section> </section> -</article> +</article> \ No newline at end of file Modified: trunk/Docs/Users/Manual/Quick_start.xml =================================================================== --- trunk/Docs/Users/Manual/Quick_start.xml 2008-08-10 04:21:06 UTC (rev 5779) +++ trunk/Docs/Users/Manual/Quick_start.xml 2008-08-10 08:09:36 UTC (rev 5780) @@ -4,9 +4,9 @@ <section> <title><indexterm> - <primary>Getting started with WinMerge</primary> + <primary>getting started with WinMerge</primary> </indexterm><indexterm> - <primary>Opening files and folders</primary> + <primary>opening files and folders</primary> <secondary>getting started</secondary> </indexterm>Opening files and folders</title> @@ -435,4 +435,4 @@ </inlinemediaobject> toolbar button, or pressing <keycap>F5</keycap>.</para> </section> -</article> +</article> \ No newline at end of file Property changes on: trunk/Docs/Users/Manual/screenshots/options_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. |
From: <ki...@us...> - 2008-08-10 08:31:15
|
Revision: 5784 http://winmerge.svn.sourceforge.net/winmerge/?rev=5784&view=rev Author: kimmov Date: 2008-08-10 08:31:13 +0000 (Sun, 10 Aug 2008) Log Message: ----------- PATCH: [ 2038924 ] Major edit Compare_files help topic Build/HTML generation changes Submitted by Denis Bradford Modified Paths: -------------- trunk/Docs/Users/Manual/build/build_common.xsl trunk/Docs/Users/Manual/css/all.css Modified: trunk/Docs/Users/Manual/build/build_common.xsl =================================================================== --- trunk/Docs/Users/Manual/build/build_common.xsl 2008-08-10 08:22:34 UTC (rev 5783) +++ trunk/Docs/Users/Manual/build/build_common.xsl 2008-08-10 08:31:13 UTC (rev 5784) @@ -34,6 +34,7 @@ <xsl:param name="admon.graphics.path">images/</xsl:param> <xsl:param name="admon.graphics.extension">.gif</xsl:param> <xsl:param name="section.autolabel" select="1"/> +<xsl:param name="appendix.autolabel">A</xsl:param> <xsl:param name="use.id.as.filename" select="1"/> <xsl:param name="chunker.output.indent" select="'yes'"></xsl:param> <xsl:param name="chunk.section.depth" select="0" /> @@ -61,4 +62,54 @@ <link rel="stylesheet" type="text/css" media="print" href="css/print.css" /> </xsl:template> +<!-- ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ +html/autotoc.xsl +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ --> +<!-- WinMerge: turn off section numbers in TOC. + Note: if we decide to set section.autolabel to 0 above, this customization can be removed --> +<xsl:template name="toc.line"> + <xsl:param name="toc-context" select="."/> + <xsl:param name="depth" select="1"/> + <xsl:param name="depth.from.context" select="8"/> + + <span> + <xsl:attribute name="class"><xsl:value-of select="local-name(.)"/></xsl:attribute> + + <!-- * if $autotoc.label.in.hyperlink is zero, then output the label --> + <!-- * before the hyperlinked title (as the DSSSL stylesheet does) --> + <xsl:if test="$autotoc.label.in.hyperlink = 0"> + <xsl:variable name="label"> + <xsl:apply-templates select="." mode="label.markup"/> + </xsl:variable> + <xsl:copy-of select="$label"/> + <xsl:if test="$label != ''"> + <xsl:value-of select="$autotoc.label.separator"/> + </xsl:if> + </xsl:if> + + <a> + <xsl:attribute name="href"> + <xsl:call-template name="href.target"> + <xsl:with-param name="context" select="$toc-context"/> + <xsl:with-param name="toc-context" select="$toc-context"/> + </xsl:call-template> + </xsl:attribute> + + <!-- * if $autotoc.label.in.hyperlink is non-zero, then output the label --> + <!-- * as part of the hyperlinked title --> + <!-- WinMerge: add test for section --> + <xsl:if test="not($autotoc.label.in.hyperlink = 0) and local-name(.) != 'section'" > + <xsl:variable name="label"> + <xsl:apply-templates select="." mode="label.markup"/> + </xsl:variable> + <xsl:copy-of select="$label"/> + <xsl:if test="$label != ''"> + <xsl:value-of select="$autotoc.label.separator"/> + </xsl:if> + </xsl:if> + <xsl:apply-templates select="." mode="titleabbrev.markup"/> + </a> + </span> +</xsl:template> + </xsl:stylesheet> Modified: trunk/Docs/Users/Manual/css/all.css =================================================================== --- trunk/Docs/Users/Manual/css/all.css 2008-08-10 08:22:34 UTC (rev 5783) +++ trunk/Docs/Users/Manual/css/all.css 2008-08-10 08:31:13 UTC (rev 5784) @@ -6,7 +6,7 @@ body,th,td { font-family: Verdana,Helvetica,Arial,sans-serif; - font-size: 80%; + font-size: 80%; } pre,code,tt { @@ -14,10 +14,6 @@ font-size: 100%; } -ul { - list-style-type: square; -} - /* Default link style */ a:link { color:#3366CC; text-decoration:underline; } a:visited { color:#003399; text-decoration:underline; } @@ -27,38 +23,80 @@ a[name]:hover { color:black; text-decoration:none; } -div.navheader, -div.navfooter { +/* Nav headers and footers */ +div.navheader, div.navfooter { background: #FFCC00; border-top: 1px solid black; border-bottom: 1px solid black; + padding: 1px 0 1px 0; } -div.navheader>table>tbody>tr>th { +div.navheader * * * th { display:none; } +div.navheader a, div.navheader a:visited, div.navfooter a, div.navfooter a:visited { + display: inline-block; + padding: 2px 4px 2px 4px; + text-decoration: none; + color: #ffdd700; + background-color: #F0E68C; + border: 1px solid #004080; +} -div.article, -div.section, -div.appendix, -div.index { - padding: 5px; +div.navheader a:hover, div.navfooter a:hover { + color: #000; + background: #fff; } -/* topic title */ -div.article>div>div>div>h2 { +/* Main topic divs */ +div.book,div.article,div.appendix,div.index { + margin: 0 10px 0 10px; +} + +div.section { + margin: 0 10px 0 20px; +} + +hr { + border: 0; + height: 1px; + color: #707070; + background-color: #707070; +} + +/* Help title page*/ +div.titlepage { + text-align: center; +} + +div.book h1 { + font-size: 200%; + color: #3333cc; + letter-spacing: 0.05em; +} + +/* Topic titles */ +div.article h2, div.appendix h2, div.index h2 { font-size: 160%; text-align: center; color: #3333cc; } div.section h2 { + text-align: left; font-size: 140%; } div.section h3 { + text-align: left; font-size: 120%; + color: #3333cc; } +div.section h4 { + text-align: left; + font-size: 110%; + color: #3333cc; +} #ads { padding-top: 10px; @@ -168,18 +206,21 @@ font-size: 100%; } -/* table of contents */ +/* Table of contents */ .toc dt { - margin-top: 1em; + line-height: 1.75em; + font-weight: bold; } .toc dd dl dt { - margin-top: 0; + line-height: 1.25em; + font-weight: normal; } -/*.toc .sect1,*/ -.toc .article, -.toc .appendix, -.toc .index { - font-size: 120%; - font-weight: bold; +/* TOC title */ +div.toc p{ + font-size: 150%; } + +div.toc a:visited, div.toc a:link { + text-decoration: none; +} This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site. |
From: <ki...@us...> - 2008-08-18 20:49:52
|
Revision: 5818 http://winmerge.svn.sourceforge.net/winmerge/?rev=5818&view=rev Author: kimmov Date: 2008-08-18 20:49:44 +0000 (Mon, 18 Aug 2008) Log Message: ----------- PATCH: [ 2053195 ] Update Help topics docedit-misc-5812.patch Submitted by Denis Bradford Modified Paths: -------------- trunk/Docs/Users/Manual/Compare_files.xml trunk/Docs/Users/Manual/Faq.xml trunk/Docs/Users/Manual/Install.xml trunk/Docs/Users/Manual/Open_paths.xml Modified: trunk/Docs/Users/Manual/Compare_files.xml =================================================================== --- trunk/Docs/Users/Manual/Compare_files.xml 2008-08-18 19:39:46 UTC (rev 5817) +++ trunk/Docs/Users/Manual/Compare_files.xml 2008-08-18 20:49:44 UTC (rev 5818) @@ -181,7 +181,7 @@ </tip> </section> - <section> + <section id="CompareFiles_fonts"> <title>File pane fonts<indexterm> <primary>fonts</primary> @@ -373,7 +373,7 @@ your WinMerge environment. For example, if you click in a line of text within a difference, you might notice several navigation and merge buttons become enabled in the toolbar. If you click in another area of text that - is not within a difference, these functions become unavailable. </para> + is not within a difference, these functions become unavailable.</para> <para>Difference functions are available in the WinMerge toolbar,and also through these alternate mechanisms:</para> @@ -662,7 +662,7 @@ <replaceable>n</replaceable> spaces, where <replaceable>n</replaceable> is the number of characters defined as the <guilabel>Tab size</guilabel> in the Editor page of - WinMerge options (4 by default). </para> + WinMerge options (4 by default).</para> </listitem> <listitem> @@ -1532,7 +1532,7 @@ <listitem> <para>Use all the normal compare and merge functions described earlier - in this topic to resolve the conflicts in the Mine File pane. </para> + in this topic to resolve the conflicts in the Mine File pane.</para> </listitem> <listitem> Modified: trunk/Docs/Users/Manual/Faq.xml =================================================================== --- trunk/Docs/Users/Manual/Faq.xml 2008-08-18 19:39:46 UTC (rev 5817) +++ trunk/Docs/Users/Manual/Faq.xml 2008-08-18 20:49:44 UTC (rev 5818) @@ -468,14 +468,14 @@ </qandaset> </section> - <section> + <section id="Faq_encoding"> <title>Text encoding (codepages)</title> <qandaset> <qandaentry> - <question> - <para>How do I tell if my file is coded in the local windows (ie, - ANSI) codepage?</para> + <question id="Faq_detectencoding"> + <para id="Faq_detectencoding_text">How do I tell if my file is coded + in the local windows (ie, ANSI) codepage?</para> </question> <answer> Modified: trunk/Docs/Users/Manual/Install.xml =================================================================== --- trunk/Docs/Users/Manual/Install.xml 2008-08-18 19:39:46 UTC (rev 5817) +++ trunk/Docs/Users/Manual/Install.xml 2008-08-18 20:49:44 UTC (rev 5818) @@ -26,7 +26,7 @@ sites.</para> </section> - <section> + <section id="Installing_usinginstaller"> <title>Using the installer (recommended)</title> <note> @@ -68,9 +68,10 @@ <simpara>In the Select Components page, choose one of the preconfigured installations in the top control. We recommend the <guilabel>Typical</guilabel> configuration for most users. The lower box - shows all the available components. You can modify a preconfigured - installation by checking or unchecking components. For example, you - might choose additional language files. Components are:</simpara> + shows all the available components. You can modify the default + configuration by checking or unchecking components. For example, if you + want to use a WinMerge localization for a different language than + English, select the <guilabel>Languages</guilabel> component. </simpara> <variablelist> <varlistentry> @@ -102,12 +103,14 @@ <term>Languages</term> <listitem> - <para>WinMerge translation files. After installing translation - file user interface language can be selected from menu <menuchoice> - <guimenu>View</guimenu> - - <guimenuitem>Language</guimenuitem> - </menuchoice>.</para> + <para>WinMerge translation files. If you want to configure + WinMerge to use a different language than English, expand this + item and choose one or more available translations. The installer + creates a Languages subfolder in the WinMerge folder, containing a + *.po translation file for each of your selections. After + installation, you can open WinMerge and change its localization to + one of the translation file languages. See <xref + linkend="Locales" /> for details.</para> </listitem> </varlistentry> </variablelist> @@ -209,8 +212,8 @@ </orderedlist> </section> - <section> - <title id="InstallFromArchive">Installing from an archive</title> + <section id="InstallFromArchive"> + <title>Installing from an archive</title> <para>WinMerge is pretty much independent of other system components. It is not tightly integrated with Windows, and does not use many DLLs.</para> @@ -423,4 +426,4 @@ </orderedlist></para> </section> </section> -</article> \ No newline at end of file +</article> Modified: trunk/Docs/Users/Manual/Open_paths.xml =================================================================== --- trunk/Docs/Users/Manual/Open_paths.xml 2008-08-18 19:39:46 UTC (rev 5817) +++ trunk/Docs/Users/Manual/Open_paths.xml 2008-08-18 20:49:44 UTC (rev 5818) @@ -277,7 +277,7 @@ <para>By default, WinMerge does not include subfolders in compare operations. To change the default behavior, enable <guilabel>Include - subfolders by befault</guilabel> in the System page of WinMerge options. + subfolders by default</guilabel> in the System page of WinMerge options. To change include subfolders while using the shell integration, press and hold the <keycap>Control</keycap> key while selecting <guimenuitem>Compare</guimenuitem> in the Windows Explorer context @@ -490,4 +490,4 @@ example, <left></left> or <left/></literal>).</para> </section> </section> -</article> \ No newline at end of file +</article> This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site. |
From: <ki...@us...> - 2008-08-19 14:43:27
|
Revision: 5820 http://winmerge.svn.sourceforge.net/winmerge/?rev=5820&view=rev Author: kimmov Date: 2008-08-19 14:43:22 +0000 (Tue, 19 Aug 2008) Log Message: ----------- PATCH: [ 2053195 ] Update Help topics docedit-plugins-5819.patch Submitted by Denis Bradford Modified Paths: -------------- trunk/Docs/Users/Manual/Open_paths.xml trunk/Docs/Users/Manual/Plugins.xml trunk/Docs/Users/Manual/replaceables.xml Added Paths: ----------- trunk/Docs/Users/Manual/select_unpacker.xml Modified: trunk/Docs/Users/Manual/Open_paths.xml =================================================================== --- trunk/Docs/Users/Manual/Open_paths.xml 2008-08-18 20:51:51 UTC (rev 5819) +++ trunk/Docs/Users/Manual/Open_paths.xml 2008-08-19 14:43:22 UTC (rev 5820) @@ -31,7 +31,7 @@ Select Files or Folders dialog more efficiently.</para> <section> - <title>Environment variables</title> + <title>Using environment variables</title> <para>You can use environment variables in your paths. Windows expands the variable name between % (percent) delimiters. For example, if an @@ -69,7 +69,7 @@ </section> <section> - <title>Filter selection</title> + <title>Selecting filters</title> <para>The third edit field in the Select Files or Folders dialog, <guilabel>Filter</guilabel>, enables you to restrict the files that are @@ -106,6 +106,29 @@ default <filename>*.*</filename> extension list).</para> </note> </section> + + <section id="Open_paths_unpacker"> + <title>Selecting an unpacker for file comparisons</title> + + <para>Unpackers are plugins that are installed with WinMerge to provide + functionality that is not used by default. Plugins that can be used to + preprocess certain types of files before comparing them. For example, + WinMerge cannot normally compare MS Word doc files, but by unpacking them, + you can compare just the text contents. See <xref linkend="Plugins" /> for + details.</para> + + <para>To apply a plugin to your file comparison, click the + <guibutton>Select</guibutton> button for the <guilabel>Unpacker</guilabel> + option. In the Select Unpacker dialog:</para> + + <xi:include href="select_unpacker.xml" + xmlns:xi="http://www.w3.org/2001/XInclude" + xpointer="element(select-unpacker-proc)" /> + + <para>Your choice is displayed in the <guilabel>Unpacker</guilabel> field. + Note that you cannot select an unpacker when launching a Folder Compare + operation.</para> + </section> </section> <section id="OpenPaths_shell-integ"> @@ -196,8 +219,7 @@ (<guilabel>Left</guilabel>) path in the comparison. The path is loaded in memory; meanwhile WinMerge waits for you select the second path in Windows Explorer, using the - <guimenuitem>Compare</guimenuitem> shortcut (described next). - </para> + <guimenuitem>Compare</guimenuitem> shortcut (described next).</para> </listitem> </varlistentry> @@ -248,11 +270,11 @@ <para>The shell integration paths that you map are stored in memory until you use them to open WinMerge. As a result, you don't need to select both - files at the same time or even using the same Windows Explorer view: you - can choose one, open a different directory, and choose the other one. - Both paths are discarded from memory after a compare operation. This means that you cannot select one - <guimenuitem>Compare To</guimenuitem> path and compare it against several - paths.</para> + files at the same time or even using the same Windows Explorer view: you + can choose one, open a different directory, and choose the other one. Both + paths are discarded from memory after a compare operation. This means that + you cannot select one <guimenuitem>Compare To</guimenuitem> path and + compare it against several paths.</para> <para>Here is a simple method of using the advanced integration נthere are other scenarios, of course. In Windows Explorer:</para> @@ -277,7 +299,7 @@ <para>By default, WinMerge does not include subfolders in compare operations. To change the default behavior, enable <guilabel>Include - subfolders by default</guilabel> in the System page of WinMerge options. + subfolders by befault</guilabel> in the System page of WinMerge options. To change include subfolders while using the shell integration, press and hold the <keycap>Control</keycap> key while selecting <guimenuitem>Compare</guimenuitem> in the Windows Explorer context Modified: trunk/Docs/Users/Manual/Plugins.xml =================================================================== --- trunk/Docs/Users/Manual/Plugins.xml 2008-08-18 20:51:51 UTC (rev 5819) +++ trunk/Docs/Users/Manual/Plugins.xml 2008-08-19 14:43:22 UTC (rev 5820) @@ -2,238 +2,329 @@ <article id="Plugins"> <title>Plugins</title> - <para>Plugins are extra-features for WinMerge. They are not included in the - basic version because they interest few users, or because they do not fit in - WinMerge architecture.</para> + <para>WinMerge plugins are custom dlls or scriptlets, written in the COM API, + that preprocess data before a comparison. For example, you can use a plugin to + extract text data from MS Word files for WinMerge to compare. Plugins are not + included when you install WinMerge, either because the functions that they + provide are of interest to only a few users, or because they do not fit into + the WinMerge architecture.</para> - <para>Each plugin:</para> + <para>Each plugin is:</para> <itemizedlist> <listitem> - <simpara>is a single file, either a dll or a scriptlet (extension - <filename class="extension">.sct</filename>)</simpara> + <para>A single dll or a scriptlet (<filename + class="extension">sct</filename>) file</para> </listitem> <listitem> - <simpara>is installed in the subfolder <filename - class="directory">MergePlugins</filename></simpara> + <para>Installed in the <filename class="directory">MergePlugins</filename> + subfolder. A number of plugins are installed for you by WinMerge.</para> </listitem> <listitem> - <simpara>is easy to install: copy the plugin file in <filename - class="directory">MergePlugins</filename>, close WinMerge if it is - running, and launch it again</simpara> + <para>Easy to install: To install a plugin that is not included in the + WinMerge installation, just copy the plugin file to <filename + class="directory">MergePlugins</filename>. The plugin is available the + next time you open WinMerge.</para> </listitem> </itemizedlist> <section> - <title>Three categories of plugins</title> + <title>Plugin Types</title> - <para>"<guilabel>Plugins</guilabel>" is a generic name for extra-feature dll - or scriptlets. Plugins features are spread over three categories:</para> + <para>Plugins are grouped into three main categories:</para> - <section> - <title>Editor complement</title> + <variablelist> + <varlistentry> + <term>Editor complement</term> - <para>Operate custom operations on the currently selected text from the - active editor pane.</para> + <listitem> + <para>This type of plugin performs custom operations on selected text + in the active editor (File pane) of the File Compare window.</para> + </listitem> + </varlistentry> - <para>Example plugin: <xref linkend="EditorAddin" /> (Turn the selection - to UPPER CASE or lower case.)</para> - </section> + <varlistentry> + <term>Unpacker: transform a file to a text format</term> - <section> - <title>Unpacker - Transform a file to a text format</title> + <listitem> + <para>This type of plugin transforms a compressed file to a viewable + format by decompressing it. The original file is not changed: a + temporary transformed file is created and loaded in WinMerge.</para> - <para>The plugin transform a file in a viewable format (for example, - decompress a file). The original file is not changed. A temporary - transformed file is created and loaded in WinMerge.</para> + <para>Unpacker plugins operate on entire files, not to selected text + or diffs within files. Therefore, they are available only when you + launch file comparisons, from either the Folder Compare window or the + Select Files or Folders dialog. Unpacker plugins are not available in + the File Compare window.</para> - <para>Sometimes the transformed file can be packed back. (See the plugin - details to know if it supports packing back.) Then you may merge and save - the transformed file. The packing is done automatically in this case. To - avoid problems, you are proposed to change the filename when saving a - changed file.</para> + <para>Sometimes the unpacked file can be repacked (see the details in + <xref linkend="Plugins_available" /> to check whether a plugin + supports repacking). Then, you can merge and save the transformed + file. The packing is done automatically in this case. To be safe, we + suggest that you rename the transformed file when you save it.</para> - <note> - <para>When you compare folders, WinMerge doesn't need to display the - files, but the diffing process can give a different result when you - compare compressed and not compressed files (for example, uncompressed - files may be identical, but the compressed files may differ if they - include the date of creation). WinMerge applies the unpacker in all - situations, and you are sure to have the same result when you compare - folder, or when you merge two versions of a file.</para> - </note> + <note> + <para>When you compare folders, WinMerge can give different results + for compressed and uncompressed files. For example, files that are + identical when uncompressed might be different if they include the + creation date. WinMerge applies the unpacker in all situations, and + you are sure to have the same result when you compare a folder, or + when you merge two versions of a file.</para> + </note> - <para>Example plugin: <xref linkend="DisplayXMLFiles" /> (Display XML - files nicely, by consistently inserting tabs and linebreaks.)</para> - </section> + <para>Example plugin: <xref linkend="DisplayXMLFiles" /> reformats XML + files for readability.</para> + </listitem> + </varlistentry> - <section> - <title>Prediffer - Preprocess files to hide some differences</title> + <varlistentry> + <term>Prediffer: preprocess files to hide some differences</term> - <para>The plugin is not apply to the files displayed in the editor. It is - applied only to temporary copies of the files, and this copies are then - scanned to create the difference list.</para> + <listitem> + <para>This type of plugin does not operate on the source files + displayed in the Compare window. It operates instead on temporary + copies of the files, and the copies are then scanned to create the + difference list.</para> - <para>Example plugin: <xref linkend="IgnoreColumns" /> (Ignore the - differences inside given columns, while displaying the characters in these - columns.)</para> - </section> + <para>Example plugin: <xref linkend="IgnoreColumns" /> ignores the + differences inside specified columns, while displaying the characters + in these columns.</para> + </listitem> + </varlistentry> + </variablelist> </section> <section> - <title>Select and apply a plugin</title> + <title>Suggested plugins and automatic modes</title> - <section> - <title>"<guilabel>Suggested plugin</guilabel>" and "<guilabel>Automatic - mode</guilabel>"</title> + <para>How is WinMerge able to apply the right plugin for a given file? Each + plugin specifies a list of file extensions (also listed in each plugin's + <xref linkend="Plugins_available" /> section, under <citetitle>File + filter</citetitle>). The extensions are used to associate one or more file + types with the plugin: when a compared file's extension matches an extension + in the plugin's list, the plugin is considered to be a <firstterm>suggested + plugin. </firstterm></para> - <para>Each plugin specifies a list of file extensions (see plugins details - for more info). When the file extension, either from the left or from the - right file, matches the plugin list, the plugin is called "<guilabel>a - suggested plugin</guilabel>".</para> + <para>There are separate WinMerge options for the unpacking and prediffer + types, described later in this topic, that enable you to apply the plugins + either manually or automatically. There is no automatic mode for editor + complement plugins.</para> - <para>When "<guilabel>Automatic mode</guilabel>" is on, WinMerge searches - for a suggested plugin and applies it if it is avaialble. When two - suggested plugins are available for a file, WinMerge applies the first one - only (alphabetical order).</para> + <para>When you apply plugins to a selected file using automatic mode, + WinMerge searches its list of suggested plugins for that file type, and + applies the first plugin whose name matches. The search is performed in + alphabetical order, so if there are multiple suggested plugins for a file + type, only the first one found is applied.</para> + </section> - <note> - <para>"<guimenuitem>Automatic Unpacking</guimenuitem>" and - "<guimenuitem>Auto prediffer</guimenuitem>" are two separate options. - There is no option for editor complements.</para> - </note> - </section> + <section> + <title>Applying plugins</title> - <section> - <title>Editor complement in folder view</title> + <para>The following subsections describe how to apply each type of plugin. + The methods are different for each type of plugin, and also vary depending + on whether you are comparing folders or files.</para> - <para><emphasis>Not available</emphasis></para> - </section> - <section> - <title>Editor complement in editor view</title> + <title>Applying editor complement plugins in the File Compare + window</title> - <para>Access list from <menuchoice> + <para>With your cursor in either File pane of the File Compare window, + click <menuchoice> <guimenu>Edit</guimenu> <guisubmenu>Scripts</guisubmenu> + </menuchoice> and choose one of these functions:</para> - <guimenuitem>...</guimenuitem> - </menuchoice> in the main menu.</para> - </section> + <itemizedlist> + <listitem> + <para><function>MakeUpper</function></para> + </listitem> - <section> - <title>Unpacker in folder view</title> + <listitem> + <para><function>MakeLower</function></para> + </listitem> - <para>Check <menuchoice> - <guimenu>Plugins</guimenu> + <listitem> + <para><function>InsertDate</function></para> + </listitem> - <guimenuitem>Automatic Unpacking</guimenuitem> - </menuchoice> in the main menu. You need to update the results - (<keycap>F5</keycap>). Each file is loaded again with its suggested - unpacker and compared.</para> + <listitem> + <para><function>InsertTime</function></para> + </listitem> + </itemizedlist> + + <para>The functions are contributed to the + <guisubmenu>Scripts</guisubmenu> menu by the <xref + linkend="EditorAddin" /> and <xref linkend="Plugins_datetime" /> + plugins.</para> + + <note> + <para>Editor complement plugins are not available in the Folder Compare + window.</para> + </note> </section> <section> - <title>Unpacker in editor view</title> + <title>Applying unpacker plugins in the Folder Compare window</title> - <orderedlist> - <listitem> - <para>Open dialog: Select the two files first and then press the - <guibutton>Select</guibutton> button right from the field - "<guilabel>Unpacker</guilabel>". WinMerge displays the standard dialog - for unpacker selection. Use the top combobox to select the plugin. Two - generic choices "<guilabel>None</guilabel>" and - "<guilabel>Automatic</guilabel>" are also available.</para> - </listitem> + <para>Before applying unpacker plugins, you can set its mode to either + automatic or manual mode.</para> + <itemizedlist> <listitem> - <para>From the folder view when <menuchoice> + <para>To set automatic mode for this type of plugin, click <menuchoice> <guimenu>Plugins</guimenu> <guimenuitem>Automatic Unpacking</guimenuitem> - </menuchoice> is checked: Just double click to open the file. The - suggested plugin used during the folder comparison is used to load the - file in the editor.</para> + </menuchoice>.</para> </listitem> <listitem> - <para>From the folder view, always: Select one file, then main menu - <menuchoice> + <para>To set manual mode, click <menuchoice> <guimenu>Plugins</guimenu> - <guimenuitem>Edit with Unpacker</guimenuitem> - </menuchoice>. WinMerge displays the dialog for unpacker selection. - Select an unpacker and press <guibutton>OK</guibutton>, WinMerge opens - the editor view and applies this unpacker to load the file. This - plugin is forgotten when you close the editor view.</para> + <guimenuitem>Manual Unpacking</guimenuitem> + </menuchoice>.</para> </listitem> - </orderedlist> + </itemizedlist> + + <para>Remember to click <keycap>F5</keycap> to reload the Folder Compare + window using the new setting.</para> + + <section> + <title>Using automatic mode</title> + + <para>To apply plugins when automatic unpacking is set, simply launch a + compare operation on a file in the Folder Compare window. If the file's + type suggested unpacker plugin (if any) preprocesses the file before + WinMerge opens it in the File Compare window. </para> + + <para>For example, suppose you right-click an MS Word + <filename>doc</filename> file and choose + <guimenuitem>Compare</guimenuitem> (also assume that the <xref + linkend="Plugins_msword" /> plugin is available). WinMerge converts the + doc file (or rather, a copy of it ) to a plain text file and opens it in + the File Compare window. </para> + </section> + + <section> + <title>Using manual mode</title> + + <para>Manual mode enables you to choose a different unpacker plugin than + the one that is selected for you in automatic mode. You can also launch + the compare using no plugin.</para> + + <para>To apply plugins when manual unpacking is set:</para> + + <orderedlist> + <listitem> + <para>Select the file you want to compare. </para> + </listitem> + + <listitem> + <para>Click <menuchoice> + <guimenu>Plugins</guimenu> + + <guimenuitem>Edit with Unpacker</guimenuitem> + </menuchoice>. </para> + + <para>This menu item is enabled only if the selected file's type is + supported by an available unpacking plugin.</para> + </listitem> + + <listitem> + <para>In the Select Unpacker dialog:</para> + + <xi:include href="select_unpacker.xml" + xmlns:xi="http://www.w3.org/2001/XInclude" + xpointer="element(select-unpacker-proc)" /> + </listitem> + + <listitem> + <para>Click <guibutton>OK</guibutton> to close the Select Unpacker + dialog and launch the file comparison.</para> + </listitem> + </orderedlist> + </section> </section> <section> - <title>Prediffer in folder view</title> + <title>Applying unpacker plugins in the Select Files or Folders + dialog</title> - <para>When the files are selected, right-click to open the context menu. - Follow <menuchoice> + <para>You can use the Select Unpacker dialog to apply a plugin when you + launch a file comparison from the Select Files or Folders dialog. See + <xref linkend="Open_paths_unpacker" /> for details.</para> + </section> + + <section> + <title>Applying prediffer plugins in the Folder Compare window</title> + + <para>With prediffer plugins, you set the mode (<firstterm>Auto + prediiffer</firstterm> or <firstterm>No prediffer</firstterm>) for + individual files. (Contrast this with unpacker plugins, where you set the + mode for all files.) That is, some files in the same folder have different + prediffer modes.</para> + + <para>To set the mode for one or more files in the Folder Compare window, + right-click the files and choose <menuchoice> <guimenu>Plugin Settings</guimenu> <guisubmenu>Prediffer Settings</guisubmenu> - </menuchoice> and select "<guimenuitem>Auto prediffer</guimenuitem>" or - "<guimenuitem>No prediffer</guimenuitem>". Refresh the view - (<keycap>F5</keycap>) to update the results.</para> + </menuchoice>, then choose one of the submenu options:</para> + <itemizedlist> + <listitem> + <para><guisubmenu>Auto Prediffer</guisubmenu> selects the first + prediffer plugin available for the file type.</para> + </listitem> + + <listitem> + <para><guisubmenu>No prediffer</guisubmenu> means that no prediffer + plugin is used.</para> + </listitem> + </itemizedlist> + + <para>Click <keycap>F5</keycap> to update the window.</para> + <note> - <para>"<guimenuitem>Auto prediffer</guimenuitem>" is a per-file option. - Some files in the same folder can be in mode "<guimenuitem>No - prediffer</guimenuitem>" and some in mode "<guimenuitem>Auto - prediffer</guimenuitem>". When you change folder during a non-recursive - compare, the mode is always reset to "<guimenuitem>No - prediffer</guimenuitem>".</para> + <para>When you open a subfolder during a non-recursive compare, the mode + is always reset to <guimenuitem>No prediffer</guimenuitem>.</para> </note> + + <para>When you open a file from the Folder Compare window, your prediffer + setting for that file is applied before the File Compare window is + opened.</para> </section> <section> - <title>Prediffer in editor view</title> + <title>Applying prediffer plugins in the File Compare window</title> - <orderedlist> - <listitem> - <para>From the folder view when "<guimenuitem>Auto - prediffer</guimenuitem>" is checked for a file: Just double click to - open the file. The plugin used during the folder comparison is used in - the editor before the diff algorithm.</para> - </listitem> + <para>In the File Compare winodw, you can apply a prediffer plugin by + clicking <menuchoice> + <guimenu>Plugins</guimenu> - <listitem> - <para>During an editor session, access prediffer lists with menu - <menuchoice> - <guimenu>Plugins</guimenu> - - <guisubmenu>Prediffer</guisubmenu> - - <guimenuitem>...</guimenuitem> - </menuchoice>: The active prediffer is checked. Suggested plugins - are indicated first above the not-suggested ones. The files are - compared again after the selection, you don't need to rescan.</para> - </listitem> - </orderedlist> + <guisubmenu>Prediffer</guisubmenu> + </menuchoice> and choosing one of the plugins in the list. Suggested + plugins are indicated at the top of the list. The files are compared again + after the plugin is applied, so you don't need to rescan the files.</para> </section> </section> - <section> + <section id="Plugins_available"> <title>Available plugins</title> <section> <title><filename>CompareMSExcelFiles.dll</filename></title> - <para>Displays the text content of a <trademark + <para>Displays the text contents of a <trademark class="registered">Microsoft</trademark> <application>Excel</application> file, stripping away all formatting and embedded objects.</para> <para><segmentedlist> - <segtitle>Categorie</segtitle> + <segtitle>Category</segtitle> <segtitle>File filter</segtitle> @@ -254,7 +345,7 @@ </segmentedlist></para> </section> - <section> + <section id="Plugins_msword"> <title><filename>CompareMSWordFiles.dll</filename></title> <para>Displays the text content of a <trademark @@ -262,7 +353,7 @@ file, stripping away all formatting and embedded objects.</para> <para><segmentedlist> - <segtitle>Categorie</segtitle> + <segtitle>Category</segtitle> <segtitle>File filter</segtitle> @@ -288,12 +379,12 @@ <section id="DisplayXMLFiles"> <title><filename>DisplayXMLFiles.dll</filename></title> - <para>This plugin display XML files nicely, by consistently inserting tabs - and linebreaks. This is to fix XML files which do not have line returns in + <para>This plugin pretty-prints XML files nicely by inserting tabs and + line breaks. This is useful for XML files that do not have line returns in convenient locations.</para> <para><segmentedlist> - <segtitle>Categorie</segtitle> + <segtitle>Category</segtitle> <segtitle>File filter</segtitle> @@ -312,7 +403,7 @@ <section id="EditorAddin"> <title><filename>editor addin.sct</filename></title> - <para>Add two functions to the <menuchoice> + <para>Adds two functions to the <menuchoice> <guimenu>Edit</guimenu> <guisubmenu>Scripts</guisubmenu> @@ -331,7 +422,7 @@ </itemizedlist> <para><segmentedlist> - <segtitle>Categorie</segtitle> + <segtitle>Category</segtitle> <seglistitem> <seg>Editor complement</seg> @@ -342,13 +433,15 @@ <section id="IgnoreColumns"> <title><filename>IgnoreColumns.dll</filename></title> - <para>The plugin ignore the characters at specified columns. It does not - support files with tabulations (no crash, but all tabs will be treated as - a normal character). The first column has number 1.</para> + <para>This plugin ignores characters at specified columns. The first + column is number 1</para> - <para>For the parameters, you just need to rename the dll with the - following syntax:</para> + <para>Note that this plugin does not support files with tabs: the plugin + does not fail, but all tabs are be treated as normal characters.</para> + <para>To specify columns, rename the <filename>dll</filename> using + following fields as parameters:</para> + <itemizedlist> <listitem> <simpara>Delimiters between ranges: _ or ,</simpara> @@ -364,12 +457,12 @@ </listitem> <listitem> - <simpara>When max = min, max may be omitted.</simpara> + <simpara>When max = min, max can be omitted.</simpara> </listitem> </itemizedlist> <example> - <title><filename>IgnoreColumns.dll</filename> syntax</title> + <title><filename>IgnoreColumns.dll</filename> examples</title> <variablelist> <varlistentry> @@ -394,7 +487,7 @@ </example> <para><segmentedlist> - <segtitle>Categorie</segtitle> + <segtitle>Category</segtitle> <segtitle>File filter</segtitle> @@ -409,12 +502,12 @@ <section> <title><filename>IgnoreCommentsC.dll</filename></title> - <para>The plugin ignores comments (<constant>//</constant>... and - <constant>/*</constant> ... <constant>*/</constant>) in C, C++, PHP and - JavaScript files.</para> + <para>The plugin ignores comments within<constant> //</constant>... and + <constant>/*</constant> ... <constant>*/</constant> delimiters in C, C++, + PHP and JavaScript files.</para> <para><segmentedlist> - <segtitle>Categorie</segtitle> + <segtitle>Category</segtitle> <segtitle>File filter</segtitle> @@ -435,15 +528,16 @@ <section> <title><filename>IgnoreFieldsComma.dll</filename></title> - <para>The plugin is for files with fields and <emphasis>comma</emphasis> - as delimiters (CSV files for example). It ignore the characters in the - specified fields. First field has number 1.</para> + <para>This plugin is for files with fields and commas as delimiters (CSV + files, for example). It ignores the delimiter characters. The first field + is number 1.</para> - <para>Modify the filename to specify the fields. See <xref - linkend="IgnoreColumns" /> for the syntax.</para> + <para>To specify the delimiters, rename the <filename>dll</filename> using + the same parameter fields used for <xref + linkend="IgnoreColumns" />.</para> <para><segmentedlist> - <segtitle>Categorie</segtitle> + <segtitle>Category</segtitle> <segtitle>File filter</segtitle> @@ -458,17 +552,17 @@ <section> <title><filename>IgnoreFieldsTab.dll</filename></title> - <para>The plugin is for files with fields and - <emphasis>tabulations</emphasis> as delimiters - (<application>Excel</application> files saved in format <filename - class="extension">*.txt</filename> for example). It ignore the characters - in the specified fields. First field has number 1.</para> + <para>This plugin is for files that use fields and tabs as delimiters + (<application>for examle, Excel</application> files saved in the <filename + class="extension">*.txt</filename> format). It ignores the delimiter + characters. The first field is number 1.</para> - <para>Modify the filename to specify the fields. See <xref - linkend="IgnoreColumns" /> for the syntax.</para> + <para>To specify the delimiters, rename the <filename>dll</filename> using + the same parameter fields used for <xref + linkend="IgnoreColumns" />.</para> <para><segmentedlist> - <segtitle>Categorie</segtitle> + <segtitle>Category</segtitle> <segtitle>File filter</segtitle> @@ -484,10 +578,10 @@ <title><filename>IgnoreLeadingLineNumbers.dll</filename></title> <para>This plugin ignores the leading line numbers in text files (for - example NC and BASIC files).</para> + example, NC and BASIC files).</para> <para><segmentedlist> - <segtitle>Categorie</segtitle> + <segtitle>Category</segtitle> <segtitle>File filter</segtitle> @@ -503,10 +597,10 @@ </segmentedlist></para> </section> - <section> + <section id="Plugins_datetime"> <title><filename>insert datetime.sct</filename></title> - <para>Add two functions to the <menuchoice> + <para>Adds two functions to the <menuchoice> <guimenu>Edit</guimenu> <guisubmenu>Scripts</guisubmenu> @@ -525,7 +619,7 @@ </itemizedlist> <para><segmentedlist> - <segtitle>Categorie</segtitle> + <segtitle>Category</segtitle> <seglistitem> <seg>Editor complement</seg> @@ -537,15 +631,15 @@ <title><filename>RCLocalizationHelper.dll</filename>, <filename>RCLocalizationHelperU.dll</filename></title> - <para>The plugin preprocesses RC files by stripping out localized strings, - to enable comparing differnt language versions of the same RC file and - ignoring the translations.</para> + <para>This plugin preprocesses RC files by stripping out localized + strings, to enable comparing different language versions of the same RC + file and ignoring the translations.</para> <para><filename>RCLocalizationHelperU.dll</filename> is the Unicode version.</para> <para><segmentedlist> - <segtitle>Categorie</segtitle> + <segtitle>Category</segtitle> <segtitle>File filter</segtitle> @@ -561,8 +655,8 @@ <title><filename>WatchBeginningOfLog.dll</filename>, <filename>WatchEndOfLog.dll</filename></title> - <para>For long LOG files, the user is often interested only in the first - lines or in the last lines.</para> + <para>For long LOG files, often only in the first lines or in the last + lines are significant.</para> <itemizedlist> <listitem> @@ -577,7 +671,7 @@ </itemizedlist> <para><segmentedlist> - <segtitle>Categorie</segtitle> + <segtitle>Category</segtitle> <segtitle>File filter</segtitle> @@ -592,9 +686,9 @@ </seglistitem> </segmentedlist></para> - <para>Developers may find information and code of examples in the source - package, under the folder "<filename - class="directory">Plugins</filename>".</para> + <para>Developers can find information and code examples in the source + package, under the <filename class="directory">Plugins</filename> + folder.</para> </section> </section> @@ -604,26 +698,25 @@ <section> <title>Windows Script Host</title> - <para>Some editor complements need this optional component from <trademark - class="registered">Microsoft</trademark>.</para> + <para>Some editor complement plugins require this optional component from + <trademark class="registered">Microsoft</trademark>.</para> - <para>If the list of editor complements does not present all editor - plugins, this component is probably missing. You can check easily. - WinMerge informs you with a comment at the bottom of the list. You may - install WSH on any version of Windows (need IE 4.0). Download it from - <ulink + <para>If the list of editor complements does not include all editor + plugins, this component is probably missing. To help you verify, WinMerge + displays a comment at the bottom of the list. You can install WSH on any + version of Windows Download it from <ulink url="http://msdn.microsoft.com/library/default.asp?url=/downloads/list/webdev.asp">MSDN - Library</ulink>.</para> + Library</ulink>, using IE 4.0 or later.</para> </section> <section id="MSVBVM60"> <title><application>Visual Basic</application> runtime library</title> - <para>Some plugins require <application>Visual Basic</application> runtime - library to work.</para> + <para>Some plugins require <application>the Visual Basic</application> + runtime library to work.</para> <para>You can download the required file <filename><ulink - url="http://www.dll-files.com/dllindex/dll-files.shtml?msvbvm60">msvbvm60.dll</ulink></filename> + url="http://www.dll-files.com/dllindex/dll-files.shtml?msvbvm60">msvbvm60.dll</ulink></filename>, or use the <ulink url="http://www.microsoft.com/downloads/details.aspx?familyid=7b9ba261-7a9c-43e7-9117-f673077ffb3c">Run-Time Redistribution Pack</ulink> from <trademark Modified: trunk/Docs/Users/Manual/replaceables.xml =================================================================== --- trunk/Docs/Users/Manual/replaceables.xml 2008-08-18 20:51:51 UTC (rev 5819) +++ trunk/Docs/Users/Manual/replaceables.xml 2008-08-19 14:43:22 UTC (rev 5820) @@ -1,6 +1,5 @@ <?xml version="1.0" encoding="UTF-8"?> -<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN" -"http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd"> +<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "build/dtd/docbookx.dtd"> <section> <title>Replaceable phrases</title> Added: trunk/Docs/Users/Manual/select_unpacker.xml =================================================================== --- trunk/Docs/Users/Manual/select_unpacker.xml (rev 0) +++ trunk/Docs/Users/Manual/select_unpacker.xml 2008-08-19 14:43:22 UTC (rev 5820) @@ -0,0 +1,42 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "build/dtd/docbookx.dtd"> +<section id="select-unpacker"> + <title>Using the Select Unpacker dialog</title> + + <orderedlist id="select-unpacker-proc"> + <listitem> + <para>Configure automatic plugin selection or choose a plugin + manually:</para> + + <itemizedlist> + <listitem> + <para>To use automatic mode (which applies the first available + plugin), verify that <guilabel><None></guilabel> is displayed in + the the <guilabel>File unpacker</guilabel> control.</para> + </listitem> + + <listitem> + <para>To choose a different plugin (if available), use the + <guilabel>File unpacker</guilabel> control to choose the + plugin.</para> + + <para>By default, this control lists only suggested plugins for the + file type you selected to compare. To see all available plugins, + enable the option, <guilabel>Display all packers, don't check the + extension</guilabel>.</para> + </listitem> + + <listitem> + <para>To launch the compare without using any plugin, choose + <guimenuitem><None></guimenuitem> in the <guilabel>File + unpacker</guilabel> control.</para> + </listitem> + </itemizedlist> + </listitem> + + <listitem> + <para>Click <guibutton>OK</guibutton> to close the Select Unpacker + dialog.</para> + </listitem> + </orderedlist> +</section> Property changes on: trunk/Docs/Users/Manual/select_unpacker.xml ___________________________________________________________________ Added: svn:keywords + Author Date Id Revision Added: svn:eol-style + native This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site. |
From: <ki...@us...> - 2008-08-31 11:26:58
|
Revision: 5869 http://winmerge.svn.sourceforge.net/winmerge/?rev=5869&view=rev Author: kimmov Date: 2008-08-31 11:26:54 +0000 (Sun, 31 Aug 2008) Log Message: ----------- PATCH: [ 2053195 ] Update Help topics Improve HTML manual look Submitted by Denis Bradford Modified Paths: -------------- trunk/Docs/Users/Manual/css/all.css trunk/Docs/Users/Manual/css/print.css Added Paths: ----------- trunk/Docs/Users/Manual/images/head.gif Modified: trunk/Docs/Users/Manual/css/all.css =================================================================== --- trunk/Docs/Users/Manual/css/all.css 2008-08-31 11:15:00 UTC (rev 5868) +++ trunk/Docs/Users/Manual/css/all.css 2008-08-31 11:26:54 UTC (rev 5869) @@ -31,10 +31,22 @@ padding: 1px 0 1px 0; } +div.navheader { + height: 50px; + background-image: url("../images/head.gif"); + background-repeat: no-repeat; + background-position: center top; +} + +div.navheader table { + height: 50px; +} + div.navheader * * * th { display:none; } -div.navheader a, div.navheader a:visited, div.navfooter a, div.navfooter a:visited { + +div.navheader a, div.navheader a:visited, div.navfooter a, div.navfooter a:visited { display: inline-block; padding: 2px 4px 2px 4px; text-decoration: none; @@ -50,7 +62,7 @@ /* Main topic divs */ div.book,div.article,div.appendix,div.index { - margin: 0 10px 0 10px; + margin: 0 10px 10px 10px; } div.section { @@ -64,38 +76,27 @@ background-color: #707070; } -/* Help title page*/ -div.titlepage { - text-align: center; -} - -div.book h1 { +/* Manual title */ +h1 { font-size: 200%; - color: #3333cc; letter-spacing: 0.05em; } /* Topic titles */ -div.article h2, div.appendix h2, div.index h2 { - font-size: 160%; - text-align: center; - color: #3333cc; +h2 { + font-size: 180%; } +/* Section titles */ div.section h2 { - text-align: left; font-size: 140%; } div.section h3 { - text-align: left; font-size: 120%; - color: #3333cc; } div.section h4 { - text-align: left; font-size: 110%; - color: #3333cc; } #ads { @@ -157,18 +158,21 @@ font-style: italic; } +.guibutton, .keycap { + font-weight: bold; +} /* FAQ */ .question { font-weight: bold; } /* tables */ -.table table { +.table table, .informaltable table { border-collapse: collapse; border: 1px solid black; } -.table th { +.table th, .informaltable th { padding: 2px; text-align: left; color: white; @@ -176,7 +180,7 @@ border: 1px solid black; } -.table td { +.table td, .informaltable td { padding: 2px; border: 1px solid black; } Modified: trunk/Docs/Users/Manual/css/print.css =================================================================== --- trunk/Docs/Users/Manual/css/print.css 2008-08-31 11:15:00 UTC (rev 5868) +++ trunk/Docs/Users/Manual/css/print.css 2008-08-31 11:26:54 UTC (rev 5869) @@ -1,150 +1,51 @@ -body,th,td { - font-family: Verdana,Helvetica,Arial,sans-serif; - font-size: 80%; +@import url("all.css") print; +body { + font-family: Georgia,"Times New Roman",Times,serif; + font-size: 77%; } -pre,code,tt { - font-family: "Courier New",Courier,monospace; - font-size: 100%; -} -ul { - list-style-type: square; -} - -/* Default link style */ -a:link { color:black; text-decoration:underline; } -a:visited { color:black; text-decoration:underline; } -a:focus { color:black; text-decoration:none; } -a:hover { color:black; text-decoration:none; } -a:active { color:black; text-decoration:none; } - -.navheader { +.navheader,.navfooter, div#ads { display: none; } -.navfooter { - display: none; -} -#ads { - display: none; +h1, h2 { + font-family: Verdana,Helvetica,Arial,sans-serif; } -.mediaobject { - margin-top: 10px; +h1 { + font-size: 160%; + letter-spacing: inherit; } -.screen { - padding: 0; - background-color: white; - border: 0; +div.article h2, div.appendix h2, div.index h2 { + font-size: 140%; } -.caution { - background-color: white; - border: 1px solid black; -} -.important { - background-color: white; - border: 1px solid black; -} -.note { - background-color: white; - border: 1px solid black; -} -.tip { - background-color: white; - border: 1px solid black; -} -.warning { - background-color: white; - border: 1px solid black; -} -/* Examples */ -.example,.informalexample { - padding-left: 7px; - border-left: 3px solid black; +div.section h3 { + font-size: 120%; } - -/* Command synopsis */ -.cmdsynopsis p { - padding: 0; - color: black; - background-color: white; - border: 0; +div.section h4 { + font-size: 110%; } -.command,.option,.replaceable { - color: black; +div.toc p{ + color: #000; } -/* GUI elements */ -.guimenu,.guisubmenu,.guimenuitem,.guilabel { - font-style: italic; -} -/* FAQ */ -.question { - font-weight: bold; +.screen { + padding: 5px; + background-color: inherit; + border: 0.5px solid #BEBEBE; } -/* tables */ -.table table { - border-collapse: collapse; - border: 1px solid black; +.caution,.important,.note,.tip,.warning { + background-color: none; + border: 1px solid #808080; } -.table th { - padding: 2px; - text-align: left; - color: black; - background: white; - border: 1px solid black; - border-bottom: 2px solid black; -} - -.table td { - padding: 2px; - border: 1px solid black; -} - -/* variablelist */ -.variablelist dl { - margin-left: 2em; -} -.variablelist dt { - font-weight: bold; -} -.variablelist dd { - margin-left: 2em; -} -.variablelist dd p { - margin-top: 0.5em; -} - -/* authorgroup */ -.authorgroup { - margin-left: 2em; -} -.author h3 { - margin: 0; - margin-bottom: 0.25em; - padding: 0; - font-size: 100%; -} - -/* table of contents */ -.toc dt { - margin-top: 1em; -} -.toc dd dl dt { - margin-top: 0; -} - -.toc .sect1, -.toc .appendix, -.toc .index { - font-size: 120%; - font-weight: bold; -} \ No newline at end of file +/* links */ +a:link { color:black; text-decoration:underline; } +a:visited { color:black; text-decoration:underline; } Property changes on: trunk/Docs/Users/Manual/images/head.gif ___________________________________________________________________ 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. |
From: <ki...@us...> - 2008-09-03 13:26:47
|
Revision: 5884 http://winmerge.svn.sourceforge.net/winmerge/?rev=5884&view=rev Author: kimmov Date: 2008-09-03 13:26:43 +0000 (Wed, 03 Sep 2008) Log Message: ----------- PATCH: [ 2091055 ] Doc edit: Filters.xml Submitted by Denis Bradford Modified Paths: -------------- trunk/Docs/Users/Manual/Filters.xml trunk/Docs/Users/Manual/WinMerge_help.xml Modified: trunk/Docs/Users/Manual/Filters.xml =================================================================== --- trunk/Docs/Users/Manual/Filters.xml 2008-09-03 03:19:49 UTC (rev 5883) +++ trunk/Docs/Users/Manual/Filters.xml 2008-09-03 13:26:43 UTC (rev 5884) @@ -1,331 +1,1179 @@ <?xml version="1.0" encoding="UTF-8"?> <article id="Filters"> - <title>Filters</title> + <title>Using Filters<indexterm> + <primary>filtering</primary> + </indexterm></title> - <para>There are two kinds of filters in WinMerge: file filters for filtering - files and folders in folder compare and line filters for ignoring lines from - files before comparing.</para> + <para>When you compare files or folders, you can use filters to narrow the + scope of the comparison. This can be useful when you want to simplify the + comparison result by eliminating differences that you are not interested in. + Filters are rules based on regular expressions. WinMerge uses the popular PCRE + (Perl Compatible Regular Expressions) regular expression engine.<indexterm> + <primary>regular expressions</primary> - <section> - <title>Regular expressions</title> + <secondary>supported engine</secondary> + </indexterm><indexterm> + <primary>PCRE regular expression engine</primary> + </indexterm><indexterm> + <primary>regexp</primary> - <para>Filters are based on regular expressions (regexps). Each line filter - or file filter rule is regexp which is matched against file/folder name or - line.</para> + <see>regular expressions</see> + </indexterm></para> - <para>Regexps can be very complex to read. Luckily most file filtering - needs are for file extensions. File filters installed with WinMerge have - many useful examples.</para> + <para>The basic function of filtering is simple: evaluate each item that would + normally be compared (a folder, file, or line within a file), and if the + filter expression matches the target item, apply the filter. Depending on the + type of filter, the item is either included or excluded in the + comparison.</para> - <para>WinMerge uses popular PCRE (Perl Compatible Regular Expressions) - regular expression engine. There are lots of resources for help with Perl - regular expression.</para> + <para>There are different WinMerge filters for folder compare and file compare + operations:</para> - <section> - <title>Help with regexps</title> + <variablelist> + <varlistentry> + <term>Folder comparison: File masks and file filters<indexterm> + <primary>comparing folders</primary> - <para>There are many guides and help sites in Web, for example:</para> + <secondary>filtering</secondary> + </indexterm></term> + <listitem> + <para>You can specify files to include in a folder comparison by using + simple file masks, or, for more complex filtering, by applying multiple + rules specified in a file filter. You cannot apply both a file mask and + a file filter in the same operation.</para> + + <para>Files and folders that are filtered are hidden in the result by + default, which is typically what you want. You can click <menuchoice> + <guimenu>View</guimenu> + + <guimenuitem>Show Skipped Items</guimenuitem> + </menuchoice> to unhide filtered items, but the Folder Compare window + shows only minimal information about them. For example, you cannot tell + whether a skipped file is a text file or binary.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term>File comparisons: Line filters<indexterm> + <primary>comparing files</primary> + + <secondary>filtering</secondary> + </indexterm></term> + + <listitem> + <para>Line filters are applied only to file compare operations. They let + you ignore single line differences.</para> + </listitem> + </varlistentry> + </variablelist> + + <section id="Filters_Mask"> + <title>Using file masks<indexterm> + <primary>file masks</primary> + </indexterm><indexterm> + <primary>filters</primary> + + <secondary>file masks</secondary> + </indexterm><indexterm> + <primary>filtering</primary> + + <secondary>in folder comparisons</secondary> + </indexterm></title> + + <para>You can use one or more <glossterm>file masks</glossterm> that specify + file extensions to include in a folder comparison. All other files are + omitted from your selection.</para> + + <section id="Filters_MaskApply"> + <title>Defining and applying file masks</title> + + <para>Define and apply a file mask at the time you launch your folder + compare operation:</para> + + <itemizedlist> + <listitem> + <para>If you are using the Select Files or Folders dialog, after + choosing the <guilabel>Left</guilabel> and <guilabel>Right</guilabel> + folders, enter one or more file masks in the + <guilabel>Filter</guilabel> field. The masks are applied when you + start the folder compare operation.</para> + </listitem> + + <listitem> + <para>If you are using the WinMerge command line, use the + <option>-f</option> flag to specify file masks (see the example in the + next section).</para> + </listitem> + </itemizedlist> + + <para>Remember, you cannot specify both a file mask and a file filter in + the field or command line.</para> + </section> + + <section id="Filters_MaskSyntax"> + <title>File mask syntax and example<indexterm> + <primary>rules</primary> + + <secondary>file masks</secondary> + </indexterm><indexterm> + <primary>filters</primary> + + <secondary>file mask syntax</secondary> + </indexterm><indexterm> + <primary>regular expressions</primary> + + <secondary>in file masks</secondary> + </indexterm></title> + + <para>Use this syntax for file masks:</para> + + <synopsis>*.[<replaceable>extension</replaceable>][<replaceable>delimiter</replaceable> *.<replaceable>extension</replaceable> ...]</synopsis> + + <para>Valid delimiters are spaces, commas, colons or semicolons.</para> + + <para>A mask with no extension ( <filename>*.</filename> ) selects files + without any extension, such as + <filename><filename>README</filename></filename>.</para> + + <example> + <title>File mask</title> + + <para>In this command-line example, the folder compare operation + includes only files with <filename>xml</filename> or + <filename>txt</filename> extensions. All other files are omitted:</para> + + <para><userinput>WinMergeU c:\project\docs c:\temp /f + *.xml;*.txt</userinput></para> + </example> + </section> + </section> + + <section id="Filters_FileFilter"> + <title>Using File filters<indexterm> + <primary>filters</primary> + + <secondary>file filters</secondary> + </indexterm><indexterm> + <primary>filtering</primary> + + <secondary>in folder comparisons</secondary> + </indexterm></title> + + <para><glossterm>File filters</glossterm> are text files with an extension + of <filename>flt</filename>. They enable you to apply multiple filtering + rules to a folder comparison. Unlike file masks, file filters can either + include or exclude matches.</para> + + <para><indexterm> + <primary>file filters</primary> + + <secondary>template</secondary> + </indexterm>WinMerge installs a number of predefined file filters. If + these file filters do not provide the filtering you need, you can create + your own. To make that task easier, WinMerge also provides a template file + named <filename>FileFilter.tmpl</filename>. This section describes how to + apply file filters to comparisons, and documents the file filter syntax. + <xref linkend="Filters_Dlg" /> describes how to add, edit, and manage + filters.</para> + + <section id="Filters_FileFilterLoc"> + <title>File filter locations<indexterm> + <primary>Filters folders</primary> + + <secondary>locations</secondary> + </indexterm><indexterm> + <primary>file filters</primary> + + <secondary>locations</secondary> + </indexterm></title> + + <para>WinMerge automatically detects file filters in these + locations:</para> + <variablelist> <varlistentry> - <term>Good site devoted for regexps:</term> + <term>Filters subfolder in the WinMerge installation folder</term> <listitem> - <simpara><ulink - url="http://www.regular-expressions.info/">http://www.regular-expressions.info/</ulink></simpara> + <para>This is where the predefined file filters are installed. For + example, <filename>C:\Program Files\WinMerge\Filters</filename>. You + can create or copy filter files in this location to make them + available to all users on your system.</para> + + <para>Before creating a new file filter, see if the predefined ones + already contain what you need. If not, you might find useful rule + examples in the existing files.</para> </listitem> </varlistentry> <varlistentry> - <term>Good HOWTO document for regexps:</term> + <term>Default private filter folder</term> <listitem> - <simpara><ulink - url="http://www.amk.ca/python/howto/regex/">http://www.amk.ca/python/howto/regex/</ulink></simpara> + <para>The location of this folder is defined in the System page of + WinMerge options. By default, it is specified as a subfolder in your + user profile folder (for example, <filename>My + Documents\WinMerge\Filters</filename> in Windows XP). Filters that + are created or copied here are normally visible only to you. If you + create new file filters, you can copy them here to keep them + private.</para> </listitem> </varlistentry> + </variablelist> + <para>Before you can apply file filters that exist in any other folder, + you must first install them.</para> + </section> + + <section id="Filters_FileFilterApply"> + <title>Applying file filters</title> + + <para>You can apply a file filter using any of these methods:</para> + + <itemizedlist> + <listitem> + <para>When you launch a folder compare from the Select Files or + Folders dialog:</para> + + <orderedlist> + <listitem> + <para>After choosing the <guilabel>Left</guilabel> and + <guilabel>Right</guilabel> folders, click + <guibutton>Select</guibutton> next to the + <guilabel>Filter</guilabel> field.</para> + </listitem> + + <listitem> + <para>In the Filters dialog, use the Filefilters tab to choose a + file filter and load it in the <guilabel>Filter</guilabel> + field.</para> + + <note> + <para>If a file filter is currently enabled, the selected file + filter is already loaded in the <guilabel>Filter</guilabel> + field.</para> + </note> + </listitem> + + <listitem> + <para>Proceed with the compare operation. The file in the + <guilabel>Filter</guilabel> field is applied when you start the + operation.</para> + </listitem> + </orderedlist> + </listitem> + + <listitem> + <para>To change file filtering after you have already launched a + folder compare operation (for example, applying a different filter or + disabling filtering):</para> + + <orderedlist> + <listitem> + <para>Click <menuchoice> + <guimenu>Tools</guimenu> + + <guimenuitem>Filters</guimenuitem> + </menuchoice>.</para> + </listitem> + + <listitem> + <para>In the Filters dialog, configure your new file filter + setting, and click <guibutton>OK</guibutton>.</para> + </listitem> + + <listitem> + <para>The new filtering is not automatically applied when you + close the Filters dialog: press <keycap>F5</keycap> to see the new + results in the Folder Compare window.</para> + </listitem> + </orderedlist> + </listitem> + + <listitem> + <para>When you launch a folder compare from the WinMerge command line, + use the <option>-f</option> flag to specify a file filter.</para> + </listitem> + </itemizedlist> + + <para>Remember, you cannot apply both a file mask and a file filter in the + field or command line.</para> + </section> + + <section id="Filters_FileFilterSyntax"> + <title>File filter syntax<indexterm> + <primary>rules</primary> + + <secondary>file filter</secondary> + </indexterm><indexterm> + <primary>filters</primary> + + <secondary>file filter syntax</secondary> + </indexterm></title> + + <para>This section describes the syntax of WinMerge file filters and + provides guidelines for writing them.</para> + + <para>The comment delimiter is <code>##</code>. After a comment delimiter, + all characters in a line are ignored. WinMerge ignores most whitespace + characters in rules. However, a comment must always be preceded by one or + more whitespace (space or tab) characters. To use <code>##</code> as + characters in a rule, omit the whitespace prefix.</para> + + <para>The first two required lines of a file filter are:</para> + + <variablelist> <varlistentry> - <term>Tutorial:</term> + <term>name</term> <listitem> - <simpara><ulink - url="http://www.zvon.org/other/PerlTutorial/Output/index.html">http://www.zvon.org/other/PerlTutorial/Output/index.html</ulink></simpara> + <para>The filter name that is listed in the Files dialog</para> </listitem> </varlistentry> <varlistentry> - <term>PDF quick reference:</term> + <term>def</term> <listitem> - <simpara><ulink - url="http://www.night-ray.com/regex.pdf">http://www.night-ray.com/regex.pdf</ulink></simpara> + <para>The type of filtering to be applied. Specify one of these + values:</para> + + <variablelist> + <varlistentry> + <term>include</term> + + <listitem> + <para>Includes everything except items matching the specified + rule.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term>exclude</term> + + <listitem> + <para>Excludes everything except items matching the specified + rule.</para> + + <para>When you choose the exclude method, you must also add a + <guilabel>d</guilabel> (directory) rule that specifies the + subfolders. It's usually a good idea to specify all + subfolders, like this:</para> + + <screen>d: \\*$ ## Subfolders</screen> + </listitem> + </varlistentry> + </variablelist> + + <tip> + <para>Don't confuse these terms. Remember, in file filters, an + <guilabel>include</guilabel> rule does not specify what to + include, it specifies what <emphasis>not</emphasis> to include. + Similarly, <guilabel>exclude</guilabel> does not specify what to + exclude, it specifies what not to exclude.</para> + </tip> </listitem> </varlistentry> </variablelist> + + <para>Next, your file should contain one or more filter rules. You can add + as many rules as you like. There must be one rule per line, and each rule + must be entirely on one line (no line breaks are allowed in a rule). Each + rule consists of either an <guilabel>f:</guilabel> or a + <guilabel>d:</guilabel> type designator, followed by a reqular expression, + where:</para> + + <variablelist> + <varlistentry> + <term>f: <replaceable>regexp</replaceable></term> + + <listitem> + <para>matches for files, or</para> + </listitem> + </varlistentry> + + <varlistentry> + <term>d: <replaceable>regexp</replaceable></term> + + <listitem> + <para>matches for folders</para> + </listitem> + </varlistentry> + </variablelist> + + <para>Among the many regexp special characters, the following are + particularly important in file filter rules:<indexterm> + <primary>regular expressions</primary> + + <secondary>special characters in filters</secondary> + </indexterm><indexterm> + <primary>regular expressions</primary> + + <secondary>in file filters</secondary> + </indexterm></para> + + <variablelist> + <varlistentry> + <term>^ (beginning of line)</term> + + <listitem> + <para>Frequently required for rules to work correctly.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term>$ (end of line)</term> + + <listitem> + <para>Frequently required for rules to work correctly. For + example:</para> + + <screen>\.c$ ## matches only file names with the extension, <filename>c</filename>. +\.c ## matches any extension beginning with <filename>c</filename>, like <filename>cpp</filename> and <filename>com</filename>.</screen> + </listitem> + </varlistentry> + + <varlistentry> + <term>\ (escape)</term> + + <listitem> + <para>Forces special characters to match normal characters. For + example, to match a folder name, precede the folder backslash + delimiter with a backslash (<code>\\</code>). To match the dot in a + file name, specify a backslash followed by a dot + (<code>\.</code>).</para> + </listitem> + </varlistentry> + </variablelist> + + <para>No special characters or wildcards are used to match file names. To + match all filenames of a certain type, simply omit the filename.</para> + + <para>Rules are case-insensitive. For example, <code>f: \.bat&</code> + matches <filename>winmerge.bat</filename> and + <filename>compare.BAT</filename>.</para> + + <example> + <title>File filter rule examples</title> + + <para>Some simple file filter rules:</para> + + <screen>f: \.cpp$ ## Match <filename>*.cpp</filename> files +f: \.h$ ## Match <filename>*.h</filename> files +f: ^My ## Match <filename>My*.*</filename> files +f: Dlg\. ## Match <filename>*Dlg.*</filename> files +d: \\test$ ## Match <filename>test</filename> folders +d: ^\\Build$ ## Match <filename>Build</filename> folders +d: Temp$ ## Match <filename>*Temp</filename> folders (for example, <filename>FirstTemp</filename>) +d: Src ## Match <filename>*Src*</filename> folders</screen> + + <para>Some rules with more complex regular expressions:</para> + + <screen format="linespecific">f: ^\.#.*$ ## <filename>.#filename.version</filename> files +f: Dlg\.c(pp)?$ ## <filename>*Dlg.c</filename> and <filename>*Dlg.cpp</filename> files +f: ^I.*\.h$ ## <filename>I*.h</filename> files +f: Srv[1-9]\.def$ ## <filename>*Srv1.def</filename> to <filename>*Srv9.def</filename> files +f: ^[h,k,m] ## <filename>h*.*</filename>, <filename>k*.*</filename>, and <filename>m*.*</filename> files</screen> + </example> </section> </section> - <section> - <title>File filters</title> + <section id="Filters_LineFilter"> + <title>Using Line filters<indexterm> + <primary>filters</primary> - <para>A file filter is a set of rules saved to one file. Every file and - folder is tested against all these rules before comparing. Files and - folders that match the rules are excluded if it is an inclusive filter, or - included if it is an exclusive filter.</para> + <secondary>line filters</secondary> + </indexterm><indexterm> + <primary>filtering</primary> - <tip> - <para>Ignored items have "<guilabel>Skipped</guilabel>" status in folder - compare. User can select them to visible or hidden from - <guimenu>View</guimenu> menu. Usually its wise to keep skipped items - hidden.</para> - </tip> + <secondary>in file comparisons</secondary> + </indexterm></title> - <para>WinMerge's filtering system allows only one filter set to be active - at a time. Active filter set can be selected from Open-dialog or from - menu: <menuchoice> - <guimenu>Tools</guimenu> + <para>In a file comparison, you can use line filters to ignore single lines. + For example, you might use line filters to ignore comments or certain type + of generated code, like version control system timestamps. Each line filter + is a rule, and you can apply any number of line filters to a file + comparison.</para> - <guimenuitem>Filters</guimenuitem> - </menuchoice>. Also empty filter can be selected when no folders or - files are ignored.</para> + <para>To learn how to add, edit, and manage filters, see <xref + linkend="Filters_Dlg" />.</para> - <para>Filtered out files get only minimal needed attention by the folder - compare. This means that WinMerge misses a lot of information it gets for - non-ignored files. For example there is no way to know if filtered file is - a text file or a binary file. The reason is simple: as user tolds WinMerge - one does not care about the file, WinMerge tries to minimize the effort - and time for the file.</para> + <section id="Filters_LineFilterApply"> + <title>Applying line filters</title> - <section> - <title>Filter files</title> + <para>You can apply line filters using any of these methods:</para> - <para>Filter files are normal text files, with an extension of <filename - class="extension">.flt</filename>. Files have defined format which is - explained later in this chapter. Filters-dialog allows creating new - filter files based on template file. Filter files can be created from - the scratch but using template file is the recommended way to create a - new filter. The template file is named - <filename>FileFilter.tmpl</filename> and can be modified if needed. The - template file is located in <filename - class="directory">WinMerge/Filters</filename> -folder.</para> + <itemizedlist> + <listitem> + <para>When you launch a file compare from the Select Files or Folders + dialog</para> - <para>Filter files have two possible locations:</para> + <orderedlist> + <listitem> + <para>After choosing the <guilabel>Left</guilabel> and + <guilabel>Right</guilabel> files, click + <guibutton>Select</guibutton> next to the + <guilabel>Filter</guilabel> field.</para> + </listitem> + <listitem> + <para>In the Filters dialog, use the Linefilters tab to enable the + line filters you want to use (if any), or to see what line filters + are currently enabled.</para> + + <note> + <para>The <guilabel>Filter</guilabel> field does not indicate + what line filters are enabled.</para> + </note> + </listitem> + + <listitem> + <para>Proceed with the file compare operation. The enabled line + filters are applied when you start the operation.</para> + </listitem> + </orderedlist> + </listitem> + + <listitem> + <para>After you have already launched a file compare operation (for + example, to apply different filters or disabling filtering)</para> + + <orderedlist> + <listitem> + <para>Click <menuchoice> + <guimenu>Tools</guimenu> + + <guimenuitem>Filters</guimenuitem> + </menuchoice>.</para> + </listitem> + + <listitem> + <para>Open the Filefilters tab.</para> + </listitem> + + <listitem> + <para>Check the individual line filters you want to apply, and + uncheck filters that you don't want to apply.</para> + + <para>You can also add, edit, and remove filters from the list by + using the <guibutton>New</guibutton>, <guibutton>Edit</guibutton>, + and <guibutton>Remove</guibutton> buttons.</para> + </listitem> + + <listitem> + <para>To turn on line filtering, check the <guilabel>Enable Line + Filters</guilabel>. To turn line filtering off, uncheck the + option.</para> + </listitem> + + <listitem> + <para>Click <guibutton>OK</guibutton> to dismiss the File Filters + dialog.</para> + </listitem> + + <listitem> + <para>Click <keycap>F5</keycap> to apply your changes and refresh + the File Compare window.</para> + </listitem> + </orderedlist> + </listitem> + </itemizedlist> + </section> + + <section id="Filters_LineFilterSyntax"> + <title>Line filter syntax<indexterm> + <primary>rules</primary> + + <secondary>line filter</secondary> + </indexterm><indexterm> + <primary>filters</primary> + + <secondary>line filter syntax</secondary> + </indexterm><indexterm> + <primary>regular expressions</primary> + + <secondary>in line filters</secondary> + </indexterm></title> + + <para>A line filter is a rule that is evaluated against each single-line + difference in your compared files, if line filter rules are enabled. When + a rule matches a single-line difference, the difference is ignored.</para> + + <para>Ignored differences are marked in the File Compare window with the + <guilabel>Ignored Difference</guilabel> color (as defined in the Colors + page of WinMerge Options). This enables you to distinguish ignored + differences from other types. However, you cannot select or merge ignored + difference.</para> + + <para>Line filter matching can be described in terms of two ideas:</para> + <itemizedlist> <listitem> - <para>"<filename class="directory">Filters</filename>" subfolder in - the WinMerge program folder. E.g. <filename - class="directory">C:\Program - Files\WinMerge\Filters</filename>.</para> + <para>When a rule matches any part of the line, the entire difference + is ignored. Therefore, you cannot filter just part of a line. For + example, suppose two files have the following single-line + difference:</para> + + <formalpara> + <title>File1:</title> + + <para><screen># Jean Sibelius</screen></para> + </formalpara> + + <formalpara> + <title>File2:</title> + + <para><screen># Janne Sibelius</screen></para> + </formalpara> + + <para>With no filtering, the line is detected as a difference. But if + we apply a line filter rule with the expression, <code>^#</code>, the + lines are reported as identical, because the expression specifies only + the first character, which matches in both files.</para> </listitem> <listitem> - <para>User-defined folder. Selected in Options (<menuchoice> - <guimenu>Edit</guimenu> + <para>A rule is applied to a multi-line difference only if all the + lines match. For example, consider this two-line difference:</para> - <guimenuitem>Options</guimenuitem> + <formalpara> + <title>File1:</title> - <guimenuitem>System</guimenuitem> + <para><screen># Jean Sibelius +# Pekka Himanen</screen></para> + </formalpara> - <guilabel>Filter Folder</guilabel> - </menuchoice>). By default it is <filename class="directory"> My - Documents\WinMerge\Filters</filename> folder.</para> + <formalpara> + <title>File2:</title> + + <para><screen># Janne Sibelius +Pekka Himanen</screen></para> + </formalpara> + + <para>The same <code>^#</code> rule matches the first line, but not + the second line. Therefore, the difference is not ignored.</para> </listitem> </itemizedlist> - <important> - <para>With WinMerge 2.6.0 and later filter files are not anymore - loaded from profile folder like with earlier versions. Using - user-defined folder for filter files provides more flexibility and - easier access to filter files.</para> - </important> + <tip> + <para>It's usually good practice to use the beginning of line ( + <code>^</code> ) and end of line ( <code>&</code> ) of line markers + to control your patterns precisely, because the rule is applied if any + part of a line matches the expression.</para> + </tip> - <para>First part of filter file defines name and basic functionality of - the filter:</para> + <example> + <title>Sample line filters</title> - <para><screen>name: Example filter -def: include</screen>where <constant>def</constant>: is:<itemizedlist> + <screen format="linespecific">^MYTAG$</screen> + + <para>Filters lines that exactly match <literal>MYTAG</literal></para> + + <screen format="linespecific">^::</screen> + + <para>Filters lines beginning with <literal>::</literal></para> + + <screen format="linespecific">^/\**.\*/$</screen> + + <para>Filters lines beginning with + <literal><constant>/*</constant></literal> and ending with + <literal>*/</literal></para> + + <screen format="linespecific">^[1-5]00</screen> + + <para>Filters lines beginning with numbers 100, 200, 300, 400, and + 500</para> + </example> + + <example> + <title>Line filter rule matching CVS Id lines</title> + + <para>Id lines look like this:</para> + + <screen>// $Id$</screen> + + <para>... and can be filtered with this rule:</para> + + <screen>^// \WId: .*\$</screen> + </example> + + <example> + <title>Filter line number comments in po files</title> + + <para>po line number comments look like this:</para> + + <screen>#: src/filename.c:766</screen> + + <para>... and can be filtered with this rule:</para> + + <screen>^#</screen> + </example> + </section> + </section> + + <section id="Filters_Dlg"> + <title>Using the Filters dialog<indexterm> + <primary>Filters dialog</primary> + </indexterm><indexterm> + <primary>filters</primary> + + <secondary>managing and enabling</secondary> + </indexterm></title> + + <para>This section describes the Filters dialog, which provides functions to + create and manage file filters and line filters.</para> + + <para>To open the Filters dialog, use either of these methods:</para> + + <itemizedlist> + <listitem> + <para>In the Select Files or Folders dialog, click + <guibutton>Select</guibutton> to the right of the + <guilabel>Filter</guilabel> field. You use this method when you want to + apply a file filter to a folder compare operation.</para> + </listitem> + + <listitem> + <para>Click <menuchoice> + <guimenu>Tools</guimenu> + + <guimenuitem>Filters</guimenuitem> + </menuchoice>. This method can be used at any time except when the + Select Files or Folders dialog is open.</para> + </listitem> + </itemizedlist> + + <para>The Filters dialog has a tab for each type of WinMerge filter:</para> + + <variablelist> + <varlistentry> + <term>Filefilters</term> + + <listitem> + <para>Choose this tab to work with file filters for folder compare + operations.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term>Linefilters</term> + + <listitem> + <para>Choose this tab to work with line filters for file compare + operations.</para> + </listitem> + </varlistentry> + </variablelist> + + <section id="Filters_FileFiltersTab"> + <title>Using the Filefilters tab<indexterm> + <primary>file filters</primary> + + <secondary>enabling</secondary> + </indexterm></title> + + <para>The main part of this tab is a list of file filters that are + available for folder compare operations. The list includes shared, + private, and installed file filters that WinMerge knows about, as + described in <xref linkend="Filters_FileFilterLoc" />.</para> + + <section id="Filters_FileFilterEnabling"> + <title>Enabling and disabling file filters</title> + + <para>You must enable a file filter to make it available in a folder + comparison operation, or to disable a current filter to stop it from + being used:</para> + + <orderedlist> <listitem> - <para><constant>include</constant> - inclusive filter. This filter - type filters out files and folders that match rules in - filter.</para> + <para>Open the Filters dialog, if it is not already open.</para> </listitem> <listitem> - <para><constant>exclude</constant> - exclusive filter. This filter - type lets through files and folders that match rules in - filter.</para> + <para>Select a file filter or + <guimenuitem><None></guimenuitem> from the list.</para> </listitem> - </itemizedlist>When using exclusive filter its worth noting that the - filter must contain rule to include all wanted subfolders. Usually its - wise to use this rule to include all subfolders:</para> - <screen>d: \\*$ ## Subfolders</screen> + <listitem> + <para>Click <guibutton>OK</guibutton> to dismiss the Filters + dialog.</para> + </listitem> + </orderedlist> - <para>There can be one filter rule in one line. And rule cannot be split - to several lines. Common format for one filter line is like this:</para> + <para>There are several ways to apply file filters after enabling them. + For details, see <xref linkend="Filters_FileFilterApply" />.</para> + </section> - <screen>f: \.ext$ ## Match files *.ext</screen> + <section id="Filters_FileFilterCfg"> + <title>Configuring file filters</title> - <para>or</para> + <para>Use these buttons to manage your <guilabel>Filefilters</guilabel> + list and create new file filters:</para> - <screen>d: \\folder$ ## Match given folder name</screen> + <variablelist> + <varlistentry> + <term>Test</term> - <para>Rule begins with "<constant>f:</constant>" if it matches for - filenames and "<constant>d:</constant>" if it matches for folder names. - (d comes from "folder".) Filenames are given to filter as is, there are - no special characters added. Folder names have preceding backslash - before them (e.g. "\Folder name"). So if folder names are matched by the - beginning of the name, the filter must start with "\\" to match the - first backslash. "<constant>##</constant>" is a comment separator, all - characters in line after that are ignored by WinMerge.</para> + <listitem> + <para>Select a file filter in the list and click + <guibutton>Test</guibutton> to quickly see how the filter works. + See <xref linkend="Filters_TestingDlg" /> for details.</para> + </listitem> + </varlistentry> - <para><note> - <para>File filter rules are case-insensitive. Rule - <constant>.\bat$</constant> matches to - <filename>winmerge.bat</filename> and - <filename>compare.BAT</filename>.</para> - </note></para> + <varlistentry> + <term>Install</term> - <para>So simple filters can be for example:</para> + <listitem> + <para>Enables you to locate a file filter and adds it to the + Filters list. File filters that are not in either the shared or + default private folder are not detected unless you install + them.</para> + </listitem> + </varlistentry> - <example> - <title>Simple filefilter rules</title> + <varlistentry> + <term>New</term> - <screen>f: \.cpp$ ## Match *.cpp files -f: \.h$ ## Match *.h files -f: ^My ## Match My*.* files -f: Dlg\. ## Match *Dlg.* files -d: \\test$ ## Match 'test' folders -d: ^\\Build$ ## Match 'Build' folders -d: Temp$ ## Match *Temp folders (e.g. FirstTemp) -d: Src ## Match *Src* folders</screen> - </example> + <listitem> + <para>Creates a new copy of a file template in either the shared + or private filter folders, and opens it in your default editor. + Edit the template and add your rules, as described in <xref + linkend="Filters_CreatingFile" />.</para> + </listitem> + </varlistentry> - <para>Line begin or -end marker (<constant>"^"</constant> or - <constant>"$"</constant>) is usually required filter to work correctly. - Dot in filename must be "escaped" with <constant>"\"</constant> so - <constant>"\."</constant> means dot in filename.</para> + <varlistentry> + <term>Edit</term> - <note> - <para>Don't forget "<constant>$</constant>" at end. It marks end of - folder- or filename and without it rule may not work like expected. - While "<literal>\.c$</literal>" matches with only filenames having - extension <filename class="extension">.c</filename> - "<literal>\.c</literal>" matches all extensions beginning with - "<literal>c</literal>" (<filename class="extension">.cpp</filename>, - <filename class="extension">.com</filename>, etc).</para> - </note> + <listitem> + <para>Select a file filter in the list and click + <guibutton>Edit</guibutton> to open the file in your default + editor.</para> + </listitem> + </varlistentry> - <para>Since file filter rules are regular expressions more complex rules - are also possible. Following few rules show some possibilities for more - complex rules:</para> + <varlistentry> + <term>Delete</term> - <example> - <title>More complex file filter rules</title> + <listitem> + <para>Select a file filter in the list and click + <guibutton>Delete</guibutton> to delete the file and remove it + from the list. Yes, the file is really deleted!</para> + </listitem> + </varlistentry> + </variablelist> - <screen format="linespecific">f: ^\.#.*$ ## .#filename.version files -f: Dlg\.c(pp)?$ ## *Dlg.c & *Dlg.cpp files -f: ^I.*\.h$ ## I*.h files -f: Srv[1-9]\.def$ ## *Srv1.def - *Srv9.def files -f: ^[h,k,m] ## h*.* & k*.* & m*.* files</screen> - </example> + <para>Your changes are saved when you click <guibutton>OK</guibutton> to + dismiss the Filters dialog.</para> + </section> - <para>WinMerge ignores most whitespace characters in rules definition - lines. However comment must always start with one or more whitespace - character (space or tabulator) and comment-marker - (<constant>##</constant>). <constant>##</constant> can be used as part - of rule if there is no whitespace character before it.</para> + <section id="Filters_CreatingFile"> + <title>Creating a file filter</title> + + <para>If the file filters that are installed with WinMerge do not + provide the filtering you need, you can create your own:</para> + + <orderedlist> + <listitem> + <para>Click <menuchoice> + <guimenu>Tools</guimenu> + + <guimenuitem>Filters</guimenuitem> + </menuchoice>. Or, from the Select Files or Folders dialog, click + <guibutton>Select</guibutton> to the right of the + <guilabel>Filter</guilabel> field.</para> + </listitem> + + <listitem id="Filters_New_step"> + <para>In the Filters dialog Filefilters tab, click + <guibutton>New</guibutton>.</para> + </listitem> + + <listitem> + <para>In the Shared or Private Filter dialog, choose + <guilabel>Shared Filter</guilabel> or <guilabel>Private + Filter</guilabel> (see <xref linkend="Filters_FileFilterLoc" /> for + their uses) and click <keycap>OK</keycap>.</para> + + <para>The Select filename for new filter dialog opens in the shared + or private files folder on your system (if the private folder does + not exist, WinMerge creates it).</para> + </listitem> + + <listitem> + <para>In the Select filename for new filter dialog, enter a new file + name and click <guibutton>Save</guibutton>.</para> + + <note> + <para>Don't choose an existing file name: to edit an existing + file, go back to Step <xref linkend="Filters_New_step" /> and + click Edit instead of New.</para> + </note> + + <para>WinMerge initializes the new file with the contents of the + <filename>FileFilter.tmpl</filename> tempate, and opens it in your + default text editor.</para> + </listitem> + + <listitem> + <para>Follow the template instructions to edit the template, + updating the placeholder name and description and adding filter + rules as described in <xref linkend="Filters_FileFilterSyntax" />. + Save the file in your text editor.</para> + + <tip> + <para>If you want to quickly test a rule that you are defining, + try clicking Test in the Filters dialog. See <xref + linkend="Filters_TestingDlg" /> for details.</para> + </tip> + </listitem> + + <listitem> + <para>If you created your file filter in one of the standard + <filename>Filters</filename> folders, and the Filters dialog does + not list your new file filter, try clicking + <guibutton>OK</guibutton> to close it, then click <menuchoice> + <guimenu>Tools</guimenu> + + <guimenuitem>Filters</guimenuitem> + </menuchoice> again to reopen it. The + <guilabel>Filefilters</guilabel> list should now include the new + file filter.</para> + + <para>If you saved the file in an alternate location on your file + system), WinMerge cannot detect it unless you install it. To make a + file filter detectable anywhere on your system:</para> + + <orderedlist numeration="loweralpha"> + <listitem> + <para>Click <guibutton>Install</guibutton> in the Filters + dialog.</para> + </listitem> + + <listitem> + <para>In the Locate filter file to install dialog, navigate to + the <filename>flt</filename> file on your system, and click + <guibutton>Open</guibutton>. The Filefilters list should now + include the installed file filter.</para> + </listitem> + </orderedlist> + </listitem> + </orderedlist> + </section> + + <section id="Filters_TestingDlg"> + <title>Testing file filter rules<indexterm> + <primary>file filters</primary> + + <secondary>testing</secondary> + </indexterm><indexterm> + <primary>testing file filters</primary> + </indexterm></title> + + <para>Use the Test Filter dialog to quickly test a file filter against + sample data, to help you develop new rules or to understand how existing + rules work. It can be easier than running a full compare + operation.</para> + + <para>Starting from the Filters dialog:</para> + + <orderedlist> + <listitem> + <para>In the Filefilters tab, choose the file filter you want to + test.</para> + </listitem> + + <listitem> + <para>If you want to see the rules you will be testing,click + <guibutton>Edit</guibutton> now to open the file so that you can + view it during the next steps.</para> + </listitem> + + <listitem> + <para>Click <guibutton>Test</guibutton>.</para> + </listitem> + + <listitem> + <para>In the Test Filter dialog, choose the type of rule to + test:</para> + + <itemizedlist> + <listitem> + <para>To test an <guilabel>f:</guilabel> file rule in your file + filter, uncheck the <guilabel>Folder Name</guilabel> + option.</para> + </listitem> + + <listitem> + <para>To test a <guilabel>d:</guilabel> folder rule, check the + <guilabel>Folder Name</guilabel> option.</para> + </listitem> + </itemizedlist> + </listitem> + + <listitem> + <para>Enter the text to test.</para> + + <para>The text should be appropriate for the type of rule you are + testing. For example, if you have checked the <guilabel>Folder + Name</guilabel> option, you probably want to enter a folder name, + such as \temp.</para> + + <para>The <guilabel>Result</guilabel> box displays your entry, + followed by its status: either + <computeroutput>passed</computeroutput> or + <computeroutput>failed</computeroutput>.</para> + </listitem> + </orderedlist> + </section> </section> - </section> - <section> - <title>Line filters</title> + <section id="Filters_LineFiltersTab"> + <title>Using the Linefilters tab<indexterm> + <primary>line filters</primary> - <para>Line filters can be used to ignore single lines from compared files. - Line filters are handy when user doesn't want to compare comments or - certain generated code. For example version control system - (time)stamps.</para> + <secondary>enabling</secondary> + </indexterm></title> - <important> - <para>Line filter rule ignores single line it matches. It is not - possible to ignore partial lines or several lines with file filter rule. - Also, all lines in difference must match the filter so that difference - is ignored. If only one line of several matches, the difference is not - ignored.</para> - </important> + <para>Use this tab to configure and enable line filters for file compare + operations. The tab features a list of rules. Each rule contains a single + regular expression. You can apply any combination of rules from the list + to a file comparison.</para> - <para>In file compare ignored differences are shown with own colors to - differentiate them from other differences. User can see these differences - but cannot select or merge them.</para> + <section id="Filters_LineFilterCfg"> + <title>Configuring line filters</title> - <para>Line filter rules are regular expressions like file filter rules. - Since filter matches if any part of line matches it is usually recommended - to add begin (<constant>"^"</constant>) or end (<constant>"$"</constant>) - marker to rule. Or both markers if exact line is wanted to - filtered.</para> + <para>Below the <guilabel>Regular Expressions</guilabel> list is an edit + box and buttons that you can use to maintain the list at any time by + adding, editing, and removing rules.</para> - <para>Rules can be added and edited in Filters-dialog (Menu: <menuchoice> - <guimenu>Tools</guimenu> + <para>To add a new rule:</para> - <guimenuitem>Filters</guimenuitem> - </menuchoice>). Type one rule per row to the list. At the beginning of - the row is a checkbox for enabling / disabling single rules.</para> + <orderedlist> + <listitem> + <para>Click <guibutton>New</guibutton>. Your edit cursor is + automatically enabled in the edit box.</para> + </listitem> - <para>Compare results are not updated automatically after changing line - filter rules. User can update compare results by selecting <menuchoice> - <guimenu>Edit</guimenu> + <listitem> + <para>Enter an expression in the edit box below the + <guilabel>Regular Expressions</guilabel> list.</para> + </listitem> - <guimenuitem>Refresh</guimenuitem> - </menuchoice> or <keycap>F5</keycap>.</para> + <listitem> + <para>Click <guibutton>Save</guibutton> to load the expression in a + new line in the list.</para> + </listitem> + </orderedlist> - <example> - <title>Some example line filters</title> + <para>To edit an existing rule:</para> - <screen format="linespecific">^MYTAG$</screen> + <orderedlist> + <listitem> + <para>Select the line and click <guibutton>Edit</guibutton>.</para> + </listitem> - <para>- Filters out lines being exactly - <constant>"MYTAG"</constant></para> + <listitem> + <para>Edit the expression in the edit box.</para> + </listitem> - <screen format="linespecific">^::</screen> + <listitem> + <para>Click <guibutton>Save</guibutton><guibutton> </guibutton>when + you're done.</para> + </listitem> + </orderedlist> - <para>- Filters out lines beginning with - <constant>"::"</constant></para> + <para>To delete an existing rule, select (check) the rule and click + <guibutton>Remove</guibutton>.</para> + </section> - <screen format="linespecific">^/\**.\*/$</screen> + <section id="Filters_LineFilterEnabling"> + <title>Enabling and disabling line filters<indexterm> + <primary>line filters</primary> - <para>- Filters out lines beginning with <constant>"/*"</constant> and - ending with <constant>"*/"</constant></para> + <secondary>list of available</secondary> + </indexterm></title> - <screen format="linespecific">^[1-5]00</screen> + <orderedlist> + <listitem> + <para>In the <guilabel>Regular Expressions</guilabel> list, check + just the filters that you want to apply, and uncheck any filters you + do not want to apply.</para> + </listitem> - <para>- Filters out lines beginning with numbers 100, 200, 300, 400 - & 500</para> - </example> + <listitem> + <para>Check or uncheck the <guilabel>Enable Line Filters</guilabel> + option. If you turn filtering on, all the rules that are currently + checked in the <guilabel>Regular Expression</guilabel> list are + used. If filtering is off, no rules are used even if they are + checked.</para> + </listitem> - <example> - <title>Line filter rule matching CVS "Id:" -lines:</title> + <listitem> + <para>Click <guibutton>OK</guibutton> to dismiss the Filters dialog + and save your settings.</para> + </listitem> + </orderedlist> - <para>Id-lines are like this:</para> + <para>There are several ways to apply file filters after enabling them. + For details, see <xref linkend="Filters_LineFilterApply" />.</para> + </section> + </section> + </section> - <screen>// $Id$</screen> + <section id="AboutFilters_regexp"> + <title>Getting help with regular expressions<indexterm> + <primary>regular expressions</primary> - <para>And they can be filtered with rule:</para> + <secondary>getting help</secondary> + </indexterm></title> - <screen>^// \WId: .*\$</screen> - </example> + <para>Regular expressions can be very complex. Fortunately, most file + filters in WinMerge involve simple extension expressions, as shown in the + examples in this topic. The filter files installed with WinMerge include + many other useful examples.</para> - <example> - <title>Filter out line number comments in po files:</title> + <para>Finally, there are lots of resources on the Web for help with regexps, + including these sites:</para> - <para>po line number comments are like this:</para> + <variablelist> + <varlistentry> + <term>Good site devoted to regexps:</term> - <screen>#: src/filename.c:766</screen> + <listitem> + <simpara><ulink + url="http://www.regular-expressions.info/">http://www.regular-expressions.info/</ulink></simpara> + </listitem> + </varlistentry> - <para>And they can be filtered out with rule:</para> + <varlistentry> + <term>Good HOWTO for regexps:</term> - <screen>^#</screen> - </example> + <listitem> + <simpara><ulink + url="http://www.amk.ca/python/howto/regex/">http://www.amk.ca/python/howto/regex/</ulink></simpara> + </listitem> + </varlistentry> + + <varlistentry> + <term>Tutorial:</term> + + <listitem> + <simpara><ulink + url="http://www.zvon.org/other/PerlTutorial/Output/index.html">http://www.zvon.org/other/PerlTutorial/Output/index.html</ulink></simpara> + </listitem> + </varlistentry> + + <varlistentry> + <term>PDF quick reference:</term> + + <listitem> + <simpara><ulink + url="http://www.night-ray.com/regex.pdf">http://www.night-ray.com/regex.pdf</ulink></simpara> + </listitem> + </varlistentry> + </variablelist> </section> -</article> +</article> \ No newline at end of file Modified: trunk/Docs/Users/Manual/WinMerge_help.xml =================================================================== --- trunk/Docs/Users/Manual/WinMerge_help.xml 2008-09-03 03:19:49 UTC (rev 5883) +++ trunk/Docs/Users/Manual/WinMerge_help.xml 2008-09-03 13:26:43 UTC (rev 5884) @@ -21,7 +21,9 @@ ]> <book id="index"> <bookinfo> - <title>WinMerge 2.8 Manual</title> + <title>WinMerge <xi:include href="replaceables.xml" + xmlns:xi="http://www.w3.org/2001/XInclude" xpointer="element(version)" /> + Help</title> <productname>WinMerge</productname> This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site. |
From: <ki...@us...> - 2008-09-05 16:49:51
|
Revision: 5896 http://winmerge.svn.sourceforge.net/winmerge/?rev=5896&view=rev Author: kimmov Date: 2008-09-05 16:49:49 +0000 (Fri, 05 Sep 2008) Log Message: ----------- PATCH: [ 2091055 ] Doc edit: Filters.xml Submitted by Denis Bradford Modified Paths: -------------- trunk/Docs/Users/Manual/Configuration.xml trunk/Docs/Users/Manual/Open_paths.xml trunk/Docs/Users/Manual/Quick_start.xml Modified: trunk/Docs/Users/Manual/Configuration.xml =================================================================== --- trunk/Docs/Users/Manual/Configuration.xml 2008-09-05 10:08:59 UTC (rev 5895) +++ trunk/Docs/Users/Manual/Configuration.xml 2008-09-05 16:49:49 UTC (rev 5896) @@ -1125,7 +1125,7 @@ <itemizedlist> <listitem> <para><option>Enabled</option> (default): Files and folders that you - deletein a Folder Compare window are moved to the Recycle Bin, if it + delete in a Folder Compare window are moved to the Recycle Bin, if it is available.</para> <important> @@ -1265,7 +1265,7 @@ <section> <title>Filter Folder<indexterm> - <primary>filtering, folder used</primary> + <primary> Filter folders, specifying default private folder</primary> </indexterm></title> <para>Use this field to specify your own private folder for file filters. Modified: trunk/Docs/Users/Manual/Open_paths.xml =================================================================== --- trunk/Docs/Users/Manual/Open_paths.xml 2008-09-05 10:08:59 UTC (rev 5895) +++ trunk/Docs/Users/Manual/Open_paths.xml 2008-09-05 16:49:49 UTC (rev 5896) @@ -68,43 +68,33 @@ </tip> </section> - <section> - <title>Selecting filters</title> + <section id="Open_paths_filters"> + <title>Specifying filters</title> - <para>The third edit field in the Select Files or Folders dialog, - <guilabel>Filter</guilabel>, enables you to restrict the files that are - included in a folder compare. You can specify a list of file extensions to - include, or a file filter. A list is one or more extensions separated by - spaces, commas, colons or semicolons, using this syntax:</para> + <para>The <guilabel>Filter</guilabel> edit field enables you to restrict + the files to be included in your folder compare. You can specify one or + more file masks, or a single file filter (not both).</para> - <synopsis>*.[<replaceable>extension</replaceable>][<replaceable>delimiter</replaceable> *.<replaceable>extension</replaceable> ...]</synopsis> + <para>A mask is a simple expression based on file extensions. For example, + this list of file masks includes only files with the specified extensions; + all others are excluded from the selection when the compare operation + starts:</para> - <example> - <title>Extension list</title> + <screen>*.h;*.cpp *.txt,*.ini</screen> - <screen>*.h;*.cpp *.txt,*.ini</screen> - </example> + <para>File masks are practical for simple filtering; for more advanced + selecting, use filter files. Filter files are collections of regular + expressions that can either include or exclude files. WinMerge installs a + number of predefined filter files in its <filename>Filters</filename> + folder, and you can create your own, too. </para> - <tip> - <para><filename>*.</filename> (star, dot and no extension) selects files - without any extension, for example "<filename>README</filename>".</para> - </tip> + <para>To specify a filter, click the <guibutton>Select</guibutton> button + next to the <guilabel>Filters</guilabel> field to choose from a list of + available filters. Or, click the Filter drop-down list and choose a + recently-used filter file.</para> - <para>A file extension list can be used only for simple selections; for - more advanced selecting, use file filters. Different extensions can be - separated by spaces, commas, colons, or semicolons.</para> - - <para>You can also enter a file filter name in the - <guilabel>Filter</guilabel> field. The easiest way is to click - <guibutton>Select</guibutton> and use the Filters dialog to select a file - filter. You can also create, edit, and delete filter files using the - Filters dialog.</para> - - <note> - <para>If the specified filter cannot be found or if the extension list - is not valid, WinMerge selects all files (that is, it uses uses the - default <filename>*.*</filename> extension list).</para> - </note> + <para>For full information about filter masks and filter files, see <xref + linkend="Filters" />.</para> </section> <section id="Open_paths_unpacker"> @@ -299,7 +289,7 @@ <para>By default, WinMerge does not include subfolders in compare operations. To change the default behavior, enable <guilabel>Include - subfolders by befault</guilabel> in the System page of WinMerge options. + subfolders by default</guilabel> in the System page of WinMerge options. To change include subfolders while using the shell integration, press and hold the <keycap>Control</keycap> key while selecting <guimenuitem>Compare</guimenuitem> in the Windows Explorer context Modified: trunk/Docs/Users/Manual/Quick_start.xml =================================================================== --- trunk/Docs/Users/Manual/Quick_start.xml 2008-09-05 10:08:59 UTC (rev 5895) +++ trunk/Docs/Users/Manual/Quick_start.xml 2008-09-05 16:49:49 UTC (rev 5896) @@ -25,15 +25,7 @@ <itemizedlist> <listitem> - <para>Double-click the <inlinemediaobject> - <imageobject> - <imagedata contentwidth="32" fileref="screenshots/wm_icon.png" /> - </imageobject> - - <textobject> - <phrase>WinMerge desktop shortcut</phrase> - </textobject> - </inlinemediaobject> WinMerge desktop shortcut.</para> + <para>Double-click the WinMerge desktop shortcut.</para> </listitem> <listitem> @@ -173,30 +165,45 @@ <para>If you are comparing folders, you can use the <guilabel>Filter</guilabel> field to eliminate some files from the operation. The field specifies a subset of files in the selected paths - that are to be included; all unspecified files are excluded. There are - two methods of filtering:</para> + that are to be included; all unspecified files are excluded.</para> + <para>You can enter file masks to filter files with certain extensions. + For example, this expression includes only C and C++ source files; all + other file types are eliminated from your selection.</para> + + <para><filename><userinput>*.cpp;*.hpp;*.c;*.h</userinput></filename></para> + + <para>For more robust filtering, enter a filter file instead of file + masks: click the <guibutton>Select</guibutton> button next to the + <guilabel>Filters</guilabel> field to choose from a list of available + filters. File filters contain any number of rules to either include or + exclude files. WinMerge installs a set of filter files, which you can + edit or augment with your own files.</para> + + <para>See <xref linkend="Filters" /> for full details about file masks + and filter files.</para> + + <!-- <variablelist> <varlistentry> - <term>File extension</term> + <term>File masks</term> <listitem> <para>In this method, you specify the types of files to include in the operation; all other files are excluded (filtered). With no - filter value or a value of <literal>*.*</literal>, all files in - the paths are included, so no filtering is performed. To add - filtering, enter one or more file extension specifications. - Separate multiple items with spaces or semicolons.</para> + file mask or the default mask of <literal>*.*</literal>, all files + in the paths are included, so no filtering is performed. To add + filtering, enter one or more masks. Separate multiple masks with + spaces, commas, colons or semicolons.</para> <para>For example, this expression filters all files from the operation except C and C++ source files:</para> <para><filename><userinput>*.cpp;*.hpp;*.c;*.h</userinput></filename></para> - <para>You cannot filter by file name, which is represented in the - file extension expression only by the <literal>*</literal> - wildcard character. For example, these expressions are not - valid:</para> + <para>File names cannot be filtered: they are represented in the + masks only by the <literal>*</literal> wildcard character. For + example, these expressions are not valid masks:</para> <para><userinput>mybook.xml</userinput></para> @@ -211,11 +218,11 @@ <para>File filtering is more powerful than extension filtering. Click the <guibutton>Select</guibutton> button next to the <guilabel>Filters</guilabel> field to choose from a list of - available filters. See <xref linkend="Filters" /> for full - details.</para> + available filters. </para> </listitem> </varlistentry> </variablelist> +--> </listitem> <listitem> This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site. |
From: <ki...@us...> - 2008-09-08 16:01:32
|
Revision: 5927 http://winmerge.svn.sourceforge.net/winmerge/?rev=5927&view=rev Author: kimmov Date: 2008-09-08 16:01:26 +0000 (Mon, 08 Sep 2008) Log Message: ----------- PATCH: [ 2099169 ] Update css for HTML Help Submitted by Denis Bradford Modified Paths: -------------- trunk/Docs/Users/Manual/build/build_htmlhelp.bat trunk/Docs/Users/Manual/css/help.css Modified: trunk/Docs/Users/Manual/build/build_htmlhelp.bat =================================================================== --- trunk/Docs/Users/Manual/build/build_htmlhelp.bat 2008-09-08 03:09:44 UTC (rev 5926) +++ trunk/Docs/Users/Manual/build/build_htmlhelp.bat 2008-09-08 16:01:26 UTC (rev 5927) @@ -25,7 +25,7 @@ echo Copy stylesheets... if not exist "%docbook_outputdir%\css" mkdir "%docbook_outputdir%\css" -copy "..\css\help.css" "%docbook_outputdir%\css\help.css" +copy "..\css\*.css" "%docbook_outputdir%\css\." echo Create HTML files... %docbook_java_exe% %docbook_java_parameters% -cp %docbook_saxon_jar%;%docbook_xerces_jar%;%docbook_saxon_xsl% -Djavax.xml.parsers.DocumentBuilderFactory=%DBFACTORY% -Djavax.xml.parsers.SAXParserFactory=%SPFACTORY% -Dorg.apache.xerces.xni.parser.XMLParserConfiguration=%XINCLUDE% com.icl.saxon.StyleSheet %docbook_inputfile% %docbook_use_stylesheet% base.dir=%docbook_outputdir%\ Modified: trunk/Docs/Users/Manual/css/help.css =================================================================== --- trunk/Docs/Users/Manual/css/help.css 2008-09-08 03:09:44 UTC (rev 5926) +++ trunk/Docs/Users/Manual/css/help.css 2008-09-08 16:01:26 UTC (rev 5927) @@ -1,125 +1,4 @@ -body,th,td { - font-family: Verdana,Helvetica,Arial,sans-serif; - font-size: 80%; -} +@import url("all.css") screen; +@import url("print.css") print; -pre,code,tt { - font-family: "Courier New",Courier,monospace; - font-size: 100%; -} - -ul { - list-style-type: square; -} - -/* Default link style */ -a:link { color:#3366CC; text-decoration:underline; } -a:visited { color:#003399; text-decoration:underline; } -a:focus { color:#3366CC; text-decoration:none; } -a:hover { color:#3366CC; text-decoration:none; } -a:active { color:#003399; text-decoration:none; } - -a[name]:hover { color:black; text-decoration:none; } - -.mediaobject { - margin-top: 10px; -} - -.screen { - padding: 5px; - background-color: #EEEEEE; - border-left: 10px solid #CCCCCC; -} - -.caution { - background-color: #FFDDAA; - border: 1px solid olive; -} -.important { - background-color: #FFFFDD; - border: 1px solid olive; -} -.note { - background-color: #DDDDFF; - border: 1px solid blue; -} -.tip { - background-color: #DDFFDD; - border: 1px solid green; -} -.warning { - background-color: #FFDDDD; - border: 1px solid red; -} - -/* Examples */ -.example,.informalexample { - padding-left: 7px; - border-left: 3px solid black; -} - -/* Command synopsis */ -.cmdsynopsis p { - padding: 5px; - color: gray; - background-color: #EEEEEE; - border-left: 10px solid #CCCCCC; -} - -.command,.option,.replaceable { - color: black; -} - -/* GUI elements */ -.guimenu,.guisubmenu,.guimenuitem,.guilabel { - font-style: italic; -} - -/* FAQ */ -.question { - font-weight: bold; -} - -/* tables */ -.table table { - border-collapse: collapse; - border: 1px solid black; -} - -.table th { - padding: 2px; - text-align: left; - color: white; - background: black; - border: 1px solid black; -} - -.table td { - padding: 2px; - border: 1px solid black; -} - -/* variablelist */ -.variablelist dl { - margin-left: 2em; -} -.variablelist dt { - font-weight: bold; -} -.variablelist dd { - margin-left: 2em; -} -.variablelist dd p { - margin-top: 0.5em; -} - -/* authorgroup */ -.authorgroup { - margin-left: 2em; -} -.author h3 { - margin: 0; - margin-bottom: 0.25em; - padding: 0; - font-size: 100%; -} \ No newline at end of file +/* Add any HTML Help specific rules below */ \ No newline at end of file This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site. |
From: <ki...@us...> - 2008-09-08 21:01:34
|
Revision: 5930 http://winmerge.svn.sourceforge.net/winmerge/?rev=5930&view=rev Author: kimmov Date: 2008-09-08 21:01:31 +0000 (Mon, 08 Sep 2008) Log Message: ----------- PATCH: [ 2086711 ] Edit text encoding Help topic Submitted by Denis Bradford Modified Paths: -------------- trunk/Docs/Users/Manual/Compare_dirs.xml trunk/Docs/Users/Manual/Compare_files.xml trunk/Docs/Users/Manual/Configuration.xml trunk/Docs/Users/Manual/Install.xml trunk/Docs/Users/Manual/Text_encoding.xml trunk/Docs/Users/Manual/WinMerge_help.xml Modified: trunk/Docs/Users/Manual/Compare_dirs.xml =================================================================== --- trunk/Docs/Users/Manual/Compare_dirs.xml 2008-09-08 16:23:58 UTC (rev 5929) +++ trunk/Docs/Users/Manual/Compare_dirs.xml 2008-09-08 21:01:31 UTC (rev 5930) @@ -7,6 +7,8 @@ <para>This topic describes how to compare and merge folders using the Folder Compare window.</para> + <xi:include href="Text_encoding.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/> + <section id="Compare_dirs_starting"> <title>Starting a folder compare operation</title> @@ -46,42 +48,58 @@ </variablelist> <tip> - <para>Recursive mode is useful for detecting and manipulating different - files in an entire folder structure. However, it can be slow if there are - many subfolders and files.</para> + <title>Tips</title> - <para>Nonrecursive mode has the advantage of speed when there are many - subfolders that need not be examined. Also, the display can be easier to - manage because it shows items in only selected folders.</para> - </tip> + <variablelist> + <varlistentry> + <term>Recursive mode</term> - <note> - <title>Compare by Quick Contents option</title> + <listitem> + <para>Recursive mode is useful for detecting and manipulating + different files in an entire folder structure. However, it can be + slow if there are many subfolders and files.</para> - <para>The <guilabel>Quick Contents</guilabel> method for file comparison, - described in <xref linkend="Configuration" />, can be useful when you - compare big binary files; and it is automatically used to compare files - bigger than 4 MB. Possible disadvantages are that line filters do not - work, and there is no difference counts information in the Folder Compare - window. This should not matter In most cases, because such large files are - usually binary.</para> + <para>Nonrecursive mode has the advantage of speed when there are + many subfolders that need not be examined. Also, the display can be + easier to manage because it shows items in only selected + folders.</para> + </listitem> + </varlistentry> - <para>To use this method, configure it before your compare operation: in - the Compare page of the WinMerge options, click the <guilabel>File Compare - method</guilabel> drop-down menu and choose <guimenuitem>Quick - Contents</guimenuitem>.</para> - </note> + <varlistentry> + <term>Quick Contents comparisons</term> - <note> - <title>For advanced users</title> + <listitem> + <para>The <guilabel>Quick Contents</guilabel> method for file + comparison, described in <xref linkend="Configuration" />, can be + useful when you compare big binary files; and it is automatically + used to compare files bigger than 4 MB. Possible disadvantages are + that line filters do not work, and there is no difference counts + information in the Folder Compare window. This should not matter In + most cases, because such large files are usually binary.</para> - <para>You can change the 4 MB file size limit of the <guilabel>Compare by - Quick Contents</guilabel>, for example if you have a lot of very big text - files. To do so, run the Windows <command>regedit</command> command, - navigate to this keyword, and modify its value: <screen>HKEY_CURRENT_USER\Software\Thingamahoochie\WinMerge\Settings\QuickMethodLimit</screen>As - usual, be careful when changing values directly in the registry!</para> - </note> + <para>To use this method, configure it before your compare + operation: in the Compare page of the WinMerge options, click the + <guilabel>File Compare method</guilabel> drop-down menu and choose + <guimenuitem>Quick Contents</guimenuitem>.</para> + </listitem> + </varlistentry> + <varlistentry> + <term>For advanced users</term> + + <listitem> + <para>You can change the 4 MB file size limit of the + <guilabel>Compare by Quick Contents</guilabel>, for example if you + have a lot of very big text files. To do so, run the Windows + <command>regedit</command> command, navigate to this keyword, and + modify its value: <screen>HKEY_CURRENT_USER\Software\Thingamahoochie\WinMerge\Settings\QuickMethodLimit</screen>As + usual, be careful when editing the registry!</para> + </listitem> + </varlistentry> + </variablelist> + </tip> + <section> <title>Folder Compare Progress window<indexterm> <primary>Folder Compare Progress window</primary> Modified: trunk/Docs/Users/Manual/Compare_files.xml =================================================================== --- trunk/Docs/Users/Manual/Compare_files.xml 2008-09-08 16:23:58 UTC (rev 5929) +++ trunk/Docs/Users/Manual/Compare_files.xml 2008-09-08 21:01:31 UTC (rev 5930) @@ -9,6 +9,8 @@ used here, we suggest you read read <xref linkend="IntroductDiffing" /> first.</para> + <xi:include href="Text_encoding.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/> + <section id="Compare_files_starting"> <title>Starting a file compare operation</title> Modified: trunk/Docs/Users/Manual/Configuration.xml =================================================================== --- trunk/Docs/Users/Manual/Configuration.xml 2008-09-08 16:23:58 UTC (rev 5929) +++ trunk/Docs/Users/Manual/Configuration.xml 2008-09-08 21:01:31 UTC (rev 5930) @@ -712,7 +712,7 @@ <section> <title>Filter Comments<indexterm> - <primary>filtering</primary> + <primary>filters</primary> <secondary>comments</secondary> </indexterm></title> @@ -1265,7 +1265,9 @@ <section> <title>Filter Folder<indexterm> - <primary> Filter folders, specifying default private folder</primary> + <primary>Filters folders</primary> + + <secondary>specifying default private folder</secondary> </indexterm></title> <para>Use this field to specify your own private folder for file filters. @@ -1422,10 +1424,41 @@ <secondary>options</secondary> </indexterm></title> - <para>This page allow you to specify the codepage that WinMerge uses for - ANSI files, and whether the codepage of certain file formats should be - detected from the contents of the files.</para> + <para>This page allows you to specify the codepage that the ANSI version of + WinMerge uses for ANSI files. , and whether the codepage of certain file + formats should be detected from the contents of the files.</para> + <important> + <para>The ANSI version of WinMerge (<filename>WinMerge.exe</filename>) is + normally installed only on Windows 9X and WME. On all other, newer Windows + systems, the Unicode version (<filename>WinMergeU.exe</filename>) is + installed. The Unicode version of WinMerge handles encoding transparently. + You should not need to change any settings in this page unless you are + running the ANSI version.</para> + </important> + + <note> + <para>A full explanation of text encoding and Windows codepages is beyond + the scope of WinMerge documentation. Fortunately, there is lots of + information about them on the Internet. For example, here are some places + to start:</para> + + <itemizedlist> + <listitem> + <para><ulink url="http://en.wikipedia.org/wiki/Code_pages">Wikipedia: + Code pages</ulink>, <ulink + url="http://en.wikipedia.org/wiki/Character_encoding">Character + encoding</ulink></para> + </listitem> + + <listitem> + <para><ulink + url="http://www.microsoft.com/globaldev/reference/wincp.mspx">Microsoft: + Code Pages Supported by Windows</ulink></para> + </listitem> + </itemizedlist> + </note> + <section> <title>Default codepage for ANSI files</title> Modified: trunk/Docs/Users/Manual/Install.xml =================================================================== --- trunk/Docs/Users/Manual/Install.xml 2008-09-08 16:23:58 UTC (rev 5929) +++ trunk/Docs/Users/Manual/Install.xml 2008-09-08 21:01:31 UTC (rev 5930) @@ -71,14 +71,16 @@ shows all the available components. You can modify the default configuration by checking or unchecking components. For example, if you want to use a WinMerge localization for a different language than - English, select the <guilabel>Languages</guilabel> component. </simpara> + English, select the <guilabel>Languages</guilabel> component.</simpara> <variablelist> <varlistentry> <term>WinMerge core files</term> <listitem> - <para>WinMerge executable, Help, and other needed files. Cannot be + <para>WinMerge executable (<filename>WinMerge.exe</filename> on + Windows 9X and WME; <filename>WinMergeU.exe</filename> on all + other Windows versions), Help, and other needed files. Cannot be unchecked.</para> </listitem> </varlistentry> Modified: trunk/Docs/Users/Manual/Text_encoding.xml =================================================================== --- trunk/Docs/Users/Manual/Text_encoding.xml 2008-09-08 16:23:58 UTC (rev 5929) +++ trunk/Docs/Users/Manual/Text_encoding.xml 2008-09-08 21:01:31 UTC (rev 5930) @@ -1,80 +1,19 @@ -<article id="TextEncoding"> - <title>Text Encoding (codepages)</title> - <section> - <title>Common scenarios</title> - <orderedlist> - <listitem> - <para>Comparing English files coded in ASCII</para> - <para>You may easily use <filename>WinMerge.exe</filename>. You may also use <filename>WinMergeU.exe</filename> (if you are on NT/2000/XP/2003), but it will be slower due to encoding conversion.</para> - </listitem> - <listitem> - <para>Comparing western European files coded in the common windows codepage</para> - <para>(See FAQ: How do I tell what encoding my file uses) You may easily use <filename>WinMerge.exe</filename>. You may also use <filename>WinMergeU.exe</filename> (if you are on NT/2000/XP/2003), but it will be slower due to encoding conversion.</para> - </listitem> - <listitem> - <para>Comparing Unicode files</para> - <para>You should use <filename>WinMergeU.exe</filename> -(if you are on NT/2000/XP/2003) as it will be at least as fast, -and may be faster than <filename>WinMerge.exe</filename>, in this -scenario. Also, <filename>WinMergeU.exe</filename> correctly -handles UTF-8 files, unlike <filename>WinMerge.exe</filename>. -If you are on Win95/98/ME, or if your files are all in English -or a western European language, you may get by with -<filename>WinMerge.exe</filename>.</para> - </listitem> - <listitem> - <para>Comparing multilingual files</para> - <para>You should use <filename>WinMergeU.exe</filename> (if you are on NT/2000/XP/2003) in order to be able to see the characters from different languages simultaneously. If you are on Win95/98/ME, then you may attempt to view the files in <filename>WinMerge.exe</filename>, but it is recommended that you do not attempt to merge them.</para> - </listitem> - <listitem> - <para>Comparing East Asian files</para> - <para>You should use <filename>WinMergeU.exe</filename> (if you are on NT/2000/XP/2003) in order to correctly display double-wide characters. See the Font section for font recommendations. If you are on Win95/98/ME, then you may attempt to view the files in <filename>WinMerge.exe</filename>, but it is recommended that you do not attempt to merge them.</para> - </listitem> - </orderedlist> - </section> - <section> - <title>Explanation</title> - <para>Characters (such as "a" or "1" or "&") are represented by computers as numbers, and there is more than one way to do this. A text encoding method is a way to encode the characters into the numbers (bytes) of which a file is comprised. There are four main text encoding families:</para> - <itemizedlist> - <listitem> - <para>ASCII</para> - <para>Each character is one byte in the file. This is an old encoding which only supports English letters, numbers, and puncuation.</para> - </listitem> - <listitem> - <para>Windows codepages</para> - <para>Each character is one byte in the file. These are used by default by versions of the Windows operating system. Examples include:</para> - <itemizedlist> - <listitem> - <para>1252 (windows-1252) Western European (supports many western European languages including English, French, Spanish, and German)</para> - </listitem> - <listitem> - <para>1251 (windows-1251) Cyrillic (supports Cyrillic languages including Russian and Bulgarian)</para> - </listitem> - <listitem> - <para>1250 (windows-1250) Central European (supports central European Latin-scrypt languages including Polish)</para> - </listitem> - <listitem> - <para>1253 (windows-1253) Greek (supports Greek)</para> - </listitem> - </itemizedlist> - </listitem> - <listitem> - <para>ISO codepages</para> - <para>Each character is one byte in the file. These have names such as "ISO-8859-1". Some windows codepages approximate some of these. Examples include:</para> - <itemizedlist> - <listitem> - <para>ISO-8851-1 ("Latin-1") This is approximated by windows-1252</para> - </listitem> - </itemizedlist> - </listitem> - <listitem> - <para>UCS-2LE (Microsoft's style of Unicode)</para> - <para>Each character is two bytes in the file. This supports Unicode 2.0, which is most of the characters in the Unicode character set.</para> - </listitem> - <listitem> - <para>UTF-8</para> - <para>Each character may be one, two, three, four, five, or six bytes in the file. This supports the full range of Unicode 3.x.</para> - </listitem> - </itemizedlist> - </section> -</article> +<?xml version="1.0" encoding="UTF-8"?> +<!DOCTYPE note PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" +"build/dtd/docbookx.dtd"> +<note> + <title>Important note for ANSI WinMerge users</title> + + <para>In the ANSI version of WinMerge (WinMerge.exe) that is typically + installed on older versions of windows, comparisons are set by default to use + the default Windows ANSI codepages on your system - for example, Windows-1252 + on many Western European systems). If the files you are comparing all use this + format, the default settings are fine.</para> + + <para>However, if you plan to compare files with different encodings (for + example, UTF or another Windows codepage), you might need to change the + default codepage settings, as described in <xref + linkend="Configuration_codepage" />. If you are running the Unicode version of + WinMerge (WinMergeU.exe), comparisons handle different encodings + transparently, and so codepage settings do not affect you.</para> +</note> \ No newline at end of file Modified: trunk/Docs/Users/Manual/WinMerge_help.xml =================================================================== --- trunk/Docs/Users/Manual/WinMerge_help.xml 2008-09-08 16:23:58 UTC (rev 5929) +++ trunk/Docs/Users/Manual/WinMerge_help.xml 2008-09-08 21:01:31 UTC (rev 5930) @@ -10,7 +10,6 @@ <!ENTITY CompareDirs SYSTEM "Compare_dirs.xml"> <!ENTITY CompareFiles SYSTEM "Compare_files.xml"> <!ENTITY Configuration SYSTEM "Configuration.xml"> -<!ENTITY TextEncoding SYSTEM "Text_encoding.xml"> <!ENTITY Locales SYSTEM "Locales.xml"> <!ENTITY Plugins SYSTEM "Plugins.xml"> <!ENTITY Filters SYSTEM "Filters.xml"> @@ -103,8 +102,6 @@ &Configuration; - &TextEncoding; - &Locales; &Plugins; This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site. |
From: <ge...@us...> - 2008-11-20 15:57:36
|
Revision: 6107 http://winmerge.svn.sourceforge.net/winmerge/?rev=6107&view=rev Author: gerundt Date: 2008-11-20 15:57:31 +0000 (Thu, 20 Nov 2008) Log Message: ----------- PATCH: [ 2316040 ] Manual: Add general compare status icons Modified Paths: -------------- trunk/Docs/Users/Manual/Compare_dirs.xml trunk/Docs/Users/Manual/screenshots/equal.png trunk/Docs/Users/Manual/screenshots/fileskip.png trunk/Docs/Users/Manual/screenshots/folderskip.png trunk/Docs/Users/Manual/screenshots/notequal.png Added Paths: ----------- trunk/Docs/Users/Manual/screenshots/equaltextfile.png trunk/Docs/Users/Manual/screenshots/notequaltextfile.png Modified: trunk/Docs/Users/Manual/Compare_dirs.xml =================================================================== --- trunk/Docs/Users/Manual/Compare_dirs.xml 2008-11-20 14:25:18 UTC (rev 6106) +++ trunk/Docs/Users/Manual/Compare_dirs.xml 2008-11-20 15:57:31 UTC (rev 6107) @@ -230,12 +230,24 @@ <imageobject> <imagedata fileref="screenshots/equal.png" format="PNG" /> </imageobject> - </inlinemediaobject> Identical text files</member> + </inlinemediaobject> Identical files</member> <member><inlinemediaobject> <imageobject> <imagedata fileref="screenshots/notequal.png" format="PNG" /> </imageobject> + </inlinemediaobject> Differing files</member> + + <member><inlinemediaobject> + <imageobject> + <imagedata fileref="screenshots/equaltextfile.png" format="PNG" /> + </imageobject> + </inlinemediaobject> Identical text files</member> + + <member><inlinemediaobject> + <imageobject> + <imagedata fileref="screenshots/notequaltextfile.png" format="PNG" /> + </imageobject> </inlinemediaobject> Differing text files</member> <member><inlinemediaobject> Modified: trunk/Docs/Users/Manual/screenshots/equal.png =================================================================== (Binary files differ) Added: trunk/Docs/Users/Manual/screenshots/equaltextfile.png =================================================================== (Binary files differ) Property changes on: trunk/Docs/Users/Manual/screenshots/equaltextfile.png ___________________________________________________________________ Added: svn:mime-type + application/octet-stream Modified: trunk/Docs/Users/Manual/screenshots/fileskip.png =================================================================== (Binary files differ) Modified: trunk/Docs/Users/Manual/screenshots/folderskip.png =================================================================== (Binary files differ) Modified: trunk/Docs/Users/Manual/screenshots/notequal.png =================================================================== (Binary files differ) Added: trunk/Docs/Users/Manual/screenshots/notequaltextfile.png =================================================================== (Binary files differ) Property changes on: trunk/Docs/Users/Manual/screenshots/notequaltextfile.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. |
From: <ge...@us...> - 2008-12-22 23:31:16
|
Revision: 6229 http://winmerge.svn.sourceforge.net/winmerge/?rev=6229&view=rev Author: gerundt Date: 2008-12-22 23:31:10 +0000 (Mon, 22 Dec 2008) Log Message: ----------- PATCH: [ 2459688 ] Manual: Link to new forum Modified Paths: -------------- trunk/Docs/Users/Manual/Introduction.xml trunk/Docs/Users/Manual/Locales.xml Modified: trunk/Docs/Users/Manual/Introduction.xml =================================================================== --- trunk/Docs/Users/Manual/Introduction.xml 2008-12-22 23:25:39 UTC (rev 6228) +++ trunk/Docs/Users/Manual/Introduction.xml 2008-12-22 23:31:10 UTC (rev 6229) @@ -153,7 +153,7 @@ </indexterm>Getting support and reporting bugs</title> <para>The <ulink - url="http://sourceforge.net/forum/forum.php?forum_id=41637">Open Discussion + url="http://apps.sourceforge.net/phpbb/winmerge/viewforum.php?f=4">Open Discussion forum</ulink> is the fastest way to get help. Please be patient, it may take some time for somebody to answer.</para> @@ -229,7 +229,7 @@ url="http://winmerge.org/support/mailing-lists.php">development-mailing</ulink> list is the preferred place for development discussions. Another place is in the <ulink - url="http://sourceforge.net/forum/forum.php?forum_id=41639">developers-forum</ulink>. + url="http://apps.sourceforge.net/phpbb/winmerge/viewforum.php?f=6">developers-forum</ulink>. If you are interested in helping with WinMerge development, let us know. If you want to fix one of our <ulink url="http://sourceforge.net/tracker/?group_id=13216&atid=113216" Modified: trunk/Docs/Users/Manual/Locales.xml =================================================================== --- trunk/Docs/Users/Manual/Locales.xml 2008-12-22 23:25:39 UTC (rev 6228) +++ trunk/Docs/Users/Manual/Locales.xml 2008-12-22 23:31:10 UTC (rev 6229) @@ -253,7 +253,6 @@ translation) does not require you to have all the compile tools or to know about WinMerge internals, just to follow the instructions in the preceding link. And if you have problems, ask for help from us in one of the <ulink - url="http://sourceforge.net/forum/?group_id=13216">WinMerge - forums</ulink>.</para> + url="http://forums.winmerge.org/">WinMerge forums</ulink>.</para> </section> </article> \ No newline at end of file This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site. |
From: <den...@us...> - 2009-05-06 13:03:10
|
Revision: 6713 http://winmerge.svn.sourceforge.net/winmerge/?rev=6713&view=rev Author: denisbradford Date: 2009-05-06 13:03:03 +0000 (Wed, 06 May 2009) Log Message: ----------- Document tree view. Modified Paths: -------------- trunk/Docs/Users/Manual/Compare_dirs.xml trunk/Docs/Users/Manual/screenshots/foldercomp1.png Added Paths: ----------- trunk/Docs/Users/Manual/screenshots/folderdiff.png trunk/Docs/Users/Manual/screenshots/foldersame.png trunk/Docs/Users/Manual/screenshots/treeview-01.png Modified: trunk/Docs/Users/Manual/Compare_dirs.xml =================================================================== --- trunk/Docs/Users/Manual/Compare_dirs.xml 2009-05-03 09:37:54 UTC (rev 6712) +++ trunk/Docs/Users/Manual/Compare_dirs.xml 2009-05-06 13:03:03 UTC (rev 6713) @@ -60,7 +60,10 @@ <listitem> <para>Recursive mode is useful for detecting and manipulating different files in an entire folder structure. However, it can be - slow if there are many subfolders and files.</para> + slow if there are many subfolders and files. For deeply nested + directory structures, consider enabling the <xref + linkend="Compare_dirs_treeview" /> for easier navigation of the + Compare window.</para> <para>Nonrecursive mode has the advantage of speed when there are many subfolders that need not be examined. Also, the display can be @@ -146,9 +149,9 @@ <title>Folder Compare window<indexterm> <primary>Folder Compare window</primary> - <seealso>Compare windows</seealso> + <seealso>Compare window</seealso> </indexterm><indexterm> - <primary>Compare windows</primary> + <primary>Compare window</primary> <secondary>Folder</secondary> </indexterm><indexterm> @@ -157,19 +160,95 @@ <secondary>in Folder Compare window</secondary> </indexterm></title> - <para>The Folder Compare window shows the result of a folder compare in a - tabular view. Each row lists a file, parent folder, or subfolder in the - result, and the columns show different types of data for each item. You can - customize the table by changing the sorting of rows or the types of column - data displayed. Here is an example of a folder compare result:</para> + <para>The Folder Compare window shows the result of a folder compare. Two + different views are available:</para> - <mediaobject> - <imageobject> - <imagedata contentwidth="600" fileref="screenshots/foldercomp1.png" - format="PNG" /> - </imageobject> - </mediaobject> + <variablelist> + <varlistentry id="Compare_dirs_tabview"> + <term>Tabular view<indexterm> + <primary>tabular view, Compare window</primary> + </indexterm></term> + <listitem> + <para>In tabular view, each file or folder in the result is listed in + a row. This is the default view. Here's an example:</para> + + <mediaobject> + <imageobject> + <imagedata contentwidth="600" + fileref="screenshots/foldercomp1.png" format="PNG" /> + </imageobject> + </mediaobject> + </listitem> + </varlistentry> + + <varlistentry id="Compare_dirs_treeview"> + <term remap="" xreflabel="tree view">Tree view<indexterm> + <primary>tree view, Compare window</primary> + </indexterm></term> + + <listitem> + <para>In the tree view, folders are expandable and collapsible, + containing files and subfolders. The tree view is available only in + recursive compares. For example:</para> + + <mediaobject> + <imageobject> + <imagedata contentwidth="599" + fileref="screenshots/treeview-01.png" format="PNG" /> + </imageobject> + </mediaobject> + + <itemizedlist> + <listitem> + <para>To expand or collapse a single folder, click the plus or + minus control beside the folder icon, or double-click anywhere in + the row.</para> + </listitem> + + <listitem> + <para>To expand or collapse all folders in the view, click + <menuchoice> + <guimenu>View</guimenu> + + <guimenuitem>Expand All Subfolders</guimenuitem> + </menuchoice> or <menuchoice> + <guimenu>View</guimenu> + + <guimenuitem>Collapse All Subfolders</guimenuitem> + </menuchoice> in the menu.</para> + </listitem> + </itemizedlist> + </listitem> + </varlistentry> + </variablelist> + + <para>During a recursive compare (that is, if you enabled the + <option>Include Subfolders</option> option in the Select Files or Folders + dialog when you launched the compare), you can click <menuchoice> + <guimenu>View</guimenu> + + <guimenuitem>Tree Mode</guimenuitem> + </menuchoice> command to switch between the two views. The <menuchoice> + <guimenu>View</guimenu> + + <guimenuitem>Tree Mode</guimenuitem> + </menuchoice> command is disabled for non-recursive compares.</para> + + <para>In both views, the columns show different types of data for each + result item. You can control the sorting of items in the view by clicking a + column heading. This changes the sorting in two ways:</para> + + <itemizedlist> + <listitem> + <para>Toggles (reverses) the sort order of the column.</para> + </listitem> + + <listitem> + <para>Resorts all the rows in the view by the column.</para> + </listitem> + </itemizedlist> + <section> <title>Recursive and nonrecursive compare results<indexterm> <primary>recursive folder compare</primary> @@ -228,89 +307,117 @@ <simplelist> <member><inlinemediaobject> <imageobject> - <imagedata fileref="screenshots/equal.png" format="PNG" /> + <imagedata contentwidth="16" fileref="screenshots/equal.png" + format="PNG" /> </imageobject> </inlinemediaobject> Identical files</member> <member><inlinemediaobject> <imageobject> - <imagedata fileref="screenshots/notequal.png" format="PNG" /> + <imagedata contentwidth="16" fileref="screenshots/notequal.png" + format="PNG" /> </imageobject> - </inlinemediaobject> Differing files</member> + </inlinemediaobject> Different files</member> <member><inlinemediaobject> <imageobject> - <imagedata fileref="screenshots/equaltextfile.png" format="PNG" /> + <imagedata contentwidth="16" + fileref="screenshots/equaltextfile.png" format="PNG" /> </imageobject> </inlinemediaobject> Identical text files</member> <member><inlinemediaobject> <imageobject> - <imagedata fileref="screenshots/notequaltextfile.png" format="PNG" /> + <imagedata contentwidth="16" + fileref="screenshots/notequaltextfile.png" format="PNG" /> </imageobject> - </inlinemediaobject> Differing text files</member> + </inlinemediaobject> Different text files</member> <member><inlinemediaobject> <imageobject> - <imagedata fileref="screenshots/binary.png" format="PNG" /> + <imagedata contentwidth="16" fileref="screenshots/binary.png" + format="PNG" /> </imageobject> </inlinemediaobject> Identical binary files</member> <member><inlinemediaobject> <imageobject> - <imagedata fileref="screenshots/binarydiff.png" format="PNG" /> + <imagedata contentwidth="16" fileref="screenshots/binarydiff.png" + format="PNG" /> </imageobject> - </inlinemediaobject> Differing binary files</member> + </inlinemediaobject> Different binary files</member> <member><inlinemediaobject> <imageobject> - <imagedata fileref="screenshots/lfolder.png" format="PNG" /> + <imagedata contentwidth="16" fileref="screenshots/foldersame.png" + format="PNG" /> </imageobject> + </inlinemediaobject> Identical folders (in tree view only)</member> + + <member><inlinemediaobject> + <imageobject> + <imagedata contentwidth="16" fileref="screenshots/folderdiff.png" + format="PNG" /> + </imageobject> + </inlinemediaobject> Different folders (in tree view only)</member> + + <member><inlinemediaobject> + <imageobject> + <imagedata contentwidth="16" fileref="screenshots/lfolder.png" + format="PNG" /> + </imageobject> </inlinemediaobject> Left-only folders</member> <member><inlinemediaobject> <imageobject> - <imagedata fileref="screenshots/rfolder.png" format="PNG" /> + <imagedata contentwidth="16" fileref="screenshots/rfolder.png" + format="PNG" /> </imageobject> </inlinemediaobject> Right-only folders</member> <member><inlinemediaobject> <imageobject> - <imagedata fileref="screenshots/lfile.png" format="PNG" /> + <imagedata contentwidth="16" fileref="screenshots/lfile.png" + format="PNG" /> </imageobject> </inlinemediaobject> Left-only files</member> <member><inlinemediaobject> <imageobject> - <imagedata fileref="screenshots/rfile.png" format="PNG" /> + <imagedata contentwidth="16" fileref="screenshots/rfile.png" + format="PNG" /> </imageobject> </inlinemediaobject> Right-only files</member> <member><inlinemediaobject> <imageobject> - <imagedata fileref="screenshots/folderskip.png" format="PNG" /> + <imagedata contentwidth="16" fileref="screenshots/folderskip.png" + format="PNG" /> </imageobject> - </inlinemediaobject> Skipped directories (filtered out)</member> + </inlinemediaobject> Skipped (filtered) directories</member> <member><inlinemediaobject> <imageobject> - <imagedata fileref="screenshots/fileskip.png" format="PNG" /> + <imagedata contentwidth="16" fileref="screenshots/fileskip.png" + format="PNG" /> </imageobject> - </inlinemediaobject> Skipped files (filtered out)</member> + </inlinemediaobject> Skipped (filtered) files</member> <member><inlinemediaobject> <imageobject> - <imagedata fileref="screenshots/error.png" format="PNG" /> + <imagedata contentwidth="16" fileref="screenshots/error.png" + format="PNG" /> </imageobject> - </inlinemediaobject> Items that couldn't be compared. This usually - happens when other program has locked the file.</member> + </inlinemediaobject> Items that can't be compared; for example when + another program has locked the file.</member> <member><inlinemediaobject> <imageobject> - <imagedata fileref="screenshots/aborted.png" format="PNG" /> + <imagedata contentwidth="16" fileref="screenshots/aborted.png" + format="PNG" /> </imageobject> </inlinemediaobject> Aborted item. WinMerge did not finish comparing - this item when compare was stopped. Result is unknown.</member> + this item when the compare was stopped. The result is unknown.</member> </simplelist> </section> @@ -345,88 +452,135 @@ contents by copying, moving, or delete one or more files or subfolders.</para> </section> - </section> - <section id="Compare_dirs_multiwin"> - <title>Working with multiple Folder Compare windows<indexterm> - <primary>Folder Compare window</primary> + <section> + <title>Working with multiple Compare windows</title> + <indexterm> + <primary>Compare window</primary> + <secondary>using multiple</secondary> - </indexterm></title> + </indexterm> - <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> + <para>By default, the WinMerge window displays a single File Compare or + Folder Compare window.</para> - <section> - <title>Using tabs with maximized Compare windows</title> + <para>In single compare mode, of you start a file or folder comparison + while a Compare window is currently open, the current File Compare window + is closed if there are no changes in either side. But if WinMerge detects + unsaved changes (for example, if you have merged or edited a + file),.WinMerge prompts you to save or discard your changes before opening + a new File Compare window.</para> - <para>If you open multiple Compare windows, they are displayed by default - as individually resizeable child windows within the WinMerge window, like - this:</para> + <para>For example, in the next screen shot WinMerge gives you a chance to + save changes detected in the right side file:</para> <mediaobject> <imageobject> - <imagedata contentwidth="569" - fileref="screenshots/multifoldercomp1.png" format="PNG" /> + <imagedata contentwidth="400" fileref="screenshots/save_mod1.png" + format="PNG" /> </imageobject> <textobject> - <phrase>Multiple Folder Compare windows: default display</phrase> + <phrase>Save modifed files dialog</phrase> </textobject> </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> + <para>If you want to work with multiple compare operations simultaneously, + consider setting (checking) the <guilabel>Enable multiple compare windows + for Folder compare</guilabel> option, which is disabled by default. With + this option enabled, you can open multiple File Compare windows without + the intervening Save step.</para> + <para>When you open multiple Compare windows, they're displayed by default + as individually resizeable child windows within the WinMerge window. This + example shows a Folder Compare window — the File Compare window has + similar child windows:</para> + <mediaobject> <imageobject> <imagedata contentwidth="569" - fileref="screenshots/multifoldercomp2.png" format="PNG" /> + fileref="screenshots/multifoldercomp1.png" format="PNG" /> </imageobject> <textobject> - <phrase>Multiple Folder Compare windows: maximized</phrase> + <phrase>Multiple Folder Compare windows: default display</phrase> </textobject> </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> + <para>You can control the layering of multiple windows in either of two + ways:</para> + + <itemizedlist> + <listitem> + <para>Control the windows directly, for example by clicking a title + bar to bring its window to the top, or minimizing a window.</para> + </listitem> + + <listitem> + <para>Click the <guimenu>Window</guimenu> menu, which lists the + windows that are currently open, and choose the window that you want + to bring to the top.</para> + </listitem> + </itemizedlist> + + <section> + <title>Using tabs with maximized Compare windows<indexterm> + <primary>Compare window</primary> + + <secondary>using tabs when maximizing</secondary> + </indexterm></title> + + <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="15" fileref="screenshots/restore_btn.png" /> + <imagedata contentwidth="569" + fileref="screenshots/multifoldercomp2.png" format="PNG" /> </imageobject> <textobject> - <phrase>Restore button</phrase> + <phrase>Multiple Folder Compare windows: maximized</phrase> </textobject> - </inlinemediaobject> Restore button. A better solution is to enable tabs - by setting (checking) <menuchoice> - <guimenu>View</guimenu> + </mediaobject> - <guimenuitem>Tab Bar</guimenuitem> - </menuchoice>.</para> + <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> - <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> + <textobject> + <phrase>Restore button</phrase> + </textobject> + </inlinemediaobject> Restore button. A better solution is to enable + tabs by setting (checking) <menuchoice> + <guimenu>View</guimenu> - <mediaobject> - <imageobject> - <imagedata contentwidth="569" - fileref="screenshots/multifoldercomp3.png" format="PNG" /> - </imageobject> + <guimenuitem>Tab Bar</guimenuitem> + </menuchoice>.</para> - <textobject> - <phrase>Multiple Folder Compare windows: tabbed</phrase> - </textobject> - </mediaobject> + <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> + + <textobject> + <phrase>Multiple Folder Compare windows: tabbed</phrase> + </textobject> + </mediaobject> + </section> </section> </section> Modified: trunk/Docs/Users/Manual/screenshots/foldercomp1.png =================================================================== (Binary files differ) Added: trunk/Docs/Users/Manual/screenshots/folderdiff.png =================================================================== (Binary files differ) Property changes on: trunk/Docs/Users/Manual/screenshots/folderdiff.png ___________________________________________________________________ Added: svn:mime-type + application/octet-stream Added: trunk/Docs/Users/Manual/screenshots/foldersame.png =================================================================== (Binary files differ) Property changes on: trunk/Docs/Users/Manual/screenshots/foldersame.png ___________________________________________________________________ Added: svn:mime-type + application/octet-stream Added: trunk/Docs/Users/Manual/screenshots/treeview-01.png =================================================================== (Binary files differ) Property changes on: trunk/Docs/Users/Manual/screenshots/treeview-01.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. |
From: <den...@us...> - 2009-05-07 14:01:32
|
Revision: 6715 http://winmerge.svn.sourceforge.net/winmerge/?rev=6715&view=rev Author: denisbradford Date: 2009-05-07 13:39:18 +0000 (Thu, 07 May 2009) Log Message: ----------- Bug 2714147: improved description of line differences. Modified Paths: -------------- trunk/Docs/Users/Manual/Compare_files.xml trunk/Docs/Users/Manual/Configuration.xml trunk/Docs/Users/Manual/Intro_diffs.xml Added Paths: ----------- trunk/Docs/Users/Manual/screenshots/char-diff-01.png trunk/Docs/Users/Manual/screenshots/diff-blocks-01.png trunk/Docs/Users/Manual/screenshots/ignore-blank-lines.png trunk/Docs/Users/Manual/screenshots/line-diff-punctuation.png trunk/Docs/Users/Manual/screenshots/moved-01.png trunk/Docs/Users/Manual/screenshots/word-diff-allwhite.png trunk/Docs/Users/Manual/screenshots/word-diff-nochange.png trunk/Docs/Users/Manual/screenshots/word-diff-nowhite.png Modified: trunk/Docs/Users/Manual/Compare_files.xml =================================================================== --- trunk/Docs/Users/Manual/Compare_files.xml 2009-05-06 13:43:29 UTC (rev 6714) +++ trunk/Docs/Users/Manual/Compare_files.xml 2009-05-07 13:39:18 UTC (rev 6715) @@ -51,9 +51,9 @@ <title>File Compare window<indexterm> <primary>File Compare window</primary> - <seealso>Compare windows</seealso> + <seealso>Compare window</seealso> </indexterm><indexterm> - <primary>Compare windows</primary> + <primary>Compare window</primary> <secondary>File</secondary> </indexterm></title> @@ -129,36 +129,343 @@ </variablelist> </section> - <section> - <title>Difference colors in File panes<indexterm> + <section id="CompareFiles_diffcolors"> + <title>Difference highlighting<indexterm> <primary>difference colors</primary> <secondary>in File panes</secondary> </indexterm></title> - <para>Unless your files are identical, the content of the File panes - includes some differences. Difference blocks are marked with background - colors, which you can configure in WinMerge options. The basic - difference color is dark yellow, by default. When selected, the - difference color is red. Identical lines (like the second line in the - preceding screen shot) have white backgrounds.</para> + <para>WinMerge highlights several types of differences in the File + panes. The Colors page in the Options dialog defines a set of background + and text colors for each difference type, depending on whether it is + unselected, selected, or deleted. This section describes each of the + basic difference types and the configuration options that affect their + detection.</para> - <para>WinMerge inserts one or more gray blank lines in one version of a - difference when the other version has more lines. These empty lines - (which change from gray to light red when the difference is selected) do - not represent blank lines in the source file; they are only placeholders - in the display. The purpose of placeholder lines is to keep the left and - right versions of differences vertically aligned.</para> + <variablelist> + <varlistentry> + <term>Difference</term> - <para>By default, different words within difference lines are also - marked with a background color. You can disable this coloring, or (for - even more granular highlighting) add character-level difference - coloring. Both are controlled by the Line Difference Coloring settings - in the Editing page of WinMerge options. To change the various - difference colors used, edit the values in the Colors page of WinMerge - options.</para> + <listitem> + <para>A difference block contains one or more contiguous lines + that are different. The default difference background color is + gold, but blank lines are marked with the deleted color.</para> + + <para>For this and other screens in this section, we enabled + <option>View line numbers</option> to show which lines in the + source files are compared.</para> + + <mediaobject> + <imageobject> + <imagedata contentwidth="489" + fileref="screenshots/diff-blocks-01.png" + format="PNG" /> + </imageobject> + + <textobject> + <phrase>Difference block background colors</phrase> + </textobject> + </mediaobject> + + <para>This comparison detects three difference blocks:</para> + + <orderedlist> + <listitem> + <para>The first difference is a single line.</para> + </listitem> + + <listitem> + <para>The blank line in <filename>file2</filename> has no + corresponding blank line in <filename>file1</filename>. + WinMerge treats the missing blank line as a deleted + difference, marked here with the default gray color.</para> + </listitem> + + <listitem> + <para>The last difference block includes two lines.</para> + </listitem> + </orderedlist> + </listitem> + </varlistentry> + + <varlistentry> + <term>Ignored Difference</term> + + <listitem> + <para>This color marks content that you have configured WinMerge + to ignore. In contrast to difference blocks, ignored content is + not compared, it is simply highlighted to help you see what has + been ignored. Ignored differences include:</para> + + <itemizedlist> + <listitem> + <para>Blank lines, if you have enabled <option>Ignore blank + lines</option> in the Options dialog Compare page.</para> + </listitem> + + <listitem> + <para>Differences that match patterns in line filters that you + have defined (see <xref linkend="Filters" /> to learn + how).</para> + </listitem> + </itemizedlist> + + <para>The next example repeats the previous comparison, this time + with <option>Ignore blank lines</option> enabled. There are now + only two differences. The blank line on the right side is marked + with the Ignored Differences color. </para> + + <mediaobject> + <imageobject> + <imagedata contentwidth="492" + fileref="screenshots/ignore-blank-lines.png" + format="PNG" /> + </imageobject> + + <textobject> + <phrase>Difference block colors with ignored diff</phrase> + </textobject> + </mediaobject> + </listitem> + </varlistentry> + + <varlistentry> + <term>Moved</term> + + <listitem> + <para>Moved differences are identical lines found in different + locations in the compared files, if <option>Moved block + detection</option> is enabled in the Options dialog Compare page. + The next screen shot repeats the previous comparison, this time + with moved block detection enabled.</para> + + <mediaobject> + <imageobject> + <imagedata contentwidth="490" + fileref="screenshots/moved-01.png" format="PNG" /> + </imageobject> + + <textobject> + <phrase>Difference block colors with moved block + detection</phrase> + </textobject> + </mediaobject> + + <para>Notice that the two identical lines (containing + <literal>a</literal> and <literal>c</literal>) that are in + different locations are marked with the default orange moved + color. Another effect of moved block detection in this case is + that the last two lines are now two separate differences instead + of a single difference block.</para> + + <para>In some cases, showing moved differences can make it easier + to visualize changes in files. However, too many moved lines might + make your comparison hard to navigate. Use your own + judgement!</para> + </listitem> + </varlistentry> + + <varlistentry> + <term>Word Difference</term> + + <listitem> + <para>WinMerge can mark the text that is changed with difference + blocks. Line differences are marked with the word difference + color. See <xref linkend="CompareFiles_linediff-highlight" /> for + details.</para> + </listitem> + </varlistentry> + </variablelist> </section> + <section id="CompareFiles_linediff-highlight"> + <title>Line difference highlighting<indexterm> + <primary>line differences</primary> + + <secondary>detection</secondary> + </indexterm><indexterm> + <primary>whitespace</primary> + + <secondary>in line differences</secondary> + </indexterm></title> + + <para>Sometimes it's useful to highlight not just difference blocks, but + also the text within them that is changed. You can disable or enable + them in two ways:</para> + + <itemizedlist> + <listitem> + <para>Set all <option>View line differences</option> options in the + Options dialog Editor page.</para> + </listitem> + + <listitem> + <para>Click <menuchoice> + <guimenu>View</guimenu> + + <guimenuitem>View line differences</guimenuitem> + </menuchoice> to toggle line differences on or off.</para> + </listitem> + </itemizedlist> + + <note> + <para>Remember that WinMerge navigation and merging functions (like + Next Difference or Copy Left) work on difference blocks, not on line + differences within them.</para> + </note> + + <para>This section describes how line differences are detected and + marked. Note that the effect of these options is also affected by your + current whitespace settings in the Options dialog Compare page.</para> + + <variablelist> + <varlistentry> + <term id="wordlevel-linediffs">Word-level line differences</term> + + <listitem> + <indexterm> + <primary>word-level line difference</primary> + </indexterm> + + <para>The following examples show how word-level line differences + are displayed with each of the whitespace settings:</para> + + <example> + <title>Line differences with Whitespace: Compare</title> + + <para>WinMerge detects all different words and spaces:</para> + + <mediaobject> + <imageobject> + <imagedata contentwidth="530" + fileref="screenshots/word-diff-allwhite.png" + format="PNG" /> + </imageobject> + + <textobject> + <phrase>Word-level line diff comparing whitespace</phrase> + </textobject> + </mediaobject> + </example> + + <example> + <title>Line differences with Whitespace: Ignore change</title> + + <para>Multiple spaces and tabs are treated the same as a single + space. In the example, the extra space between the last two + words is not marked:</para> + + <mediaobject> + <imageobject> + <imagedata contentwidth="530" + fileref="screenshots/word-diff-nochange.png" + format="PNG" /> + </imageobject> + + <textobject> + <phrase>Word-level line diff comparing no whitespace + changes</phrase> + </textobject> + </mediaobject> + </example> + + <example> + <title>Line differences with Whitespace: Ignoring all</title> + + <para>No spaces between words are compared, so these lines are + treated as identical:</para> + + <mediaobject> + <imageobject> + <imagedata contentwidth="530" + fileref="screenshots/word-diff-nowhite.png" + format="PNG" /> + </imageobject> + + <textobject> + <phrase>Word-level line diff comparing no + whitespace</phrase> + </textobject> + </mediaobject> + </example> + </listitem> + </varlistentry> + + <varlistentry> + <term>Character-level line differences</term> + + <listitem> + <indexterm> + <primary>character-level line difference</primary> + </indexterm> + + <para>A character-level line difference includes the first and + last different characters in a word, and all the characters + between them. A single character-level difference can span + adjacent words. The following example illustrates:</para> + + <mediaobject> + <imageobject> + <imagedata contentwidth="485" + fileref="screenshots/char-diff-01.png" format="PNG" /> + </imageobject> + + <textobject> + <phrase>Character-level line diff comparing no + whitespace</phrase> + </textobject> + </mediaobject> + + <note> + <para>As with word-level line differences, character + highlighting varies according to how WinMerge is configured to + detect word breaks. In the example, the extra space after the + word <literal>cure</literal> in <filename>file2</filename> is + highlighted only if whitespace is compared.</para> + </note> + </listitem> + </varlistentry> + </variablelist> + + <variablelist> + <varlistentry> + <term>Breaks for words or character</term> + + <listitem> + <indexterm> + <primary>word breaks in line differences</primary> + </indexterm> + + <para>Words and characters in line differences can be separated by + whitespace, or by a combination of whitespace and punctuation. + Whitespace (the default) is the typical choice for comparing most + text files. All the preceding line difference examples use + whitespace to break words and characters.</para> + + <para>In some cases it's useful to break at punctuation. For + example, the next screen shot compares a comma-separated list. To + highlight meaningful line differences, we have enabled + <option>Break at whitespace or punctuation</option> in the Options + dialog Editor page.</para> + + <mediaobject> + <imageobject> + <imagedata contentwidth="494" + fileref="screenshots/line-diff-punctuation.png" + format="PNG" /> + </imageobject> + + <textobject> + <phrase>Character-level line diff comparing no + whitespace</phrase> + </textobject> + </mediaobject> + </listitem> + </varlistentry> + </variablelist> + </section> + <section id="CompareFiles_editing"> <title>File pane editing features<indexterm> <primary>editing</primary> @@ -414,7 +721,7 @@ <para><menuchoice> <guimenu>File</guimenu> - <guimenu>Merge Mode</guimenu> + <guimenuitem>Merge Mode</guimenuitem> </menuchoice> restores these WinMerge 1.7.1 single keyboard shortcuts for difference merging and navigating functions:</para> @@ -551,13 +858,13 @@ </indexterm></term> <listitem> - <para>The Location pane can indicate difference blocks that are - moved. Moved blocks are two sides of a difference that are in - different locations. Moved blocks are indicated by the - <guilabel>Moved</guilabel> and <guilabel>Selected Moved</guilabel> - difference colors (configurable in WinMerge Options) and by lines - connecting their locations in the left and right location bars. For - example:</para> + <para>Moved differences are identical lines in different locations, + shown only if the Enable moved block detection is checked in the + Options dialog Compare page. See <xref + linkend="CompareFiles_diffcolors" /> for more details about moved + differences in the File pane. The Location pane draws a line + connecting moved differences in the left and right location bars. + For example:</para> <mediaobject> <imageobject> @@ -570,10 +877,6 @@ <phrase>Location pane with moved diff</phrase> </textobject> </mediaobject> - - <para>Showing moved blocks can make it easier to visualize changes - in files. However, if there are too many moved lines it can appear - cluttered. Use your own judgement!</para> </listitem> </varlistentry> </variablelist> @@ -751,7 +1054,7 @@ <title>Working with multiple File Compare windows<indexterm> <primary>File Compare window</primary> - <secondary>multiple</secondary> + <secondary>using multiple</secondary> </indexterm></title> <para>By default, the WinMerge window displays a single File Compare @@ -1571,4 +1874,4 @@ conflict file is also accepted in command line.</para> </section> </section> -</article> +</article> \ No newline at end of file Modified: trunk/Docs/Users/Manual/Configuration.xml =================================================================== --- trunk/Docs/Users/Manual/Configuration.xml 2009-05-06 13:43:29 UTC (rev 6714) +++ trunk/Docs/Users/Manual/Configuration.xml 2009-05-07 13:39:18 UTC (rev 6715) @@ -313,7 +313,7 @@ <section id="Configuration_multicompwin"> <title>Enable multiple compare windows for<indexterm> - <primary>Compare windows</primary> + <primary>Compare window</primary> <secondary>opening multiple</secondary> </indexterm></title> @@ -418,35 +418,44 @@ <secondary>detecting and ignoring differences</secondary> </indexterm></title> - <para>Whitespace, the space between words and lines, is represented in - text files by special, nonprinting characters like spaces, tabs, and - linefeeds. The significance of whitespace varies a lot: spaces between - words are usually important; in some text documents, indents and linefeeds - are critical to meaning and readability; in structured code, linefeeds and - tabs might be significant.</para> + <para>Whitespace is the space between words and lines. It is represented + in text files by special, nonprinting characters like spaces, tabs, and + linefeeds. The significance of whitespace depends on how you want to read + or process differences. It might be important to detect all changes in + whitespace. Conversely, you might prefer to treat all whitespace the same + whether one space, two spaces, an indent, or a tab. And in some structured + documents (like comma-separated lists), you might want to disregard all + whitespace.</para> - <para>These whitespace options are available:</para> + <note> + <para>The effects of whitespace on changes within lines are visible only + when <option>View line differences</option> is enabled. This is in + contrast to difference blocks, which are always highlighted.</para> + </note> - <variablelist> - <varlistentry> - <term>Compare</term> + <example> + <title>Lines with different whitespace</title> - <listitem> - <para>Default: All whitespace is compared. If you are not sure which - option your document requires, this is the safest choice. In the - example below, all lines are detected as different.</para> + <para>One space between words:<screen format="linespecific">Two Words</screen></para> - <example> - <title>Ignore whitespace change</title> + <para>Two spaces between words:<screen format="linespecific">Two Words</screen></para> - <para>One space between words:<screen format="linespecific">Two Words</screen></para> + <para>Tab between words:<screen format="linespecific">Two Words</screen></para> - <para>Two spaces between words:<screen format="linespecific">Two Words</screen></para> + <para>No spaces between words:<screen format="linespecific">TwoWords</screen></para> + </example> - <para>Tab between words:<screen format="linespecific">Two Words</screen></para> + <para>You can control whitespace detection by choosing one of these + options:</para> - <para>No spaces between words:<screen format="linespecific">TwoWords</screen></para> - </example> + <variablelist> + <varlistentry> + <term>Compare</term> + + <listitem> + <para>All whitespace is compared (default). If you are not sure + which option your document requires, this is probably the safest + choice. In the example, all lines are detected as different.</para> </listitem> </varlistentry> @@ -454,8 +463,8 @@ <term>Ignore change</term> <listitem> - <para>Compares differences in whitespace. In the preceding example, - the first three lines have different whitespace, but are detected as + <para>Compares differences in whitespace. In the example, the first + three lines have different whitespace, but are detected as identical: tabs and multiple are treated as if they are single space. The last line has no whitespace, so the difference is <emphasis>not</emphasis> ignored (in effect, the words in the last @@ -468,11 +477,22 @@ <listitem> <para>Ignores all whitespace characters, except linefeeds (so lines - are detected, and preserved in a merge). All lines in the preceding - example are detected as identical.</para> + are detected and preserved in a merge). All lines in the example are + detected as identical.</para> </listitem> </varlistentry> </variablelist> + + <note> + <title>Related topics</title> + + <para>The effects of whitespace settings on line differences is + described in <xref linkend="CompareFiles_linediff-highlight" />.</para> + + <para>The Options dialog Editor page contains related options that + control how whitespace is used to detect breaks between words. See <xref + linkend="Configuration_viewlinediffs" /> for details.</para> + </note> </section> <section> @@ -821,7 +841,7 @@ them as differences. Thus, the File Compare window status bar shows the EOL style as <guilabel>Win</guilabel>.</para> - <para>For most situations, you should leave this option disabled: this + <para>For most situations you should leave this option disabled: the default behavior works even when comparing two files that have different line ending styles.</para> </listitem> @@ -888,80 +908,53 @@ </variablelist> </section> - <section> + <section id="Configuration_viewlinediffs"> <title>View line differences<indexterm> <primary>line differences</primary> <secondary>viewing options</secondary> </indexterm></title> - <para>WinMerge can highlight not only different lines, but also - differences within lines. You can enable and disable line difference - coloring using either the <guilabel>View Line Differences</guilabel> - option in this page, or by clicking <menuchoice> - <guimenu>View</guimenu> + <para>These settings enable and configure the detection of <glossterm>line + differences</glossterm> (changes within the lines of difference + blocks):</para> - <guimenuitem>View Line Differences</guimenuitem> - </menuchoice>. For example, when the menu item is checked, the option in - this page is also checked, and changing either setting automatically - changes the other.</para> - - <para>However, <guilabel>View Line Differences</guilabel> and the options - under it give you control over exactly what kinds of differences are - detected within lines:</para> - <itemizedlist> <listitem> <para><option>Enabled</option> (default): WinMerge highlights - differences within lines (also enables the <menuchoice> + differences within lines. Also enables the <menuchoice> <guimenu>View</guimenu> <guimenuitem>View Line Differences</guimenuitem> - </menuchoice> menu item).</para> + </menuchoice> menu item.</para> - <para>When this option is enabled, you can choose one of these - suboptions. The best choice usually depends on the file types you are - comparing:</para> + <para>Choose one of these suboptions:</para> <itemizedlist> <listitem> - <para><guilabel>Character level</guilabel>: Detects individual - characters that are different. This option can be useful for file - formats that do not have clear word breaks, or if you are looking - for single-character differences. For example, this level makes it - easy to spot a single changed character in the middle of a - word.</para> + <para><guilabel>Character level</guilabel>: Highlights individual + characters that are different. This option can be useful if you + are looking for changes within words, or for file formats that do + not have clear word breaks.</para> </listitem> <listitem> - <para><guilabel>Word-level</guilabel> (default): Detects words - that are different. Possible advantage: making it easy to copy and - paste words.</para> + <para><guilabel>Word-level</guilabel> (default): Highlights entire + words that are different.</para> <itemizedlist> <listitem> <para><guilabel>Break at whitespace</guilabel> (default): Words are assumed to be separated by whitespace characters. This usually works for typical text files.</para> - - <para>For example, these two lines contain punctuation but no - whitespace. So, with the <guilabel>Break at - whitespace</guilabel> option, WinMerge detects no word breaks. - Instead, it highlights the text as a single word-level line - difference.</para> - - <para><screen>10,20,30,40,50</screen></para> - - <para><screen>10,25,30,45,50</screen></para> </listitem> <listitem> <para><guilabel>Break at whitespace or punctuation</guilabel>: Considers both whitespace and punctuation characters to be - word breaks. This is useful for handling lists that are - separated with punctuation (like comma-separated lists). In - the preceding example, WinMerge highlights only 20 and 40 in - the first line, and 25 and 45 in the second line.</para> + word breaks. This can useful for handling lists that are + separated with punctuation (like comma-separated + lists).</para> </listitem> </itemizedlist> </listitem> @@ -969,15 +962,22 @@ </listitem> <listitem> - <para><option>Disabled</option>: WinMerge does not highlight - differences within lines, and all settings for the level and - whitespace options are ignored (also disables the <menuchoice> + <para><option>Disabled</option>: WinMerge does not highlight line + differences, and all settings for the level and whitespace options are + ignored. Also disables the <menuchoice> <guimenu>View</guimenu> <guimenuitem>View Line Differences</guimenuitem> - </menuchoice> menu item).</para> + </menuchoice> menu item.</para> </listitem> </itemizedlist> + + <note> + <title>Related topic</title> + + <para><xref linkend="CompareFiles_linediff-highlight" /> explains in + more detail how WinMerge detects and marks line differences.</para> + </note> </section> </section> @@ -1549,4 +1549,4 @@ </itemizedlist> </section> </section> -</article> +</article> \ No newline at end of file Modified: trunk/Docs/Users/Manual/Intro_diffs.xml =================================================================== --- trunk/Docs/Users/Manual/Intro_diffs.xml 2009-05-06 13:43:29 UTC (rev 6714) +++ trunk/Docs/Users/Manual/Intro_diffs.xml 2009-05-07 13:39:18 UTC (rev 6715) @@ -122,9 +122,15 @@ <term>Difference colors</term> <listitem> - <para>The basic difference color is dark yellow, by default. - Identical lines (like the third line in the example) are - unmarked: they have white backgrounds.</para> + <para>Difference blocks are marked with the difference + background color (gold, by default). </para> + + <para>Line differences can be enabled to mark changed text + within differences blocks, using the word background color + (light yellow, by default).</para> + + <para>Identical lines are unmarked: they have white backgrounds, + like the third line in the example.</para> </listitem> </varlistentry> @@ -433,4 +439,4 @@ argument, as described in <xref linkend="CommandLine" />.</para> </section> </section> -</article> +</article> \ No newline at end of file Added: trunk/Docs/Users/Manual/screenshots/char-diff-01.png =================================================================== (Binary files differ) Property changes on: trunk/Docs/Users/Manual/screenshots/char-diff-01.png ___________________________________________________________________ Added: svn:mime-type + application/octet-stream Added: trunk/Docs/Users/Manual/screenshots/diff-blocks-01.png =================================================================== (Binary files differ) Property changes on: trunk/Docs/Users/Manual/screenshots/diff-blocks-01.png ___________________________________________________________________ Added: svn:mime-type + application/octet-stream Added: trunk/Docs/Users/Manual/screenshots/ignore-blank-lines.png =================================================================== (Binary files differ) Property changes on: trunk/Docs/Users/Manual/screenshots/ignore-blank-lines.png ___________________________________________________________________ Added: svn:mime-type + application/octet-stream Added: trunk/Docs/Users/Manual/screenshots/line-diff-punctuation.png =================================================================== (Binary files differ) Property changes on: trunk/Docs/Users/Manual/screenshots/line-diff-punctuation.png ___________________________________________________________________ Added: svn:mime-type + application/octet-stream Added: trunk/Docs/Users/Manual/screenshots/moved-01.png =================================================================== (Binary files differ) Property changes on: trunk/Docs/Users/Manual/screenshots/moved-01.png ___________________________________________________________________ Added: svn:mime-type + application/octet-stream Added: trunk/Docs/Users/Manual/screenshots/word-diff-allwhite.png =================================================================== (Binary files differ) Property changes on: trunk/Docs/Users/Manual/screenshots/word-diff-allwhite.png ___________________________________________________________________ Added: svn:mime-type + application/octet-stream Added: trunk/Docs/Users/Manual/screenshots/word-diff-nochange.png =================================================================== (Binary files differ) Property changes on: trunk/Docs/Users/Manual/screenshots/word-diff-nochange.png ___________________________________________________________________ Added: svn:mime-type + application/octet-stream Added: trunk/Docs/Users/Manual/screenshots/word-diff-nowhite.png =================================================================== (Binary files differ) Property changes on: trunk/Docs/Users/Manual/screenshots/word-diff-nowhite.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. |
From: <den...@us...> - 2009-05-08 20:10:43
|
Revision: 6720 http://winmerge.svn.sourceforge.net/winmerge/?rev=6720&view=rev Author: denisbradford Date: 2009-05-08 20:10:36 +0000 (Fri, 08 May 2009) Log Message: ----------- Fix bug 2051864: document 'Match similar lines' Modified Paths: -------------- trunk/Docs/Users/Manual/Compare_files.xml trunk/Docs/Users/Manual/Configuration.xml Added Paths: ----------- trunk/Docs/Users/Manual/screenshots/simlines-diffs-off.png trunk/Docs/Users/Manual/screenshots/simlines-diffs-on.png Modified: trunk/Docs/Users/Manual/Compare_files.xml =================================================================== --- trunk/Docs/Users/Manual/Compare_files.xml 2009-05-08 16:59:58 UTC (rev 6719) +++ trunk/Docs/Users/Manual/Compare_files.xml 2009-05-08 20:10:36 UTC (rev 6720) @@ -138,10 +138,9 @@ <para>WinMerge highlights several types of differences in the File panes. The Colors page in the Options dialog defines a set of background - and text colors for each difference type, depending on whether it is - unselected, selected, or deleted. This section describes each of the - basic difference types and the configuration options that affect their - detection.</para> + and text colors for most difference types, with variations indicating + their state: unselected, selected, or deleted. This section describes + how each of the basic difference types is detected and displayed.</para> <variablelist> <varlistentry> @@ -190,7 +189,9 @@ </varlistentry> <varlistentry> - <term>Ignored Difference</term> + <term>Ignored Difference<indexterm> + <primary>ignored differences</primary> + </indexterm></term> <listitem> <para>This color marks content that you have configured WinMerge @@ -214,7 +215,7 @@ <para>The next example repeats the previous comparison, this time with <option>Ignore blank lines</option> enabled. There are now only two differences. The blank line on the right side is marked - with the Ignored Differences color. </para> + with the Ignored Differences color.</para> <mediaobject> <imageobject> @@ -231,7 +232,9 @@ </varlistentry> <varlistentry> - <term>Moved</term> + <term>Moved<indexterm> + <primary>moved differences</primary> + </indexterm></term> <listitem> <para>Moved differences are identical lines found in different @@ -276,6 +279,54 @@ details.</para> </listitem> </varlistentry> + + <varlistentry> + <term>Similar lines<indexterm> + <primary>similar lines, in differences</primary> + </indexterm></term> + + <listitem> + <para>WinMerge tries to match similar lines within difference + blocks when you enable <option>Match similar lines</option> in the + Options dialog Compare page. What does <quote>similar</quote> + mean? Generally, this feature works best in simple cases, for + example where lines that have strong similarities. When detected, + similar lines are adjusted to align in the File pane. The next + figure shows comparisons of the same two files, before and after + enabling the <option>Match similar lines</option> option:</para> + + <simplelist columns="2" type="horiz"> + <member><emphasis role="strong">Disabled</emphasis>: + <inlinemediaobject> + <imageobject> + <imagedata contentwidth="273" + fileref="screenshots/simlines-diffs-off.png" /> + </imageobject> + + <textobject> + <phrase>Compare without matching similar lines</phrase> + </textobject> + </inlinemediaobject></member> + + <member><emphasis role="strong">Enabled</emphasis>: + <inlinemediaobject> + <imageobject> + <imagedata contentwidth="273" + fileref="screenshots/simlines-diffs-on.png" /> + </imageobject> + + <textobject> + <phrase>Compare matching similar lines</phrase> + </textobject> + </inlinemediaobject></member> + </simplelist> + + <para>In the second comparison, the lines <quote>blind</quote> and + <quote>blonde</quote> are detected as similar. WinMerge adds blank + lines in the display to make these lines appear at the same level + within the difference block.</para> + </listitem> + </varlistentry> </variablelist> </section> @@ -321,13 +372,11 @@ <variablelist> <varlistentry> - <term id="wordlevel-linediffs">Word-level line differences</term> + <term id="wordlevel-linediffs">Word-level line differences<indexterm> + <primary>word differences</primary> + </indexterm></term> <listitem> - <indexterm> - <primary>word-level line difference</primary> - </indexterm> - <para>The following examples show how word-level line differences are displayed with each of the whitespace settings:</para> @@ -393,13 +442,11 @@ </varlistentry> <varlistentry> - <term>Character-level line differences</term> + <term>Character-level line differences<indexterm> + <primary>character-level line difference</primary> + </indexterm></term> <listitem> - <indexterm> - <primary>character-level line difference</primary> - </indexterm> - <para>A character-level line difference includes the first and last different characters in a word, and all the characters between them. A single character-level difference can span @@ -430,13 +477,11 @@ <variablelist> <varlistentry> - <term>Breaks for words or character</term> + <term>Breaks for words or character<indexterm> + <primary>word breaks in line differences</primary> + </indexterm></term> <listitem> - <indexterm> - <primary>word breaks in line differences</primary> - </indexterm> - <para>Words and characters in line differences can be separated by whitespace, or by a combination of whitespace and punctuation. Whitespace (the default) is the typical choice for comparing most @@ -550,18 +595,24 @@ <guimenuitem>View Margins</guimenuitem> </menuchoice>. If you are using multiple File Compare windows, you can control margins for each window independently. The margin can show any - or all of these features:<indexterm> - <primary>line numbers</primary> + or all of these features:</para> - <secondary>in File panes</secondary> - </indexterm><indexterm> - <primary>bookmarks</primary> - </indexterm><indexterm> - <primary>word wrapping</primary> + <indexterm> + <primary>line numbers</primary> - <secondary>in File panes</secondary> - </indexterm></para> + <secondary>in File panes</secondary> + </indexterm> + <indexterm> + <primary>bookmarks</primary> + </indexterm> + + <indexterm> + <primary>word wrapping</primary> + + <secondary>in File panes</secondary> + </indexterm> + <itemizedlist> <listitem> <para>Line numbers, if <menuchoice> @@ -751,10 +802,16 @@ </section> <section> - <title>Location pane<indexterm> - <primary>Location pane, File Compare window</primary> - </indexterm></title> + <title>Location pane</title> + <indexterm> + <primary>Location pane, File Compare window</primary> + </indexterm> + + <indexterm> + <primary>difference navigation</primary> + </indexterm> + <para>The Location pane, to the left of the File panes, maps the entire length of the compared files into two vertical bars (corresponding to the left and right File panes). It is especially useful for working with files @@ -853,14 +910,12 @@ <varlistentry> <term>Moved differences<indexterm> <primary>moved differences</primary> - - <secondary>in File Compare window</secondary> </indexterm></term> <listitem> - <para>Moved differences are identical lines in different locations, - shown only if the Enable moved block detection is checked in the - Options dialog Compare page. See <xref + <para>Moved differences are identical lines in different locations. + They are shown only if the Enable moved block detection is checked + in the Options dialog Compare page. See <xref linkend="CompareFiles_diffcolors" /> for more details about moved differences in the File pane. The Location pane draws a line connecting moved differences in the left and right location bars. Modified: trunk/Docs/Users/Manual/Configuration.xml =================================================================== --- trunk/Docs/Users/Manual/Configuration.xml 2009-05-08 16:59:58 UTC (rev 6719) +++ trunk/Docs/Users/Manual/Configuration.xml 2009-05-08 20:10:36 UTC (rev 6720) @@ -384,7 +384,7 @@ <section> <title>About ignore options<indexterm> - <primary>ignoring differences</primary> + <primary>ignored differences</primary> </indexterm></title> <para>A number of options in the Compare page (described later in this @@ -547,9 +547,9 @@ <itemizedlist> <listitem> - <para><option>Disabled</option> (default): WinMerge detects end of - line (EOL) style differences. For example, if you compare two lines - that have the same contents but different line endings, the lines are + <para><option>Disabled</option> (default): End of line (EOL) style + differences are detected. For example, if you compare two lines that + have the same contents but different line endings, the lines are considered to be different. When this happens, WinMerge displays a dialog prompting you to confirm whether to detect or ignore the difference.</para> @@ -564,8 +564,6 @@ <section> <title>Enable moved block detection<indexterm> <primary>moved differences</primary> - - <secondary>enabling and disabling detection</secondary> </indexterm></title> <itemizedlist> @@ -590,6 +588,29 @@ </section> <section> + <title>Match similar lines<indexterm> + <primary>similar lines, matching</primary> + </indexterm></title> + + <itemizedlist> + <listitem> + <para><option>Disabled</option> (default): Lines within difference + blocks are shown as they occur in the source files.</para> + </listitem> + + <listitem> + <para><option>Enabled</option>: WinMerge tries to detect lines within + a difference blocks that are similar, and adds blank lines in the File + panes to align them. This option is most effective when lines are + quite similar; less effective if lines are too different.</para> + + <para>For an example, see the <citetitle>Similar lines</citetitle> + description in <xref linkend="CompareFiles_diffcolors" />.</para> + </listitem> + </itemizedlist> + </section> + + <section> <title>Ignore time differences less than 3 seconds<indexterm> <primary>timestamps</primary> @@ -939,8 +960,8 @@ </listitem> <listitem> - <para><guilabel>Word-level</guilabel> (default): Highlights entire - words that are different.</para> + <para><guilabel>simiWord-level</guilabel> (default): Highlights + entire words that are different.</para> <itemizedlist> <listitem> Added: trunk/Docs/Users/Manual/screenshots/simlines-diffs-off.png =================================================================== (Binary files differ) Property changes on: trunk/Docs/Users/Manual/screenshots/simlines-diffs-off.png ___________________________________________________________________ Added: svn:mime-type + application/octet-stream Added: trunk/Docs/Users/Manual/screenshots/simlines-diffs-on.png =================================================================== (Binary files differ) Property changes on: trunk/Docs/Users/Manual/screenshots/simlines-diffs-on.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. |
From: <den...@us...> - 2009-05-18 11:54:56
|
Revision: 6761 http://winmerge.svn.sourceforge.net/winmerge/?rev=6761&view=rev Author: denisbradford Date: 2009-05-18 11:54:47 +0000 (Mon, 18 May 2009) Log Message: ----------- Patches #2433648: doc new 'Shell Integration' Options page; #2189315: doc shell context menu in folder compare; doc new Tools>Customize Columns menu item; miscellaneous copy edits. Modified Paths: -------------- trunk/Docs/Users/Manual/Compare_dirs.xml trunk/Docs/Users/Manual/Configuration.xml trunk/Docs/Users/Manual/Filters.xml trunk/Docs/Users/Manual/Install.xml trunk/Docs/Users/Manual/Open_paths.xml trunk/Docs/Users/Manual/Quick_start.xml trunk/Docs/Users/Manual/screenshots/ctx_menu_simple.png Modified: trunk/Docs/Users/Manual/Compare_dirs.xml =================================================================== --- trunk/Docs/Users/Manual/Compare_dirs.xml 2009-05-17 08:56:57 UTC (rev 6760) +++ trunk/Docs/Users/Manual/Compare_dirs.xml 2009-05-18 11:54:47 UTC (rev 6761) @@ -424,9 +424,16 @@ <section> <title>Navigating the Folder Compare window</title> - <para>You can use the mouse as well as keyboard and context menu shortcuts - to navigate the Folder Compare window. You can also use the toolbar - buttons. For example, the <inlinemediaobject> + <indexterm> + <primary>navigation functions</primary> + + <secondary>folder compare</secondary> + </indexterm> + + <para>You can use the mouse as well as <link + linkend="Shortcuts">keyboard</link> and context menu shortcuts to navigate + the Folder Compare window. You can also use the toolbar buttons. For + example, the <inlinemediaobject> <imageobject> <imagedata contentdepth="15" fileref="screenshots/nextdiff_btn.png" /> </imageobject> @@ -1103,8 +1110,8 @@ </variablelist> </section> - <section> - <title id="CompareDirs_browse_unique">Browsing unique folders<indexterm> + <section id="CompareDirs_browse_unique"> + <title>Browsing unique folders<indexterm> <primary>unique folders</primary> <secondary>comparing</secondary> @@ -1256,7 +1263,11 @@ <orderedlist> <listitem> <para>Right-click any column heading and choose <guimenuitem>Customize - Columns</guimenuitem>.</para> + Columns</guimenuitem>. Or, click <menuchoice> + <guimenu>Tools</guimenu> + + <guimenuitem>Customize Columns</guimenuitem> + </menuchoice></para> </listitem> <listitem> @@ -1424,4 +1435,29 @@ </tip> </section> </section> + + <section id="CompareDirs_winshell"> + <title>Using Windows shell commands from the Folder Compare window</title> + + <para>If you have <link linkend="Configuration_foldercompare">enabled + <option>Add Shell menu to context menu</option></link> in the Shell + Integration page of WinMerge options, you can right-click a selection in the + Folder Compare window and launch Windows shell commands directly from the + context menu.</para> + + <para>If the selection occurs on both sides, you can choose either the + <guimenu>Left shell menu</guimenu> or <guimenu>Right shell menu</guimenu>; + if the item occurs only on one side, only that side's shell menu is + available.</para> + + <caution> + <para>Please consider that shell menu commands run entirely outside of + WinMerge. Consequently, WinMerge might not respond to some operations in + the same way as operations performed inside WinMerge. For example, if you + delete a file through this integration instead of using the Winmerge + <command>Delete</command> command, the change is not automatically shown + in the Folder Compare window (you have to manually refresh the window to + see the change).</para> + </caution> + </section> </article> \ No newline at end of file Modified: trunk/Docs/Users/Manual/Configuration.xml =================================================================== --- trunk/Docs/Users/Manual/Configuration.xml 2009-05-17 08:56:57 UTC (rev 6760) +++ trunk/Docs/Users/Manual/Configuration.xml 2009-05-18 11:54:47 UTC (rev 6761) @@ -102,7 +102,7 @@ </section> <section id="Configuration_general"> - <title>General options</title> + <title>General page</title> <para>The General page has these options:</para> @@ -363,7 +363,7 @@ </section> <section id="Configuration_compare"> - <title>Compare options</title> + <title>Compare page</title> <para>The options in this page enable you to change some of the ways that WinMerge detects differences, such as comparing only file size, or ignoring @@ -782,7 +782,7 @@ </section> <section id="Configuration_editor"> - <title>Editor options<indexterm> + <title>Editor page<indexterm> <primary>editing</primary> <secondary>options for File Compare window</secondary> @@ -1003,7 +1003,7 @@ </section> <section id="Configuration_colors"> - <title>Colors options<indexterm> + <title>Colors page<indexterm> <primary>difference colors</primary> <secondary>options</secondary> @@ -1023,7 +1023,7 @@ </section> <section id="Configuration_textcolors"> - <title>Text Colors options<indexterm> + <title>Text Colors page<indexterm> <primary>text colors</primary> <secondary>options</secondary> @@ -1037,7 +1037,7 @@ </section> <section id="Configuration_syntaxcolors"> - <title>Syntax Colors options<indexterm> + <title>Syntax Colors page<indexterm> <primary>syntax highlighting</primary> <secondary>color options</secondary> @@ -1054,7 +1054,7 @@ </section> <section id="Configuration_archive"> - <title>Archive Support<indexterm> + <title>Archive Support page<indexterm> <primary>archiving files</primary> <secondary>configuring support after installation</secondary> @@ -1142,7 +1142,7 @@ </section> <section id="Configuration_system"> - <title>System options</title> + <title>System page</title> <section> <title>Send deleted files to Recycle Bin<indexterm> @@ -1171,92 +1171,7 @@ </itemizedlist> </section> - <section> - <title>Add to explorer context menu<indexterm> - <primary>integration</primary> - - <secondary>with Windows shell</secondary> - </indexterm></title> - - <itemizedlist> - <listitem> - <para><option>Enabled</option> (default): Adds one or more WinMerge - shortcuts to the Windows Explorer context menu. After right-clicking - one or more files or folders, choose a WinMerge shortcut to open the - items in a WinMerge compare window.</para> - - <para>Two additional options are available if you use this - integration. Neither option is enabled by default, but you can enable - one or both:</para> - - <variablelist> - <varlistentry> - <term>Enable advanced menu</term> - - <listitem> - <itemizedlist> - <listitem> - <para><option>Disabled</option> (default): The - <guimenuitem>WinMerge</guimenuitem> shortcut is included in - the Windows Explorer context menu when you right-click one - or more files or folders. If you select a single item, the - Select Files or Folders dialog opens. If you select two - items, they are opened directly in a Compare window.</para> - </listitem> - - <listitem> - <para><option>Enabled</option>: Replaces the - <guimenuitem>WinMerge</guimenuitem> shortcut in the Explorer - context menu with <guimenuitem>Compare</guimenuitem> - shortcuts, described in <xref - linkend="OpenPaths_shell-integ" />. The - <guimenuitem>Compare</guimenuitem> shortcuts enable you to - add a selected path to memory, then choose the second - separately (for example, in a different Explorer - view).</para> - </listitem> - </itemizedlist> - </listitem> - </varlistentry> - - <varlistentry> - <term>Include subfolders by default</term> - - <listitem> - <itemizedlist> - <listitem> - <para><option>Disabled</option> (default): When you use the - <guimenuitem>WinMerge</guimenuitem> or - <guimenuitem>Compare</guimenuitem> shortcut, only the top - level of files is selected: the compare operation is - non-recursive.</para> - </listitem> - - <listitem> - <para><option>Enabled</option>: The selection includes - subfolders, making the compare operation recursive.</para> - - <para>Another way to include subfolders is to press - <keycap>Control</keycap> while selecting the - <guimenuitem>WinMerge</guimenuitem> or - <guimenuitem>Compare</guimenuitem> shortcut in the Windows - Explorer context menu.</para> - </listitem> - </itemizedlist> - </listitem> - </varlistentry> - </variablelist> - </listitem> - - <listitem> - <para><option>Disabled</option>: The - <guimenuitem>WinMerge</guimenuitem> shortcut is unavailable in Windows - Explorer.</para> - </listitem> - </itemizedlist> - </section> - - <section> + <section id="Configuration_external_editor"> <title>External editor<indexterm> <primary>external editor</primary> @@ -1268,7 +1183,7 @@ WinMerge to open an external editor from the Folder Compare context menu.</para> - <para>By default, Notepad is configured as the default external editor, + <para>Installation configures Notepad as the default external editor, because it is found on all Windows systems. To configure a different external editor, enter the full path to its executable file.</para> @@ -1329,7 +1244,7 @@ </section> <section id="Configuration_backup"> - <title>Backup Files<indexterm> + <title>Backup Files page<indexterm> <primary>backup files, options</primary> </indexterm></title> @@ -1409,7 +1324,7 @@ </section> <section id="Configuration_vcs"> - <title>Version Control options<indexterm> + <title>Version Control page<indexterm> <primary>version control systems</primary> <secondary>configuring after installation</secondary> @@ -1451,7 +1366,7 @@ </section> <section id="Configuration_codepage"> - <title>Codepage options<indexterm> + <title>Codepage page<indexterm> <primary>codepage</primary> <secondary>options</secondary> @@ -1570,4 +1485,108 @@ </itemizedlist> </section> </section> + + <section id="Configuration_shell-integ"> + <title>Shell Integration page</title> + + <section id="Configuration_winexplorer-integ"> + <title>Explorer<indexterm> + <primary>integration</primary> + + <secondary>with Windows shell</secondary> + </indexterm></title> + + <para>The <option>Add to context menu</option> option enables you to + launch WinMerge directly from Windows Explorer, comparing items that you + have selected there. It is enabled or disabled by default during WinMerge + installation. If enabled, you can also enable one or both of these + options:</para> + + <variablelist> + <varlistentry> + <term>Enable advanced menu</term> + + <listitem> + <itemizedlist> + <listitem> + <para><option>Disabled</option> (default): Only the + <guimenuitem>WinMerge</guimenuitem> shortcut is included in the + Windows Explorer context menu.</para> + </listitem> + + <listitem> + <para><option>Enabled</option>: Replaces the + <guimenuitem>WinMerge</guimenuitem> shortcut in the Explorer + context menu with <guimenuitem>Compare</guimenuitem> + shortcuts.</para> + </listitem> + </itemizedlist> + </listitem> + </varlistentry> + + <varlistentry> + <term>Include subfolders by default</term> + + <listitem> + <itemizedlist> + <listitem> + <para><option>Disabled</option> (default): folder compare + operations are non-recursive.</para> + </listitem> + + <listitem> + <para><option>Enabled</option>: The selection includes + subfolders, making the compare operation recursive.</para> + </listitem> + </itemizedlist> + + <note> + <para>This option does not change the <option>Include + Subfolders</option> setting for the Select Files or Folders + dialog.</para> + </note> + </listitem> + </varlistentry> + </variablelist> + + <para><xref linkend="OpenPaths_shell-integ" /> describes how to use the + WinMerge and Compare shortcuts.</para> + </section> + + <section id="Configuration_foldercompare"> + <title>Folder compare</title> + + <para>The <option>Add Shell menu to context menu</option> option enables + you to launch some Windows shell commands from the WinMerge window:</para> + + <itemizedlist> + <listitem> + <para><option>Disabled</option> (default). No shell menus are + available in the Folder Compare context menu.</para> + </listitem> + + <listitem> + <para><option>Enabled</option>: Adds a <guimenu>Left shell + menu</guimenu> or <guimenu>Right shell menu</guimenu>, or both, to the + Folder Compare context menu. The shell menu (if added) is identical to + the path's context menu in Windows Explorer, and enables you to launch + its commands in the same way.</para> + + <para>If you right-click an item that occurs on both sides, both the + left and right shell menus are available; if the item occurs only on + one side, only that side's shell menu appears.</para> + + <note> + <para>Using the shell menu is just like launching Windows commands + outside of WinMerge. Consequently, WinMerge might not respond to + some operations in the same way as operations performed inside + WinMerge.</para> + </note> + + <para> <xref linkend="CompareDirs_winshell" /> has more information + about using the shell menus.</para> + </listitem> + </itemizedlist> + </section> + </section> </article> \ No newline at end of file Modified: trunk/Docs/Users/Manual/Filters.xml =================================================================== --- trunk/Docs/Users/Manual/Filters.xml 2009-05-17 08:56:57 UTC (rev 6760) +++ trunk/Docs/Users/Manual/Filters.xml 2009-05-18 11:54:47 UTC (rev 6761) @@ -885,7 +885,8 @@ </variablelist> <para>Your changes are saved when you click <guibutton>OK</guibutton> to - dismiss the Filters dialog.</para> + dismiss the Filters dialog. Line filters are stored in the Windows + registry.</para> </section> <section id="Filters_CreatingFile"> Modified: trunk/Docs/Users/Manual/Install.xml =================================================================== --- trunk/Docs/Users/Manual/Install.xml 2009-05-17 08:56:57 UTC (rev 6760) +++ trunk/Docs/Users/Manual/Install.xml 2009-05-18 11:54:47 UTC (rev 6761) @@ -93,7 +93,8 @@ <term>Filters</term> <listitem> - <para>File filter files</para> + <para>File filter files enable you to narrow the scope of + comparisons. </para> </listitem> </varlistentry> @@ -101,7 +102,9 @@ <term>Plugins</term> <listitem> - <para>Plugins and scripts</para> + <para>WinMerge plugins are custom dlls or scriptlets, written in + the COM API, that you can use to preprocess data before a + comparison.</para> </listitem> </varlistentry> @@ -160,8 +163,20 @@ <term>Enable Explorer context menu integration</term> <listitem> - <para>Enables basic WinMerge shell integration (can be enabled - later in WinMerge options).</para> + <indexterm> + <primary>integration</primary> + + <secondary>with Windows shell</secondary> + </indexterm> + + <indexterm> + <primary>Windows shell integration</primary> + </indexterm> + + <para>Enables you to <link linkend="OpenPaths_shell-integ">launch + WinMerge compare operations from Windows Explorer</link> (this + integration can be enabled or disabled later in WinMerge + options).</para> </listitem> </varlistentry> @@ -202,7 +217,7 @@ <term>Create a Desktop shortcut</term> <listitem> - <para>Adds the WinMerge shortcut to your Desktop.</para> + <para>Adds the WinMerge shortcut to your Windows Desktop.</para> </listitem> </varlistentry> @@ -210,7 +225,8 @@ <term>Create a Quick Launch shortcut</term> <listitem> - <para>Adds the WinMerge shortcut to Quick Launch bar.</para> + <para>Adds the WinMerge shortcut to the Windows Quick Launch + bar.</para> </listitem> </varlistentry> </variablelist> @@ -276,7 +292,8 @@ </section> <section> - <title>Shell integration<indexterm> + <title>Enabling Windows Explorer shell integration without the installer + <indexterm> <primary>integration</primary> <secondary>with Windows shell</secondary> @@ -284,10 +301,8 @@ <primary>Windows shell integration</primary> </indexterm></title> - <para>The installer enables shell integration when you choose the - <guilabel>Enable Explorer context menu integration</guilabel> option in the - Select Additional Tasks page. If you do not use the install program: you - must register the shell integration DLL + <para>If you do not use the install program and you want to enable Windows + Explorer shell integration, you must register the shell integration DLL (<filename>ShellExtension*.dll</filename>) separately.</para> <note> @@ -306,14 +321,14 @@ Windows updates all its references.</para> <section> - <title>64-bit shell integration<indexterm> + <title>64-bit Windows Explorer shell integration<indexterm> <primary>Windows 64-bit versions, WinMerge support</primary> </indexterm></title> - <para>Starting with Version 2.6, WinMerge supports 64-bit Windows versions - by including 64-bit shell integration. The WinMerge installer recognizes - 64-bit versions of Windows and can install the correct shell integration - version.</para> + <para>Starting with Version 2.6, WinMerge supports Windows Explorer shell + integration for 64-bit Windows versions. The WinMerge installer recognizes + the 64-bit versions of Windows and can install the correct shell + integration.</para> <para>When you install shell integration manually from an archive file, the shell integration DLL is named Modified: trunk/Docs/Users/Manual/Open_paths.xml =================================================================== --- trunk/Docs/Users/Manual/Open_paths.xml 2009-05-17 08:56:57 UTC (rev 6760) +++ trunk/Docs/Users/Manual/Open_paths.xml 2009-05-18 11:54:47 UTC (rev 6761) @@ -150,72 +150,76 @@ <primary>Windows shell integration</primary> </indexterm><indexterm> <primary>context menu, WinMerge shortcuts in Windows Explorer</primary> - </indexterm>Shell integration</title> + </indexterm>Launching WinMerge operations in Windows Explorer</title> - <para>The Windows shell Integration is a convenient way to select paths and - open WinMerge directly from Windows Explorer. It adds a - <guimenuitem>WinMerge</guimenuitem> shortcut in the Explorer context menu - (available when you right-click one or two files or folders in Explorer). - For example:</para> + <para>The optional Windows shell integration enables you to run WinMerge + compare operations directly from Windows Explorer, using WinMerge shortcuts + in the context menu.</para> - <mediaobject> - <imageobject> - <imagedata contentwidth="140" fileref="screenshots/ctx_menu_simple.png" - format="PNG" /> - </imageobject> + <!--WinMerge provides two optional types of integration with Windows Explorer. The first type lets you launch WinMerge compare operations directly from Windows Explorer, skipping the Select Files or Folders dialog. The second type lets you run Windows shell commands from the WinMerge window.--> - <textobject> - <phrase>Simple WinMerge context menu</phrase> - </textobject> - </mediaobject> + <section> + <title>Enabling the Windows Explorer integration</title> - <para>You can enable the shell integration when you install WinMerge. After - installing WinMerge, you can enable or disable the shell integration in the - System page of the Options dialog.</para> + <para>The Windows Explorer shell integration is available only if enabled. + You can enable it either <link linkend="Installing_usinginstaller">during + WinMerge installation</link> or later, using the <xref + linkend="Configuration_shell-integ" /> in the Options window. In the + Options window, configure the <option>Add to context menu</option> option, + including its suboptions if you like.</para> + </section> - <para>To use the shell integration, begin by selecting either one or two - paths in Windows Explorer:</para> + <section> + <title>Using the WinMerge shortcut</title> - <itemizedlist> - <listitem> - <para>If you select a single path, WinMerge opens the Select Files or - Folders dialog. It places the selected file or folder in the + <para>If you enable <option>Add to context menu</option> without the + advanced menu suboption, the <guimenuitem>WinMerge</guimenuitem> shortcut + is added to the Explorer context menu. For example:</para> + + <para>To use the basic shell integration, begin by selecting two paths in + Windows Explorer. Then, right-click and choose WinMerge in the context + menu. For example:</para> + + <mediaobject> + <imageobject> + <imagedata fileref="screenshots/ctx_menu_simple.png" format="PNG" /> + </imageobject> + + <textobject> + <phrase>WinMerge command in Windows Explorer context menu</phrase> + </textobject> + </mediaobject> + + <para>WinMerge opens the paths directly in the File Compare or Folder + Compare window.</para> + + <para>The left and right sides are determined by the sort order in Windows + Explorer. In the preceding screen shot, the Windows Explorer file list is + in ascending order, so WinMerge opens with <filename>File2</filename> on + the left side and <filename>File1</filename> on the right..</para> + + <note> + <para>If either path cannot be opened for any reason, WinMerge opens the + Select Files or Folders dialog, where you can specify new paths. + Similarly, if you select only a single path, the Select Files or Folders + dialog opens with the selected file or folder in the <guilabel>Left</guilabel> field, leaving the <guilabel>Right</guilabel> path for you to specify.</para> - </listitem> + </note> - <listitem> - <para>If you select two files or folders, WinMerge opens them directly - in the File Compare or Folder Compare window. However, if one or more - paths cannot be opened for any reason, WinMerge opens the Select Files - or Folders dialog for you to reselect the paths.</para> - </listitem> - </itemizedlist> + <para>The <guimenuitem>WinMerge</guimenuitem> shortcut is quick and easy + to use, but you can compare only files or folders that you are able to + select concurrently in Windows Explorer. For more flexible selections, + consider enabling the advanced menu, described in the next section.</para> + </section> <section> - <title>Advanced shell integration</title> + <title>Using the advanced menu</title> - <para>The advanced shell integration enables you to control the order in - which paths are compared when you launch WinMerge from the Windows - Explorer context menu. To configure the advanced shell integration, select - <guilabel>Enable advanced menu</guilabel> in the System page of WinMerge - options.</para> + <para>If you choose the <option>Enable advanced menu</option>, the + <guimenuitem>WinMerge</guimenuitem> shortcut is replaced with two + <guimenuitem>Compare</guimenuitem> shortcuts:</para> - <para>In the standard shell integration, when you select two paths in - Windows Explorer and then right-click and choose - <guimenuitem>WinMerge</guimenuitem>, the order of comparison in WinMerge - is determined by the sort order in Windows Explorer. For example, if your - Windows Explorer file list is sorted by name descending, and you select - <filename>File1</filename> and <filename>File2</filename>, WinMerge opens - with <filename>File1</filename> on the left side and - <filename>File2</filename> on the right. You can change the order only - within WinMerge, after it opens.</para> - - <para>The advanced shell integration replaces the standard - <guimenuitem>WinMerge</guimenuitem> shortcut in the Windows Explorer - context menu with a set of shortcuts that enable you to control the - comparison order before launching WinMerge:</para> - <mediaobject> <imageobject> <imagedata fileref="screenshots/ctx_menu_advanced.png" format="PNG" /> @@ -226,92 +230,61 @@ </textobject> </mediaobject> - <variablelist> - <varlistentry> - <term>Compare To</term> + <para>Use the <guimenuitem>Compare</guimenuitem> shortcuts in this + order:</para> - <listitem> - <para>Designates the selected path as the first - (<guilabel>Left</guilabel>) path in the comparison. The path is - loaded in memory; meanwhile WinMerge waits for you select the second - path in Windows Explorer, using the - <guimenuitem>Compare</guimenuitem> shortcut (described next).</para> - </listitem> - </varlistentry> + <orderedlist> + <listitem> + <para>Right-click the first path and choose <guimenuitem>Compare + To</guimenuitem>. WinMerge stores the path in memory until you select + the second path.</para> + </listitem> - <varlistentry> - <term>Compare</term> + <listitem> + <para>If you decide that you have chosen the wrong first path, you can + change it before choosing the second path:</para> - <listitem> - <para>Designates the selected path as the second - (<guilabel>Right</guilabel>) path in the comparison, and opens - WinMerge in one of these ways:</para> + <para>Right-click the new path and choose the <guimenuitem>Re-select + First</guimenuitem> shortcut. The new selection overrides your + previous path, and you can go on to the next step.</para> + </listitem> - <itemizedlist> - <listitem> - <para>If you previously designated the first path (using - <guimenu>Compare To</guimenu>), WinMerge opens the File Compare - or Folder Compare window, and compares the first and second - paths you have specified.</para> - </listitem> + <listitem> + <para>Navigate to the second file or folder that you want to compare. + The second path can be in any folder, or even in a different Windows + Explorer window from the first path. Right-click the second path and + choose <guimenuitem>Compare</guimenuitem>.</para> - <listitem> - <para>If you click <guimenuitem>Compare</guimenuitem> before - designating the first path, the Select Files or Folders dialog - is opened, with your selection as the first - (<guilabel>Left</guilabel>) path. Specify the second path in the - <guilabel>Right</guilabel> field to continue with the - comparison.</para> - </listitem> - </itemizedlist> + <para>WinMerge opens the File Compare or Folder Compare window, + loading the first and second paths in the left and right sides, + respectively.</para> + </listitem> + </orderedlist> - <!-- <tip><para>When you use this method, take advantage + <note> + <para>If you click <guimenuitem>Compare</guimenuitem> before designating + the first path, the Select Files or Folders dialog is opened, with your + selection as the first (<guilabel>Left</guilabel>) path. Specify the + second path in the <guilabel>Right</guilabel> field to continue with the + comparison.</para> + </note> + + <!-- <tip><para>When you use this method, take advantage of the Select Files or Folders dialog's MRU list. This is very handy when you need to compare one file/folder against several files/folders.</para> </tip> --> - </listitem> - </varlistentry> - <varlistentry> - <term>Re-select First</term> - - <listitem> - <para>Available in the context menu only after you apply - <guimenu>Compare To</guimenu>. Designates the selected path as the - first path, overriding the previous <guimenu>Compare To</guimenu> - selection. This is useful, for example, if you accidentally select - the wrong first path.</para> - </listitem> - </varlistentry> - </variablelist> - - <para>The shell integration paths that you map are stored in memory until - you use them to open WinMerge. As a result, you don't need to select both - files at the same time or even using the same Windows Explorer view: you - can choose one, open a different directory, and choose the other one. Both + <para>The <guimenuitem>Compare To</guimenuitem> paths is stored in memory + until WinMerge is opened. As a result, you don't need to select both files + at the same time or even using the same Windows Explorer view: you can + choose one, open a different directory, and choose the other one. Both paths are discarded from memory after a compare operation. This means that you cannot select one <guimenuitem>Compare To</guimenuitem> path and compare it against several paths.</para> - - <para>Here is a simple method of using the advanced integration נthere are - other scenarios, of course. In Windows Explorer:</para> - - <orderedlist> - <listitem> - <simpara>Right-click the first item you want to compare and choose the - <guimenuitem>Compare To</guimenuitem> shortcut in the context menu. - The path is now in memory.</simpara> - </listitem> - - <listitem> - <simpara>Locate the second item you want to compare. Right-click the - item and choose <guimenuitem>Compare</guimenuitem> to launch WinMerge - and perform the comparison.</simpara> - </listitem> - </orderedlist> </section> <section> - <title>Including Subfolders<indexterm> + <title>Including subfolders when using the Windows Explorer + integration<indexterm> <primary>recursive folder compare</primary> <secondary>specifying in Select Files or Folders dialog</secondary> @@ -321,20 +294,38 @@ <seealso>recursive folder compare</seealso> </indexterm></title> - <para>By default, WinMerge does not include subfolders in compare - operations. To change the default behavior, enable <guilabel>Include - subfolders by default</guilabel> in the System page of WinMerge options. - To change include subfolders while using the shell integration, press and - hold the <keycap>Control</keycap> key while selecting - <guimenuitem>Compare</guimenuitem> in the Windows Explorer context - menu.</para> + <para>By default, folder compares that you do using the + <guimenuitem>WinMerge</guimenuitem> or <guimenuitem>Compare</guimenuitem> + shortcut are not recursive: only files in the top level are included. + There are two ways to launch recursive compares with the Windows Explorer + integration:</para> + + <itemizedlist> + <listitem> + <para>Enable <guilabel>Include subfolders by default</guilabel> in the + Shell Integration page of the WinMerge Options dialog.</para> + </listitem> + + <listitem> + <para>Press <keycap>Control</keycap> while selecting the + <guimenuitem>WinMerge</guimenuitem> or + <guimenuitem>Compare</guimenuitem> shortcut in the Windows Explorer + context menu.</para> + </listitem> + </itemizedlist> + + <note> + <para>These settings for the Windows Explorer integration do not change + the <option>Include Subfolders</option> setting for the Select Files or + Folders dialog, described in <xref linkend="QuickStart" />.</para> + </note> </section> </section> <section id="OpenPaths_dragndrop"> <title><indexterm> <primary>drag and drop, in WinMerge window</primary> - </indexterm>Drag and drop</title> + </indexterm>Using Drag and drop</title> <para>From any Windows source that allows you to drag objects, such as Windows Explorer or the Desktop, you can drag and drop one or two paths into @@ -405,7 +396,7 @@ <itemizedlist> <listitem> - <simpara>If you specifiy two project files, the project files + <simpara>If you specify two project files, the project files themselves are compared.</simpara> </listitem> @@ -540,4 +531,4 @@ example, <left></left> or <left/></literal>).</para> </section> </section> -</article> +</article> \ No newline at end of file Modified: trunk/Docs/Users/Manual/Quick_start.xml =================================================================== --- trunk/Docs/Users/Manual/Quick_start.xml 2009-05-17 08:56:57 UTC (rev 6760) +++ trunk/Docs/Users/Manual/Quick_start.xml 2009-05-18 11:54:47 UTC (rev 6761) @@ -256,8 +256,9 @@ <itemizedlist> <listitem> - <para>Project files are the easiest and fastest way to open frequently - used paths. To open a project file, use one of these methods:</para> + <para><xref linkend="OpenPaths_project" /> are the easiest and fastest + way to open frequently used paths. To open a project file, use one of + these methods:</para> <itemizedlist> <listitem> @@ -284,25 +285,21 @@ </note> </listitem> </itemizedlist> - - <para>See <xref linkend="OpenPaths" /> for more information about - project files.</para> </listitem> <listitem> - <simpara>Right-clicking files or folders in Windows Explorer, choosing - WinMerge in the context menu.</simpara> + <simpara><xref linkend="OpenPaths_shell-integ" />.</simpara> </listitem> <listitem> - <simpara>The command line allows you to start WinMerge from other - applications, from a command prompt, or a batch or script - file.</simpara> + <simpara>Use the <xref linkend="CommandLine" /> interface to start + WinMerge from other applications, from a command prompt, or a batch or + script file.</simpara> </listitem> <listitem> - <simpara>You can drag and drop files and folders directly into the - WinMerge window or on the WinMerge desktop shortcut.</simpara> + <simpara>Drag and drop files and folders directly into the WinMerge + window or on the WinMerge desktop shortcut.</simpara> </listitem> </itemizedlist> </section> @@ -338,12 +335,12 @@ <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. 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> + different between two selected folders. A file or folder that is found only + on one side is simply shown as a unique item on that side, not 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) Modified: trunk/Docs/Users/Manual/screenshots/ctx_menu_simple.png =================================================================== (Binary files differ) This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site. |
From: <den...@us...> - 2009-05-22 13:22:05
|
Revision: 6773 http://winmerge.svn.sourceforge.net/winmerge/?rev=6773&view=rev Author: denisbradford Date: 2009-05-22 13:21:56 +0000 (Fri, 22 May 2009) Log Message: ----------- Compare_dirs.xml: modify general compare icons; Compare_files.xml: allow file reloading during rescan, list shortcuts after function descriptions; Install.xml: add WM to system path; Configuration.xml: add Open dialog on startup; Version_control: typo. Modified Paths: -------------- trunk/Docs/Users/Manual/Compare_dirs.xml trunk/Docs/Users/Manual/Compare_files.xml trunk/Docs/Users/Manual/Configuration.xml trunk/Docs/Users/Manual/Install.xml trunk/Docs/Users/Manual/Version_control.xml trunk/Docs/Users/Manual/screenshots/equal.png trunk/Docs/Users/Manual/screenshots/notequal.png Modified: trunk/Docs/Users/Manual/Compare_dirs.xml =================================================================== --- trunk/Docs/Users/Manual/Compare_dirs.xml 2009-05-22 12:33:31 UTC (rev 6772) +++ trunk/Docs/Users/Manual/Compare_dirs.xml 2009-05-22 13:21:56 UTC (rev 6773) @@ -307,24 +307,24 @@ <simplelist> <member><inlinemediaobject> <imageobject> - <imagedata contentwidth="16" fileref="screenshots/equal.png" - format="PNG" /> + <imagedata contentwidth="16" + fileref="screenshots/equaltextfile.png" format="PNG" /> </imageobject> - </inlinemediaobject> Identical files</member> + </inlinemediaobject> Identical text files</member> <member><inlinemediaobject> <imageobject> - <imagedata contentwidth="16" fileref="screenshots/notequal.png" + <imagedata contentwidth="16" fileref="screenshots/binary.png" format="PNG" /> </imageobject> - </inlinemediaobject> Different files</member> + </inlinemediaobject> Identical binary files</member> <member><inlinemediaobject> <imageobject> - <imagedata contentwidth="16" - fileref="screenshots/equaltextfile.png" format="PNG" /> + <imagedata contentwidth="16" fileref="screenshots/equal.png" + format="PNG" /> </imageobject> - </inlinemediaobject> Identical text files</member> + </inlinemediaobject> Identical files (type undetermined)</member> <member><inlinemediaobject> <imageobject> @@ -335,17 +335,17 @@ <member><inlinemediaobject> <imageobject> - <imagedata contentwidth="16" fileref="screenshots/binary.png" + <imagedata contentwidth="16" fileref="screenshots/binarydiff.png" format="PNG" /> </imageobject> - </inlinemediaobject> Identical binary files</member> + </inlinemediaobject> Different binary files</member> <member><inlinemediaobject> <imageobject> - <imagedata contentwidth="16" fileref="screenshots/binarydiff.png" + <imagedata contentwidth="16" fileref="screenshots/notequal.png" format="PNG" /> </imageobject> - </inlinemediaobject> Different binary files</member> + </inlinemediaobject> Different files (type undetermined)</member> <member><inlinemediaobject> <imageobject> Modified: trunk/Docs/Users/Manual/Compare_files.xml =================================================================== --- trunk/Docs/Users/Manual/Compare_files.xml 2009-05-22 12:33:31 UTC (rev 6772) +++ trunk/Docs/Users/Manual/Compare_files.xml 2009-05-22 13:21:56 UTC (rev 6773) @@ -1245,6 +1245,10 @@ <primary>WinMerge functions</primary> <secondary>difference navigation in File Compare window</secondary> + </indexterm><indexterm> + <primary>navigation functions</primary> + + <secondary>file compare</secondary> </indexterm></title> <para>Here are the functions for navigating differences in the File @@ -1259,22 +1263,6 @@ </indexterm></term> <listitem> - <para>Shortcuts: <inlinemediaobject> - <imageobject> - <imagedata contentdepth="15" - fileref="screenshots/diff_inline_btn.png" /> - </imageobject> - - <textobject> - <phrase>Difference in the Current Line button</phrase> - </textobject> - </inlinemediaobject> button, <menuchoice> - <guimenu>Edit</guimenu> - - <guimenuitem>Select Line Difference</guimenuitem> - </menuchoice>, <keycap>F4</keycap>, context menu in File pane - within a difference.</para> - <para>Enabled if you have clicked in (or selected) text within a difference in a File pane. Selects the word differences within the line. For example:</para> @@ -1292,6 +1280,22 @@ <para>If you want to select the difference block itself, use <command>Current Difference</command> instead.</para> + + <para>Shortcuts: <inlinemediaobject> + <imageobject> + <imagedata contentdepth="15" + fileref="screenshots/diff_inline_btn.png" /> + </imageobject> + + <textobject> + <phrase>Difference in the Current Line button</phrase> + </textobject> + </inlinemediaobject> button, <menuchoice> + <guimenu>Edit</guimenu> + + <guimenuitem>Select Line Difference</guimenuitem> + </menuchoice>, <keycap>F4</keycap>, context menu in File pane + within a difference.</para> </listitem> </varlistentry> @@ -1303,6 +1307,12 @@ </indexterm></term> <listitem> + <para>Selects the next difference below your current cursor location + in the document (not necessarily relative to the current + difference). Use to step through differences sequentially from any + point. Available except when the last difference is currently + selected.</para> + <para>Shortcuts: <inlinemediaobject> <imageobject> <imagedata contentdepth="15" @@ -1321,12 +1331,6 @@ <keycap>Down</keycap> </keycombo> (or <keycap>Down</keycap> in merge mode).</para> - - <para>Selects the next difference below your current cursor location - in the document (not necessarily relative to the current - difference). Use to step through differences sequentially from any - point. Available except when the last difference is currently - selected.</para> </listitem> </varlistentry> @@ -1338,6 +1342,11 @@ </indexterm></term> <listitem> + <para>Selects the previous difference above your current cursor + location (not necessarily relative to the current difference). Use + to step backwards sequentially through differences. Available except + when the first difference is currently selected.</para> + <para>Shortcuts: <inlinemediaobject> <imageobject> <imagedata contentdepth="15" @@ -1356,11 +1365,6 @@ <keycap>Up</keycap> </keycombo> (or <keycap>Up</keycap> in merge mode).</para> - - <para>Selects the previous difference above your current cursor - location (not necessarily relative to the current difference). Use - to step backwards sequentially through differences. Available except - when the first difference is currently selected.</para> </listitem> </varlistentry> @@ -1372,6 +1376,11 @@ </indexterm></term> <listitem> + <para>Use this to begin comparing or merging differences, or to + locate the first difference from any other location. Available + except when the first difference is currently selected. You can also + select a difference by double-clicking its text.</para> + <para>Shortcuts: <inlinemediaobject> <imageobject> <imagedata contentdepth="15" @@ -1390,11 +1399,6 @@ <keycap>Home</keycap> </keycombo>.</para> - - <para>Use this to begin comparing or merging differences, or to - locate the first difference from any other location. Available - except when the first difference is currently selected. You can also - select a difference by double-clicking its text.</para> </listitem> </varlistentry> @@ -1406,6 +1410,24 @@ </indexterm></term> <listitem> + <para>This function has two modes of action:</para> + + <para><itemizedlist> + <listitem> + <simpara>If your cursor is inside a difference but no + difference is selected, this function selects the entire + difference. This is a very handy way to select a difference + using the keyboard.</simpara> + </listitem> + + <listitem> + <simpara>When there is a current difference, the function + jumps to that location. This is handy if you have scrolled the + selected difference out of view, and want to quickly return to + its location.</simpara> + </listitem> + </itemizedlist></para> + <para>Shortcuts: <inlinemediaobject> <imageobject> <imagedata contentdepth="15" @@ -1424,24 +1446,6 @@ <keycap>Enter</keycap> </keycombo>.</para> - - <para>This function has two modes of action:</para> - - <para><itemizedlist> - <listitem> - <simpara>If your cursor is inside a difference but no - difference is selected, this function selects the entire - difference. This is a very handy way to select a difference - using the keyboard.</simpara> - </listitem> - - <listitem> - <simpara>When there is a current difference, the function - jumps to that location. This is handy if you have scrolled the - selected difference out of view, and want to quickly return to - its location.</simpara> - </listitem> - </itemizedlist></para> </listitem> </varlistentry> @@ -1457,6 +1461,9 @@ </indexterm></term> <listitem> + <para>Enabled except when the last difference is currently + selected.</para> + <para>Shortcuts: <inlinemediaobject> <imageobject> <imagedata contentdepth="15" @@ -1475,9 +1482,6 @@ <keycap>End</keycap> </keycombo>.</para> - - <para>Enabled except when the last difference is currently - selected.</para> </listitem> </varlistentry> @@ -1487,16 +1491,6 @@ </indexterm></term> <listitem> - <para>Shortcuts: <menuchoice> - <guimenu>Edit</guimenu> - - <guimenuitem>Go to</guimenuitem> - </menuchoice>, <keycombo> - <keycap>Ctrl</keycap> - - <keycap>G</keycap> - </keycombo>, context menu in File pane and Location pane.</para> - <para>Enables you to jump to either a line number or a difference number (for example, difference 2 is the second difference). Opens the Go To dialog, where you specify the number, which file to use @@ -1510,6 +1504,16 @@ <guimenuitem>Find</guimenuitem> to search text, or stepping through differences.</para> </tip> + + <para>Shortcuts: <menuchoice> + <guimenu>Edit</guimenu> + + <guimenuitem>Go to</guimenuitem> + </menuchoice>, <keycombo> + <keycap>Ctrl</keycap> + + <keycap>G</keycap> + </keycombo>, context menu in File pane and Location pane.</para> </listitem> </varlistentry> @@ -1529,10 +1533,10 @@ <primary>merging differences</primary> </indexterm></title> - <para>Merging differences amounts to copying them from one File pane to the - other: either left to right, or right to left. This is different from - directly editing text using WinMerge's editing functions (described earlier - in this topic).</para> + <para>Merging copies differences from one File pane to the other: either + left to right, or right to left. This is different from directly editing + text using WinMerge's editing functions (described earlier in this + topic).</para> <section id="Compare_files_scan"> <title>Rescanning files<indexterm> @@ -1540,22 +1544,25 @@ </indexterm></title> <para>By default, the <guilabel>Automatic rescan</guilabel> option is - enabled in the Editor page of WinMerge options. WinMerge rescans your - files after every change to update its difference mapping. Without - rescanning, WinMerge differences might not be synchronized with the - current content of the files, causing unpredictable merge results.</para> + enabled in the Editor page of WinMerge options. Rescanning keeps your your + compare and merge operations up to date. Without rescanning, WinMerge + differences does not detect changes that might occur to files while you + are comparing them, for example in an external editor.</para> - <note> - <para>Rescanning does not reload files. Therefore, if an external - program has updated a file, those changes are not seen in WinMerge: only - changes made in WinMerge are used to update differences.</para> - </note> + <para>Rescanning occurs when you perform certain actions (like merging a + difference or editing a file) during a file compare. If a file has + changed, WinMerge displays a dialog advising you that another application + has updated the file, and asks whether you want to reload the file.</para> + <para>Click <guibutton>Yes</guibutton> to reload the file before + proceeding, or <guibutton>No</guibutton> to ignore the changes and work + with the earlier loaded version of the file.</para> + <important> - <para>If <guilabel>Automatic rescan</guilabel> is disabled, we strongly - advise that you run <guimenuitem>Refresh</guimenuitem> - <emphasis>before</emphasis> performing any merge operation: click - <menuchoice> + <para>If <guilabel>Automatic rescan</guilabel> is disabled, or if you + suspect that a file might have changed, we strongly advise that you run + <guimenuitem>Refresh</guimenuitem> <emphasis>before</emphasis> + performing any merge operation: click <menuchoice> <guimenu>Edit</guimenu> <guimenuitem>Refresh</guimenuitem> @@ -1611,6 +1618,12 @@ </indexterm></term> <listitem> + <para>Copies one or more difference from left to right. Note that + differences do not need to be fully selected: At its simplest, this + means replacing text in the target difference with text in source + difference. But because differences can also contain empty lines, + new lines may be created or removed.</para> + <para>Shortcuts: <inlinemediaobject> <imageobject> <imagedata contentwidth="17" @@ -1630,12 +1643,6 @@ <keycap>Right</keycap> </keycombo> ( or <keycap>Right</keycap> in merge mode), context menu in File pane within a difference, and in Diff pane.</para> - - <para>Copies one or more difference from left to right. Note that - differences do not need to be fully selected: At its simplest, this - means replacing text in the target difference with text in source - difference. But because differences can also contain empty lines, - new lines may be created or removed.</para> </listitem> </varlistentry> @@ -1645,6 +1652,10 @@ </indexterm></term> <listitem> + <para>Copies the current difference from the right to the left File + pane. See <command>Copy Righ</command>t description for + details.</para> + <para>Shortcuts: <inlinemediaobject> <imageobject> <imagedata contentwidth="17" @@ -1664,10 +1675,6 @@ <keycap>Left</keycap> </keycombo> (or <keycap>Left</keycap> in merge mode), context menu in File pane within a difference, and in Diff pane.</para> - - <para>Copies the current difference from the right to the left File - pane. See <command>Copy Righ</command>t description for - details.</para> </listitem> </varlistentry> @@ -1677,6 +1684,11 @@ </indexterm></term> <listitem> + <para>Merges the current difference from the right to the left File + pane, then selects the next difference (if one exists). Equivalent + to <command>Copy Right</command> and <command>Next + Difference</command> in one step.</para> + <para>Shortcuts: <inlinemediaobject> <imageobject> <imagedata contentdepth="15" @@ -1697,11 +1709,6 @@ <keycap>Right</keycap> </keycombo>, context menu in File pane within a difference.</para> - - <para>Merges the current difference from the right to the left File - pane, then selects the next difference (if one exists). Equivalent - to <command>Copy Right</command> and <command>Next - Difference</command> in one step.</para> </listitem> </varlistentry> @@ -1711,6 +1718,11 @@ </indexterm></term> <listitem> + <para>Merges the current difference from left to right, then selects + the next difference (if one exists). Equivalent to <command>Copy + Left</command> and <command>Next Difference</command> in one + step.</para> + <para>Shortcuts: <inlinemediaobject> <imageobject> <imagedata contentdepth="15" @@ -1731,11 +1743,6 @@ <keycap>Left</keycap> </keycombo>, context menu in File pane within a difference.</para> - - <para>Merges the current difference from left to right, then selects - the next difference (if one exists). Equivalent to <command>Copy - Left</command> and <command>Next Difference</command> in one - step.</para> </listitem> </varlistentry> @@ -1745,6 +1752,23 @@ </indexterm></term> <listitem> + <para>Copies all differences from the left to the right File pane. + Use to synchronize two files with one command. Similarly, you can + back out the entire merge by clicking the<inlinemediaobject> + <imageobject> + <imagedata contentdepth="11" + fileref="screenshots/undo_btn.png" /> + </imageobject> + + <textobject> + <phrase>Refresh button</phrase> + </textobject> + </inlinemediaobject> Undo or pressing <keycombo> + <keycap>Ctrl</keycap> + + <keycap>Z</keycap> + </keycombo>.</para> + <para>Shortcuts: <inlinemediaobject> <imageobject> <imagedata contentdepth="15" @@ -1763,23 +1787,6 @@ <keycap>Left</keycap> </keycombo>, context menu in File pane within a difference.</para> - - <para>Copies all differences from the left to the right File pane. - Use to synchronize two files with one command. Similarly, you can - back out the entire merge by clicking the<inlinemediaobject> - <imageobject> - <imagedata contentdepth="11" - fileref="screenshots/undo_btn.png" /> - </imageobject> - - <textobject> - <phrase>Refresh button</phrase> - </textobject> - </inlinemediaobject> Undo or pressing <keycombo> - <keycap>Ctrl</keycap> - - <keycap>Z</keycap> - </keycombo>.</para> </listitem> </varlistentry> @@ -1789,6 +1796,10 @@ </indexterm></term> <listitem> + <para>Copies all differences from the right to the left File pane. + Effectively, replaces the content of the left File pane. See similar + to <command>All Right</command>.</para> + <para>Shortcuts: <inlinemediaobject> <imageobject> <imagedata contentdepth="15" @@ -1807,10 +1818,6 @@ <keycap>Left</keycap> </keycombo>, context menu in File pane within a difference.</para> - - <para>Copies all differences from the right to the left File pane. - Effectively, replaces the content of the left File pane. See similar - to <command>All Right</command>.</para> </listitem> </varlistentry> @@ -1822,6 +1829,10 @@ </indexterm></term> <listitem> + <para>Rescans files to update differences. Use after changes are + made to files, if automatic scanning is disabled (see <xref + linkend="Compare_files_scan" /> for details).</para> + <para>Shortcuts: <inlinemediaobject> <imageobject> <imagedata contentwidth="16" @@ -1836,10 +1847,6 @@ <guimenuitem>Refresh</guimenuitem> </menuchoice>, <keycap>F5</keycap>.</para> - - <para>Rescans files to update differences. Use after changes are - made to files, if automatic scanning is disabled (see <xref - linkend="Compare_files_scan" /> for details).</para> </listitem> </varlistentry> </variablelist> Modified: trunk/Docs/Users/Manual/Configuration.xml =================================================================== --- trunk/Docs/Users/Manual/Configuration.xml 2009-05-22 12:33:31 UTC (rev 6772) +++ trunk/Docs/Users/Manual/Configuration.xml 2009-05-22 13:21:56 UTC (rev 6773) @@ -284,6 +284,30 @@ </section> <section> + <title>Show "Select Files or Folders" Dialog on Startup<indexterm> + <primary>Select Files or Folders dialog</primary> + + <secondary>opening automatically</secondary> + </indexterm></title> + + <itemizedlist> + <listitem> + <para><option>Disabled</option> (default): The WinMerge window opens + when you launch WinMerge. You must then click <menuchoice> + <guimenu>File</guimenu> + + <guimenuitem>Open</guimenuitem> + </menuchoice> to open Select Files or Folders.</para> + </listitem> + + <listitem> + <para><option>Enabled</option>: The Select Files or Folders dialog + opens along with the WinMerge window when you launch WinMerge.</para> + </listitem> + </itemizedlist> + </section> + + <section> <title>Open-dialog Auto-Completion<indexterm> <primary>MRU list</primary> </indexterm></title> @@ -1583,7 +1607,7 @@ WinMerge.</para> </note> - <para> <xref linkend="CompareDirs_winshell" /> has more information + <para><xref linkend="CompareDirs_winshell" /> has more information about using the shell menus.</para> </listitem> </itemizedlist> Modified: trunk/Docs/Users/Manual/Install.xml =================================================================== --- trunk/Docs/Users/Manual/Install.xml 2009-05-22 12:33:31 UTC (rev 6772) +++ trunk/Docs/Users/Manual/Install.xml 2009-05-22 13:21:56 UTC (rev 6773) @@ -94,7 +94,7 @@ <listitem> <para>File filter files enable you to narrow the scope of - comparisons. </para> + comparisons.</para> </listitem> </varlistentry> @@ -181,6 +181,15 @@ </varlistentry> <varlistentry> + <term>Add WinMerge folder to your system path</term> + + <listitem> + <para>Adds the WinMerge installation folder to your system's Path + environment variable.</para> + </listitem> + </varlistentry> + + <varlistentry> <term>Integrate with TortoiseCVS<indexterm> <primary>TortoiseCVS integration</primary> </indexterm></term> @@ -201,7 +210,7 @@ </varlistentry> <varlistentry> - <term>Integrate with ClearCase<indexterm> + <term>Integrate with Rational ClearCase<indexterm> <primary>ClearCase integration</primary> <secondary>configuring during installation</secondary> @@ -485,4 +494,4 @@ </orderedlist></para> </section> </section> -</article> +</article> \ No newline at end of file Modified: trunk/Docs/Users/Manual/Version_control.xml =================================================================== --- trunk/Docs/Users/Manual/Version_control.xml 2009-05-22 12:33:31 UTC (rev 6772) +++ trunk/Docs/Users/Manual/Version_control.xml 2009-05-22 13:21:56 UTC (rev 6773) @@ -13,13 +13,13 @@ tools.</para> <section> - <title>Using the command-line interface (CLI) </title> + <title>Using the command-line interface (CLI)</title> <para>The WinMerge command-line interface (CLI), described in <xref linkend="CommandLine" />, enables you to run WinMerge from a Command Prompt window, from scripts, or from another tool or program. Basically, any program that allows you to call an external executable with at least one - path, can be used to launch a WinMerge operation. </para> + path, can be used to launch a WinMerge operation.</para> <para>Here are just a few examples:</para> @@ -166,7 +166,7 @@ <orderedlist> <listitem> - <para>In Windows explorer, hold <keycap>Ctrl</keycap>, select any two + <para>In Windows Explorer, hold <keycap>Ctrl</keycap>, select any two files, and right-click.</para> </listitem> Modified: trunk/Docs/Users/Manual/screenshots/equal.png =================================================================== (Binary files differ) Modified: trunk/Docs/Users/Manual/screenshots/notequal.png =================================================================== (Binary files differ) This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site. |
From: <den...@us...> - 2009-05-28 12:57:38
|
Revision: 6797 http://winmerge.svn.sourceforge.net/winmerge/?rev=6797&view=rev Author: denisbradford Date: 2009-05-28 12:57:29 +0000 (Thu, 28 May 2009) Log Message: ----------- Document map.bak for ClearCase integration in Version_control.xml, add links in Configuration.xml and Install.xml Modified Paths: -------------- trunk/Docs/Users/Manual/Configuration.xml trunk/Docs/Users/Manual/Install.xml trunk/Docs/Users/Manual/Version_control.xml Modified: trunk/Docs/Users/Manual/Configuration.xml =================================================================== --- trunk/Docs/Users/Manual/Configuration.xml 2009-05-28 10:07:38 UTC (rev 6796) +++ trunk/Docs/Users/Manual/Configuration.xml 2009-05-28 12:57:29 UTC (rev 6797) @@ -1384,9 +1384,14 @@ <listitem> <para><guilabel>Rational ClearCase</guilabel></para> - <para>Also enter the path to <filename>cleartool.exe</filename>.</para> + <para>Also enter the path to <filename>cleartool.exe</filename>. </para> </listitem> </itemizedlist> + + <note> + <para>If you are changing the WinMerge integration with ClearCase, please + see <xref linkend="VersionControl_cc" /> for details.</para> + </note> </section> <section id="Configuration_codepage"> Modified: trunk/Docs/Users/Manual/Install.xml =================================================================== --- trunk/Docs/Users/Manual/Install.xml 2009-05-28 10:07:38 UTC (rev 6796) +++ trunk/Docs/Users/Manual/Install.xml 2009-05-28 12:57:29 UTC (rev 6797) @@ -218,7 +218,8 @@ <listitem> <para>Sets WinMerge to be the ClearCase diff and merge - application</para> + application. <xref linkend="VersionControl_cc" /> has details + about changes to your ClearCase installation.</para> </listitem> </varlistentry> Modified: trunk/Docs/Users/Manual/Version_control.xml =================================================================== --- trunk/Docs/Users/Manual/Version_control.xml 2009-05-28 10:07:38 UTC (rev 6796) +++ trunk/Docs/Users/Manual/Version_control.xml 2009-05-28 12:57:29 UTC (rev 6797) @@ -5,12 +5,11 @@ </indexterm></title> <para>Comparing and merging files are often subtasks in a larger change - management process. For that reason, WinMerge is often not used by itself, but - in conjunction with other tools. In addition, even though many programs have - built-in diff and merge utilities, none provides all the features their users - need, so it's sometimes handy to combine different tools. This topic describes - the two important WinMerge features that facilitate working with other - tools.</para> + management process. For that reason, WinMerge is often used not just by + itself, but also in conjunction with other tools. In addition, diff and merge + utilities provide different features, so it's sometimes handy to combine + different tools. This topic describes the primary methods for using WinMerge + with other tools.</para> <section> <title>Using the command-line interface (CLI)</title> @@ -56,24 +55,25 @@ </indexterm></title> <para>WinMerge can integrate some key functions with a few, specific version - control system (VCS) tools. You can configure the optional VCS integrations - during or after WinMerge installation.</para> + control system (VCS) tools. There are two methods for configuring optional + VCS integrations: either during WinMerge installation or after + installation:</para> - <para>If the WinMerge installer detects that TortoiseSVN, TortoiseCVS, or - Rational ClearCase are present on your system, the Setup Additional Tasks - page contains options to enable any of the WinMerge integrations.</para> + <itemizedlist> + <listitem> + <para>If the WinMerge installer detects that TortoiseSVN, TortoiseCVS, + or Rational ClearCase is present on your system, the Setup Additional + Tasks page contains options to enable its WinMerge integration. The + installer does not detect Visual SourceSafe.</para> + </listitem> - <para>After installation, you can open the Options dialog and configure - either the ClearCase or Visual SourceSafe integration, as described in <xref - linkend="Configuration_vcs" />.</para> + <listitem> + <para>After installation, you can open the Options dialog and configure + either the ClearCase or Visual SourceSafe integration, as described in + <xref linkend="Configuration_vcs" />.</para> + </listitem> + </itemizedlist> - <note> - <para>Only the ClearCase integration can be configured using both methods. - You can configure TortoiseSVN and TortoiseCVS only during installation; - conversely, you can configure Visual SourceSafe (which is not detected by - the installer) only in the Options dialog.</para> - </note> - <para>Each WinMerge version control integration has one of these basic types of interaction:</para> @@ -85,8 +85,8 @@ <para>With version control systems that lock files (for example, ClearCase and Visual Source Safe), WinMerge opens the VCS's checkout dialog before saving a file. It is up to you to check out the file, - and then to check in the file later using the version control system's - tools. WinMerge does not provide checkin or history tools.</para> + and then to check in the file later using the VCS tools. WinMerge does + not provide checkin or history tools.</para> </listitem> </varlistentry> @@ -101,11 +101,65 @@ </varlistentry> </variablelist> - <example> - <title>TortoiseSVN integration<indexterm> - <primary>TortoiseSVN integration</primary> - </indexterm></title> + <note> + <para>If you enable the ClearCase integration</para> + </note> + <section id="VersionControl_cc"> + <title>About the ClearCase integration</title> + + <para>If you use choose the option to integrate with Rational ClearCase + during WinMerge installation, the installer:</para> + + <orderedlist> + <listitem> + <para>Creates a backup copy of the ClearCase <filename>map</filename> + file, <filename>map.bak</filename>, in the + <filename><replaceable>ccase-home-dir</replaceable>\lib\mgrs</filename> + directory. The <filename>map</filename> file is a user-configurable + file that associates ClearCase methods with the programs that carry + them out.</para> + </listitem> + + <listitem> + <para>In the the <filename>map</filename> file, modifies the + <guilabel>text_file_delta</guilabel> field to specify WinMerge instead + of the default <filename>cleardiff.exe</filename> when running the + <command>cleartool diff</command> command.</para> + </listitem> + </orderedlist> + + <para>If you later want to disable the ClearCase integration, click + <menuchoice> + <guimenu>Edit</guimenu> + + <guimenuitem>Options</guimenuitem> + </menuchoice>, open the Version Control integration page, and choose the + option, <option>None</option>. If for some reason ClearCase still uses + WinMerge for diff operations, try one of these methods:</para> + + <itemizedlist> + <listitem> + <para>Replace the ClearCase <filename>map</filename> file created by + the WinMerge installer with the <filename>map.bak</filename> backup + file or </para> + </listitem> + + <listitem> + <para>Edit the ClearCase <filename>map</filename> file to run + <filename>cleardiff.exe</filename> for the <command>cleartool + diff</command> command. </para> + </listitem> + </itemizedlist> + </section> + + <section> + <title>Tortoise SVN integration: example</title> + + <indexterm> + <primary>TortoiseSVN integration</primary> + </indexterm> + <para>TortoiseSVN is a Windows client for Subversion (SVN), an open source version control system. TortoiseSVN provides its own diff utility. The WinMerge integration with this VCS enables you to use WinMerge to compare @@ -181,14 +235,16 @@ File Compare window.</para> </listitem> </orderedlist> - </example> + </section> - <example> - <title>Visual Source Safe integration<indexterm> - <primary>Visual SourceSafe integration</primary> - </indexterm></title> + <section> + <title>Visual Source Safe integration: example</title> - <para>This example demonstrates the file checkout type of VCS + <indexterm> + <primary>Visual SourceSafe integration</primary> + </indexterm> + + <para>This example demonstrates a file checkout using the VSS integration.</para> <orderedlist> @@ -279,6 +335,6 @@ broken.</para> </listitem> </itemizedlist> - </example> + </section> </section> </article> \ No newline at end of file This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site. |
From: <den...@us...> - 2009-05-29 19:39:47
|
Revision: 6805 http://winmerge.svn.sourceforge.net/winmerge/?rev=6805&view=rev Author: denisbradford Date: 2009-05-29 19:39:33 +0000 (Fri, 29 May 2009) Log Message: ----------- Fix incorrect documentation on VCS integration. Modified Paths: -------------- trunk/Docs/Users/Manual/Configuration.xml trunk/Docs/Users/Manual/Install.xml trunk/Docs/Users/Manual/Version_control.xml Modified: trunk/Docs/Users/Manual/Configuration.xml =================================================================== --- trunk/Docs/Users/Manual/Configuration.xml 2009-05-29 09:49:24 UTC (rev 6804) +++ trunk/Docs/Users/Manual/Configuration.xml 2009-05-29 19:39:33 UTC (rev 6805) @@ -1358,17 +1358,16 @@ <secondary>with version control systems</secondary> </indexterm></title> - <!--What does version control integration do for me? How do the Option page settings work with installed -VCS integration? My installation had an option to integrate with TortoiseSVN.--> + <para>Use this page to enable or disable checkouts through an installed + version control system (VCS) that you select here. If you enable this + integration with one of the supported systems, WinMerge opens the checkout + dialog for that VCS when you save a versioned file in WinMerge.</para> - <para>Use this page to configure or disable the WinMerge integration with a - supported versioning system.</para> - - <para>Choose one of these options:</para> - <itemizedlist> <listitem> - <para><guilabel>None</guilabel> (default)</para> + <para><guilabel>None</guilabel> (default): When you save a file in + WinMerge, there are no interactions with any version control + system.</para> </listitem> <listitem> @@ -1384,14 +1383,12 @@ <listitem> <para><guilabel>Rational ClearCase</guilabel></para> - <para>Also enter the path to <filename>cleartool.exe</filename>. </para> + <para>Also enter the path to <filename>cleartool.exe</filename>.</para> </listitem> </itemizedlist> - <note> - <para>If you are changing the WinMerge integration with ClearCase, please - see <xref linkend="VersionControl_cc" /> for details.</para> - </note> + <para>See <xref linkend="VersionControl_vcs" /> for details about using this + feature.</para> </section> <section id="Configuration_codepage"> Modified: trunk/Docs/Users/Manual/Install.xml =================================================================== --- trunk/Docs/Users/Manual/Install.xml 2009-05-29 09:49:24 UTC (rev 6804) +++ trunk/Docs/Users/Manual/Install.xml 2009-05-29 19:39:33 UTC (rev 6805) @@ -205,7 +205,7 @@ </indexterm></term> <listitem> - <para>Sets WinMerge to be the TortoiseSVN diff application</para> + <para>Sets WinMerge to be the TortoiseSVN diff application.</para> </listitem> </varlistentry> @@ -217,9 +217,11 @@ </indexterm></term> <listitem> - <para>Sets WinMerge to be the ClearCase diff and merge - application. <xref linkend="VersionControl_cc" /> has details - about changes to your ClearCase installation.</para> + <para>Sets WinMerge to be the ClearCase diff application.</para> + + <para>For more information about the three integrations in this + list and related WinMerge options, see <xref + linkend="VersionControl_vcs" />.</para> </listitem> </varlistentry> @@ -262,7 +264,7 @@ <section id="InstallFromArchive"> <title>Installing from an archive<indexterm> - <primary>archive, installing Winmerge from</primary> + <primary>archive, installing WinMerge from</primary> </indexterm><indexterm> <primary>mfc71[u].dll runtime file</primary> </indexterm><indexterm> Modified: trunk/Docs/Users/Manual/Version_control.xml =================================================================== --- trunk/Docs/Users/Manual/Version_control.xml 2009-05-29 09:49:24 UTC (rev 6804) +++ trunk/Docs/Users/Manual/Version_control.xml 2009-05-29 19:39:33 UTC (rev 6805) @@ -41,300 +41,261 @@ <tip> <para>Similarly, many GUI tools (like version control clients and IDEs) that include built-in diff tools enable you to configure WinMerge as their - default diff tool, instead. Examples include TortoiseSVN, Eclipse, and - Perforce. Check their documentation or search the Internet for details and - examples.</para> + default diff tool, instead. The next section describes how to use WinMerge + this way with TortoiseSVN, TortoiseCVS, and ClearCase. For other tools, + like Eclipse and Perforce, check their documentation or search the + Internet for details and examples.</para> </tip> </section> - <section> - <title>Integration with version control tools<indexterm> + <section id="VersionControl_vcs"> + <title>Using WinMerge with version control systems<indexterm> <primary>version control systems</primary> <secondary>integration with</secondary> </indexterm></title> - <para>WinMerge can integrate some key functions with a few, specific version - control system (VCS) tools. There are two methods for configuring optional - VCS integrations: either during WinMerge installation or after - installation:</para> + <para>You can configure WinMerge to interact with a few supported version + control systems (VCS) in two ways. This section describes the two types of + VCS integration and provides an example of each.</para> - <itemizedlist> - <listitem> - <para>If the WinMerge installer detects that TortoiseSVN, TortoiseCVS, - or Rational ClearCase is present on your system, the Setup Additional - Tasks page contains options to enable its WinMerge integration. The - installer does not detect Visual SourceSafe.</para> - </listitem> + <section> + <title>Checking out versioned files from WinMerge</title> - <listitem> - <para>After installation, you can open the Options dialog and configure - either the ClearCase or Visual SourceSafe integration, as described in - <xref linkend="Configuration_vcs" />.</para> - </listitem> - </itemizedlist> + <indexterm> + <primary>Visual SourceSafe integration</primary> + </indexterm> - <para>Each WinMerge version control integration has one of these basic types - of interaction:</para> + <para>When you save a file in WinMerge and the file is a versioned + ClearCase or Visual Source Safe element, WinMerge can open the VCS's + checkout dialog for you. This makes it easy to check out files as you are + working in WinMerge. However, WinMerge does not provide checkin or history + tools, so remember to check the files in later using the VCS + interface.</para> - <variablelist> - <varlistentry> - <term>WinMerge launches VCS file checkout</term> - - <listitem> - <para>With version control systems that lock files (for example, - ClearCase and Visual Source Safe), WinMerge opens the VCS's checkout - dialog before saving a file. It is up to you to check out the file, - and then to check in the file later using the VCS tools. WinMerge does - not provide checkin or history tools.</para> - </listitem> - </varlistentry> - - <varlistentry> - <term>VCS use WinMerge as its diff tool</term> - - <listitem> - <para>When you start a diff operation using TortoiseSVN and - TortoiseCVS, the integration opens WinMerge instead of the VCS - client's own diff utility.</para> - </listitem> - </varlistentry> - </variablelist> - - <note> - <para>If you enable the ClearCase integration</para> - </note> - - <section id="VersionControl_cc"> - <title>About the ClearCase integration</title> - - <para>If you use choose the option to integrate with Rational ClearCase - during WinMerge installation, the installer:</para> - - <orderedlist> - <listitem> - <para>Creates a backup copy of the ClearCase <filename>map</filename> - file, <filename>map.bak</filename>, in the - <filename><replaceable>ccase-home-dir</replaceable>\lib\mgrs</filename> - directory. The <filename>map</filename> file is a user-configurable - file that associates ClearCase methods with the programs that carry - them out.</para> - </listitem> - - <listitem> - <para>In the the <filename>map</filename> file, modifies the - <guilabel>text_file_delta</guilabel> field to specify WinMerge instead - of the default <filename>cleardiff.exe</filename> when running the - <command>cleartool diff</command> command.</para> - </listitem> - </orderedlist> - - <para>If you later want to disable the ClearCase integration, click - <menuchoice> + <para>This integration is available after WinMerge installation. To enable + or disable the integration, click <menuchoice> <guimenu>Edit</guimenu> <guimenuitem>Options</guimenuitem> </menuchoice>, open the Version Control integration page, and choose the - option, <option>None</option>. If for some reason ClearCase still uses - WinMerge for diff operations, try one of these methods:</para> + appropriate option.</para> - <itemizedlist> - <listitem> - <para>Replace the ClearCase <filename>map</filename> file created by - the WinMerge installer with the <filename>map.bak</filename> backup - file or </para> - </listitem> + <example> + <title>Visual Source Safe integration</title> - <listitem> - <para>Edit the ClearCase <filename>map</filename> file to run - <filename>cleardiff.exe</filename> for the <command>cleartool - diff</command> command. </para> - </listitem> - </itemizedlist> - </section> + <para>Here is a sample file checkout using the VSS integration.</para> - <section> - <title>Tortoise SVN integration: example</title> + <orderedlist> + <listitem> + <para>Launch a WinMerge file or folder comparison whose left or + right target is under version control.</para> + </listitem> - <indexterm> - <primary>TortoiseSVN integration</primary> - </indexterm> + <listitem> + <para>In WinMerge, edit a version-controlled file.</para> + </listitem> - <para>TortoiseSVN is a Windows client for Subversion (SVN), an open source - version control system. TortoiseSVN provides its own diff utility. The - WinMerge integration with this VCS enables you to use WinMerge to compare - files instead of the TortoiseSVN diff tool.</para> + <listitem> + <para>Save your changes. WinMerge detects that the file is + read-only, and assumes that it is under Visual Source Safe version + control. WinMerge opens a Visual Source Save dialog, like + this:</para> - <para>One of the main uses of TortoiseSVN's diff is to see the most recent - changes to a file that is under version control: that is, a file that you - have checked out into a working copy. The following procedure illustrates - such an operation using the WinMerge integration with TortoiseSVN. The - integration with TortoiseCVS is similar.</para> + <mediaobject> + <imageobject> + <imagedata fileref="screenshots/sourcesafe1.png" format="PNG" /> + </imageobject> + </mediaobject> + </listitem> - <orderedlist> - <listitem> - <para>In Windows Explorer, navigate to a Subversion working copy that - you have checked out.</para> - </listitem> + <listitem> + <para>In the <guilabel>Database</guilabel> dropdown list, choose the + correct Visual SourceSafe database if there is more than one on your + system.</para> + </listitem> - <listitem> - <para>Right-click a file that is under Subversion management (usually - indicated by a distinct TortoiseSVN icon), and click - <guimenu>TortoiseSVN</guimenu> in the context menu.</para> + <listitem> + <para>The <guilabel>Project</guilabel> field shows the selected + file's location relative to the Visual SourceSafe database path. + Verify that the path is correct: most errors are caused by the wrong + project path. If you change folders, remember to change the project + path, too!</para> + </listitem> - <itemizedlist> - <listitem> - <para>If the file has not been modified, the context menu contains - the shortcut, <guimenuitem>Diff with previous - version</guimenuitem>. This command compares the checked-out - version of the file with the previous version that was checked in - to the repository.</para> - </listitem> + <listitem> + <para>Enter your password if required. WinMerge remembers your + password for the current session, but for your security does not + store it. Therefore, you don't need to retype the password during a + session, but you must retype the password each time you open + WinMerge.</para> + </listitem> - <listitem> - <para>If you have modified the file, the context menu contains the - same <guimenuitem>Diff with previous version</guimenuitem> - shortcut, plus the <guimenuitem>Diff</guimenuitem> shortcut. This - command compares your revision to the current version (the one you - checked out). It is useful for reviewing the changes you have - made.</para> - </listitem> - </itemizedlist> - </listitem> + <listitem> + <para>Optionally, enable one or both of these options:</para> - <listitem> - <para>Choose either the <guimenuitem>Diff with previous - version</guimenuitem> or <guimenuitem>Diff</guimenuitem> shortcut. The - WinMerge window opens, with the target file versions loaded In the - File Compare window.</para> - </listitem> - </orderedlist> + <itemizedlist> + <listitem> + <para><guilabel>Link to Destination VSS + project</guilabel></para> + </listitem> - <para>The <menuchoice> - <guimenu>TortoiseSVN</guimenu> + <listitem> + <para><guilabel>Apply to all items</guilabel>. This option + enables you to check out multiple files in a single directory + when you copy files in a folder compare operation.</para> + </listitem> + </itemizedlist> + </listitem> + </orderedlist> - <guimenuitem>Diff</guimenuitem> - </menuchoice> shortcut is available for comparing any two files in your - file system, not just files that are managed by Subversion. To illustrate - how the WinMerge integration works in this case:</para> + <para>Unfortunately, VSS provides very little information about error + conditions beyond the fact that they occur. If an operation fails, + causes might include any of the following conditions:</para> - <orderedlist> - <listitem> - <para>In Windows Explorer, hold <keycap>Ctrl</keycap>, select any two - files, and right-click.</para> - </listitem> + <itemizedlist> + <listitem> + <para>Another user might have the file checked out with exclusive + access.</para> + </listitem> - <listitem> - <para>Choose <menuchoice> - <guimenu>TortoiseSVN</guimenu> + <listitem> + <para>You might have specified the wrong project.</para> + </listitem> - <guimenuitem>Diff</guimenuitem> - </menuchoice> in the context menu.</para> + <listitem> + <para>You might have entered the project name incorrectly.</para> + </listitem> - <para>The WinMerge window opens, with the selected files loaded In the - File Compare window.</para> - </listitem> - </orderedlist> + <listitem> + <para>You might not have used a valid VSS path (for example, this is + incorrect: <userinput>$/MyProject/res</userinput>).</para> + </listitem> + + <listitem> + <para>Your connection to the VSS server computer might be + broken.</para> + </listitem> + </itemizedlist> + </example> </section> <section> - <title>Visual Source Safe integration: example</title> + <title>Using WinMerge as a version control system's diff tool</title> <indexterm> - <primary>Visual SourceSafe integration</primary> + <primary>TortoiseSVN integration</primary> </indexterm> - <para>This example demonstrates a file checkout using the VSS - integration.</para> + <para>When you compare files in TortoiseSVN, TortoiseCVS, or Rational + ClearCase, you can have the VCS launch WinMerge instead of its native diff + utility. You can configure this integration only during <link + linkend="Installing_usinginstaller">WinMerge installation</link>.</para> - <orderedlist> - <listitem> - <para>Launch a WinMerge file or folder comparison whose left or right - target is under version control</para> - </listitem> + <example> + <title>Tortoise SVN integration</title> - <listitem> - <para>In WinMerge, edit a version-controlled file</para> - </listitem> + <para>Here is a sample diff operation in TortoiseSVN that uses the + WinMerge integration. The integrations with TortoiseCVS and ClearCase + are similar.</para> - <listitem> - <para>Save your changes. WinMerge detects that the file is read-only, - and assumes that it is under Visual Source Safe version control. - WinMerge opens a Visual Source Save dialog, like this:</para> + <orderedlist> + <listitem> + <para>In Windows Explorer, navigate to a Subversion working copy + that you have checked out.</para> + </listitem> - <mediaobject> - <imageobject> - <imagedata fileref="screenshots/sourcesafe1.png" format="PNG" /> - </imageobject> - </mediaobject> - </listitem> + <listitem> + <para>Right-click a file that is under Subversion management + (usually indicated by a distinct TortoiseSVN icon), and click + <guimenu>TortoiseSVN</guimenu> in the context menu.</para> - <listitem> - <para>In the <guilabel>Database</guilabel> dropdown list, choose the - correct Visual SourceSafe database if there is more than one on your - system.</para> - </listitem> + <itemizedlist> + <listitem> + <para>If the file has not been modified, the context menu + contains the shortcut, <guimenuitem>Diff with previous + version</guimenuitem>. This command compares the checked-out + version of the file with the previous version that was checked + in to the repository.</para> + </listitem> - <listitem> - <para>The <guilabel>Project</guilabel> field shows the selected file's - location relative to the Visual SourceSafe database path. Verify that - the path is correct: most errors are caused by the wrong project path. - If you change folders, remember to change the project path, - too!</para> - </listitem> + <listitem> + <para>If you have modified the file, the context menu contains + the same <guimenuitem>Diff with previous version</guimenuitem> + shortcut, plus the <guimenuitem>Diff</guimenuitem> shortcut. + This command compares your revision to the current version (the + one you checked out). It is useful for reviewing the changes you + have made.</para> + </listitem> + </itemizedlist> + </listitem> - <listitem> - <para>Enter your password if required. WinMerge remembers your - password for the current session, but for your security does not store - it. Therefore, you don't need to retype the password during a session, - but you must retype the password each time you open WinMerge.</para> - </listitem> + <listitem> + <para>Choose either the <guimenuitem>Diff with previous + version</guimenuitem> or <guimenuitem>Diff</guimenuitem> shortcut. + The WinMerge window opens, with the target file versions loaded In + the File Compare window.</para> + </listitem> + </orderedlist> - <listitem> - <para>Optionally, enable one or both of these options:</para> + <para>The <menuchoice> + <guimenu>TortoiseSVN</guimenu> - <itemizedlist> - <listitem> - <para><guilabel>Link to Destination VSS project</guilabel></para> - </listitem> + <guimenuitem>Diff</guimenuitem> + </menuchoice> shortcut is available for comparing any two files in + your file system, not just files that are managed by Subversion. To + illustrate how the WinMerge integration works in this case:</para> - <listitem> - <para><guilabel>Apply to all items</guilabel>. This option enables - you to check out multiple files in a single directory when you - copy files in a folder compare operation.</para> - </listitem> - </itemizedlist> - </listitem> - </orderedlist> + <orderedlist> + <listitem> + <para>In Windows Explorer, hold <keycap>Ctrl</keycap>, select any + two files, and right-click.</para> + </listitem> - <para>Unfortunately, VSS provides very little information about error - conditions beyond the fact that they occur. If an operation fails, causes - might include any of the following conditions:</para> + <listitem> + <para>Choose <menuchoice> + <guimenu>TortoiseSVN</guimenu> - <itemizedlist> - <listitem> - <para>Another user might have the file checked out with exclusive - access.</para> - </listitem> + <guimenuitem>Diff</guimenuitem> + </menuchoice> in the context menu.</para> - <listitem> - <para>You might have specified the wrong project.</para> - </listitem> + <para>The WinMerge window opens, with the selected files loaded In + the File Compare window.</para> + </listitem> + </orderedlist> + </example> - <listitem> - <para>You might have entered the project name incorrectly.</para> - </listitem> + <section id="VersionControl_cc"> + <title>About the ClearCase integration</title> - <listitem> - <para>You might not have used a valid VSS path (for example, this is - incorrect: <userinput>$/MyProject/res</userinput>).</para> - </listitem> + <para>When you choose the integration option for Rational ClearCase + during WinMerge installation, the installer:</para> - <listitem> - <para>Your connection to the VSS server computer might be - broken.</para> - </listitem> - </itemizedlist> + <orderedlist> + <listitem> + <para>Creates a backup copy of the ClearCase + <filename>map</filename> file, <filename>map.bak</filename>, in the + <filename><replaceable>ccase-home-dir</replaceable>\lib\mgrs</filename> + directory. The <filename>map</filename> file is a user-configurable + file that associates ClearCase methods with the programs that carry + them out.</para> + </listitem> + + <listitem> + <para>Modifies the <guilabel>text_file_delta</guilabel> field In the + <filename>map</filename> file, specifying WinMerge instead of the + default <filename>cleardiff.exe</filename> when running the + <command>cleartool diff</command> command.</para> + </listitem> + </orderedlist> + + <para>If you later want to disable WinMerge interactions with ClearCase, + replace the ClearCase <filename>map</filename> file created by the + WinMerge installer with the <filename>map.bak</filename> backup file. + Alternatively, edit the ClearCase <filename>map</filename> file to run + <filename>cleardiff.exe</filename> for the <command>cleartool + diff</command> command.</para> + </section> </section> </section> </article> \ No newline at end of file This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site. |
From: <den...@us...> - 2009-05-29 20:34:48
|
Revision: 6806 http://winmerge.svn.sourceforge.net/winmerge/?rev=6806&view=rev Author: denisbradford Date: 2009-05-29 20:33:13 +0000 (Fri, 29 May 2009) Log Message: ----------- Change topic ids to generate HTML files with same names XML sources. Modified Paths: -------------- trunk/Docs/Users/Manual/About_Doc.xml trunk/Docs/Users/Manual/Command_line.xml trunk/Docs/Users/Manual/Compare_dirs.xml trunk/Docs/Users/Manual/Compare_files.xml trunk/Docs/Users/Manual/Configuration.xml trunk/Docs/Users/Manual/Faq.xml trunk/Docs/Users/Manual/Filters.xml trunk/Docs/Users/Manual/Install.xml trunk/Docs/Users/Manual/Intro_diffs.xml trunk/Docs/Users/Manual/Introduction.xml trunk/Docs/Users/Manual/Locales.xml trunk/Docs/Users/Manual/Open_paths.xml trunk/Docs/Users/Manual/Plugins.xml trunk/Docs/Users/Manual/Quick_start.xml trunk/Docs/Users/Manual/Shortcut_keys.xml trunk/Docs/Users/Manual/Version_control.xml trunk/Docs/Users/Manual/build/build_htmlhelp.xsl trunk/Docs/Users/Manual/select_unpacker.xml Modified: trunk/Docs/Users/Manual/About_Doc.xml =================================================================== --- trunk/Docs/Users/Manual/About_Doc.xml 2009-05-29 19:39:33 UTC (rev 6805) +++ trunk/Docs/Users/Manual/About_Doc.xml 2009-05-29 20:33:13 UTC (rev 6806) @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8"?> -<article id="AboutDoc"> +<article id="About_Doc"> <title>About WinMerge Help</title> <para>This is Help for WinMerge <xi:include href="replaceables.xml" @@ -69,10 +69,10 @@ <listitem> <para>Open your Web browser to <ulink - url="http://winmerge.org/">winmerge.org</ulink>. Under - <ulink url="http://winmerge.org/docs/">Documentation</ulink>, - follow the <ulink url="http://winmerge.org/docs/manual/">Manual</ulink> - link to the latest Help version.</para> + url="http://winmerge.org/">winmerge.org</ulink>. Under <ulink + url="http://winmerge.org/docs/">Documentation</ulink>, follow the + <ulink url="http://winmerge.org/docs/manual/">Manual</ulink> link to + the latest Help version.</para> </listitem> </varlistentry> </variablelist> @@ -86,7 +86,7 @@ <variablelist> <varlistentry> - <term><xref linkend="QuickStart" /></term> + <term><xref linkend="Quick_start" /></term> <listitem> <para>Gets you quickly started with WinMerge and shows its basic @@ -95,7 +95,7 @@ </varlistentry> <varlistentry> - <term><xref linkend="CompareDirs" /></term> + <term><xref linkend="Compare_dirs" /></term> <listitem> <para>Explains the folder comparison window, available operations, and @@ -104,7 +104,7 @@ </varlistentry> <varlistentry> - <term><xref linkend="CompareFiles" /></term> + <term><xref linkend="Compare_files" /></term> <listitem> <para>Explains the file comparison/merge window, available operations, @@ -126,7 +126,7 @@ <variablelist> <varlistentry> - <term><xref linkend="OpenPaths" /></term> + <term><xref linkend="Open_paths" /></term> <listitem> <para>Introduces several ways to open files and folders in WinMerge - @@ -154,7 +154,7 @@ </varlistentry> <varlistentry> - <term><xref linkend="CommandLine" /></term> + <term><xref linkend="Command_line" /></term> <listitem> <para>Lists command-line parameters for using WinMerge with other @@ -322,4 +322,4 @@ </tgroup> </informaltable> </section> -</article> +</article> \ No newline at end of file Modified: trunk/Docs/Users/Manual/Command_line.xml =================================================================== --- trunk/Docs/Users/Manual/Command_line.xml 2009-05-29 19:39:33 UTC (rev 6805) +++ trunk/Docs/Users/Manual/Command_line.xml 2009-05-29 20:33:13 UTC (rev 6806) @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8"?> -<article id="CommandLine"> +<article id="Command_line"> <title>Command line<indexterm> <primary>command line</primary> </indexterm><indexterm> Modified: trunk/Docs/Users/Manual/Compare_dirs.xml =================================================================== --- trunk/Docs/Users/Manual/Compare_dirs.xml 2009-05-29 19:39:33 UTC (rev 6805) +++ trunk/Docs/Users/Manual/Compare_dirs.xml 2009-05-29 20:33:13 UTC (rev 6806) @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8"?> -<article id="CompareDirs"> +<article id="Compare_dirs"> <title>Comparing and merging folders<indexterm> <primary>comparing folders</primary> </indexterm></title> @@ -30,7 +30,7 @@ all files in the folders, and is nonrecursive (does not include subfolders). To change any of these options and for more details about the Select Files or Folder dialog, see <xref - linkend="OpenPaths" />.</para> + linkend="Open_paths" />.</para> </listitem> </varlistentry> @@ -43,7 +43,7 @@ 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> + linkend="Command_line" />.</para> </listitem> </varlistentry> </variablelist> @@ -431,9 +431,9 @@ </indexterm> <para>You can use the mouse as well as <link - linkend="Shortcuts">keyboard</link> and context menu shortcuts to navigate - the Folder Compare window. You can also use the toolbar buttons. For - example, the <inlinemediaobject> + linkend="Shortcut_keys">keyboard</link> and context menu shortcuts to + navigate the Folder Compare window. You can also use the toolbar buttons. + For example, the <inlinemediaobject> <imageobject> <imagedata contentdepth="15" fileref="screenshots/nextdiff_btn.png" /> </imageobject> @@ -1454,7 +1454,7 @@ <para>Please consider that shell menu commands run entirely outside of WinMerge. Consequently, WinMerge might not respond to some operations in the same way as operations performed inside WinMerge. For example, if you - delete a file through this integration instead of using the Winmerge + delete a file through this integration instead of using the WinMerge <command>Delete</command> command, the change is not automatically shown in the Folder Compare window (you have to manually refresh the window to see the change).</para> Modified: trunk/Docs/Users/Manual/Compare_files.xml =================================================================== --- trunk/Docs/Users/Manual/Compare_files.xml 2009-05-29 19:39:33 UTC (rev 6805) +++ trunk/Docs/Users/Manual/Compare_files.xml 2009-05-29 20:33:13 UTC (rev 6806) @@ -1,13 +1,12 @@ <?xml version="1.0" encoding="UTF-8"?> -<article id="CompareFiles"> +<article id="Compare_files"> <title>Comparing and merging files<indexterm> <primary>comparing files</primary> </indexterm></title> <para>This topic describes how to use the WinMerge File Compare window to compare and merge files. To understand the basic concepts about differences - used here, we suggest you read <xref linkend="IntroductDiffing" /> - first.</para> + used here, we suggest you read <xref linkend="Intro_diffs" /> first.</para> <xi:include href="Text_encoding.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> @@ -30,7 +29,7 @@ </menuchoice>. Use the Select Files or Folders dialog to specify the left and right source files to compare. For more details about the Select Files or Folder dialog, see <xref - linkend="OpenPaths" />.</para> + linkend="Open_paths" />.</para> </listitem> </varlistentry> @@ -41,7 +40,7 @@ <para>Run <command>WinMergeU.exe</command>, which is in your WinMerge install directory. In your command arguments, include the left and right files to compare. For more information about using the command - line, see <xref linkend="CommandLine" />.</para> + line, see <xref linkend="Command_line" />.</para> </listitem> </varlistentry> </variablelist> @@ -760,9 +759,8 @@ <para>Difference functions are described in <xref linkend="Compare_files_nav" /> and <xref linkend="Compare_files_merge" />, - later in this topic. <xref linkend="QuickStart" /> and <xref - linkend="IntroductDiffing" /> provide examples of comparing and - merging.</para> + later in this topic. <xref linkend="Quick_start" /> and <xref + linkend="Intro_diffs" /> provide examples of comparing and merging.</para> <section> <title>Merge Mode<indexterm> @@ -1912,8 +1910,8 @@ <keycap>Ctrl</keycap> <keycap>S</keycap> - </keycombo> to save the the <guilabel>Mine File</guilabel> side as - the result file. By default, the new version overwrites the original + </keycombo> to save the <guilabel>Mine File</guilabel> side as the + result file. By default, the new version overwrites the original conflict file. Alternatively, you can click <menuchoice> <guimenu>File</guimenu> @@ -1932,7 +1930,7 @@ which accepts three filename parameters: <option>Theirs</option>, <option>Mine</option>, and optionally, <option>Resolved</option> (if you want a different result file from the conflict file). For more - information, see <xref linkend="CommandLine" />. Single path to the + information, see <xref linkend="Command_line" />. Single path to the conflict file is also accepted in command line.</para> </section> </section> Modified: trunk/Docs/Users/Manual/Configuration.xml =================================================================== --- trunk/Docs/Users/Manual/Configuration.xml 2009-05-29 19:39:33 UTC (rev 6805) +++ trunk/Docs/Users/Manual/Configuration.xml 2009-05-29 20:33:13 UTC (rev 6806) @@ -606,7 +606,7 @@ visualize changes in files, if there are not too many.</para> <para>For an example, see the Location pane description in <xref - linkend="CompareFiles" />.</para> + linkend="Compare_files" />.</para> </listitem> </itemizedlist> </section> Modified: trunk/Docs/Users/Manual/Faq.xml =================================================================== --- trunk/Docs/Users/Manual/Faq.xml 2009-05-29 19:39:33 UTC (rev 6805) +++ trunk/Docs/Users/Manual/Faq.xml 2009-05-29 20:33:13 UTC (rev 6806) @@ -108,7 +108,7 @@ but have no plans to implement it in near future. You can work around this limitation somewhat by using two WinMerge instances, or by using a third path parameter on the command line. See <xref - linkend="CommandLine" /> for more information.</para> + linkend="Command_line" /> for more information.</para> </answer> </qandaentry> @@ -144,7 +144,7 @@ because there already are so many good CVS clients. However, WinMerge does provide an integration with the diff function of one of those clients, TortoiseCVS (as described in <xref - linkend="VersionControl" />). Also, WinMerge can resolve conflict + linkend="Version_control" />). Also, WinMerge can resolve conflict files (see <xref linkend="ResolveConflictFiles" />).</para> </answer> </qandaentry> @@ -172,7 +172,7 @@ <answer> <para>OpenOffice files are archives. To be able to open them in - WinMerge, you have to configure archive support: </para> + WinMerge, you have to configure archive support:</para> <itemizedlist> <listitem> Modified: trunk/Docs/Users/Manual/Filters.xml =================================================================== --- trunk/Docs/Users/Manual/Filters.xml 2009-05-29 19:39:33 UTC (rev 6805) +++ trunk/Docs/Users/Manual/Filters.xml 2009-05-29 20:33:13 UTC (rev 6806) @@ -184,7 +184,7 @@ your own. To make that task easier, WinMerge also provides a template file named <filename>FileFilter.tmpl</filename>. This section describes how to apply file filters to comparisons, and documents the file filter syntax. - <xref linkend="Filters_Dlg" /> describes how to add, edit, and manage + <xref linkend="Filters_dlg" /> describes how to add, edit, and manage filters.</para> <section id="Filters_FileFilterLoc"> @@ -516,7 +516,7 @@ comparison.</para> <para>To learn how to add, edit, and manage filters, see <xref - linkend="Filters_Dlg" />.</para> + linkend="Filters_dlg" />.</para> <section id="Filters_LineFilterApply"> <title>Applying line filters</title> @@ -731,7 +731,7 @@ </section> </section> - <section id="Filters_Dlg"> + <section id="Filters_dlg"> <title>Using the Filters dialog<indexterm> <primary>Filters dialog</primary> </indexterm><indexterm> Modified: trunk/Docs/Users/Manual/Install.xml =================================================================== --- trunk/Docs/Users/Manual/Install.xml 2009-05-29 19:39:33 UTC (rev 6805) +++ trunk/Docs/Users/Manual/Install.xml 2009-05-29 20:33:13 UTC (rev 6806) @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8"?> -<article id="Installing"> +<article id="Install"> <title>Getting and installing WinMerge<indexterm> <primary>installing WinMerge</primary> </indexterm></title> Modified: trunk/Docs/Users/Manual/Intro_diffs.xml =================================================================== --- trunk/Docs/Users/Manual/Intro_diffs.xml 2009-05-29 19:39:33 UTC (rev 6805) +++ trunk/Docs/Users/Manual/Intro_diffs.xml 2009-05-29 20:33:13 UTC (rev 6806) @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8"?> -<article id="IntroductDiffing"> +<article id="Intro_diffs"> <title>Overview of file comparing and merging</title> <para>This topic describes how WinMerge detects and displays differences @@ -104,8 +104,8 @@ </mediaobject> <para>The elements are described in more detail in <xref - linkend="CompareFiles" />. Here are some features you should notice in - this example:</para> + linkend="Compare_files" />. Here are some features you should notice + in this example:</para> <variablelist> <varlistentry> @@ -123,7 +123,7 @@ <listitem> <para>Difference blocks are marked with the difference - background color (gold, by default). </para> + background color (gold, by default).</para> <para>Line differences can be enabled to mark changed text within differences blocks, using the word background color @@ -367,7 +367,7 @@ Difference 2 from <filename>File2</filename> to <filename>File1</filename>.</para> - <para>The message that the the files are identical tells you that the + <para>The message that the files are identical tells you that the merge is complete:</para> <mediaobject> @@ -436,7 +436,7 @@ <para>Similarly, in the WinMerge command line, you can leave both source versions unchanged by using the optional <option>outputfile</option> - argument, as described in <xref linkend="CommandLine" />.</para> + argument, as described in <xref linkend="Command_line" />.</para> </section> </section> </article> \ No newline at end of file Modified: trunk/Docs/Users/Manual/Introduction.xml =================================================================== --- trunk/Docs/Users/Manual/Introduction.xml 2009-05-29 19:39:33 UTC (rev 6805) +++ trunk/Docs/Users/Manual/Introduction.xml 2009-05-29 20:33:13 UTC (rev 6806) @@ -153,9 +153,9 @@ </indexterm>Getting support and reporting bugs</title> <para>The <ulink - url="http://apps.sourceforge.net/phpbb/winmerge/viewforum.php?f=4">Open Discussion - forum</ulink> is the fastest way to get help. Please be patient, it may take - some time for somebody to answer.</para> + url="http://apps.sourceforge.net/phpbb/winmerge/viewforum.php?f=4">Open + Discussion forum</ulink> is the fastest way to get help. Please be patient, + it may take some time for somebody to answer.</para> <para>If you find a bug, please submit it as a <ulink url="http://sourceforge.net/tracker/?group_id=13216&atid=113216">bug @@ -177,12 +177,13 @@ </menuchoice>.</para> </important> - <para>You must <ulink url="https://sourceforge.net/account/registration/">register - with SourceForge.net</ulink> before posting a bug report (registration is - free). We require registering because anonymous submissions caused a lot of - spam and also because there were no possibility to contact people for asking - more information. We rarely sent direct emails but you'll get notifications - when we ask questions in the bug item.</para> + <para>You must <ulink + url="https://sourceforge.net/account/registration/">register with + SourceForge.net</ulink> before posting a bug report (registration is free). + We require registering because anonymous submissions caused a lot of spam + and also because there were no possibility to contact people for asking more + information. We rarely sent direct emails but you'll get notifications when + we ask questions in the bug item.</para> </section> <section> Modified: trunk/Docs/Users/Manual/Locales.xml =================================================================== --- trunk/Docs/Users/Manual/Locales.xml 2009-05-29 19:39:33 UTC (rev 6805) +++ trunk/Docs/Users/Manual/Locales.xml 2009-05-29 20:33:13 UTC (rev 6806) @@ -1,4 +1,4 @@ -<?xml version="1.0" encoding="UTF-8"?> +<?xml version="1.0" encoding="UTF-8"?> <article id="Locales"> <title>Locale support<indexterm> <primary>localizing WinMerge</primary> Modified: trunk/Docs/Users/Manual/Open_paths.xml =================================================================== --- trunk/Docs/Users/Manual/Open_paths.xml 2009-05-29 19:39:33 UTC (rev 6805) +++ trunk/Docs/Users/Manual/Open_paths.xml 2009-05-29 20:33:13 UTC (rev 6806) @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8"?> -<article id="OpenPaths"> +<article id="Open_paths"> <title>Opening files and folders<indexterm> <primary>opening files and folders</primary> </indexterm></title> @@ -38,7 +38,7 @@ <primary>Select Files or Folders dialog</primary> </indexterm></title> - <para><xref linkend="QuickStart" /> describes the Select Files or Folders + <para><xref linkend="Quick_start" /> describes the Select Files or Folders dialog. This section provides more details, and some tips for using the Select Files or Folders dialog more efficiently.</para> @@ -63,7 +63,7 @@ </indexterm></title> <para>WinMerge archive support is provided in the 7-Zip plugin. See <xref - linkend="Installing" /> to install this plugin.</para> + linkend="Install" /> to install this plugin.</para> <para>Opening two archive files is similar to opening normal files: specify two archive files in the Open-dialog's <guilabel>Left</guilabel> @@ -71,7 +71,7 @@ format, it opens the contents of the archive files in the Folder Compare window.</para> - <para>The <xref linkend="CompareDirs" /> topic describes how to work with + <para>The <xref linkend="Compare_dirs" /> topic describes how to work with archive files. For example, if an archive file contains two subfolders named <filename class="directory">Original/</filename> and <filename class="directory">Altered/</filename>, you can compare the contents of the @@ -317,7 +317,7 @@ <note> <para>These settings for the Windows Explorer integration do not change the <option>Include Subfolders</option> setting for the Select Files or - Folders dialog, described in <xref linkend="QuickStart" />.</para> + Folders dialog, described in <xref linkend="Quick_start" />.</para> </note> </section> </section> Modified: trunk/Docs/Users/Manual/Plugins.xml =================================================================== --- trunk/Docs/Users/Manual/Plugins.xml 2009-05-29 19:39:33 UTC (rev 6805) +++ trunk/Docs/Users/Manual/Plugins.xml 2009-05-29 20:33:13 UTC (rev 6806) @@ -781,4 +781,4 @@ you can safely remove it.</para> </section> </section> -</article> +</article> \ No newline at end of file Modified: trunk/Docs/Users/Manual/Quick_start.xml =================================================================== --- trunk/Docs/Users/Manual/Quick_start.xml 2009-05-29 19:39:33 UTC (rev 6805) +++ trunk/Docs/Users/Manual/Quick_start.xml 2009-05-29 20:33:13 UTC (rev 6806) @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8"?> -<article id="QuickStart"> +<article id="Quick_start"> <title>Quick start</title> <section> @@ -278,7 +278,7 @@ file in the <guilabel>Left</guilabel> field.</para> <note> - <para>If you specify project files in both the the + <para>If you specify project files in both the <guilabel>Left</guilabel> and <guilabel>Right</guilabel> fields, WinMerge does not open either project file; it simply compares the XML content of the two files.</para> @@ -292,7 +292,7 @@ </listitem> <listitem> - <simpara>Use the <xref linkend="CommandLine" /> interface to start + <simpara>Use the <xref linkend="Command_line" /> interface to start WinMerge from other applications, from a command prompt, or a batch or script file.</simpara> </listitem> Modified: trunk/Docs/Users/Manual/Shortcut_keys.xml =================================================================== --- trunk/Docs/Users/Manual/Shortcut_keys.xml 2009-05-29 19:39:33 UTC (rev 6805) +++ trunk/Docs/Users/Manual/Shortcut_keys.xml 2009-05-29 20:33:13 UTC (rev 6806) @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8"?> -<appendix id="Shortcuts"> +<appendix id="Shortcut_keys"> <title>Shortcut keys<indexterm> <primary>shortcut keys</primary> </indexterm></title> Modified: trunk/Docs/Users/Manual/Version_control.xml =================================================================== --- trunk/Docs/Users/Manual/Version_control.xml 2009-05-29 19:39:33 UTC (rev 6805) +++ trunk/Docs/Users/Manual/Version_control.xml 2009-05-29 20:33:13 UTC (rev 6806) @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8"?> -<article id="VersionControl"> +<article id="Version_control"> <title>Using WinMerge with other tools<indexterm> <primary>integration</primary> </indexterm></title> @@ -15,7 +15,7 @@ <title>Using the command-line interface (CLI)</title> <para>The WinMerge command-line interface (CLI), described in <xref - linkend="CommandLine" />, enables you to run WinMerge from a Command Prompt + linkend="Command_line" />, enables you to run WinMerge from a Command Prompt window, from scripts, or from another tool or program. Basically, any program that allows you to call an external executable with at least one path, can be used to launch a WinMerge operation.</para> Modified: trunk/Docs/Users/Manual/build/build_htmlhelp.xsl =================================================================== --- trunk/Docs/Users/Manual/build/build_htmlhelp.xsl 2009-05-29 19:39:33 UTC (rev 6805) +++ trunk/Docs/Users/Manual/build/build_htmlhelp.xsl 2009-05-29 20:33:13 UTC (rev 6806) @@ -26,7 +26,7 @@ <xsl:param name="use.id.as.filename" select="1"/> <xsl:param name="html.stylesheet">css/help.css</xsl:param> <xsl:param name="htmlhelp.use.hhk" select="1"/> -<xsl:param name="htmlhelp.default.topic">htmlhelp/AboutDoc.html</xsl:param> +<xsl:param name="htmlhelp.default.topic">htmlhelp/About_Doc.html</xsl:param> <xsl:param name="htmlhelp.title">WinMerge Help</xsl:param> <xsl:param name="htmlhelp.show.menu" select="1"/> Modified: trunk/Docs/Users/Manual/select_unpacker.xml =================================================================== --- trunk/Docs/Users/Manual/select_unpacker.xml 2009-05-29 19:39:33 UTC (rev 6805) +++ trunk/Docs/Users/Manual/select_unpacker.xml 2009-05-29 20:33:13 UTC (rev 6806) @@ -12,7 +12,7 @@ <listitem> <para>To use automatic mode (which applies the first available plugin), verify that <guilabel><None></guilabel> is displayed in - the the <guilabel>File unpacker</guilabel> control.</para> + the <guilabel>File unpacker</guilabel> control.</para> </listitem> <listitem> This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site. |
From: <den...@us...> - 2009-08-03 13:04:15
|
Revision: 6943 http://winmerge.svn.sourceforge.net/winmerge/?rev=6943&view=rev Author: denisbradford Date: 2009-08-03 13:04:02 +0000 (Mon, 03 Aug 2009) Log Message: ----------- Add WinMerge tour files per Patch 2817443 and related build script. Update build scripts to include tour, add "withads" functionality, eliminate unneeded build_html_withads.xsl script. Modified Paths: -------------- trunk/Docs/Users/Manual/build/build_common.xsl trunk/Docs/Users/Manual/build/build_html.bat trunk/Docs/Users/Manual/build/build_html.xsl trunk/Docs/Users/Manual/screenshots/OpenDlg1.png trunk/Docs/Users/Manual/screenshots/ctx_menu_simple.png trunk/Docs/Users/Manual/screenshots/equal.png trunk/Docs/Users/Manual/screenshots/treeview-01.png Added Paths: ----------- trunk/Docs/Users/Manual/WinMerge_tour.xml trunk/Docs/Users/Manual/build/build_html_page.xsl trunk/Docs/Users/Manual/css/onepage.css trunk/Docs/Users/Manual/screenshots/ctx_menu_advanced_2wins.png trunk/Docs/Users/Manual/screenshots/dragndrop-files.png trunk/Docs/Users/Manual/screenshots/filecomp_diffpane2.png trunk/Docs/Users/Manual/screenshots/filecomp_diffpanesel.png trunk/Docs/Users/Manual/screenshots/filecomp_merged.png trunk/Docs/Users/Manual/screenshots/filecompwin01.png trunk/Docs/Users/Manual/screenshots/foldercomp2.png trunk/Docs/Users/Manual/screenshots/mergebtns-on.png trunk/Docs/Users/Manual/tour_comparingdirs.xml trunk/Docs/Users/Manual/tour_comparingfiles.xml trunk/Docs/Users/Manual/tour_sel_targets.xml Removed Paths: ------------- trunk/Docs/Users/Manual/build/build_html_withads.xsl Added: trunk/Docs/Users/Manual/WinMerge_tour.xml =================================================================== --- trunk/Docs/Users/Manual/WinMerge_tour.xml (rev 0) +++ trunk/Docs/Users/Manual/WinMerge_tour.xml 2009-08-03 13:04:02 UTC (rev 6943) @@ -0,0 +1,59 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" +"./build/dtd/docbookx.dtd"> +<book id="WinMerge_tour"> + <bookinfo> + <title>WinMerge <xi:include href="replaceables.xml" + xmlns:xi="http://www.w3.org/2001/XInclude" xpointer="element(version)" /> + Quick Tour</title> + + <abstract> + <para>WinMerge is an Open Source differencing and merging tool for + Windows. Use it to detect changes between files and folders, and then to + merge changes selectively. You can use WinMerge by itself, or launch it + from a version control system or another application.</para> + + <para>When you compare two files or folders, the result is displayed in + the WinMerge window. The WinMerge window's visual display and functions + are designed to help you see differences between your targets, and to + merge selected differences if you want to.</para> + + <formalpara> + <title>In a file comparison</title> + + <para>WinMerge shows differences between lines. The built-in text editor + provides syntax highlighting for several programming languages and other + file formats.</para> + </formalpara> + + <formalpara> + <title>In a folder comparison</title> + + <para>WinMerge indicates various kinds of differences between the files + that the folders contain.</para> + </formalpara> + + <para>Take this brief, guided tour if you are considering installing + WinMerge, or if you just want to see what the tool looks like and what you + can do with it. The topics below describe the main WinMerge features. They + include some simple examples of comparing files and folders, and merging + differences between them.</para> + + <para>This tour just scratches the surface. For detailed information and + guidance about using WinMerge, see the Help that is installed with + WinMerge and available <ulink url="http://winmerge.org/docs/manual/">on + our Web site</ulink>.</para> + </abstract> + </bookinfo> + + <toc></toc> + + <xi:include href="tour_sel_targets.xml" + xmlns:xi="http://www.w3.org/2001/XInclude" xpointer="element(/1)" /> + + <xi:include href="tour_comparingfiles.xml" + xmlns:xi="http://www.w3.org/2001/XInclude" /> + + <xi:include href="tour_comparingdirs.xml" + xmlns:xi="http://www.w3.org/2001/XInclude" /> +</book> Modified: trunk/Docs/Users/Manual/build/build_common.xsl =================================================================== --- trunk/Docs/Users/Manual/build/build_common.xsl 2009-08-02 17:02:17 UTC (rev 6942) +++ trunk/Docs/Users/Manual/build/build_common.xsl 2009-08-03 13:04:02 UTC (rev 6943) @@ -21,7 +21,6 @@ Changes Created July 2008 ******************************************************************** --> - <!-- ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ html/param.xsl parameters ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ --> @@ -57,6 +56,7 @@ <!-- ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ html/docbook.xsl ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ --> +<!-- Link to the appropriate css stylesheets --> <xsl:template name="user.head.content"> <link rel="stylesheet" type="text/css" href="css/all.css" /> <link rel="stylesheet" type="text/css" media="print" href="css/print.css" /> @@ -112,4 +112,28 @@ </span> </xsl:template> +<!-- ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ +WinMerge custom templates +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ --> +<xsl:template name="header.ads"> + <div id="ads"> + <script type="text/javascript"><!-- + google_ad_client = "pub-1411904495533584"; + google_ad_width = 728; + google_ad_height = 90; + google_ad_format = "728x90_as"; + google_ad_type = "text"; + google_ad_channel =""; + google_color_border = "FFCC00"; + google_color_bg = "FFFFCC"; + google_color_link = "0000FF"; + google_color_text = "000000"; + google_color_url = "008000"; + //--></script> + <script type="text/javascript" src="http://pagead2.googlesyndication.com/pagead/show_ads.js"> + </script> + </div> +</xsl:template> + + </xsl:stylesheet> Modified: trunk/Docs/Users/Manual/build/build_html.bat =================================================================== --- trunk/Docs/Users/Manual/build/build_html.bat 2009-08-02 17:02:17 UTC (rev 6942) +++ trunk/Docs/Users/Manual/build/build_html.bat 2009-08-03 13:04:02 UTC (rev 6943) @@ -3,14 +3,17 @@ call configuration.bat set docbook_inputfile=..\WinMerge_help.xml +set tour_inputfile=..\WinMerge_tour.xml set docbook_use_stylesheet=build_html.xsl +set tour_use_stylesheet=build_html_page.xsl set docbook_outputdir=%docbook_build_path%\html +set ads=false if "%1" == "withads" goto withads if not "%1" == "" goto withadserror goto start :withads -set docbook_use_stylesheet=build_html_withads.xsl +set ads=true echo ************************************** echo * The manual includes advertisements * echo ************************************** @@ -38,12 +41,15 @@ echo Copy stylesheets... if not exist "%docbook_outputdir%\css" mkdir "%docbook_outputdir%\css" -copy "..\css\all.css" "%docbook_outputdir%\css\all.css" -copy "..\css\print.css" "%docbook_outputdir%\css\print.css" +copy "..\css\*.css" "%docbook_outputdir%\css" +rem copy "..\css\print.css" "%docbook_outputdir%\css\print.css" -echo Create HTML files... -%docbook_java_exe% %docbook_java_parameters% -cp %docbook_saxon_jar%;%docbook_xerces_jar%;%docbook_saxon_xsl% -Djavax.xml.parsers.DocumentBuilderFactory=%DBFACTORY% -Djavax.xml.parsers.SAXParserFactory=%SPFACTORY% -Dorg.apache.xerces.xni.parser.XMLParserConfiguration=%XINCLUDE% com.icl.saxon.StyleSheet %docbook_inputfile% %docbook_use_stylesheet% base.dir=%docbook_outputdir%\ +echo Create Manual HTML files... +%docbook_java_exe% %docbook_java_parameters% -cp %docbook_saxon_jar%;%docbook_xerces_jar%;%docbook_saxon_xsl% -Djavax.xml.parsers.DocumentBuilderFactory=%DBFACTORY% -Djavax.xml.parsers.SAXParserFactory=%SPFACTORY% -Dorg.apache.xerces.xni.parser.XMLParserConfiguration=%XINCLUDE% com.icl.saxon.StyleSheet %docbook_inputfile% %docbook_use_stylesheet% base.dir=%docbook_outputdir%\ withads=%ads% +echo Create tour HTML file... +%docbook_java_exe% %docbook_java_parameters% -cp %docbook_saxon_jar%;%docbook_xerces_jar%;%docbook_saxon_xsl% -Djavax.xml.parsers.DocumentBuilderFactory=%DBFACTORY% -Djavax.xml.parsers.SAXParserFactory=%SPFACTORY% -Dorg.apache.xerces.xni.parser.XMLParserConfiguration=%XINCLUDE% com.icl.saxon.StyleSheet -o %docbook_outputdir%/WinMerge_tour.html %tour_inputfile% %tour_use_stylesheet% headtitle.suffix="' - WinMerge 2.12 Tour'" withads=%ads% + echo Finished! :end Modified: trunk/Docs/Users/Manual/build/build_html.xsl =================================================================== --- trunk/Docs/Users/Manual/build/build_html.xsl 2009-08-02 17:02:17 UTC (rev 6942) +++ trunk/Docs/Users/Manual/build/build_html.xsl 2009-08-03 13:04:02 UTC (rev 6943) @@ -17,15 +17,22 @@ <xsl:import href="../build/xsl/html/chunk.xsl"/> <xsl:import href="build_common.xsl"/> -<!-- Define suffix to appear after title text in head/title element of every topic --> + +<!-- ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ +Custom parameters ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ --> +<!-- Define suffix to appear after title text in head/title element of +every topic --> <xsl:param name="headtitle.suffix" select="' - WinMerge 2.12 Manual'"/> +<!-- Detect if we're displaying ads for the Web pages --> +<xsl:param name="withads">false</xsl:param> <!-- ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ html/docbook.xsl - Add suffix to head title text ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ --> +<!-- Add headtitle.suffix to head title text --> <xsl:template name="head.content"> <xsl:param name="node" select="."/> <xsl:param name="title"> @@ -108,4 +115,11 @@ <xsl:apply-templates select="." mode="head.keywords.content"/> </xsl:template> +<!-- For web pages add banner image and Google ad scripts --> +<xsl:template name="user.header.content"> + <xsl:if test="$withads = 'true'"> + <xsl:call-template name="header.ads"/> + </xsl:if> +</xsl:template> + </xsl:stylesheet> Added: trunk/Docs/Users/Manual/build/build_html_page.xsl =================================================================== --- trunk/Docs/Users/Manual/build/build_html_page.xsl (rev 0) +++ trunk/Docs/Users/Manual/build/build_html_page.xsl 2009-08-03 13:04:02 UTC (rev 6943) @@ -0,0 +1,62 @@ +<?xml version="1.0"?> +<xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="1.0"> + +<!-- ******************************************************************** + build_html_page.xsl + WinMerge customization of the XSL DocBook stylesheet distribution. + Contains customized templates and parameters for generating + a single HTML document; all other styles are inherited from the WinMerge + build_common.xsl and the stock DocBook stylesheets in ../build/xsl. + + See build_common.xsl for editing instructions. + ******************************************************************** + Changes: + Created July 2009 + ******************************************************************** --> + +<xsl:import href="../build/xsl/html/docbook.xsl"/> +<xsl:import href="build_common.xsl"/> + +<xsl:output method="html" + encoding="ISO-8859-1" + indent="yes"/> + +<!-- ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ +Custom parameters ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ --> +<!-- Define suffix to appear after title text in head/title element of +every topic --> +<xsl:param name="headtitle.suffix" select="' - WinMerge 2.12 Manual'"/> + +<!-- Detect if we're displaying ads for the Web pages --> +<xsl:param name="withads">false</xsl:param> + +<!-- ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ + html/param.xsl parameters ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ --> +<xsl:param name="section.autolabel" select="0"/> +<xsl:param name="generate.toc">book nop</xsl:param> +<xsl:param name="generate.meta.abstract" select="0"/> + + +<!-- ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ +html/docbook.xsl +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ --> +<!-- Link to the appropriate css stylesheets --> +<xsl:template name="user.head.content"> + <link rel="stylesheet" type="text/css" href="css/onepage.css" /> + <link rel="stylesheet" type="text/css" media="print" href="css/print.css" /> +</xsl:template> + +<!-- For web pages add banner image and Google ad scripts --> +<xsl:template name="user.header.content"> + <div class="header"><a href="http://www.winmerge.org"> + <img src="images/head.gif" alt="winmerge.org"/></a> + </div> + <xsl:if test="$withads = 'true'"> + <xsl:call-template name="header.ads"/> + </xsl:if> +</xsl:template> + +</xsl:stylesheet> Deleted: trunk/Docs/Users/Manual/build/build_html_withads.xsl =================================================================== --- trunk/Docs/Users/Manual/build/build_html_withads.xsl 2009-08-02 17:02:17 UTC (rev 6942) +++ trunk/Docs/Users/Manual/build/build_html_withads.xsl 2009-08-03 13:04:02 UTC (rev 6943) @@ -1,44 +0,0 @@ -<?xml version="1.0"?> -<xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform" - version="1.0"> - -<!-- ******************************************************************** - build_html_withads.xsl - WinMerge customization of the XSL DocBook stylesheet distribution. - Contains customized templates and parameters for the Web site version - of help; all other styles are inherited from the WinMerge - build_common.xsl and the stock DocBook stylesheets in ../build/xsl. - - See build_common.xsl for editing instructions. - ******************************************************************** - Changes - Created July 2008 - ******************************************************************** --> - -<xsl:import href="build_html.xsl"/> - -<!-- ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ -html/docbook.xsl -++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ --> -<!-- WinMerge: commercialize the header --> -<xsl:template name="user.header.content"> - <div id="ads"> - <script type="text/javascript"><!-- - google_ad_client = "pub-1411904495533584"; - google_ad_width = 728; - google_ad_height = 90; - google_ad_format = "728x90_as"; - google_ad_type = "text"; - google_ad_channel =""; - google_color_border = "FFCC00"; - google_color_bg = "FFFFCC"; - google_color_link = "0000FF"; - google_color_text = "000000"; - google_color_url = "008000"; - //--></script> - <script type="text/javascript" src="http://pagead2.googlesyndication.com/pagead/show_ads.js"> - </script> - </div> -</xsl:template> - -</xsl:stylesheet> Added: trunk/Docs/Users/Manual/css/onepage.css =================================================================== --- trunk/Docs/Users/Manual/css/onepage.css (rev 0) +++ trunk/Docs/Users/Manual/css/onepage.css 2009-08-03 13:04:02 UTC (rev 6943) @@ -0,0 +1,33 @@ +@import url("all.css"); + +div.titlepage hr {display: none;} + +div.abstract p.title {display: none;} + +div.article { + margin: 10px 0 0 0; + padding: 0 20px 0 100px; + border: 1px dotted #004080; +} + +div.header { + height: 50px; + background: #FFCC00; + border-top: 1px solid black; + border-bottom: 1px solid black; + padding: 1px 0 1px 0; + text-align: center; +} + +div.header img { + border: none; +} + +div.article h2 { + margin-left: -90px; +} + +div.section h2 { + background-color: inherit; +} + Modified: trunk/Docs/Users/Manual/screenshots/OpenDlg1.png =================================================================== (Binary files differ) Added: trunk/Docs/Users/Manual/screenshots/ctx_menu_advanced_2wins.png =================================================================== (Binary files differ) Property changes on: trunk/Docs/Users/Manual/screenshots/ctx_menu_advanced_2wins.png ___________________________________________________________________ Added: svn:mime-type + application/octet-stream Modified: trunk/Docs/Users/Manual/screenshots/ctx_menu_simple.png =================================================================== (Binary files differ) Added: trunk/Docs/Users/Manual/screenshots/dragndrop-files.png =================================================================== (Binary files differ) Property changes on: trunk/Docs/Users/Manual/screenshots/dragndrop-files.png ___________________________________________________________________ Added: svn:mime-type + application/octet-stream Modified: trunk/Docs/Users/Manual/screenshots/equal.png =================================================================== (Binary files differ) Added: trunk/Docs/Users/Manual/screenshots/filecomp_diffpane2.png =================================================================== (Binary files differ) Property changes on: trunk/Docs/Users/Manual/screenshots/filecomp_diffpane2.png ___________________________________________________________________ Added: svn:mime-type + application/octet-stream Added: trunk/Docs/Users/Manual/screenshots/filecomp_diffpanesel.png =================================================================== (Binary files differ) Property changes on: trunk/Docs/Users/Manual/screenshots/filecomp_diffpanesel.png ___________________________________________________________________ Added: svn:mime-type + application/octet-stream Added: trunk/Docs/Users/Manual/screenshots/filecomp_merged.png =================================================================== (Binary files differ) Property changes on: trunk/Docs/Users/Manual/screenshots/filecomp_merged.png ___________________________________________________________________ Added: svn:mime-type + application/octet-stream Added: trunk/Docs/Users/Manual/screenshots/filecompwin01.png =================================================================== (Binary files differ) Property changes on: trunk/Docs/Users/Manual/screenshots/filecompwin01.png ___________________________________________________________________ Added: svn:mime-type + application/octet-stream Added: trunk/Docs/Users/Manual/screenshots/foldercomp2.png =================================================================== (Binary files differ) Property changes on: trunk/Docs/Users/Manual/screenshots/foldercomp2.png ___________________________________________________________________ Added: svn:mime-type + application/octet-stream Added: trunk/Docs/Users/Manual/screenshots/mergebtns-on.png =================================================================== (Binary files differ) Property changes on: trunk/Docs/Users/Manual/screenshots/mergebtns-on.png ___________________________________________________________________ Added: svn:mime-type + application/octet-stream Modified: trunk/Docs/Users/Manual/screenshots/treeview-01.png =================================================================== (Binary files differ) Added: trunk/Docs/Users/Manual/tour_comparingdirs.xml =================================================================== --- trunk/Docs/Users/Manual/tour_comparingdirs.xml (rev 0) +++ trunk/Docs/Users/Manual/tour_comparingdirs.xml 2009-08-03 13:04:02 UTC (rev 6943) @@ -0,0 +1,172 @@ +<?xml version="1.0" encoding="UTF-8"?> +<article id="tour_comparingdirs"> + <title>Comparing Folders</title> + + <para>In addition to comparing files in WinMerge, you can compare the contents + of folders. WinMerge shows which files are different, and provides functions + to merge files between folders.</para> + + <section> + <title>The Folder Compare window</title> + + <para>If you <link linkend="tour_sel_targets">launch a WinMerge compare + operation</link> on two folders, the Folder Compare window opens:</para> + + <mediaobject> + <imageobject> + <imagedata fileref="screenshots/foldercomp1.png" format="PNG" /> + </imageobject> + + <textobject> + <phrase>Folder Compare window</phrase> + </textobject> + </mediaobject> + + <para>The Folder Compare window lists the files and subfolders found in the + target folders. Each row compares a file or subfolder in the two selected + folder targets. As with the File Compare window, the targets are represented + on <quote>left</quote> and <quote>right</quote> sides.</para> + + <para>These columns tells you whether corresponding right and left items in + each row are identical, different, or exist on only one side. The asterisk + in either the left or right date highlights the more recent date. The icons + in the Filename column provide visual cues for each type of file, like text + or binary files, and how the two sides are different. Icons are also used to + mark files and folders that are found only on one side.</para> + + <para>The columns are sortable. By default, rows are sorted by filename in + descending alphabetical order. Click the Filename column title to reverse + the sorting. Or, maybe you're only interested in rows that are different. If + so, click the Comparison result column title to sort by result type. This + groups different files together so they're easy to see.</para> + + <para>If you want to display more information, a simple customization lets + you add additional columns, including file creation time, file encoding + type, file size, and even the number of differences found.</para> + + <para>The Folder Compare window supports common operations on files, like + editing, copying, deleting, moving, and renaming (moving is equivalent to a + copy operation followed by a delete). You can use these file operations and + WinMerge functions to merge the contents of folders. You can also open files + using associated programs or external editors. You can even launch file + compare operations on individual files from the Folder Compare + window.</para> + + <para>The <inlinemediaobject> + <imageobject> + <imagedata contentwidth="23" fileref="screenshots/nav_uparrow_btn.png" /> + </imageobject> + + <textobject> + <phrase>Navigator up arrow button</phrase> + </textobject> + </inlinemediaobject> <guibutton>up arrow</guibutton> button at the top of + the Filename column navigates to the parent folder of each target.</para> + + <para>As we mentioned earlier, the WinMerge main window can contain multiple + Folder Compare or File Compare windows, and each Compare window displays the + result of a single comparison. In the preceding screen shot, the File + Compare window is maximized within the main window:</para> + </section> + + <section> + <title>Navigating folder differences</title> + + <para>To navigate differences at the folder level:</para> + + <itemizedlist> + <listitem> + <para>Use conventional keyboard and mouse actions to move between rows. + To select a difference, simply click its row.</para> + </listitem> + + <listitem> + <para>Use the Difference buttons in the toolbar to select differences + systematically. For example, click the <inlinemediaobject> + <imageobject> + <imagedata contentdepth="15" + fileref="screenshots/nextdiff_btn.png" /> + </imageobject> + + <textobject> + <phrase>Next Difference button</phrase> + </textobject> + </inlinemediaobject> <guibutton>Next Difference</guibutton> button in + the toolbar (or press <keycombo> + <keycap>Alt</keycap> + + <keycap>Enter</keycap> + </keycombo>) to select the next row that is different, automatically + skipping identical rows.</para> + </listitem> + </itemizedlist> + </section> + + <section> + <title>Comparing subfolders</title> + + <para>So far we have looked at a non-recursive comparison, meaning that it + includes only files in the root target folders. It shows subfolders, but not + their contents. If you want to see the files in a subfolder, you have to + launch a new compare operation. For example, if double-click the + <filename>Common</filename> folder in the preceding comparison, WinMerge + opens a new File Compare window that compares the two + <filename>Common</filename> folders.</para> + + <para>You can also compare folders recursively. A recursive comparison + includes all the files in all subfolders, so you don't need to launch + separate compare operations to navigate nested folders. You can As you might + expect, a recursive comparison can can take longer than a non-recursive + comparison for targets with a lot of nested files, and the result can be + harder to read.</para> + + <para>To address these drawbacks, a handy alternative is to display the + results of recursive comparisons in a hierachical tree view, instead of the + default tabular view. In the tree view, subfolders are initially collapsed + for a compact, readable display, but you can expand them to see their + contents:</para> + + <mediaobject> + <imageobject> + <imagedata fileref="screenshots/treeview-01.png" format="PNG" /> + </imageobject> + + <textobject> + <phrase>Folder Compare window</phrase> + </textobject> + </mediaobject> + </section> + + <section> + <title>Merging folder differences</title> + + <para>You merge differences in the Folder Compare window by copying one or + more files or folders from one side to the other, or by deleting + them.</para> + + <para>For example, suppose you want to update files in two folders to the + most recent version. In the preceding screen shot, you can tell from the + asterisk that the left version of <filename>AboutDlg.h</filename> is more + recent. So, to merge <filename>AboutDlg.h</filename> select the row and + click the <inlinemediaobject> + <imageobject> + <imagedata contentwidth="17" fileref="screenshots/copyr_button.png" /> + </imageobject> + + <textobject> + <phrase>Copy Right button</phrase> + </textobject> + </inlinemediaobject> <guibutton>Copy Right</guibutton> button in the + toolbar.</para> + + <para>When you merge a file or folder, the value in the <guilabel>Comparison + result</guilabel> column changes to <literal>Identical</literal>.</para> + + <para>Of course, you might not always want to merge entire files or folders. + For example, you might want to merge selected differences within the files, + or to examine the differences within files before merging them. In such + cases, you can double-click a file to launch a file comparison. WinMerge + displays the result in a new File Compare window, where you can see and + merge the line-level differences.</para> + </section> +</article> \ No newline at end of file Added: trunk/Docs/Users/Manual/tour_comparingfiles.xml =================================================================== --- trunk/Docs/Users/Manual/tour_comparingfiles.xml (rev 0) +++ trunk/Docs/Users/Manual/tour_comparingfiles.xml 2009-08-03 13:04:02 UTC (rev 6943) @@ -0,0 +1,289 @@ +<?xml version="1.0" encoding="UTF-8"?> +<article id="tour_comparingfiles"> + <title>Comparing Files</title> + + <para>When you compare two files, WinMerge shows the differences between their + lines. To demonstrate comparing and merging files, consider these two small + text files named <filename>File1</filename> and + <filename>File2</filename>:</para> + + <formalpara> + <title>File1:</title> + + <para><screen>You can cage a swallow, +can't you? +But you can't swallow +a cage, can you?</screen></para> + </formalpara> + + <formalpara> + <title>File2:</title> + + <para><screen>You can cage a swallow. +But you can't swallow +a cage. Can you?</screen></para> + </formalpara> + + <section> + <title>The File Compare window</title> + + <para>If you <link linkend="tour_sel_targets">launch a WinMerge compare + operation</link> on two files, the File Compare window opens. This screen + shot compares our two sample files:</para> + + <mediaobject> + <imageobject> + <imagedata fileref="screenshots/filecompwin01.png" /> + </imageobject> + + <textobject> + <phrase>Compare Files screen shot</phrase> + </textobject> + </mediaobject> + + <para>The File Compare window makes it easy to see differences between lines + in your files. It also has special functions for merging different lines + from one file to the other, and basic editing capabilities for more detailed + merging within lines. Notice these basic features of the File Compare + window:</para> + + <itemizedlist> + <listitem> + <para>In the bottom right corner of the window, the status bar tells you + how many differences WinMerge detects.</para> + + <para>The Location pane indicates where the differences are located in + the files. The Location pane is helpful for working with long files, + where you can't see all the differences at once in the File + panes.</para> + </listitem> + + <listitem> + <para>Differences are marked in the File panes by a gold background + color. In this comparison, the first difference is a block of two lines; + the second difference is a single line at the end.</para> + </listitem> + + <listitem> + <para>Notice that the first difference has an extra blank line on the + right side. Why does this blank line appear, since it doesn't exist in + the source file?</para> + + <para>The empty line is a placeholder in WinMerge that does not change + the source file. WinMerge inserts blank lines on one side of a + difference whenever the other side has more lines. The extra lines, + marked with a gray background color by default, keep the left and right + sides vertically aligned for ease of comparison. That is, every + difference begins on the same line in the File panes, even when they are + on different lines in the source files. Without this feature, files of + different lengths would be hard to compare.</para> + </listitem> + + <listitem> + <para>The third line is identical in both files, so it has no difference + color (its background is white).</para> + </listitem> + + <listitem> + <para>Within differences, WinMerge highlights the text that makes the + lines different. By default, different words are highlighted. To see + more detail you can highlight changes at the character level; to see + less, you can turn off all highlighting within lines.</para> + </listitem> + </itemizedlist> + + <note> + <para>The WinMerge main window can contain multiple File Compare (and + Folder compare) windows. Each File Compare window displays the result of a + single comparison, representing the two files in the left and right File + panes. In our screen shot, the File Compare window is maximized within the + main window:</para> + </note> + </section> + + <section> + <title>Navigating line differences</title> + + <para>In the File Compare window you can use standard mouse and cursor + actions to select and edit text in either File pane. But in WinMerge, + working with text and working with differences are not the same thing. + WinMerge provides special functions to navigate differences.</para> + + <para>For example, click anywhere in an area that is marked as a difference, + then click the <inlinemediaobject> + <imageobject> + <imagedata contentdepth="15" fileref="screenshots/currentdiff_btn.png" /> + </imageobject> + + <textobject> + <phrase>Current Difference button</phrase> + </textobject> + </inlinemediaobject> <guibutton>Current Difference</guibutton> button in + the toolbar.</para> + + <para>The next two screen shots show the first difference in our sample + comparison, after it's selected. When you select a difference, several + things happen:</para> + + <itemizedlist> + <listitem> + <para>The Selected Difference background color (red by default) + highlights the difference in the File panes. The Location Pane also + highlights the selected difference and marks its location with arrows. + :</para> + + <mediaobject> + <imageobject> + <imagedata fileref="screenshots/filecomp_diffpanesel.png" /> + </imageobject> + + <textobject> + <phrase>Difference selected in Compare Files panes</phrase> + </textobject> + </mediaobject> + </listitem> + + <listitem> + <para>The selected difference is loaded in the Diff pane, where you can + examine it in isolation from other differences.</para> + + <mediaobject> + <imageobject> + <imagedata fileref="screenshots/filecomp_diffpane2.png" /> + </imageobject> + + <textobject> + <phrase>Compare Files Diff Pane</phrase> + </textobject> + </mediaobject> + </listitem> + + <listitem> + <para>All the merge buttons in the toolbar are enabled: + <inlinemediaobject> + <imageobject> + <imagedata fileref="screenshots/mergebtns-on.png" /> + </imageobject> + </inlinemediaobject></para> + </listitem> + + <listitem> + <para>The status bar confirms which difference is selected.</para> + </listitem> + </itemizedlist> + </section> + + <section> + <title>Merging differences in files</title> + + <para>You can merge differences at two levels in the File Compare + window:</para> + + <variablelist> + <varlistentry> + <term>Line-level differences</term> + + <listitem> + <para>As we have seen, a difference includes one or more lines. Use + the WinMerge merge functions to copy an entire selected difference + from one side to the other. For example, click the <inlinemediaobject> + <imageobject> + <imagedata contentdepth="15" + fileref="screenshots/copyr_adv_btn.png" /> + </imageobject> + + <textobject> + <phrase>Copy Right and Advance button</phrase> + </textobject> + </inlinemediaobject> <guibutton>Copy Right and Advance</guibutton> + button.</para> + + <mediaobject> + <imageobject> + <imagedata fileref="screenshots/filecomp_merged.png" /> + </imageobject> + + <textobject> + <phrase>Compare Files window after merge</phrase> + </textobject> + </mediaobject> + + <para>Notice the changes:</para> + + <itemizedlist> + <listitem> + <para>The first difference is gone: the lines are now identical + and have no difference color.</para> + </listitem> + + <listitem> + <para>WinMerge automatically selects the next difference, skipping + over the identical line. The Location Pane also moves its + indicator.</para> + </listitem> + + <listitem> + <para>The status bar indicates that only one difference + remains.</para> + </listitem> + </itemizedlist> + + <para>You can see that the navigation and merge functions provide a + good way to systematically step through all the differences in a + comparison.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term>Differences within lines</term> + + <listitem> + <para>Instead of merging entire differences using the Merge functions, + you can change text within them by manually editing either file + directly in the File Compare window. For example, if you don't want to + use either side of the first difference, you can delete the line. Or, + you might replace <quote>words</quote> on the right side with + <quote>text</quote>.</para> + </listitem> + </varlistentry> + </variablelist> + + <para>After you finish merging, you can click <menuchoice> + <guimenu>File</guimenu> + + <guimenuitem>Save</guimenuitem> + </menuchoice> to save changes to both sides. Or, to save just one side, + click <menuchoice> + <guimenu>File</guimenu> + + <guimenuitem>Save Left</guimenuitem> + </menuchoice> or <menuchoice> + <guimenu>File</guimenu> + + <guimenuitem>Save</guimenuitem> + </menuchoice>.</para> + + <para>This was a trivial example — there were only two differences and we + only merged one of them. But you can use the methods shown here to navigate + and merge line differences between files of any length.</para> + + <!-- + <para>When you launch a file compare operation, WinMerge opens the File + Compare window. The window features two columns representing the + <quote>left</quote> and <quote>right</quote> files that you are comparing, and + indicates whether the corresponding lines on each side are identical or + different. WinMerge can also highlight the content within lines that makes + them different.</para> + + <para>You can tailor how differences are detected and displayed. For example, + if whitespace differences are not meaningful to your comparison, you can + choose to ignore whitespace or different line ending encodings. You can change + the colors used to highlight line differences and the text within them.</para> + + <para>The Compare window has special functions that make it easy to step + through line differences quickly and systematically, and functions to merge + differences from one file to the other if you want to. You can also edit the + files directly in the Compare window.</para> +--> + </section> +</article> \ No newline at end of file Added: trunk/Docs/Users/Manual/tour_sel_targets.xml =================================================================== --- trunk/Docs/Users/Manual/tour_sel_targets.xml (rev 0) +++ trunk/Docs/Users/Manual/tour_sel_targets.xml 2009-08-03 13:04:02 UTC (rev 6943) @@ -0,0 +1,184 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" +"build/dtd/docbookx.dtd"> +<article id="tour_sel_targets"> + <title>Starting WinMerge compare operations</title> + + <para>Every WinMerge compare operation has two targets: either two files or + two folders. WinMerge makes it easy to select targets and launch comparisons + from different places in your Windows environment. Here are some commonly used + methods:</para> + + <section> + <title>Drag and drop</title> + + <para>Select two files or two folders in Windows Explorer and drag them to + the WinMerge shortcut on your desktop, or into the WinMerge window if it's + already open.</para> + + <mediaobject> + <imageobject> + <imagedata fileref="screenshots/dragndrop-files.png" format="PNG" /> + </imageobject> + + <textobject> + <phrase>Drag and drop to WinMerge Desktop icon</phrase> + </textobject> + </mediaobject> + + <note> + <para>If you drop only one file or folder into the WinMerge icon or + window, WinMerge opens the <xref linkend="sel_targets_dialog" />, where + you can specify the other target.</para> + </note> + </section> + + <section> + <title>Windows Explorer context menu shortcuts</title> + + <para>WinMerge has an option that adds a <guimenuitem>WinMerge</guimenuitem> + shortcut to the context menu when you select one or two files or folders in + Windows Explorer. Choosing the shortcut opens WinMerge and compares the + selected items:</para> + + <mediaobject> + <imageobject> + <imagedata fileref="screenshots/ctx_menu_simple.png" format="PNG" /> + </imageobject> + + <textobject> + <phrase>Windows Explorer basic context menu integration</phrase> + </textobject> + </mediaobject> + + <para>For even more flexibility, you can replace the basic + <guimenuitem>WinMerge</guimenuitem> shortcut with a set of advanced + shortcuts. Use these shortcuts to select objects separately, even from + different Explorer folders or windows. The next screen shot shows a typical + sequence: we choose the first compare target in one Explorer view, then the + second target in another Explorer view.</para> + + <mediaobject> + <imageobject> + <imagedata fileref="screenshots/ctx_menu_advanced_2wins.png" + format="PNG" /> + </imageobject> + + <textobject> + <phrase>Windows Explorer advanced context menu integration</phrase> + </textobject> + </mediaobject> + </section> + + <section id="sel_targets_dialog"> + <title>Select Files or Folder dialog</title> + + <para>For maximum flexibility in launching compare operations, click + <menuchoice> + <guimenu>File</guimenu> + + <guimenuitem>Open</guimenuitem> + </menuchoice> in the main WinMerge window to open the Select Files or + Folders dialog:</para> + + <mediaobject> + <imageobject> + <imagedata fileref="screenshots/OpenDlg1.png" format="PNG" /> + </imageobject> + + <textobject> + <phrase>Select Files or Folders window</phrase> + </textobject> + </mediaobject> + + <para>This dialog lets you browse anywhere for the files or folders to + compare. Alternatively, you might choose a recently-used file or folder from + the <guilabel>Left</guilabel> and <guilabel>Right</guilabel> drop-down + controls. You can even drag a file or folder from Windows Explorer into the + <guilabel>Left</guilabel> or <guilabel>Right</guilabel> field. A message + prompts you if either target is not found, or if you entered a combination + of file and folder (WinMerge can't compare files to folders!) in the two + fields.</para> + + <para>The dialog contains several options to tailor your compare operation, + including these:</para> + + <variablelist> + <varlistentry> + <term>Filter</term> + + <listitem> + <para>Use this option to apply a filter to narrow the scope of the + comparison. There two kinds of filters:</para> + + <formalpara> + <title>File filters</title> + + <para>include or exclude files that match regular expressions. For + example, the expression <code>^test</code> matches files that start + with the string, <literal>test</literal>, like + <filename>testheaders.h</filename>. WinMerge installs a number of + filter files that specify commonly-excluded files for various + languages, like C#, C++, and Visual Basic. You can edit these files + and, of course, add your own.</para> + </formalpara> + + <formalpara> + <title>Line filters</title> + + <para>ignore lines <emphasis>within</emphasis> files that match + patterns. For example, the expression <code>^[1-5]00</code> ignores + lines beginning with numbers <literal>100</literal>, + <literal>200</literal>, <literal>300</literal>, + <literal>400</literal>, and <literal>500</literal>.</para> + </formalpara> + + <para>WinMerge provides the Filters dialog for creating and managing + filters.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term>Include Subfolders</term> + + <listitem> + <para>This option lets you control the depth of a folder comparison. + Enabling it compares all folder levels, which might take a while if + there are a lot of files. Disable it to compare only the top level of + the target folders. This is the fastest option, and you can + <quote>drill down</quote> into nested folders later in the Compare + Folders window.</para> + </listitem> + </varlistentry> + </variablelist> + </section> + + <section> + <title>Command line</title> + + <para>The WinMerge CLI includes commands with a full set of parameters and + options that you can use in a script or Command Prompt window to launch + comparisons. This example compares two folders recursively and displays the + result in the WinMerge window:</para> + + <para><userinput>WinMergeU <filename>/r C:\folder1</filename> <filename + class="directory"><filename>C:\folder2</filename> + </filename></userinput></para> + </section> + + <section> + <title>Version control systems</title> + + <para>If you run TortoiseSVN, TortoiseCVS, or Rational ClearCase, you can + configure your version control system to open WinMerge directly. That is, if + you compare files using one of these VCS tools, WinMerge opens instead of + the tool's native diff utility.</para> + + <note> + <para>Another handy VCS integration automatically launches your version + control system's checkout dialog whenever you change a managed file in the + WinMerge window. This integration works with version control systems that + lock files, specifically ClearCase and Visual Source Safe.</para> + </note> + </section> +</article> \ No newline at end of file This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site. |
From: <den...@us...> - 2009-08-10 21:47:21
|
Revision: 6949 http://winmerge.svn.sourceforge.net/winmerge/?rev=6949&view=rev Author: denisbradford Date: 2009-08-10 21:47:13 +0000 (Mon, 10 Aug 2009) Log Message: ----------- re patch 2817443: separate Quick Tour files and output from Manual. Modified Paths: -------------- trunk/Docs/Users/Manual/build/build_html.bat trunk/Docs/Users/Manual/build/build_html_page.xsl Added Paths: ----------- trunk/Docs/Users/Manual/tour/ trunk/Docs/Users/Manual/tour/WinMerge_tour.xml trunk/Docs/Users/Manual/tour/screenshots/ trunk/Docs/Users/Manual/tour/screenshots/OpenDlg_tr.png trunk/Docs/Users/Manual/tour/screenshots/copyr_adv_btn_tr.png trunk/Docs/Users/Manual/tour/screenshots/copyr_button_tr.png trunk/Docs/Users/Manual/tour/screenshots/ctx_menu_advanced_tr.png trunk/Docs/Users/Manual/tour/screenshots/ctx_menu_simple_tr.png trunk/Docs/Users/Manual/tour/screenshots/currentdiff_btn_tr.png trunk/Docs/Users/Manual/tour/screenshots/dragndrop_files_tr.png trunk/Docs/Users/Manual/tour/screenshots/filecomp_diffpane_tr.png trunk/Docs/Users/Manual/tour/screenshots/filecomp_diffpanesel_tr.png trunk/Docs/Users/Manual/tour/screenshots/filecomp_merged_tr.png trunk/Docs/Users/Manual/tour/screenshots/filecompwin_tr.png trunk/Docs/Users/Manual/tour/screenshots/foldercomp_tr.png trunk/Docs/Users/Manual/tour/screenshots/mergebtns_on_tr.png trunk/Docs/Users/Manual/tour/screenshots/nav_uparrow_btn_tr.png trunk/Docs/Users/Manual/tour/screenshots/nextdiff_btn_tr.png trunk/Docs/Users/Manual/tour/screenshots/treeview_tr.png trunk/Docs/Users/Manual/tour/tour_comparingdirs.xml trunk/Docs/Users/Manual/tour/tour_comparingfiles.xml trunk/Docs/Users/Manual/tour/tour_sel_targets.xml Modified: trunk/Docs/Users/Manual/build/build_html.bat =================================================================== --- trunk/Docs/Users/Manual/build/build_html.bat 2009-08-10 13:16:23 UTC (rev 6948) +++ trunk/Docs/Users/Manual/build/build_html.bat 2009-08-10 21:47:13 UTC (rev 6949) @@ -3,10 +3,11 @@ call configuration.bat set docbook_inputfile=..\WinMerge_help.xml -set tour_inputfile=..\WinMerge_tour.xml +set tour_inputfile=..\tour\WinMerge_tour.xml set docbook_use_stylesheet=build_html.xsl set tour_use_stylesheet=build_html_page.xsl set docbook_outputdir=%docbook_build_path%\html +set tour_outputdir=%docbook_build_path%\tour set ads=false if "%1" == "withads" goto withads if not "%1" == "" goto withadserror @@ -25,8 +26,9 @@ :start if not exist "%docbook_outputdir%" mkdir "%docbook_outputdir%" +if not exist "%docbook_outputdir%" mkdir "%tour_outputdir%" -echo Copy images... +echo Copy images ... if not exist "%docbook_outputdir%\images" mkdir "%docbook_outputdir%\images" copy "..\images\*.gif" "%docbook_outputdir%\images\." copy "..\images\*.png" "%docbook_outputdir%\images\." @@ -34,6 +36,8 @@ echo Copy screenshots... if not exist "%docbook_outputdir%\screenshots" mkdir "%docbook_outputdir%\screenshots" copy "..\screenshots\*.*" "%docbook_outputdir%\screenshots\." +if not exist "%tour_outputdir%\screenshots" mkdir "%tour_outputdir%\screenshots" +copy "..\tour\screenshots\*.*" "%tour_outputdir%\screenshots\." echo Copy art... if not exist "%docbook_outputdir%\art" mkdir "%docbook_outputdir%\art" @@ -42,13 +46,12 @@ echo Copy stylesheets... if not exist "%docbook_outputdir%\css" mkdir "%docbook_outputdir%\css" copy "..\css\*.css" "%docbook_outputdir%\css" -rem copy "..\css\print.css" "%docbook_outputdir%\css\print.css" echo Create Manual HTML files... %docbook_java_exe% %docbook_java_parameters% -cp %docbook_saxon_jar%;%docbook_xerces_jar%;%docbook_saxon_xsl% -Djavax.xml.parsers.DocumentBuilderFactory=%DBFACTORY% -Djavax.xml.parsers.SAXParserFactory=%SPFACTORY% -Dorg.apache.xerces.xni.parser.XMLParserConfiguration=%XINCLUDE% com.icl.saxon.StyleSheet %docbook_inputfile% %docbook_use_stylesheet% base.dir=%docbook_outputdir%\ withads=%ads% echo Create tour HTML file... -%docbook_java_exe% %docbook_java_parameters% -cp %docbook_saxon_jar%;%docbook_xerces_jar%;%docbook_saxon_xsl% -Djavax.xml.parsers.DocumentBuilderFactory=%DBFACTORY% -Djavax.xml.parsers.SAXParserFactory=%SPFACTORY% -Dorg.apache.xerces.xni.parser.XMLParserConfiguration=%XINCLUDE% com.icl.saxon.StyleSheet -o %docbook_outputdir%/WinMerge_tour.html %tour_inputfile% %tour_use_stylesheet% headtitle.suffix="' - WinMerge 2.12 Tour'" withads=%ads% +%docbook_java_exe% %docbook_java_parameters% -cp %docbook_saxon_jar%;%docbook_xerces_jar%;%docbook_saxon_xsl% -Djavax.xml.parsers.DocumentBuilderFactory=%DBFACTORY% -Djavax.xml.parsers.SAXParserFactory=%SPFACTORY% -Dorg.apache.xerces.xni.parser.XMLParserConfiguration=%XINCLUDE% com.icl.saxon.StyleSheet -o %tour_outputdir%/WinMerge_tour.html %tour_inputfile% %tour_use_stylesheet% headtitle.suffix="' - WinMerge 2.12 Tour'" withads=%ads% admon.graphics.path="../html/images/" echo Finished! Modified: trunk/Docs/Users/Manual/build/build_html_page.xsl =================================================================== --- trunk/Docs/Users/Manual/build/build_html_page.xsl 2009-08-10 13:16:23 UTC (rev 6948) +++ trunk/Docs/Users/Manual/build/build_html_page.xsl 2009-08-10 21:47:13 UTC (rev 6949) @@ -45,14 +45,14 @@ ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ --> <!-- Link to the appropriate css stylesheets --> <xsl:template name="user.head.content"> - <link rel="stylesheet" type="text/css" href="css/onepage.css" /> - <link rel="stylesheet" type="text/css" media="print" href="css/print.css" /> + <link rel="stylesheet" type="text/css" href="../html/css/onepage.css" /> + <link rel="stylesheet" type="text/css" media="print" href="../html/css/print.css" /> </xsl:template> <!-- For web pages add banner image and Google ad scripts --> <xsl:template name="user.header.content"> <div class="header"><a href="http://www.winmerge.org"> - <img src="images/head.gif" alt="winmerge.org"/></a> + <img src="../html/images/head.gif" alt="winmerge.org"/></a> </div> <xsl:if test="$withads = 'true'"> <xsl:call-template name="header.ads"/> Property changes on: trunk/Docs/Users/Manual/tour ___________________________________________________________________ Added: bugtraq:url + http://sourceforge.net/support/tracker.php?aid=%BUGID% Added: bugtraq:logregex + (\d{6,}) Added: trunk/Docs/Users/Manual/tour/WinMerge_tour.xml =================================================================== --- trunk/Docs/Users/Manual/tour/WinMerge_tour.xml (rev 0) +++ trunk/Docs/Users/Manual/tour/WinMerge_tour.xml 2009-08-10 21:47:13 UTC (rev 6949) @@ -0,0 +1,59 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" +"../build/dtd/docbookx.dtd"> +<book id="WinMerge_tour"> + <bookinfo> + <title>WinMerge <xi:include href="../replaceables.xml" + xmlns:xi="http://www.w3.org/2001/XInclude" + xpointer="element(version)" /> Quick Tour</title> + + <abstract> + <para>WinMerge is an Open Source differencing and merging tool for + Windows. Use it to detect changes between files and folders, and then to + merge changes selectively. You can use WinMerge by itself, or launch it + from a version control system or another application.</para> + + <para>When you compare two files or folders, the result is displayed in + the WinMerge window. The WinMerge window's visual display and functions + are designed to help you see differences between your targets, and to + merge selected differences if you want to.</para> + + <formalpara> + <title>In a file comparison</title> + + <para>WinMerge shows differences between lines. The built-in text editor + provides syntax highlighting for several programming languages and other + file formats.</para> + </formalpara> + + <formalpara> + <title>In a folder comparison</title> + + <para>WinMerge indicates various kinds of differences between the files + that the folders contain.</para> + </formalpara> + + <para>Take this brief, guided tour if you are considering installing + WinMerge, or if you just want to see what the tool looks like and what you + can do with it. The topics below describe the main WinMerge features. They + include some simple examples of comparing files and folders, and merging + differences between them.</para> + + <para>This tour just scratches the surface. For detailed information and + guidance about using WinMerge, see the Help that is installed with + WinMerge and available <ulink url="http://winmerge.org/docs/manual/">on + our Web site</ulink>.</para> + </abstract> + </bookinfo> + + <toc></toc> + + <xi:include href="tour_sel_targets.xml" + xmlns:xi="http://www.w3.org/2001/XInclude" xpointer="element(/1)" /> + + <xi:include href="tour_comparingfiles.xml" + xmlns:xi="http://www.w3.org/2001/XInclude" /> + + <xi:include href="tour_comparingdirs.xml" + xmlns:xi="http://www.w3.org/2001/XInclude" /> +</book> Property changes on: trunk/Docs/Users/Manual/tour/screenshots ___________________________________________________________________ Added: bugtraq:url + http://sourceforge.net/support/tracker.php?aid=%BUGID% Added: bugtraq:logregex + (\d{6,}) Added: trunk/Docs/Users/Manual/tour/screenshots/OpenDlg_tr.png =================================================================== (Binary files differ) Property changes on: trunk/Docs/Users/Manual/tour/screenshots/OpenDlg_tr.png ___________________________________________________________________ Added: svn:mime-type + application/octet-stream Added: trunk/Docs/Users/Manual/tour/screenshots/copyr_adv_btn_tr.png =================================================================== (Binary files differ) Property changes on: trunk/Docs/Users/Manual/tour/screenshots/copyr_adv_btn_tr.png ___________________________________________________________________ Added: svn:mime-type + application/octet-stream Added: trunk/Docs/Users/Manual/tour/screenshots/copyr_button_tr.png =================================================================== (Binary files differ) Property changes on: trunk/Docs/Users/Manual/tour/screenshots/copyr_button_tr.png ___________________________________________________________________ Added: svn:mime-type + application/octet-stream Added: trunk/Docs/Users/Manual/tour/screenshots/ctx_menu_advanced_tr.png =================================================================== (Binary files differ) Property changes on: trunk/Docs/Users/Manual/tour/screenshots/ctx_menu_advanced_tr.png ___________________________________________________________________ Added: svn:mime-type + application/octet-stream Added: trunk/Docs/Users/Manual/tour/screenshots/ctx_menu_simple_tr.png =================================================================== (Binary files differ) Property changes on: trunk/Docs/Users/Manual/tour/screenshots/ctx_menu_simple_tr.png ___________________________________________________________________ Added: svn:mime-type + application/octet-stream Added: trunk/Docs/Users/Manual/tour/screenshots/currentdiff_btn_tr.png =================================================================== (Binary files differ) Property changes on: trunk/Docs/Users/Manual/tour/screenshots/currentdiff_btn_tr.png ___________________________________________________________________ Added: svn:mime-type + application/octet-stream Added: trunk/Docs/Users/Manual/tour/screenshots/dragndrop_files_tr.png =================================================================== (Binary files differ) Property changes on: trunk/Docs/Users/Manual/tour/screenshots/dragndrop_files_tr.png ___________________________________________________________________ Added: svn:mime-type + application/octet-stream Added: trunk/Docs/Users/Manual/tour/screenshots/filecomp_diffpane_tr.png =================================================================== (Binary files differ) Property changes on: trunk/Docs/Users/Manual/tour/screenshots/filecomp_diffpane_tr.png ___________________________________________________________________ Added: svn:mime-type + application/octet-stream Added: trunk/Docs/Users/Manual/tour/screenshots/filecomp_diffpanesel_tr.png =================================================================== (Binary files differ) Property changes on: trunk/Docs/Users/Manual/tour/screenshots/filecomp_diffpanesel_tr.png ___________________________________________________________________ Added: svn:mime-type + application/octet-stream Added: trunk/Docs/Users/Manual/tour/screenshots/filecomp_merged_tr.png =================================================================== (Binary files differ) Property changes on: trunk/Docs/Users/Manual/tour/screenshots/filecomp_merged_tr.png ___________________________________________________________________ Added: svn:mime-type + application/octet-stream Added: trunk/Docs/Users/Manual/tour/screenshots/filecompwin_tr.png =================================================================== (Binary files differ) Property changes on: trunk/Docs/Users/Manual/tour/screenshots/filecompwin_tr.png ___________________________________________________________________ Added: svn:mime-type + application/octet-stream Added: trunk/Docs/Users/Manual/tour/screenshots/foldercomp_tr.png =================================================================== (Binary files differ) Property changes on: trunk/Docs/Users/Manual/tour/screenshots/foldercomp_tr.png ___________________________________________________________________ Added: svn:mime-type + application/octet-stream Added: trunk/Docs/Users/Manual/tour/screenshots/mergebtns_on_tr.png =================================================================== (Binary files differ) Property changes on: trunk/Docs/Users/Manual/tour/screenshots/mergebtns_on_tr.png ___________________________________________________________________ Added: svn:mime-type + application/octet-stream Added: trunk/Docs/Users/Manual/tour/screenshots/nav_uparrow_btn_tr.png =================================================================== (Binary files differ) Property changes on: trunk/Docs/Users/Manual/tour/screenshots/nav_uparrow_btn_tr.png ___________________________________________________________________ Added: svn:mime-type + application/octet-stream Added: trunk/Docs/Users/Manual/tour/screenshots/nextdiff_btn_tr.png =================================================================== (Binary files differ) Property changes on: trunk/Docs/Users/Manual/tour/screenshots/nextdiff_btn_tr.png ___________________________________________________________________ Added: svn:mime-type + application/octet-stream Added: trunk/Docs/Users/Manual/tour/screenshots/treeview_tr.png =================================================================== (Binary files differ) Property changes on: trunk/Docs/Users/Manual/tour/screenshots/treeview_tr.png ___________________________________________________________________ Added: svn:mime-type + application/octet-stream Added: trunk/Docs/Users/Manual/tour/tour_comparingdirs.xml =================================================================== --- trunk/Docs/Users/Manual/tour/tour_comparingdirs.xml (rev 0) +++ trunk/Docs/Users/Manual/tour/tour_comparingdirs.xml 2009-08-10 21:47:13 UTC (rev 6949) @@ -0,0 +1,172 @@ +<?xml version="1.0" encoding="UTF-8"?> +<article id="tour_comparingdirs"> + <title>Comparing Folders</title> + + <para>In addition to comparing files in WinMerge, you can compare the contents + of folders. WinMerge shows which files are different, and provides functions + to merge files between folders.</para> + + <section> + <title>The Folder Compare window</title> + + <para>If you <link linkend="tour_sel_targets">launch a WinMerge compare + operation</link> on two folders, the Folder Compare window opens:</para> + + <mediaobject> + <imageobject> + <imagedata fileref="screenshots/foldercomp_tr.png" format="PNG" /> + </imageobject> + + <textobject> + <phrase>Folder Compare window</phrase> + </textobject> + </mediaobject> + + <para>The Folder Compare window lists the files and subfolders found in the + target folders. Each row compares a file or subfolder in the two selected + folder targets. As with the File Compare window, the targets are represented + on <quote>left</quote> and <quote>right</quote> sides.</para> + + <para>These columns tells you whether corresponding right and left items in + each row are identical, different, or exist on only one side. The asterisk + in either the left or right date highlights the more recent date. The icons + in the Filename column provide visual cues for each type of file, like text + or binary files, and how the two sides are different. Icons are also used to + mark files and folders that are found only on one side.</para> + + <para>The columns are sortable. By default, rows are sorted by filename in + descending alphabetical order. Click the Filename column title to reverse + the sorting. Or, maybe you're only interested in rows that are different. If + so, click the Comparison result column title to sort by result type. This + groups different files together so they're easy to see.</para> + + <para>If you want to display more information, a simple customization lets + you add additional columns, including file creation time, file encoding + type, file size, and even the number of differences found.</para> + + <para>The Folder Compare window supports common operations on files, like + editing, copying, deleting, moving, and renaming (moving is equivalent to a + copy operation followed by a delete). You can use these file operations and + WinMerge functions to merge the contents of folders. You can also open files + using associated programs or external editors. You can even launch file + compare operations on individual files from the Folder Compare + window.</para> + + <para>The <inlinemediaobject> + <imageobject> + <imagedata contentwidth="23" fileref="screenshots/nav_uparrow_btn_tr.png" /> + </imageobject> + + <textobject> + <phrase>Navigator up arrow button</phrase> + </textobject> + </inlinemediaobject> <guibutton>up arrow</guibutton> button at the top of + the Filename column navigates to the parent folder of each target.</para> + + <para>As we mentioned earlier, the WinMerge main window can contain multiple + Folder Compare or File Compare windows, and each Compare window displays the + result of a single comparison. In the preceding screen shot, the File + Compare window is maximized within the main window:</para> + </section> + + <section> + <title>Navigating folder differences</title> + + <para>To navigate differences at the folder level:</para> + + <itemizedlist> + <listitem> + <para>Use conventional keyboard and mouse actions to move between rows. + To select a difference, simply click its row.</para> + </listitem> + + <listitem> + <para>Use the Difference buttons in the toolbar to select differences + systematically. For example, click the <inlinemediaobject> + <imageobject> + <imagedata contentdepth="15" + fileref="screenshots/nextdiff_btn_tr.png" /> + </imageobject> + + <textobject> + <phrase>Next Difference button</phrase> + </textobject> + </inlinemediaobject> <guibutton>Next Difference</guibutton> button in + the toolbar (or press <keycombo> + <keycap>Alt</keycap> + + <keycap>Enter</keycap> + </keycombo>) to select the next row that is different, automatically + skipping identical rows.</para> + </listitem> + </itemizedlist> + </section> + + <section> + <title>Comparing subfolders</title> + + <para>So far we have looked at a non-recursive comparison, meaning that it + includes only files in the root target folders. It shows subfolders, but not + their contents. If you want to see the files in a subfolder, you have to + launch a new compare operation. For example, if double-click the + <filename>Common</filename> folder in the preceding comparison, WinMerge + opens a new File Compare window that compares the two + <filename>Common</filename> folders.</para> + + <para>You can also compare folders recursively. A recursive comparison + includes all the files in all subfolders, so you don't need to launch + separate compare operations to navigate nested folders. You can As you might + expect, a recursive comparison can can take longer than a non-recursive + comparison for targets with a lot of nested files, and the result can be + harder to read.</para> + + <para>To address these drawbacks, a handy alternative is to display the + results of recursive comparisons in a hierachical tree view, instead of the + default tabular view. In the tree view, subfolders are initially collapsed + for a compact, readable display, but you can expand them to see their + contents:</para> + + <mediaobject> + <imageobject> + <imagedata fileref="screenshots/treeview_tr.png" format="PNG" /> + </imageobject> + + <textobject> + <phrase>Folder Compare window</phrase> + </textobject> + </mediaobject> + </section> + + <section> + <title>Merging folder differences</title> + + <para>You merge differences in the Folder Compare window by copying one or + more files or folders from one side to the other, or by deleting + them.</para> + + <para>For example, suppose you want to update files in two folders to the + most recent version. In the preceding screen shot, you can tell from the + asterisk that the left version of <filename>AboutDlg.h</filename> is more + recent. So, to merge <filename>AboutDlg.h</filename> select the row and + click the <inlinemediaobject> + <imageobject> + <imagedata contentwidth="17" fileref="screenshots/copyr_button_tr.png" /> + </imageobject> + + <textobject> + <phrase>Copy Right button</phrase> + </textobject> + </inlinemediaobject> <guibutton>Copy Right</guibutton> button in the + toolbar.</para> + + <para>When you merge a file or folder, the value in the <guilabel>Comparison + result</guilabel> column changes to <literal>Identical</literal>.</para> + + <para>Of course, you might not always want to merge entire files or folders. + For example, you might want to merge selected differences within the files, + or to examine the differences within files before merging them. In such + cases, you can double-click a file to launch a file comparison. WinMerge + displays the result in a new File Compare window, where you can see and + merge the line-level differences.</para> + </section> +</article> Added: trunk/Docs/Users/Manual/tour/tour_comparingfiles.xml =================================================================== --- trunk/Docs/Users/Manual/tour/tour_comparingfiles.xml (rev 0) +++ trunk/Docs/Users/Manual/tour/tour_comparingfiles.xml 2009-08-10 21:47:13 UTC (rev 6949) @@ -0,0 +1,289 @@ +<?xml version="1.0" encoding="UTF-8"?> +<article id="tour_comparingfiles"> + <title>Comparing Files</title> + + <para>When you compare two files, WinMerge shows the differences between their + lines. To demonstrate comparing and merging files, consider these two small + text files named <filename>File1</filename> and + <filename>File2</filename>:</para> + + <formalpara> + <title>File1:</title> + + <para><screen>You can cage a swallow, +can't you? +But you can't swallow +a cage, can you?</screen></para> + </formalpara> + + <formalpara> + <title>File2:</title> + + <para><screen>You can cage a swallow. +But you can't swallow +a cage. Can you?</screen></para> + </formalpara> + + <section> + <title>The File Compare window</title> + + <para>If you <link linkend="tour_sel_targets">launch a WinMerge compare + operation</link> on two files, the File Compare window opens. This screen + shot compares our two sample files:</para> + + <mediaobject> + <imageobject> + <imagedata fileref="screenshots/filecompwin_tr.png" /> + </imageobject> + + <textobject> + <phrase>Compare Files screen shot</phrase> + </textobject> + </mediaobject> + + <para>The File Compare window makes it easy to see differences between lines + in your files. It also has special functions for merging different lines + from one file to the other, and basic editing capabilities for more detailed + merging within lines. Notice these basic features of the File Compare + window:</para> + + <itemizedlist> + <listitem> + <para>In the bottom right corner of the window, the status bar tells you + how many differences WinMerge detects.</para> + + <para>The Location pane indicates where the differences are located in + the files. The Location pane is helpful for working with long files, + where you can't see all the differences at once in the File + panes.</para> + </listitem> + + <listitem> + <para>Differences are marked in the File panes by a gold background + color. In this comparison, the first difference is a block of two lines; + the second difference is a single line at the end.</para> + </listitem> + + <listitem> + <para>Notice that the first difference has an extra blank line on the + right side. Why does this blank line appear, since it doesn't exist in + the source file?</para> + + <para>The empty line is a placeholder in WinMerge that does not change + the source file. WinMerge inserts blank lines on one side of a + difference whenever the other side has more lines. The extra lines, + marked with a gray background color by default, keep the left and right + sides vertically aligned for ease of comparison. That is, every + difference begins on the same line in the File panes, even when they are + on different lines in the source files. Without this feature, files of + different lengths would be hard to compare.</para> + </listitem> + + <listitem> + <para>The third line is identical in both files, so it has no difference + color (its background is white).</para> + </listitem> + + <listitem> + <para>Within differences, WinMerge highlights the text that makes the + lines different. By default, different words are highlighted. To see + more detail you can highlight changes at the character level; to see + less, you can turn off all highlighting within lines.</para> + </listitem> + </itemizedlist> + + <note> + <para>The WinMerge main window can contain multiple File Compare (and + Folder compare) windows. Each File Compare window displays the result of a + single comparison, representing the two files in the left and right File + panes. In our screen shot, the File Compare window is maximized within the + main window:</para> + </note> + </section> + + <section> + <title>Navigating line differences</title> + + <para>In the File Compare window you can use standard mouse and cursor + actions to select and edit text in either File pane. But in WinMerge, + working with text and working with differences are not the same thing. + WinMerge provides special functions to navigate differences.</para> + + <para>For example, click anywhere in an area that is marked as a difference, + then click the <inlinemediaobject> + <imageobject> + <imagedata contentdepth="15" fileref="screenshots/currentdiff_btn_tr.png" /> + </imageobject> + + <textobject> + <phrase>Current Difference button</phrase> + </textobject> + </inlinemediaobject> <guibutton>Current Difference</guibutton> button in + the toolbar.</para> + + <para>The next two screen shots show the first difference in our sample + comparison, after it's selected. When you select a difference, several + things happen:</para> + + <itemizedlist> + <listitem> + <para>The Selected Difference background color (red by default) + highlights the difference in the File panes. The Location Pane also + highlights the selected difference and marks its location with arrows. + :</para> + + <mediaobject> + <imageobject> + <imagedata fileref="screenshots/filecomp_diffpanesel_tr.png" /> + </imageobject> + + <textobject> + <phrase>Difference selected in Compare Files panes</phrase> + </textobject> + </mediaobject> + </listitem> + + <listitem> + <para>The selected difference is loaded in the Diff pane, where you can + examine it in isolation from other differences.</para> + + <mediaobject> + <imageobject> + <imagedata fileref="screenshots/filecomp_diffpane_tr.png" /> + </imageobject> + + <textobject> + <phrase>Compare Files Diff Pane</phrase> + </textobject> + </mediaobject> + </listitem> + + <listitem> + <para>All the merge buttons in the toolbar are enabled: + <inlinemediaobject> + <imageobject> + <imagedata fileref="screenshots/mergebtns_on_tr.png" /> + </imageobject> + </inlinemediaobject></para> + </listitem> + + <listitem> + <para>The status bar confirms which difference is selected.</para> + </listitem> + </itemizedlist> + </section> + + <section> + <title>Merging differences in files</title> + + <para>You can merge differences at two levels in the File Compare + window:</para> + + <variablelist> + <varlistentry> + <term>Line-level differences</term> + + <listitem> + <para>As we have seen, a difference includes one or more lines. Use + the WinMerge merge functions to copy an entire selected difference + from one side to the other. For example, click the <inlinemediaobject> + <imageobject> + <imagedata contentdepth="15" + fileref="screenshots/copyr_adv_btn_tr.png" /> + </imageobject> + + <textobject> + <phrase>Copy Right and Advance button</phrase> + </textobject> + </inlinemediaobject> <guibutton>Copy Right and Advance</guibutton> + button.</para> + + <mediaobject> + <imageobject> + <imagedata fileref="screenshots/filecomp_merged_tr.png" /> + </imageobject> + + <textobject> + <phrase>Compare Files window after merge</phrase> + </textobject> + </mediaobject> + + <para>Notice the changes:</para> + + <itemizedlist> + <listitem> + <para>The first difference is gone: the lines are now identical + and have no difference color.</para> + </listitem> + + <listitem> + <para>WinMerge automatically selects the next difference, skipping + over the identical line. The Location Pane also moves its + indicator.</para> + </listitem> + + <listitem> + <para>The status bar indicates that only one difference + remains.</para> + </listitem> + </itemizedlist> + + <para>You can see that the navigation and merge functions provide a + good way to systematically step through all the differences in a + comparison.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term>Differences within lines</term> + + <listitem> + <para>Instead of merging entire differences using the Merge functions, + you can change text within them by manually editing either file + directly in the File Compare window. For example, if you don't want to + use either side of the first difference, you can delete the line. Or, + you might replace <quote>words</quote> on the right side with + <quote>text</quote>.</para> + </listitem> + </varlistentry> + </variablelist> + + <para>After you finish merging, you can click <menuchoice> + <guimenu>File</guimenu> + + <guimenuitem>Save</guimenuitem> + </menuchoice> to save changes to both sides. Or, to save just one side, + click <menuchoice> + <guimenu>File</guimenu> + + <guimenuitem>Save Left</guimenuitem> + </menuchoice> or <menuchoice> + <guimenu>File</guimenu> + + <guimenuitem>Save</guimenuitem> + </menuchoice>.</para> + + <para>This was a trivial example — there were only two differences and we + only merged one of them. But you can use the methods shown here to navigate + and merge line differences between files of any length.</para> + + <!-- + <para>When you launch a file compare operation, WinMerge opens the File + Compare window. The window features two columns representing the + <quote>left</quote> and <quote>right</quote> files that you are comparing, and + indicates whether the corresponding lines on each side are identical or + different. WinMerge can also highlight the content within lines that makes + them different.</para> + + <para>You can tailor how differences are detected and displayed. For example, + if whitespace differences are not meaningful to your comparison, you can + choose to ignore whitespace or different line ending encodings. You can change + the colors used to highlight line differences and the text within them.</para> + + <para>The Compare window has special functions that make it easy to step + through line differences quickly and systematically, and functions to merge + differences from one file to the other if you want to. You can also edit the + files directly in the Compare window.</para> +--> + </section> +</article> Added: trunk/Docs/Users/Manual/tour/tour_sel_targets.xml =================================================================== --- trunk/Docs/Users/Manual/tour/tour_sel_targets.xml (rev 0) +++ trunk/Docs/Users/Manual/tour/tour_sel_targets.xml 2009-08-10 21:47:13 UTC (rev 6949) @@ -0,0 +1,182 @@ +<?xml version="1.0" encoding="UTF-8"?> +<article id="tour_sel_targets"> + <title>Starting WinMerge compare operations</title> + + <para>Every WinMerge compare operation has two targets: either two files or + two folders. WinMerge makes it easy to select targets and launch comparisons + from different places in your Windows environment. Here are some commonly used + methods:</para> + + <section> + <title>Drag and drop</title> + + <para>Select two files or two folders in Windows Explorer and drag them to + the WinMerge shortcut on your desktop, or into the WinMerge window if it's + already open.</para> + + <mediaobject> + <imageobject> + <imagedata fileref="screenshots/dragndrop_files_tr.png" format="PNG" /> + </imageobject> + + <textobject> + <phrase>Drag and drop to WinMerge Desktop icon</phrase> + </textobject> + </mediaobject> + + <note> + <para>If you drop only one file or folder into the WinMerge icon or + window, WinMerge opens the <xref linkend="sel_targets_dialog" />, where + you can specify the other target.</para> + </note> + </section> + + <section> + <title>Windows Explorer context menu shortcuts</title> + + <para>WinMerge has an option that adds a <guimenuitem>WinMerge</guimenuitem> + shortcut to the context menu when you select one or two files or folders in + Windows Explorer. Choosing the shortcut opens WinMerge and compares the + selected items:</para> + + <mediaobject> + <imageobject> + <imagedata fileref="screenshots/ctx_menu_simple_tr.png" format="PNG" /> + </imageobject> + + <textobject> + <phrase>Windows Explorer basic context menu integration</phrase> + </textobject> + </mediaobject> + + <para>For even more flexibility, you can replace the basic + <guimenuitem>WinMerge</guimenuitem> shortcut with a set of advanced + shortcuts. Use these shortcuts to select objects separately, even from + different Explorer folders or windows. The next screen shot shows a typical + sequence: we choose the first compare target in one Explorer view, then the + second target in another Explorer view.</para> + + <mediaobject> + <imageobject> + <imagedata fileref="screenshots/ctx_menu_advanced_tr.png" + format="PNG" /> + </imageobject> + + <textobject> + <phrase>Windows Explorer advanced context menu integration</phrase> + </textobject> + </mediaobject> + </section> + + <section id="sel_targets_dialog"> + <title>Select Files or Folder dialog</title> + + <para>For maximum flexibility in launching compare operations, click + <menuchoice> + <guimenu>File</guimenu> + + <guimenuitem>Open</guimenuitem> + </menuchoice> in the main WinMerge window to open the Select Files or + Folders dialog:</para> + + <mediaobject> + <imageobject> + <imagedata fileref="screenshots/OpenDlg_tr.png" format="PNG" /> + </imageobject> + + <textobject> + <phrase>Select Files or Folders window</phrase> + </textobject> + </mediaobject> + + <para>This dialog lets you browse anywhere for the files or folders to + compare. Alternatively, you might choose a recently-used file or folder from + the <guilabel>Left</guilabel> and <guilabel>Right</guilabel> drop-down + controls. You can even drag a file or folder from Windows Explorer into the + <guilabel>Left</guilabel> or <guilabel>Right</guilabel> field. A message + prompts you if either target is not found, or if you entered a combination + of file and folder (WinMerge can't compare files to folders!) in the two + fields.</para> + + <para>The dialog contains several options to tailor your compare operation, + including these:</para> + + <variablelist> + <varlistentry> + <term>Filter</term> + + <listitem> + <para>Use this option to apply a filter to narrow the scope of the + comparison. There two kinds of filters:</para> + + <formalpara> + <title>File filters</title> + + <para>include or exclude files that match regular expressions. For + example, the expression <code>^test</code> matches files that start + with the string, <literal>test</literal>, like + <filename>testheaders.h</filename>. WinMerge installs a number of + filter files that specify commonly-excluded files for various + languages, like C#, C++, and Visual Basic. You can edit these files + and, of course, add your own.</para> + </formalpara> + + <formalpara> + <title>Line filters</title> + + <para>ignore lines <emphasis>within</emphasis> files that match + patterns. For example, the expression <code>^[1-5]00</code> ignores + lines beginning with numbers <literal>100</literal>, + <literal>200</literal>, <literal>300</literal>, + <literal>400</literal>, and <literal>500</literal>.</para> + </formalpara> + + <para>WinMerge provides the Filters dialog for creating and managing + filters.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term>Include Subfolders</term> + + <listitem> + <para>This option lets you control the depth of a folder comparison. + Enabling it compares all folder levels, which might take a while if + there are a lot of files. Disable it to compare only the top level of + the target folders. This is the fastest option, and you can + <quote>drill down</quote> into nested folders later in the Compare + Folders window.</para> + </listitem> + </varlistentry> + </variablelist> + </section> + + <section> + <title>Command line</title> + + <para>The WinMerge CLI includes commands with a full set of parameters and + options that you can use in a script or Command Prompt window to launch + comparisons. This example compares two folders recursively and displays the + result in the WinMerge window:</para> + + <para><userinput>WinMergeU <filename>/r C:\folder1</filename> <filename + class="directory"><filename>C:\folder2</filename> + </filename></userinput></para> + </section> + + <section> + <title>Version control systems</title> + + <para>If you run TortoiseSVN, TortoiseCVS, or Rational ClearCase, you can + configure your version control system to open WinMerge directly. That is, if + you compare files using one of these VCS tools, WinMerge opens instead of + the tool's native diff utility.</para> + + <note> + <para>Another handy VCS integration automatically launches your version + control system's checkout dialog whenever you change a managed file in the + WinMerge window. This integration works with version control systems that + lock files, specifically ClearCase and Visual Source Safe.</para> + </note> + </section> +</article> This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site. |