PageRenderTime 153ms CodeModel.GetById 20ms app.highlight 6ms RepoModel.GetById 125ms app.codeStats 0ms

/www/tags/NOV_07_2009/htdocs/42docs/users-guide/macros-misc.html

#
HTML | 74 lines | 74 code | 0 blank | 0 comment | 0 complexity | 98d62342ed481806b0f1a9b6dae3ff83 MD5 | raw file
 1<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>Miscellaneous Macros</title><meta name="generator" content="DocBook XSL Stylesheets V1.65.1"><link rel="home" href="index.html" title="jEdit 4.2 User's Guide"><link rel="up" href="macro-index.html" title="Appendix F. Macros Included With jEdit"><link rel="previous" href="macros-java.html" title="Java Code Macros"><link rel="next" href="macros-properties.html" title="Property Macros"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">Miscellaneous Macros</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="macros-java.html">Prev</a> </td><th width="60%" align="center">Appendix F. Macros Included With jEdit</th><td width="20%" align="right"> <a accesskey="n" href="macros-properties.html">Next</a></td></tr></table><hr></div><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="macros-misc"></a>Miscellaneous Macros</h2></div></div><div></div></div><p>
 2    While these macros do not fit easily into the other categories, they all provide
 3    interesting and useful functions.
 4</p><div class="itemizedlist"><ul type="disc"><li><p><tt class="filename">Display_Abbreviations.bsh</tt></p><p>
 5        Displays the abbreviations registered for each of jEdit's
 6        editing modes.
 7    </p><p>
 8        The macro provides a read-only view of the abbreviations
 9        contained in the &#8220;<span class="quote">Abbreviations</span>&#8221; option pane.  Pressing
10        a letter key will scroll the table to the first entry beginning with
11        that letter.  A further option is provided to write a selected mode's
12        abbreviations or all abbreviations in a text buffer for printing as a
13        reference. Notes in the source code listing point out some display options
14        that are configured by modifying global variables.
15    </p></li><li><p><tt class="filename">Display_Actions.bsh</tt></p><p>
16		Displays a list of all the actions known to jEdit categorised by
17		their action set.
18	</p><p>
19		This macro can be a useful reference if you want to use the jEdit 4.2 action bar.
20	</p></li><li><p><tt class="filename">Display_Character_Code.bsh</tt></p><p>
21    Display int and hex values for the character at the caret, 
22    in the status bar.
23  </p></li><li><p><tt class="filename">Display_Shortcuts.bsh</tt></p><p>
24        Displays a sorted list of the keyboard shortcuts currently in effect.
25    </p><p>
26        The macro provides a combined read-only view of command, macro
27        and plugin shortcuts. Pressing a letter key will
28        scroll the table to the first entry beginning with that letter.
29        A further option is provided to write the shortcut assignments in a
30        text buffer for printing as a reference. Notes in the source code
31        listing point out some display options that are configured by
32        modifying global variables.
33    </p></li><li><p><tt class="filename">Evaluate_Buffer_in_BeanShell.bsh</tt></p><p>
34        Evaluates contents of current buffer as a BeanShell script,
35        and opens a new
36        buffer to receive any text output.
37    </p><p>
38        This is a quick way to test a macro script even before its text
39        is saved to a file.  Opening a new buffer for output is a precaution
40        to prevent the macro from inadvertently erasing or overwriting
41        itself.  BeanShell scripts that operate on the contents of the
42        current buffer will not work meaningfully when tested using this
43        macro.
44    </p></li><li><p><tt class="filename">Hex_Convert.bsh</tt></p><p>
45    Converts byte characters to their hex equivalent, and vice versa.
46  </p></li><li><p><tt class="filename">HyperSearch_Results_to_Buffer.bsh</tt></p><p>
47	Writes HyperSeach results to a new buffer.
48	</p></li><li><p><tt class="filename">Include_Guard.bsh</tt></p><p>
49		Intended for C/C++ header files, this macro inserts a preprocessor
50		directive in the current buffer to ensure that the header is
51		included only once per compilation unit.
52    </p><p>
53        To use the macro, first place the caret at the beginning of the
54		header file before any uncommented text.  The macro will return to
55		this position upon completion.  The defined term that triggers the
56		&#8220;<span class="quote">include guard</span>&#8221; is taken from the buffer's name.
57    </p></li><li><p><tt class="filename">Make_Bug_Report.bsh</tt></p><p>
58      Creates a new buffer with installation and error information
59	    extracted from the activity log.
60    </p><p>
61	  The macro extracts initial messages written to the activity log
62	  describing the user's operating system, JDK, jEdit version and
63	  installed plugins. It then appends the last set of error messages
64	  written to the activity log.  The new text buffer can be saved and
65	  attached to an email message or a bug report made on SourceForge.
66	</p></li><li><p><tt class="filename">Run_Script.bsh</tt></p><p>
67    Runs script using interpreter based upon buffer's editing mode
68    (by default, determined using file extension). You must have the
69    appropriate interpreter (such as Perl, Python, or Windows Script Host)
70    installed on your system.
71  </p></li><li><p><tt class="filename">Show_Threads.bsh</tt></p><p>
72      Displays in a tree format all running Java threads of the current
73      Java Virtual Machine.
74    </p></li></ul></div></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="macros-java.html">Prev</a> </td><td width="20%" align="center"><a accesskey="u" href="macro-index.html">Up</a></td><td width="40%" align="right"> <a accesskey="n" href="macros-properties.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">Java Code Macros </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> Property Macros</td></tr></table></div></body></html>