/plugins/JDiffPlugin/tags/jdiffplugin-1_0/JDiffPlugin.html

# · HTML · 179 lines · 139 code · 40 blank · 0 comment · 0 complexity · a205ab4ebb62757d9da7a34c4aa86eaa MD5 · raw file 

    

  1. <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 3.2//EN">
    2. 

  2. <HTML>
    3. 

  3. <HEAD>
    4. 

  4. <TITLE>JDiff Plugin</TITLE>
    5. 

  5. </HEAD>
    6. 

  6. <BODY BGCOLOR="#FFFFFF">
    7. 

  7. 

  8. 

  9. <TABLE
    10. 

  10.     CELLSPACING="0"
    11. 

  11.     CELLPADDING="3"
    12. 

  12.     BGCOLOR="#CCCCFF"
    13. 

  13.     BORDER="0"
    14. 

  14.     WIDTH="100%"
    15. 

  15.     SUMMARY="JDiff Plugin header"
    16. 

  16. >
    17. 

  17. <TR WIDTH="100%">
    18. 

  18. <TD><BIG><BIG>JDiff Plugin</BIG></BIG></TD>
    19. 

  19. <TD ALIGN="right"><SMALL>By Andr&eacute; Kaplan<BR>
    20. 

  20. <EM>akaplan@users.sourceforge.net</EM></SMALL></TD>
    21. 

  21. </TR>
    22. 

  22. </TABLE>
    23. 

  23. 

  24. 

  25. <UL>
    26. 

  26.     <LI><A HREF="#general">Presentation</A></LI>
    27. 

  27.     <LI><A HREF="#usage">Usage</A></LI>
    28. 

  28.     <LI><A HREF="#display">Display</A></LI>
    29. 

  29.     <LI><A HREF="#options">Options</A></LI>
    30. 

  30.     <LI><A HREF="#credits">Credits</A></LI>
    31. 

  31.     <LI><A HREF="#feedback">Feedback</A></LI>
    32. 

  32. </UL>
    33. 

  33. 

  34. 

  35. <H2><A NAME="general">Presentation</A></H2>
    36. 

  36. 

  37. <P>JDiffPlugin is a visual diff utility for jEdit.</P>
    38. 

  38. 

  39. <P>It features:</P>
    40. 

  40. <UL>
    41. 

  41.     <LI>Diff overviews (local and global)</LI>
    42. 

  42.     <LI>Synchronized scrolling</LI>
    43. 

  43. </UL>
    44. 

  44. 

  45. <P>It requires:</P>
    46. 

  46. <UL>
    47. 

  47.     <LI>JDK 1.1
    48. 

  48.     <LI>jEdit 3.0
    49. 

  49. </UL>
    50. 

  50. 

  51. 

  52. <H2><A NAME="usage">Usage</A></H2>
    53. 

  53. 

  54. <OL>
    55. 

  55.     <LI>Split your view in two (vertically)<BR>
    56. 

  56.     <SMALL><EM>Note</EM>: JDiff will split your view in two if necessary.</SMALL>
    57. 

  57.     <LI>Edit the buffers you want to compare:
    58. 

  58.     <UL>
    59. 

  59.         <LI>the buffer on the left is the original
    60. 

  60.         <LI>the buffer on the right is the revision
    61. 

  61.     </UL>
    62. 

  62.     <LI>Activate JDiff:
    63. 

  63.         <EM>Plugins&nbsp;-&gt;&nbsp;JDiff&nbsp;-&gt;&nbsp;Dual&nbsp;Diff</EM>
    64. 

  64.     <LI>Figure&nbsp;1 shows you the result
    65. 

  65. </OL>
    66. 

  66. 

  67. <TABLE
    68. 

  68.     ALIGN="CENTER"
    69. 

  69.     CELLSPACING="0"
    70. 

  70.     CELLPADDING="3"
    71. 

  71.     BORDER="0"
    72. 

  72.     SUMMARY="JDiff Plugin snapshot"
    73. 

  73. >
    74. 

  74. <TR>
    75. 

  75. <TD><IMG SRC="diff_snapshot.jpg" BORDER="0" ALT="JDiff Plugin snapshot"></TD>
    76. 

  76. </TR>
    77. 

  77. <TR>
    78. 

  78. <TH>Figure&nbsp;1 - JDiff Plugin</TH>
    79. 

  79. </TR>
    80. 

  80. </TABLE>
    81. 

  81. 

  82. 

  83. <H2><A NAME="display">Display</A></H2>
    84. 

  84. 

  85. <P>Once JDiff is activated as in Figure&nbsp;1, you should see :</P>
    86. 

  86. <UL>
    87. 

  87.     <LI>Text Highlights
    88. 

  88.     <LI>A local overview (right of the original)
    89. 

  89.     <LI>A global overview (right of the revision)
    90. 

  90. </UL>
    91. 

  91. 

  92. <H3>Color conventions</H3>
    93. 

  93. 

  94. <P>By default:</P>
    95. 

  95. <UL>
    96. 

  96.     <LI>Changed lines apppear in yellow
    97. 

  97.     <LI>Deleted (from the original) lines appear in red
    98. 

  98.     <LI>Inserted (to the revision) lines appear in green
    99. 

  99.     <LI>Invalid lines appear as thin dark grey lines.
    100. 

  100.     <UL>
    101. 

  101.         <LI>In the original, invalid lines indicate where a block was inserted
    102. 

  102.         in the revision.
    103. 

  103.         <LI>In the revision, invalid lines indicate where a block was deleted in
    104. 

  104.         the original.
    105. 

  105.     </UL>
    106. 

  106. </UL>
    107. 

  107. 

  108. <H3>Local overview</H3>
    109. 

  109. 

  110. <P>The local overview shows how the visible changed/inserted/deleted blocks
    111. 

  111. from the original and the revision relate to each other.
    112. 

  112. </P>
    113. 

  113. 

  114. <H3>Global overview</H3>
    115. 

  115. 

  116. <P>The global overview should help you estimate how the two edited buffers
    117. 

  117. differ.
    118. 

  118. It also displays two cursors which indicate the visible parts of the two
    119. 

  119. buffers.
    120. 

  120. </P>
    121. 

  121. 

  122. <H2><A NAME="options">Options</A></H2>
    123. 

  123. 

  124. <P>You can configure whether JDiff should ignore case or not (default).</P>
    125. 

  125. 

  126. <P>You can also configure the color of:</P>
    127. 

  127. 

  128. <UL>
    129. 

  129.     <LI>Changed lines</LI>
    130. 

  130.     <LI>Deleted lines</LI>
    131. 

  131.     <LI>Inserted lines</LI>
    132. 

  132.     <LI>Invalid lines</LI>
    133. 

  133. </UL>
    134. 

  134. 

  135. <P>You can also choose whether:</P>
    136. 

  136. 

  137. <UL>
    138. 

  138.     <LI>the highlighted lines should appear brighter than these colors</LI>
    139. 

  139.     <LI>the lines in the overviews should appear darker than these colors</LI>
    140. 

  140. </UL>
    141. 

  141. 

  142. <P>At last, you can choose the color of the left and right cursor in the global
    143. 

  143. overview.
    144. 

  144. </P>
    145. 

  145. 

  146. 

  147. <H2><A NAME="credits">Credits</A></H2>
    148. 

  148. 

  149. <UL>
    150. 

  150.     <LI>Stuart D. Gathman ported the GNU diff algorithm to Java.
    151. 

  151.     See
    152. 

  152.     <A HREF="http://www.bmsi.com/java/">http://www.bmsi.com/java/</A>
    153. 

  153.     </LI>
    154. 

  154. 

  155.     <LI>Mike Dillon <EM>&lt;mdillon@gjt.org&gt;</EM> is the author of JDiff.
    156. 

  156.     See
    157. 

  157.     <A HREF="http://sourceforge.net/projects/jdiff">http://sourceforge.net/projects/jdiff</A>
    158. 

  158.     </LI>
    159. 

  159. </UL>
    160. 

  160. 

  161. 

  162. <H2><A NAME="feedback">Feedback</A></H2>
    163. 

  163. 

  164. <P>
    165. 

  165. The preferred way to send bug reports is to use the Bug Tracker at
    166. 

  166. <A HREF="http://sourceforge.net/bugs/?group_id=588">http://sourceforge.net/bugs/?group_id=588</A>.
    167. 

  167. </P>
    168. 

  168. 

  169. <P>Also you can write to:</P>
    170. 

  170. <UL>
    171. 

  171. <LI>Andr&eacute; Kaplan <EM>&lt;akaplan@users.sourceforge.net&gt;</EM>;
    172. 

  172. <LI>or jEdit-users mailing-list <EM>&lt;jedit-users@lists.sourceforge.net&gt;</EM>;
    173. 

  173. <LI>or jEdit-devel mailing.list <EM>&lt;jedit-devel@lists.sourceforge.net&gt;</EM>.
    174. 

  174. </UL>
    175. 

  175. 

  176. 

  177. </BODY>
    178. 

  178. </HTML>
    179.