Skip to content

Commit 875710d

Browse files
committed
Edited contents and fixed typos
1 parent 72cea31 commit 875710d

File tree

5 files changed

+23
-22
lines changed

5 files changed

+23
-22
lines changed

alignRules.md

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ subtitle: Change the default file names alignment method
1010

1111
Before being compared two files they must be aligned, the alignment rule can be configured
1212

13-
# Align by name case sensitivity
13+
# Align by Name Case Sensitivity
1414

1515
The default alignment method compares file name strings, if they are match case then they will be aligned.
1616
Suppose you have the scenario shown below
@@ -54,7 +54,7 @@ This can be achieved selecting 'Ignore File Name Case' from popup menu.</p>
5454
</tr>
5555
</table>
5656

57-
# Align by HFS+ filesystem case
57+
# Align by HFS+ Filesystem Case
5858

5959
Normally the <acronym title="Hierarchical File System">HFS+</acronym> disks are formatted ignoring the file name case, so if we have winter.jpg and WINTER.JPG they cannot be created on same directory (because they have the same name).
6060

@@ -68,7 +68,7 @@ It is possible to let VisualDiffer determine the file name alignment case algori
6868

6969
If the last scenario is true, the alignment will try to be smart, first it searches if a match case is available (winter.jpg with winter.jpg) then it tries to align with the most similar name.
7070

71-
# Align by user defined rules (not available on OSX 10.6 Snow Leopard)
71+
# Align by User Defined Rules (required OSX Lion or above)
7272

7373
There are scenarios where it is necessary to align files having different names.
7474

@@ -115,15 +115,15 @@ Suppose you want to align ignoring the file extension to produce the result show
115115

116116
This can be achieved using VisualDiffer 'user defined alignment rules'.
117117

118-
## Managing alignment rules
118+
## Managing Alignment Rules
119119

120120
You can create, edit or delte rules from Session Preferences Dialog
121121

122122
![image]({{ site.prefixDir }}images/screenshots/sessionPrefAlignment.png)
123123

124124
More rules can be assigned to a VisualDiffer session comparison, they are evaluated from top to bottom.
125125

126-
## Creating a rule
126+
## Creating a Rule
127127

128128
When you add a new rule (or edit an existing one) you access to the dialog shown below
129129

@@ -136,11 +136,11 @@ A rule has
136136

137137
_If you are not familiar with regular expressions please refer to [ICU](http://userguide.icu-project.org/strings/regexp) documentation._
138138

139-
## Left regular expression
139+
## Left Regular Expression
140140

141141
The left regexp is used to match a filename on the left side of VisualDiffer Folder View, we want to find all jpg files so we create a group `(.*)` followed by `.jpg` extension.
142142

143-
## Right pattern expression
143+
## Right Pattern Expression
144144

145145
Notice the right expression **isn't** a regular expression, it should contain some special patterns used to access to regular expression groups (if any).
146146

@@ -173,4 +173,5 @@ But `002.jpg` and `002.RAW` files are not aligned because `002.RAW` extension is
173173
![image]({{ site.prefixDir }}images/screenshots/alignRuleIgnoreCase.png)
174174

175175
## Test Rule
176-
TODO
176+
177+
It is possible to verify immediately if the expressions work as expected using the 'Test Rule', just type a file name and the 'Result' field will be filled accordingly.

comparisonMethods.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,11 @@ layout: default
44

55
# mainAnchor is used by Apple links
66
mainAnchor: comparisonMethod
7-
title: Comparison method
8-
subtitle: Choose the method to compare folders and how to handle special files and metadata
7+
title: Comparison Method
8+
subtitle: The folders comparison method, special files and metadata
99
---
1010

11-
# Comparison method
11+
# Comparison Method
1212

1313
It is possible to choose which method to use to compare two folders.
1414
The method to use is strictly related to user needs, comparing source code (files large only few kilobytes) should use a content comparison but to find which movies (files larger than a gigabytes) are not present on right side is faster compare by file size or file timestamp.
@@ -59,7 +59,7 @@ The complete list of supported comparison methods
5959
</table>
6060

6161

62-
# Compare Finder metadata
62+
# Compare Finder Metadata
6363

6464
It is possible to compare OSX Finder Metadata.
6565

@@ -84,7 +84,7 @@ The complete list of supported metadata
8484
</table>
8585

8686

87-
# Special files handling
87+
# Special Files Handling
8888

8989
User can choose to not traverse special files like symbolic links and packages
9090

@@ -105,7 +105,7 @@ User can choose to not traverse special files like symbolic links and packages
105105
</table>
106106

107107

108-
# Timestamp tolerance
108+
# Timestamp Tolerance
109109

110110
The timestamp comparison considers two files matching when the time (including the seconds) is identical but sometime it would be useful to have a range of tolerance for example when the difference is between 5 seconds.
111111

@@ -114,9 +114,9 @@ You can set this tolerance entering a positive integer number into the text fiel
114114
Ignore differences of X seconds or less
115115

116116

117-
# File to show
117+
# Choose Files to View according to differences found
118118

119-
After the comparison complete you can determine which files to show
119+
After the comparison complete you can choose which files to view
120120

121121
Definition: **Orphan** indicates a file present only on one side
122122

fileFilters.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -70,10 +70,10 @@ Pay attention to not add extra characters, the following paths will never found
7070
<strong>project_1/src/</strong>&nbsp;&nbsp;&nbsp;invalid, trailing slash
7171

7272

73-
# File size Filters
73+
# File Size Filters
7474

7575
It is possible to specify files (not folders) to exclude based on their size expressed in bytes, KB, MB and GB
7676

77-
# File modification date Filters
77+
# File Modification Date Filters
7878

7979
It is possible to specify files (not folders) to exclude based on their last modification date and time

finder.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,14 +21,14 @@ You don't need to run VisualDiffer then select items to compare, if you are on F
2121

2222
Add to Finder context menu (under Services) a new menu item to allow files and folders comparison.
2323

24-
## How to install
24+
## How to Install
2525
- On Lion or above double click on "Compare with VisualDiffer.workflow" file
2626
- On Snow Leopard you must copy manually the file "Compare with VisualDiffer.workflow" inside the directort /Users/your account
2727
name/Library/Services. If the directory 'Services' doesn't exist you must create it
2828

2929
More details about installation are available <a href="https://github.com/visualdiffer/scripts/blob/master/installServices.md">here</a>
3030

31-
## How to use
31+
## How to Use
3232

3333
- When elements to compare are both visible on Finder window simply select the two files or folders and choose "Compare with VisualDiffer"
3434
from service menu

trustedPaths.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ Applications like Dreamweaver save to temporary file the remote version and then
2525

2626
This behaviour generates a very frustrating user experience because the user must select the file from the panel again and again.
2727

28-
Use trusted paths
28+
Use Trusted Paths
2929
=================
3030

3131
Trusted paths resolve this problem, applications save files always on their own specific temporary folders, for example SourceTree can generate the following path
@@ -38,7 +38,7 @@ We can trust **/var/folders** that is the root used by SourceTree to saves tempo
3838

3939
Trusting **/var/folders** ensures every path generated inside it (at any deeper subfolder level) doesn't require any additional user permission and the file panel prompts no longer appears
4040

41-
Where configure trusted paths
41+
Where configure Trusted Paths
4242
=============================
4343

4444
You can add and removed trusted paths from VisualDiffer Preference panel

0 commit comments

Comments
 (0)