/plugins/JDiffPlugin/tags/jdiffplugin-2_1_0/docs/index.html

# · HTML · 506 lines · 379 code · 127 blank · 0 comment · 0 complexity · ffb462e7f275f0c27f244d3222a2c01c MD5 · raw file 

    

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

  2. <html>
    3. 

  3. <head>
    4. 

  4. <meta name="generator" content="HTML Tidy, see www.w3.org">
    5. 

  5. <title>JDiff Plugin</title>
    6. 

  6. </head>
    7. 

  7. <body>
    8. 

  8. <h2>JDiff Plugin @@build.num@@</h2>
    9. 

  9. 

  10. <p>Authors: André Kaplan, Mark Wickens, Dale Anson</p>
    11. 

  11. 

  12. <h3>Legal Notice</h3>
    13. 

  13. 

  14. <p>Permission is granted to copy, distribute and/or modify this
    15. 

  15. document under the terms of the GNU Free Documentation License,
    16. 

  16. Version 1.1 or any later version published by the Free Software
    17. 

  17. Foundation; with no Invariant Sections, Front-Cover Texts or
    18. 

  18. Back-Cover Texts, each as defined in the license. A copy of the
    19. 

  19. license can be found in the file COPYING.DOC.txt included with
    20. 

  20. jEdit.</p>
    21. 

  21. 

  22. <hr>
    23. 

  23. <a name="presentation"> 
    24. 

  24. 

  25. <h3>Presentation</h3>
    26. 

  26. 

  27. <p>JDiffPlugin is a visual diff and merge utility for jEdit.</p>
    28. 

  28. 

  29. <p>It features:</p>
    30. 

  30. 

  31. <ul>
    32. 

  32. <li>
    33. 

  33. <p>Diff overviews (local and global)</p>
    34. 

  34. </li>
    35. 

  35. 

  36. <li>
    37. 

  37. <p>Synchronized scrolling</p>
    38. 

  38. </li>
    39. 

  39. 

  40. <li>
    41. 

  41. <p>Ignore case option</p>
    42. 

  42. </li>
    43. 

  43. 

  44. <li>
    45. 

  45. <p>Ignore leading and trailing whitespace option</p>
    46. 

  46. </li>
    47. 

  47. 

  48. <li>
    49. 

  49. <p>Ignore amount of whitespace option</p>
    50. 

  50. </li>
    51. 

  51. 

  52. <li>
    53. 

  53. <p>Ignore all whitespace option</p>
    54. 

  54. </li>
    55. 

  55. 

  56. <li>
    57. 

  57. <p>Normal diff output</p>
    58. 

  58. </li>
    59. 

  59. 

  60. <li>
    61. 

  61. <p>Visual merging of differences between two files</p>
    62. 

  62. </li>
    63. 

  63. </ul>
    64. 

  64. 

  65. <hr>
    66. 

  66. <a name="usage"> 
    67. 

  67. 

  68. <h3>Usage</h3>
    69. 

  69. 

  70. <p>The simplest method is to open the Dual Diff Dialog (Plugins
    71. 

  71. -&gt; JDiff -&gt; <b>Show dual diff dialog</b>) and choose the
    72. 

  72. files to compare.</p>
    73. 

  73. 

  74. <p>But you can also:</p>
    75. 

  75. 

  76. <ol>
    77. 

  77. <li>
    78. 

  78. <p>Split your view in two (vertically)</p>
    79. 

  79. </li>
    80. 

  80. 

  81. <li>
    82. 

  82. <p>Edit the buffers you want to compare:</p>
    83. 

  83. 

  84. <ul>
    85. 

  85. <li>
    86. 

  86. <p>the buffer on the left is the original</p>
    87. 

  87. </li>
    88. 

  88. 

  89. <li>
    90. 

  90. <p>the buffer on the right is the revision</p>
    91. 

  91. </li>
    92. 

  92. </ul>
    93. 

  93. </li>
    94. 

  94. 

  95. <li>
    96. 

  96. <p>Activate JDiff: <b>Plugins</b> &gt; <b>JDiff</b>&gt; <b>Dual
    97. 

  97. Diff</b></p>
    98. 

  98. </li>
    99. 

  99. </ol>
    100. 

  100. 

  101. <p>Or if you have JDiff docked:</p>
    102. 

  102. 

  103. <ol>
    104. 

  104. <li>Open the dockable.</li>
    105. 

  105. 

  106. <li>Click the 'Diff' button: 
    107. 

  107. 

  108. <p><img alt="" src="delta.png"></p>
    109. 

  109. </li>
    110. 

  110. </ol>
    111. 

  111. 

  112. <p>Figure 1 shows the result</p>
    113. 

  113. 

  114. <img alt="" src="diff_overview.jpg" format="JPG"> 
    115. 

  115. 

  116. <hr>
    117. 

  117. <a name="display"> 
    118. 

  118. 

  119. <h3>Display</h3>
    120. 

  120. 

  121. <p>Once JDiff is activated as in Figure 1, you should see:</p>
    122. 

  122. 

  123. <ul>
    124. 

  124. <li>
    125. 

  125. <p>Text Highlights</p>
    126. 

  126. </li>
    127. 

  127. 

  128. <li>
    129. 

  129. <p>A local overview (right of the original)</p>
    130. 

  130. </li>
    131. 

  131. 

  132. <li>
    133. 

  133. <p>A global overview (right of the revision)</p>
    134. 

  134. </li>
    135. 

  135. 

  136. <li>
    137. 

  137. <p>If you have activated the Diff dockable, you'll also see the
    138. 

  138. merge controls and the line overview.</p>
    139. 

  139. </li>
    140. 

  140. </ul>
    141. 

  141. 

  142. <h3>Color conventions</h3>
    143. 

  143. 

  144. <p>By default:</p>
    145. 

  145. 

  146. <ul>
    147. 

  147. <li>
    148. 

  148. <p>Changed lines appear in yellow</p>
    149. 

  149. </li>
    150. 

  150. 

  151. <li>
    152. 

  152. <p>Deleted (from the original) lines appear in red</p>
    153. 

  153. </li>
    154. 

  154. 

  155. <li>
    156. 

  156. <p>Inserted (to the revision) lines appear in green</p>
    157. 

  157. </li>
    158. 

  158. 

  159. <li>
    160. 

  160. <p>Invalid lines appear as thin dark grey lines.</p>
    161. 

  161. 

  162. <ul>
    163. 

  163. <li>
    164. 

  164. <p>In the original, invalid lines indicate where a block was
    165. 

  165. inserted in the revision.</p>
    166. 

  166. </li>
    167. 

  167. 

  168. <li>
    169. 

  169. <p>In the revision, invalid lines indicate where a block was
    170. 

  170. deleted in the original.</p>
    171. 

  171. </li>
    172. 

  172. </ul>
    173. 

  173. </li>
    174. 

  174. </ul>
    175. 

  175. 

  176. <h3>Local overview</h3>
    177. 

  177. 

  178. <p>The local overview shows how the visible
    179. 

  179. changed/inserted/deleted blocks from the original and the
    180. 

  180. revision relate to each other. Merging between files can be
    181. 

  181. performed by clicking a right arrow in the local overview, which
    182. 

  182. will select the corresponding text from the original and replace
    183. 

  183. the related text in the revision. The blocks to be merged are
    184. 

  184. indicated by vertical black bars so it is obvious which code is
    185. 

  185. moving. Clicking a left arrow in the local overview will select
    186. 

  186. the corresponding text block from the revision and replace the
    187. 

  187. related text in the original. Note that the code moves are by
    188. 

  188. block, not by line, so the entire diff will be moved.</p>
    189. 

  189. 

  190. <h3>Global overview</h3>
    191. 

  191. 

  192. <p>The global overview should help you estimate how the two
    193. 

  193. edited buffers differ. It also displays two cursors which
    194. 

  194. indicate the visible parts of the two buffers. Clicking within
    195. 

  195. the global overview will move the view to the corresponding part
    196. 

  196. of the file.</p>
    197. 

  197. 

  198. <h3>Line overview</h3>
    199. 

  199. 

  200. <p>The line overview shows character-by-character differences
    201. 

  201. between the current cursor lines within a diff block. This makes
    202. 

  202. it easy to see the difference of even a single character change
    203. 

  203. between the left and right lines. This overview only shows one
    204. 

  204. line at a time of the diff block, move the cursor within the
    205. 

  205. block to see the individual line differences for each line.</p>
    206. 

  206. 

  207. <h3>Merge controls</h3>
    208. 

  208. 

  209. <p>The merge control has 8 buttons. From left to right in
    210. 

  210. horizontal mode:</p>
    211. 

  211. 

  212. <ol>
    213. 

  213. <li><img alt="" src="diff.jpg">&nbsp; Start a diff.</li>
    214. 

  214. 

  215. <li><img alt="" src="unsplit.jpg"> &nbsp; Unsplit the view, which
    216. 

  216. ends the diff session.</li>
    217. 

  217. 

  218. <li><img alt="" src="next_diff.jpg">&nbsp; Move to next
    219. 

  219. diff.</li>
    220. 

  220. 

  221. <li><img alt="" src="move_right.jpg">&nbsp; Move current diff to
    222. 

  222. right. This replaces the diff block on the right with the text
    223. 

  223. from the left diff block.</li>
    224. 

  224. 

  225. <li><img alt="" src="move_left.jpg">&nbsp; Move current diff to
    226. 

  226. left. This replaces the diff block on the left with the text from
    227. 

  227. the right diff block.</li>
    228. 

  228. 

  229. <li><img alt="" src="prev_diff.jpg">&nbsp; Move to previous
    230. 

  230. diff.</li>
    231. 

  231. 

  232. <li><img alt="" src="swap.jpg">&nbsp; Swap text areas, that is,
    233. 

  233. put the file that was on the left on the right, and put the file
    234. 

  234. that was on the right on the left.</li>
    235. 

  235. 

  236. <li><img alt="" src="refresh.jpg">&nbsp; Refresh the diff.</li>
    237. 

  237. </ol>
    238. 

  238. 

  239. <p>The merge controls can also be displayed vertically or in a
    240. 

  240. compact form (as shown in the image above), and with or without
    241. 

  241. the line overview. The vertical display is convenient for the
    242. 

  242. left or right docking areas. The horizontal layout works well in
    243. 

  243. the top or bottom docking areas. The compact layout uses less
    244. 

  244. vertical space in the top or bottom docking areas when the line
    245. 

  245. overview is also displayed.</p>
    246. 

  246. 

  247. <hr>
    248. 

  248. <a name="other_commands"> 
    249. 

  249. 

  250. <h3>Other commands</h3>
    251. 

  251. 

  252. <p>These commands are available on the plugin menu:</p>
    253. 

  253. 

  254. <ul>
    255. 

  255. <li>
    256. 

  256. <p><b>Refresh</b>: refreshes the diff display</p>
    257. 

  257. </li>
    258. 

  258. 

  259. <li>
    260. 

  260. <p><b>Go to previous/next difference</b></p>
    261. 

  261. </li>
    262. 

  262. 

  263. <li>
    264. 

  264. <p><b>Ignore case</b>: toggles the "Ignore case" option for the
    265. 

  265. current diff</p>
    266. 

  266. </li>
    267. 

  267. 

  268. <li>
    269. 

  269. <p><b>Ignore leading and trailing whitespace</b>: toggles the
    270. 

  270. "Ignore leading and trailing whitespace" option for the current
    271. 

  271. diff</p>
    272. 

  272. </li>
    273. 

  273. 

  274. <li>
    275. 

  275. <p><b>Ignore amount of whitespace</b>: toggles the "Ignore amount
    276. 

  276. of whitespace" option for the current diff</p>
    277. 

  277. </li>
    278. 

  278. 

  279. <li>
    280. 

  280. <p><b>Ignore all whitespace</b>: toggles the "Ignore all
    281. 

  281. whitespace" option for the current diff</p>
    282. 

  282. </li>
    283. 

  283. 

  284. <li>
    285. 

  285. <p><b>Normal Diff Output</b>: generates a diff file using the
    286. 

  286. normal method</p>
    287. 

  287. </li>
    288. 

  288. </ul>
    289. 

  289. 

  290. <hr>
    291. 

  291. <a name="options"> 
    292. 

  292. 

  293. <h3>Options</h3>
    294. 

  294. 

  295. <p>These settings can be made in the JDiff options panel, Plugins
    296. 

  296. -&gt; Plugin Options... -&gt; JDiff Plugin</p>
    297. 

  297. 

  298. <h3>Line comparison options</h3>
    299. 

  299. 

  300. <p>You can configure how JDiff compares lines by default. JDiff
    301. 

  301. can:</p>
    302. 

  302. 

  303. <ul>
    304. 

  304. <li>
    305. 

  305. <p>Ignore case: upper-cased lines are compared.</p>
    306. 

  306. </li>
    307. 

  307. 

  308. <li>
    309. 

  309. <p>Ignore leading and trailing whitespace: lines are compared as
    310. 

  310. if leading and trailing whitespaces were removed.</p>
    311. 

  311. </li>
    312. 

  312. 

  313. <li>
    314. 

  314. <p>Ignore amount of whitespace: lines are compared as if any</p>
    315. 

  315. 

  316. <ul>
    317. 

  317. <li>
    318. 

  318. <p>leading and trailing whitespaces were removed</p>
    319. 

  319. </li>
    320. 

  320. 

  321. <li>
    322. 

  322. <p>sequence of whitespaces were replaced by one single space.</p>
    323. 

  323. </li>
    324. 

  324. </ul>
    325. 

  325. </li>
    326. 

  326. 

  327. <li>
    328. 

  328. <p>Ignore all whitespace: lines are compared as if:</p>
    329. 

  329. 

  330. <ul>
    331. 

  331. <li>
    332. 

  332. <p>any leading, trailing and inner whitespaces were removed</p>
    333. 

  333. </li>
    334. 

  334. </ul>
    335. 

  335. </li>
    336. 

  336. </ul>
    337. 

  337. 

  338. <h3>Control layout</h3>
    339. 

  339. 

  340. <p>Automatically display dockable on diff: When starting a new
    341. 

  341. diff from the plugin menu, if on, this setting will cause the
    342. 

  342. diff dockable to be displayed immediately so the merge controls
    343. 

  343. are quickly accessible.</p>
    344. 

  344. 

  345. <p>Show line diffs in dockable: Toggles display of the line diff
    346. 

  346. in the dockable. Turning this off will reduce the amount of
    347. 

  347. screen space the dockable occupies.</p>
    348. 

  348. 

  349. <p>Merge control layout</p>
    350. 

  350. 

  351. <ul>
    352. 

  352. <li>Horizontal: default, merge control buttons in a single
    353. 

  353. horizontal line. Best used docked at top or bottom.</li>
    354. 

  354. 

  355. <li>Vertical: merge controls in a single vertical line. Best used
    356. 

  356. docked at the left or right. Not a good choice when the line
    357. 

  357. overview is also on.</li>
    358. 

  358. 

  359. <li>Compact: merge controls in 2 columns of 4 buttons. Occupies
    360. 

  360. smallest amount of screen space when used with the line
    361. 

  361. overview.</li>
    362. 

  362. </ul>
    363. 

  363. 

  364. <h3>Overview colors</h3>
    365. 

  365. 

  366. <p>You can configure the colors of:</p>
    367. 

  367. 

  368. <ul>
    369. 

  369. <li>
    370. 

  370. <p>Changed lines</p>
    371. 

  371. </li>
    372. 

  372. 

  373. <li>
    374. 

  374. <p>Deleted lines</p>
    375. 

  375. </li>
    376. 

  376. 

  377. <li>
    378. 

  378. <p>Inserted lines</p>
    379. 

  379. </li>
    380. 

  380. 

  381. <li>
    382. 

  382. <p>Invalid lines</p>
    383. 

  383. </li>
    384. 

  384. 

  385. <li>
    386. 

  386. <p>Left cursor in the global overview</p>
    387. 

  387. </li>
    388. 

  388. 

  389. <li>
    390. 

  390. <p>Right cursor in the global overview</p>
    391. 

  391. </li>
    392. 

  392. </ul>
    393. 

  393. 

  394. <h3>Highlight colors</h3>
    395. 

  395. 

  396. <p>You can configure the colors of:</p>
    397. 

  397. 

  398. <ul>
    399. 

  399. <li>
    400. 

  400. <p>Changed lines</p>
    401. 

  401. </li>
    402. 

  402. 

  403. <li>
    404. 

  404. <p>Deleted lines</p>
    405. 

  405. </li>
    406. 

  406. 

  407. <li>
    408. 

  408. <p>Inserted lines</p>
    409. 

  409. </li>
    410. 

  410. 

  411. <li>
    412. 

  412. <p>Invalid lines</p>
    413. 

  413. </li>
    414. 

  414. </ul>
    415. 

  415. 

  416. <hr>
    417. 

  417. <a name="license"> 
    418. 

  418. 

  419. <h3>License</h3>
    420. 

  420. 

  421. <p>The source code is distributed under the GPL. Please see <a
    422. 

  422. href=
    423. 

  423. "http://www.fsf.org/copyleft/gpl.html">http://www.fsf.org/copyleft/gpl.html</a></p>
    424. 

  424. 

  425. <hr>
    426. 

  426. <a name="feedback"> 
    427. 

  427. 

  428. <h3>Feedback</h3>
    429. 

  429. 

  430. <p>The preferred way to send bug reports is to use the
    431. 

  431. Sourceforge Bug Tracker at <a href=
    432. 

  432. "http://sourceforge.net/bugs/?group_id=588">http://sourceforge.net/bugs/?group_id=588</a></p>
    433. 

  433. 

  434. <p>You can also write to:</p>
    435. 

  435. 

  436. <ul>
    437. 

  437. <li>
    438. 

  438. <p>jEdit-users mailing-list <a href=
    439. 

  439. "mailto:jedit-users@lists.sourceforge.net">jedit-users@lists.sourceforge.net</a></p>
    440. 

  440. </li>
    441. 

  441. 

  442. <li>
    443. 

  443. <p>or jEdit-devel mailing-list <a href=
    444. 

  444. "mailto:jedit-devel@lists.sourceforge.net">mailto:jedit-devel@lists.sourceforge.net</a></p>
    445. 

  445. </li>
    446. 

  446. </ul>
    447. 

  447. 

  448. <hr>
    449. 

  449. <a name="history"> 
    450. 

  450. 

  451. <h3>History</h3>
    452. 

  452. 

  453. <ul>
    454. 

  454. <li>
    455. 

  455. <p>Version 1.8. Bug fixes, added "Diff" and "Refresh" buttons to
    456. 

  456. merge controls, major code refactoring to clean up the various
    457. 

  457. painting issues.</p>
    458. 

  458. </li>
    459. 

  459. 

  460. <li>
    461. 

  461. <p>Version 1.7. Added a dockable to display line diff and merge
    462. 

  462. controls. Added merge functionality, added mouse listener to
    463. 

  463. global overview. (Dale Anson)</p>
    464. 

  464. </li>
    465. 

  465. 

  466. <li>
    467. 

  467. <p>Version 1.5.2. Fixes to ignore whitespace options (1522563 -
    468. 

  468. aconnor78)</p>
    469. 

  469. </li>
    470. 

  470. 

  471. <li>
    472. 

  472. <p>Version 1.5, updated to work with jEdit 4.3pre3+</p>
    473. 

  473. </li>
    474. 

  474. 

  475. <li>
    476. 

  476. <p>Version 1.4. Updated to work with jEdit v4.2+, including edits
    477. 

  477. for new JEditTextArea handling and new plugin API.</p>
    478. 

  478. </li>
    479. 

  479. 

  480. <li>
    481. 

  481. <p>Version 1.3.2. Last pre-jEdit v4.2 version of plugin by
    482. 

  482. Andr??.</p>
    483. 

  483. </li>
    484. 

  484. </ul>
    485. 

  485. 

  486. <hr>
    487. 

  487. <a name="credits"> 
    488. 

  488. 

  489. <h3>Credits</h3>
    490. 

  490. 

  491. <ul>
    492. 

  492. <li>
    493. 

  493. <p>Stuart D. Gathman ported the GNU diff algorithm to Java. See
    494. 

  494. <a href=
    495. 

  495. "http://www.bmsi.com/java/">http://www.bmsi.com/java/</a></p>
    496. 

  496. </li>
    497. 

  497. 

  498. <li>
    499. 

  499. <p>Some code and ideas borrowed from JDiff by Mike Dillon
    500. 

  500. (mdillon@jedit.org). See <a href=
    501. 

  501. "http://sourceforge.net/projects/jdiff">http://sourceforge.net/projects/jdiff</a></p>
    502. 

  502. </li>
    503. 

  503. </ul>
    504. 

  504. </body>
    505. 

  505. </html>
    506.