PageRenderTime 67ms CodeModel.GetById 16ms RepoModel.GetById 0ms app.codeStats 0ms

/jEdit/tags/jedit-4-5-pre1/doc/users-guide/customizing.xml

#
XML | 713 lines | 554 code | 150 blank | 9 comment | 0 complexity | 93478b064e80013079f3307e719ad5e5 MD5 | raw file
Possible License(s): BSD-3-Clause, AGPL-1.0, Apache-2.0, LGPL-2.0, LGPL-3.0, GPL-2.0, CC-BY-SA-3.0, LGPL-2.1, GPL-3.0, MPL-2.0-no-copyleft-exception, IPL-1.0
  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <chapter id="customizing">
  3. <title>Customizing jEdit</title>
  4. <!-- jEdit buffer-local properties: -->
  5. <!-- :tabSize=1:indentSize=1:noTabs=true:wrap=soft:maxLineLen=0: -->
  6. <!-- :xml.root=users-guide.xml: -->
  7. <section id="buffer-opts">
  8. <title>The Buffer Options Dialog Box</title>
  9. <para><guimenu>Utilities</guimenu>&gt;<guimenuitem>Buffer
  10. Options</guimenuitem> displays a dialog box for changing editor settings
  11. on a per-buffer basis. Changes made in this dialog box are not retained
  12. after the buffer is closed.</para>
  13. <para>The following settings can be changed here:</para>
  14. <itemizedlist>
  15. <listitem>
  16. <para>The line separator (see <xref
  17. linkend="line-separators" />)</para>
  18. </listitem>
  19. <listitem>
  20. <para>The character encoding (see <xref
  21. linkend="encodings" />)</para>
  22. </listitem>
  23. <listitem>
  24. <para>If the file should be GZipped on disk (see <xref
  25. linkend="opening" />)</para>
  26. </listitem>
  27. <listitem>
  28. <para>The edit mode (see <xref linkend="modes" />)</para>
  29. </listitem>
  30. <listitem>
  31. <para>The fold mode (see <xref linkend="folding" />)</para>
  32. </listitem>
  33. <listitem>
  34. <para>The wrap mode and margin (see <xref
  35. linkend="word-wrap" />)</para>
  36. </listitem>
  37. <listitem>
  38. <para>The tab width (see <xref linkend="indent" />)</para>
  39. </listitem>
  40. <listitem>
  41. <para>The indent width</para>
  42. </listitem>
  43. <listitem>
  44. <para>If soft tabs should be used (see <xref
  45. linkend="indent" />)</para>
  46. </listitem>
  47. </itemizedlist>
  48. </section>
  49. <section id="buffer-local">
  50. <title>Buffer-Local Properties</title>
  51. <para>Buffer-local properties provide an alternate way to change editor
  52. settings on a per-buffer basis. While changes made in the
  53. <guimenuitem>Buffer Options</guimenuitem> dialog box are lost after the
  54. buffer is closed, buffer-local properties take effect each time the file
  55. is opened, because they are embedded in the file itself.</para>
  56. <para>When jEdit loads a file, it checks the first and last 10 lines for
  57. colon-enclosed name/value pairs. For example, placing the following in a
  58. buffer changes the indent width to 4 characters, enables soft tabs, and
  59. activates the Perl edit mode:</para>
  60. <screen>:indentSize=4:noTabs=true:mode=perl:</screen>
  61. <para>Adding buffer-local properties to a buffer takes effect after the
  62. next time the buffer is saved.</para>
  63. <para>The following table describes each buffer-local property in
  64. detail.</para>
  65. <informaltable>
  66. <tgroup cols="2">
  67. <colspec colnum="1" colwidth="1.5in" />
  68. <colspec colwidth="1*"/>
  69. <thead>
  70. <row>
  71. <entry>Property name</entry>
  72. <entry>Description</entry>
  73. </row>
  74. </thead>
  75. <tbody>
  76. <row>
  77. <entry><varname>collapseFolds</varname></entry>
  78. <entry>Folds with a level of this or higher will be
  79. collapsed when the buffer is opened. If set to zero, all
  80. folds will be expanded initially. See <xref
  81. linkend="folding" />.</entry>
  82. </row>
  83. <row>
  84. <entry><varname>deepIndent</varname></entry>
  85. <entry>When set to <quote>true</quote>, multiple-line
  86. expressions delimited by parentheses are aligned like
  87. so: <programlisting>retVal.x = (int)(horizontalOffset
  88. + Chunk.offsetToX(info.chunks,
  89. offset));</programlisting> With this setting disabled, the
  90. text would look like so: <programlisting>retVal.x = (int)(horizontalOffset
  91. + Chunk.offsetToX(info.chunks,
  92. offset));</programlisting></entry>
  93. </row>
  94. <row><entry><varname>encoding</varname></entry>
  95. <entry> The character encoding that should be used for this file
  96. (only works if at the top of file).
  97. See <xref linkend="encodings"/>. </entry></row>
  98. <row>
  99. <entry><varname>folding</varname></entry>
  100. <entry>The fold mode; one of <quote>none</quote>,
  101. <quote>indent</quote>, <quote>explicit</quote>, or the
  102. name of a plugin folding mode. See <xref
  103. linkend="folding" />.</entry>
  104. </row>
  105. <row>
  106. <entry><varname>indentSize</varname></entry>
  107. <entry>The width, in characters, of one indent. Must be
  108. an integer greater than 0. See <xref
  109. linkend="indent" />.</entry>
  110. </row>
  111. <row>
  112. <entry><varname>maxLineLen</varname></entry>
  113. <entry>The maximum line length and wrap column position.
  114. Inserting text beyond this column will automatically
  115. insert a line break at the appropriate position. See
  116. <xref linkend="entering-text" />.</entry>
  117. </row>
  118. <row>
  119. <entry><varname>mode</varname></entry>
  120. <entry>The default edit mode for the buffer. See <xref
  121. linkend="modes" />.</entry>
  122. </row>
  123. <row>
  124. <entry><varname>noTabs</varname></entry>
  125. <entry>If set to <quote>true</quote>, soft tabs
  126. (multiple space characters) will be used instead of
  127. <quote>real</quote> tabs. See <xref
  128. linkend="indent" />.</entry>
  129. </row>
  130. <row>
  131. <entry><varname>noWordSep</varname></entry>
  132. <entry>A list of non-alphanumeric characters that are
  133. <emphasis>not</emphasis> to be treated as word
  134. separators. Global default is <quote>_</quote>.</entry>
  135. </row>
  136. <row>
  137. <entry><varname>tabSize</varname></entry>
  138. <entry>The tab width. Must be an integer greater than 0.
  139. See <xref linkend="indent" />.</entry>
  140. </row>
  141. <row>
  142. <entry><varname>wordBreakChars</varname></entry>
  143. <entry>Characters, in addition to spaces and tabs, at
  144. which lines may be split when word wrapping. See <xref
  145. linkend="entering-text" />.</entry>
  146. </row>
  147. <row>
  148. <entry><varname>wrap</varname></entry>
  149. <entry>The word wrap mode; one of <quote>none</quote>,
  150. <quote>soft</quote>, or <quote>hard</quote>. See <xref
  151. linkend="word-wrap" />.</entry>
  152. </row>
  153. </tbody>
  154. </tgroup>
  155. </informaltable>
  156. </section>
  157. <section id="global-opts">
  158. <title>The Global Options Dialog Box</title>
  159. <para><guimenu>Utilities</guimenu>&gt;<guimenuitem>Global
  160. Options</guimenuitem> displays the global options dialog box. The dialog
  161. box is divided into several panes, each pane containing a set of related
  162. options. Use the list on the left of the dialog box to switch between
  163. panes. Only panes created by jEdit are described here; some plugins add
  164. their own option panes, and information about them can be found in the
  165. documentation for the plugins in question.</para>
  166. <section id="general-pane">
  167. <title>The General Pane</title>
  168. <para>The <guibutton>General</guibutton> pane contains various
  169. settings, such as
  170. the number of recent files to remember,
  171. how often to check for changed files,
  172. if the recent file list should be sorted,
  173. if previously open files or split configurations should be restored on startup, and so on.</para>
  174. </section>
  175. <section id="abbrevs-pane">
  176. <title>The Abbreviations Pane</title>
  177. <indexterm>
  178. <primary>Abbreviations</primary>
  179. <secondary>creating and editing</secondary>
  180. </indexterm>
  181. <para>The <guibutton>Abbreviations</guibutton> option pane can be
  182. used to enable or disable automatic abbreviation expansion, and to
  183. edit currently defined abbreviations.</para>
  184. <para>The combo box labelled <quote>Abbrev set</quote> selects the
  185. abbreviation set to edit. The first entry, <quote>global</quote>,
  186. contains abbreviations available in all edit modes. The subsequent
  187. entries correspond to each mode's local set of abbreviations.</para>
  188. <para>To change an abbreviation or its expansion, either
  189. double-click the appropriate table entry, or click a table entry and
  190. then click the <guibutton>Edit</guibutton> button. This will display
  191. a dialog box for modifying the abbreviation.</para>
  192. <para>The <guibutton>Add</guibutton> button displays a dialog box
  193. where you can define a new abbreviation. The
  194. <guibutton>Remove</guibutton> button removes the currently selected
  195. abbreviation from the list.</para>
  196. <para>See <xref linkend="positional-params" /> for information about
  197. positional parameters in abbreviations.</para>
  198. </section>
  199. <section id="appearance-pane">
  200. <title>The Appearance Pane</title>
  201. <para>The <guibutton>Appearance</guibutton> pane can be used to
  202. change the appearance of user interface controls such as buttons,
  203. labels and menus. It can also be used to change the docking
  204. framework (the dockable window manager). The number of items
  205. retained in history text fields can also be set here; see
  206. <xref linkend="history" />.</para>
  207. </section>
  208. <section id="context-pane">
  209. <title>The Context Menu Pane</title>
  210. <para>The <guibutton>Context Menu</guibutton> option pane edits the
  211. text area's right-click context menu. See <xref
  212. linkend="views" />.</para>
  213. </section>
  214. <section id="docking-pane">
  215. <title>The Docking Pane</title>
  216. <para>The <guibutton>Docking</guibutton> option pane shows a
  217. list of available dockables, and allows you to specify
  218. docking locations for each of them. Another way to
  219. specify docking locations is to use the popup menus associated with each dockable window. </para>
  220. <para> It is possible to configure jEdit to automatically load and/or save <emphasis role="bold">Docking Layouts</emphasis> (similar to eclipse perspectives) based on the edit mode of your current b uffer through the checkboxes in this pane. See <xref linkend="docking" />.
  221. </para>
  222. </section>
  223. <section id="editing-pane">
  224. <title>The Editing Pane</title>
  225. <para>The <guibutton>Editing</guibutton> option pane contains
  226. settings such as the tab size, syntax highlighting and soft tabs on
  227. a global or mode-specific basis. </para>
  228. <para>Changing options from this optionpane does not change XML mode definition files on disk; it merely writes values to the user properties file which
  229. override those set in mode files. To find out how to edit mode files directly, see <xref linkend="writing-modes-part" />. Some of these options can be further overridden on an individual file basis through the use of buffer-local properties. </para>
  230. <para>The <literal>File name
  231. glob</literal> and <literal>First line glob</literal> text
  232. fields let you specify a glob pattern that names and first lines of
  233. buffers will be matched against to determine the edit mode. See
  234. <xref linkend="globs" /> for information about glob patterns.</para>
  235. <para> The <literal>Extra Word Characters</literal> allows you to set the <literal>noLineSep</literal> buffer property on a mode-wide basis, allowing you to define what is considered part of a word when double-clicking on it in the text area.
  236. </para>
  237. <para> The <literal>Deep Indent</literal> option instructs jEdit to indent subsequent lines so that they line up with the open bracket on the previous line. </para>
  238. </section>
  239. <section id="encodings-pane">
  240. <title>The Encodings Pane</title>
  241. <para>This option pane offers
  242. users of jEdit many flexible options for defining how Encodings are handled in jEdit. See <xref linkend="encodings" /> for the
  243. basics.</para>
  244. <para>The default line separator character (see <xref linkend="line-separators" />) can be set from here. </para>
  245. <para> <guilabel>Use autodetection when possible</guilabel> is an option you can switch on or off.</para>
  246. <para>The <literal>List of Encoding Autodetector Names</literal>
  247. can be used to control what encoding detections are used on each file when it is loaded.
  248. The order they appear in this list determines the order of detectors that are tried.
  249. There are some detectors which are available with jEdit core:
  250. <itemizedlist>
  251. <listitem><para>
  252. <literal>BOM</literal>:
  253. detects <ulink url="http://www.unicode.org/faq/utf_bom.html#BOM">
  254. Byte Order Mark</ulink>.
  255. </para></listitem>
  256. <listitem><para>
  257. <literal>XML-PI</literal>:
  258. detects <ulink url="http://www.w3.org/TR/REC-xml/#charencoding">
  259. encoding declaration in XML Processing Instruction</ulink>.
  260. </para></listitem>
  261. <listitem><para>
  262. <literal>html</literal>:
  263. detects <ulink url="http://www.w3.org/TR/html4/struct/global.html#edef-META">
  264. charset description in HTML META element</ulink>.
  265. </para></listitem>
  266. <listitem><para>
  267. <literal>python</literal>:
  268. detects <ulink url="http://docs.python.org/reference/lexical_analysis.html#encoding-declarations">
  269. various encoding declaration accepted in Python</ulink>. This
  270. accepts encoding declarations for GNU Emacs or Bram Moolenaar's
  271. VIM.
  272. </para></listitem>
  273. <listitem><para>
  274. <literal>buffer-local-property</literal>:
  275. detects same syntax described at <xref linkend="buffer-local" />
  276. for property name "encoding". Note that unlike other buffer-local
  277. properties, this one will not work unless it is at the top of the file.
  278. </para></listitem>
  279. </itemizedlist>
  280. Others can be defined in plugins as services and added to this
  281. space-separated list. See <ulink
  282. url="../api/org/gjt/sp/jedit/io/EncodingDetector.html">EncodingDetector</ulink>
  283. for details on how to offer additional encoding autodetector.</para>
  284. <para>The <literal>List of Fallback Encodings</literal> is used when
  285. a file fails to open in the default encoding, and the Encoding
  286. Autodetectors also fail. The list order here determines the order of
  287. encodings that are tried. Each is separated by a space. This is
  288. especially handy when doing directory searches through files of
  289. different encodings. We suggest using <literal>UTF-8</literal> as
  290. either your default or one of the fallback encodings.</para>
  291. <para>While jEdit allows you to edit files in a variety of different
  292. encodings, the average user switches between only 2 or 3. In other
  293. parts of jEdit, where the list of encodings is displayed in a
  294. combobox (such as the buffer options) or a menu (such as
  295. <guimenuitem>File - Reload with Encoding</guimenuitem> submenu) it
  296. may be desirable to display only a subset of available encodings,
  297. those that are in common local use. The Encodings checkbox list
  298. allows the user to select the subset of supported encodings to
  299. display in other GUI components that list all of the
  300. encodings.</para>
  301. </section>
  302. <section id="gutter-pane">
  303. <title>The Gutter Pane</title>
  304. <para>The <guibutton>Gutter</guibutton> option pane contains
  305. settings to customize the appearance of the gutter. Some new options were added
  306. to jEdit 4.3, including "show gutter", "minimal number of digits to reserve for line numbers",
  307. and "fold style". See <xref linkend="overview" />.</para>
  308. </section>
  309. <section id="mouse-pane">
  310. <title>The Mouse Pane</title>
  311. <para>The <guibutton>Mouse</guibutton> option pane contains settings
  312. for toggling drag and drop of text, as well as gutter mouse click
  313. behavior.</para>
  314. <para> The only option that may not be self-explanatory is the <emphasis role="bold">Double-Click drag joins non-alphanumeric characters</emphasis>. This option means that double-click will select a region that includes the non-alphabetical characters, as defined for the current mode. The actual set of characters can be defined for an indiviual file via buffer-local properties (<literal>noWordSep</literal>) or on a mode-wide basis from the Editing option pane (<literal>Extra Word Characters</literal>). </para>
  315. </section>
  316. <section id="printing-pane">
  317. <title>The Printing Pane</title>
  318. <para>The <guibutton>Printing</guibutton> option pane contains
  319. settings to control the appearance of printed output. Workarounds
  320. that might be needed for your Java version to print correctly can
  321. also be enabled here. See <xref linkend="printing" />.</para>
  322. </section>
  323. <section id="pluginmgr-pane">
  324. <title>The Plugin Manager Pane</title>
  325. <para>The <guibutton>Plugin Manager</guibutton> pane contains a
  326. chooser for the desired download mirror, as well as various settings
  327. such as the directory where plugins are to be installed. In addition, you can set the time in minutes that the pluginlist can be cached from jedit.org, helping to reduce the server load. See <xref
  328. linkend="using-plugins" />.</para>
  329. </section>
  330. <section id="firewall-pane">
  331. <title>The Proxy Servers Pane</title>
  332. <para>The <guibutton>Proxy Servers</guibutton> option pane lets you
  333. specify HTTP and SOCKS proxy servers to use when jEdit makes network
  334. connections, for example when downloading plugins.</para>
  335. </section>
  336. <section id="autosave-backups-pane">
  337. <title>The Saving and Backup Pane</title>
  338. <para>The <guibutton>Saving and Backup</guibutton> option pane contains
  339. settings for the autosave and backup features. See <xref
  340. linkend="autosave" /> and <xref linkend="backups" />.</para>
  341. </section>
  342. <section id="shortcuts-pane">
  343. <title>The Shortcuts Pane</title>
  344. <para>The <guibutton>Shortcuts</guibutton> option pane associates
  345. keyboard shortcuts with commands. Each command can have up to two
  346. shortcuts associated with it.</para>
  347. <para>The combo box at the top of the option pane selects the
  348. command set to edit. Command sets include the set of all built-in
  349. commands, the commands of each plugin, and the set of macros.</para>
  350. <para>To change a shortcut, click the appropriate table entry and
  351. press the keys you want associated with that command in the
  352. resulting dialog box. The dialog box will warn you if the shortcut
  353. is already assigned.</para>
  354. <bridgehead> 2-key shortcut prefixes </bridgehead>
  355. <para> Some shortcuts, such as C+e, C+m, and C+r, are prefixes for two-keystroke shortcuts. Another keystroke may be used as a prefix in a 2-key shortcut, so for example, C+x can be redefined as a prefix to make it more emacs-like, by mapping any other action to a C+x prefixed shortcut.</para>
  356. <para> Conversely, emacs users will notice at first that C+e can not be mapped as a single key shortcut to go to the end of the line, unless all of the other actions that contain C+e prefixed shortcuts are remapped to other shortcuts first. After that, C+e can be bound to end-of-line. </para>
  357. <para> The default shortcuts can be found in <literal>jedit_keys.props</literal>. </para>
  358. </section>
  359. <section id="status-bar-pane">
  360. <title>The Status Bar Pane</title>
  361. <para>The <guibutton>Status Bar</guibutton>, its API, and its coprresponding option pane were redesigned in jEdit 4.3. Now, the pane contains settings to customize which widgets are in the status bar, their order, and what separators exist between them. Or, you can disable it completely, for regular and/or plain views. See <xref linkend="status-bar" />.</para>
  362. <para> From the <literal>Options</literal> tab, you can
  363. customize information about the caret display in the lower
  364. left corner. </para>
  365. <para> Selecting the <literal>Widgets</literal> tab of this option pane shows you what widgets on the right, and their order. You can add or remove widgets and separators/labels here. </para>
  366. </section>
  367. <section id="syntax-hilite-pane">
  368. <title>The Syntax Highlighting Pane</title>
  369. <para>The <guibutton>Syntax Highlighting</guibutton> pane can be
  370. used to customize the fonts and colors for syntax highlighting. See
  371. <xref linkend="syntax-hilite" />.</para>
  372. </section>
  373. <section id="text-area-pane">
  374. <title>The Text Area Pane</title>
  375. <para>The <guibutton>Text Area</guibutton> pane contains settings to
  376. customize the appearance of the text area. See <xref
  377. linkend="overview" />.</para>
  378. </section>
  379. <section id="toolbar-pane">
  380. <title>The Tool Bar Pane</title>
  381. <para>The <guibutton>Tool Bar</guibutton> option pane lets you edit
  382. the tool bar, or disable it completely. See <xref
  383. linkend="views" />.</para>
  384. </section>
  385. <section id="view-pane">
  386. <title>The View Pane</title>
  387. <para>The <guibutton>View</guibutton> option pane lets you change
  388. various settings related to the editor window's appearance,
  389. including the arrangement of dockable windows, and if the search bar
  390. and buffer switcher should be visible. See <xref
  391. linkend="views" />.</para>
  392. </section>
  393. <section id="vfs-browser-pane">
  394. <title>The File System Browser Panes</title>
  395. <para>The <guibutton>File System Browser</guibutton> group contains
  396. two option panes, <guibutton>General</guibutton> and
  397. <guibutton>Colors</guibutton>. The former contains various file
  398. system browser settings. The latter configures glob patterns used
  399. for coloring the file list. See <xref linkend="vfs-browser" /> for
  400. more information.</para>
  401. </section>
  402. </section>
  403. <section id="settings-directory">
  404. <title>The jEdit Settings Directory</title>
  405. <para>jEdit stores settings, macros, and plugins as files inside the
  406. <firstterm>settings directory</firstterm>. In most cases, editing these
  407. files by hand is not necessary, since graphical tools and editor
  408. commands can do the job. However, being familiar with the structure of
  409. the settings directory still comes in handy in certain situations, for
  410. example when you want to copy jEdit settings between computers.</para>
  411. <para>The location of the settings directory is system-specific; it is
  412. printed to the activity log
  413. (<guimenu>Utilities</guimenu>&gt;<guisubmenu>Troubleshooting</guisubmenu>&gt;<guimenuitem>Activity
  414. Log</guimenuitem>). For example:</para>
  415. <screen>[message] jEdit: Settings directory is /home/slava/.jedit</screen>
  416. <para>Another way to find the location of your settings directory is to
  417. use the "Utilities" menu, then the "Settings Directory" menu item. The
  418. first item in the pullout menu is the location of your settings directory.
  419. </para>
  420. <para>Specifying the <userinput>-settings</userinput> switch on the
  421. command line instructs jEdit to store settings in a directory other than
  422. the default. For example, the following command will instruct jEdit to
  423. store all settings in the <filename>jedit</filename> subdirectory of the
  424. <filename>C:</filename> drive:</para>
  425. <screen><prompt>C:\jedit&gt;</prompt> <userinput>jedit -settings=C:\jedit</userinput></screen>
  426. <para>The <userinput>-nosettings</userinput> switch will force jEdit to
  427. not look for or create a settings directory; default settings will be
  428. used instead.</para>
  429. <!-- para>
  430. If you are using <application>jEditLauncher</application>
  431. to start jEdit on Windows, these parameters cannot be specified on the
  432. MS-DOS prompt command line when starting jEdit; they must be set as described
  433. in <xref linkend="launcher-starting" />.
  434. </para -->
  435. <para>jEdit creates the following files and directories inside the
  436. settings directory; plugins may add more:</para>
  437. <itemizedlist>
  438. <listitem>
  439. <para><filename>abbrevs</filename> - a plain text file which
  440. stores all defined abbreviations. See <xref
  441. linkend="abbrevs" />.</para>
  442. </listitem>
  443. <listitem>
  444. <para><filename>activity.log</filename> - a plain text file
  445. which contains the full activity log. See <xref
  446. linkend="activity-log" />.</para>
  447. </listitem>
  448. <listitem>
  449. <para><filename>history</filename> - a plain text file which
  450. stores history lists, used by history text fields and the
  451. <guimenu>Edit</guimenu>&gt;<guimenuitem>Paste
  452. Previous</guimenuitem> command. See <xref
  453. linkend="text-transfer" /> and <xref
  454. linkend="history" />.</para>
  455. </listitem>
  456. <listitem>
  457. <para><filename>jars</filename> - this directory contains
  458. plugins. See <xref linkend="using-plugins" />.</para>
  459. </listitem>
  460. <listitem>
  461. <para><filename>jars-cache</filename> - this directory contains
  462. plugin cache files which decrease the time to start jEdit. They
  463. are automatically updated when plugins are installed or
  464. updated.</para>
  465. </listitem>
  466. <listitem>
  467. <para><filename>killring.xml</filename> - stores recently
  468. deleted text. See <xref linkend="text-transfer" />.</para>
  469. </listitem>
  470. <listitem>
  471. <para><filename>macros</filename> - this directory contains
  472. macros. See <xref linkend="using-macros" />.</para>
  473. </listitem>
  474. <listitem>
  475. <para><filename>modes</filename> - this directory contains
  476. custom edit modes. See <xref
  477. linkend="writing-modes-part" />.</para>
  478. </listitem>
  479. <listitem>
  480. <para><filename>perspective.xml</filename> - an XML file that
  481. stores the list of open buffers and views used to maintain
  482. editor state between sessions.</para>
  483. </listitem>
  484. <listitem>
  485. <para><filename>PluginManager.download</filename> - this
  486. directory is usually empty. It only contains files while the
  487. plugin manager is downloading a plugin. For information about
  488. the plugin manager, see <xref linkend="using-plugins" />.</para>
  489. </listitem>
  490. <listitem><para>
  491. <filename>pluginMgr-Cached.xml.gz</filename> -
  492. this contains a cached copy of the last XML plugin list downloaded from plugin central. If you delete this file, a new one will be created next time you try to install a plugin via Plugin Manager. </para>
  493. </listitem>
  494. <listitem>
  495. <para><filename>printspec</filename> - a binary file that stores
  496. printing settings when running under Java 2 version 1.4.</para>
  497. </listitem>
  498. <listitem>
  499. <para><filename>properties</filename> - a plain text file that
  500. stores the majority of jEdit's and its plugins settings. For
  501. more information see <xref linkend="propertiesfile" />.</para>
  502. </listitem>
  503. <listitem>
  504. <para><filename>recent.xml</filename> - an XML file which stores
  505. the list of recently opened files. jEdit remembers the caret
  506. position and character encoding of each recent file, and
  507. automatically restores those values when one of the files is
  508. opened.</para>
  509. </listitem>
  510. <listitem>
  511. <para><filename>registers.xml</filename> - an XML file that
  512. stores register contents. See <xref linkend="registers" /> for
  513. more information about registers.</para>
  514. </listitem>
  515. <listitem>
  516. <para><filename>server</filename> - a plain text file that only
  517. exists while jEdit is running. The edit server's port number and
  518. authorization key is stored here. See <xref
  519. linkend="starting" />.</para>
  520. </listitem>
  521. <listitem>
  522. <para><filename>settings-backup</filename> - this directory
  523. contains numbered backups of all automatically-written settings
  524. files.</para>
  525. </listitem>
  526. </itemizedlist>
  527. <section id="propertiesfile">
  528. <title>The jEdit properties file</title>
  529. <para>The jEdit <literal>properties</literal> file uses the Java
  530. properties syntax to store key/value pairs. All of the values are
  531. stored as strings, but are interpreted as other types (such as
  532. integer or boolean) by plugins at runtime.</para>
  533. <para>Do not edit this file while jEdit is running. If you do, it
  534. is possible that your changes will be lost since jEdit writes to this
  535. this file frequently.</para>
  536. </section>
  537. <section id="sitepropertiesfiles">
  538. <title>Site Properties</title>
  539. <para>
  540. You may also put properties files in the "properties" directory in
  541. the jEdit home directory (NOT the .jedit settings directory). You
  542. can locate the jEdit home directory by going to the Utilities menu
  543. directory, then the "jEdit Home Directory" menu item, and the first
  544. item in the pullout menu will be the location of the jEdit home
  545. directory. This is intended for site-wide settings and it is
  546. useful for things like a set of custom key bindings that you might
  547. want to share between different computers. This lets you keep your
  548. custom properties separate from the jEdit properties, so they are
  549. easier to find, edit, and move between machines. Note that your
  550. custom properties files must have ".props" as the file name extension.
  551. </para>
  552. <para>
  553. Site properties files are read in alphabetically by file name. This means
  554. that if you have a property with the same name in more than one file,
  555. the value for that property will be the value found in the last file
  556. that was read.
  557. </para>
  558. <para>
  559. You can edit these files inside jEdit - changes made to these files will not be re-read until the next time jEdit is started.
  560. </para>
  561. </section>
  562. </section>
  563. </chapter>