/plugins/BufferLocal/tags/1.4.0/src/docs/index.html

# · HTML · 73 lines · 72 code · 0 blank · 1 comment · 0 complexity · b630e2207475ce93f35b3dd6104f9bb7 MD5 · raw file 

    

  1. <html>
    2. 

  2. <body>
    3. 

  3. <h1>BufferLocal Plugin</h1>
    4. 

  4. <b>
    5. 

  5. Author: Dale Anson<br>
    6. 

  6. Version: @@build.num@@<br>
    7. 

  7. Date: @@tstamp@@
    8. 

  8. </b>
    9. 

  9. <p>
    10. 

  10. The BufferLocal Plugin saves the settings made using the Buffer Options dialog
    11. 

  11. and restores those settings the next time the file is opened. This means that
    12. 

  12. you don't have to manually change the settings each time the file is opened. The
    13. 

  13. motivation for this comes from jEdit itself... </p>
    14. 

  14. <p> The file that is used to store bufferlocal properties is in your jEdit settings directory,
    15. 

  15. and named <tt>.bufferlocalplugin.cfg</tt>. </p>
    16. 

  16. <p>
    17. 

  17. Swiped directly from the jEdit 4.2 documentation, with emphasis added:
    18. 

  18. <p>
    19. 

  19. <table border="1" bgcolor="lightgray">
    20. 

  20. <tr><td>
    21. 

  21. Buffer-local properties provide an alternate way to change editor settings on a
    22. 

  22. per-buffer basis. <b><i>While changes made in the Buffer Options dialog box are lost
    23. 

  23. after the buffer is closed,</i></b> buffer-local properties take effect each time the
    24. 

  24. file is opened, because they are embedded in the file itself.
    25. 

  25. <p>
    26. 

  26. When jEdit loads a file, it checks the first and last 10 lines for colon-enclosed
    27. 

  27. name/value pairs. For example, placing the following in a buffer changes the
    28. 

  28. indent width to 4 characters, enables soft tabs, and activates the Perl edit mode:
    29. 

  29. <p>
    30. 

  30. :indentSize=4:noTabs=true:mode=perl:
    31. 

  31. <p>
    32. 

  32. Adding buffer-local properties to a buffer takes effect after the next time the
    33. 

  33. buffer is saved.
    34. 

  34. </td></tr>
    35. 

  35. </table>
    36. 

  36. <p>
    37. 

  37. Unfortunately, there isn't a nice gui to create the buffer-local line, and some
    38. 

  38. coding standards prohibit putting such editor/ide specific lines directly into
    39. 

  39. the source code.
    40. 

  40. <p>
    41. 

  41. To get around this, the BufferLocal plugin stores the settings made using the
    42. 

  42. Buffer Options dialog box and applies those settings to each file as they are
    43. 

  43. opened.
    44. 

  44. <p>
    45. 

  45. There is no set up or configuration required for this plugin, once installed, it is active.
    46. 

  46. Use the Buffer Option dialog to adjust the settings for a file, and those settings
    47. 

  47. will automatically be saved and applied to the file the next time it is opened.
    48. 

  48. <p>
    49. 

  49. Version 1.2:
    50. 

  50. <p>
    51. 

  51. Originally, BufferLocal was called "BufferMinder" and closed buffers that were open
    52. 

  52. for a while but not used. I'll refer to these buffers as "stale".
    53. 

  53. Closing stale buffers helps reduce clutter without any work. This feature
    54. 

  54. never made it into the initial release, but others have requested it, so it's back now.
    55. 

  55. It is off by default, use the Plugin Options to turn it on and to adjust
    56. 

  56. how long a file should be unused before it is closed. Files that need saved will
    57. 

  57. not be closed, you'll need to save first.
    58. 

  58. <p>
    59. 

  59. To turn on automatic buffer closing, click 'Plugins' then 'Plugin Options'.
    60. 

  60. Select 'BufferLocal' from the tree on the left side. Check the box that says
    61. 

  61. 'Close files not used'. Set the time limit with the spinner.  Check the box
    62. 

  62. 'while window is active' to have the timer run only when the jEdit window is
    63. 

  63. active.  This means you can open a file, minimize jEdit for a couple of hours
    64. 

  64. and you files will still be there when you come back and the timer will pick
    65. 

  65. up where it left off.
    66. 

  66. <p>
    67. 

  67. When the 'Close files not used' box is unchecked, BufferLocal will still
    68. 

  68. keep track of stale buffers. You can close stale buffers at any time by
    69. 

  69. clicking 'Plugins', then 'BufferLocal', then 'Close Stale Buffers'.
    70. 

  70. <p>
    71. 

  71. <!-- $Id: index.html 16813 2010-01-02 07:45:29Z ezust $ -->
    72. 

  72. </body>
    73. 

  73. </html>
    74.