From: Kimmo Varis Date: Mon, 27 Nov 2006 18:03:24 +0000 (+0000) Subject: PATCH: [ 1603393 ] Improve project file documentation X-Git-Tag: 2.16.5~4556 X-Git-Url: http://git.osdn.net/view?a=commitdiff_plain;h=641f44422b1d2f24922cf64396794a37e52fb02f;p=winmerge-jp%2Fwinmerge-jp.git PATCH: [ 1603393 ] Improve project file documentation --- diff --git a/Docs/Users/Manual/Changes.txt b/Docs/Users/Manual/Changes.txt index b16a4036c..cf33c0c27 100644 --- a/Docs/Users/Manual/Changes.txt +++ b/Docs/Users/Manual/Changes.txt @@ -3,6 +3,9 @@ Manual: Faq.xml PATCH: [ 1603385 ] Manual: fix filter file path, clarify template file usage Manual: Filters.xml + PATCH: [ 1603393 ] Improve project file documentation + Manual: Open_paths.xml + Manual/screenshots new file: projfile_save.png 2006-11-26 Kimmo PATCH: [ 1602658 ] Manual: note about some 7-zip MSI installers missing file diff --git a/Docs/Users/Manual/Open_paths.xml b/Docs/Users/Manual/Open_paths.xml index b160b71c8..00416eefe 100644 --- a/Docs/Users/Manual/Open_paths.xml +++ b/Docs/Users/Manual/Open_paths.xml @@ -46,7 +46,7 @@ subfolders Original/ and Altered/ it must be opened by selecting same filename to both sides in - Open-dialog or commandline. Then + Open-dialog or command line. Then WinMerge can compare contents of those two subfolders. @@ -86,7 +86,7 @@ Field can also contain file filter name. Easiest way to select file filter is using Filters-dialog which can be - opended with "Select..." button next to field. + opened with "Select..." button next to field. That dialog allows also creating, editing and deleting of filter files. @@ -99,14 +99,12 @@ - Shell Integration - - - Shell Integration - + <indexterm> + <primary>Shell Integration</primary> + </indexterm>Shell Integration The Shell Integration is a convenient way to select the paths using - Windows Explorer. Installer enables Shell Integration if choosen so. Shell + Windows Explorer. Installer enables Shell Integration if chosen so. Shell Integration can be enabled or disabled from Options/System. When the Shell Integration is enabled item WinMerge is added @@ -125,7 +123,7 @@ Selecting "Enable advanced menu" for Shell Integration from options adds more choices for path selection. Now - WinMerge adds two menuitems to Explorer context menu: + WinMerge adds two menu items to Explorer context menu: "Compare To" and "Compare...". Compare To selects path as first ("Left") @@ -149,8 +147,8 @@ Browse to location of second item you want to compare and - select it. Open context menu and move menuselection over first - "Compare" item. Now Explorer's statusbar + select it. Open context menu and move menu selection over first + "Compare" item. Now Explorer's status bar shows memorized path to which you are comparing newly selected path. @@ -197,60 +195,80 @@ - Project file - - Simple project files can be used to select commonly used paths with - filter. Project file can be given to commandline like normal file or - opened from - File - - Open Project... - WinMerge reads paths project - file contains and if two paths are given opens them. If only one path is - given or one of paths is invalid Open-dialog is shown - for user to select second path or valid paths. - - Project files can be edited and saved using Project - File -dialog that can be opened from - File - - Save Project... - When opened, the dialog is initialized with values from - current compare. Values can be edited and saved to project file with - Save... button. One can also load existing project - file with Open... button. - - Project file can be selected also in Open - dialog. There are couple of things to remember: - - - - If two project files are selected, project files themselves - are compared. - - - - If project file is selected as left-side file, and right-side - file is empty, project file is opened like using - File - - Open Project... - dialog. - - - - If project file is selected as left-side file and any other - file as right-side file, contents of project file and another file are - compared. - - - - Project files are simple XML files with .WinMerge extension. + <indexterm> + <primary>Project Files</primary> + </indexterm>Project Files + + Project files allow fast and easy opening of commonly used paths + (and filter). The user can easily save currently open paths as project + file for later use. + + + Opening Project File + + Project file can be given to command line like normal file or + opened from + File + + Open Project... + WinMerge reads paths from project file and if two paths + are given opens them. If only one path is given or one of paths is + invalid, the Open-dialog is shown for user to + select the second path or valid paths. + + Project file can be selected also in Open + dialog. There are couple of things to remember: + + + + If two project files are selected, project files themselves + are compared. + + + + If project file is selected as left-side file, and + right-side file is empty, project file is opened like using + + File + + Open Project... + dialog. + + + + If project file is selected as left-side file and any other + file as right-side file, contents of project file and another file + are compared. + + + + + + Editing and Saving Project File + + Project files can be edited and saved using Project + File -dialog that can be opened from + File + + Save Project... + When opened, the dialog is initialized with values from + the current compare. Values can be edited and saved to the project file + with Save... button. One can also load existing + project file with Open... button. + + + + + + + Format + Project files are simple XML files with .WinMerge extension. + <?xml version='1.0' encoding='UTF-8'?> <project> <paths> @@ -263,7 +281,7 @@ </paths> </project> - The project file has four fields: + The project file has six fields: @@ -300,8 +318,8 @@ - None of fields are required and they can be empty + None of the fields are required and they can be empty (<left></left>). - + \ No newline at end of file diff --git a/Docs/Users/Manual/screenshots/projfile_save.png b/Docs/Users/Manual/screenshots/projfile_save.png new file mode 100644 index 000000000..bc940e599 Binary files /dev/null and b/Docs/Users/Manual/screenshots/projfile_save.png differ