path: root/devdocs/elisp/text.html

 <h2 class="chapter">Text</h2>  <p>This chapter describes the functions that deal with the text in a buffer. Most examine, insert, or delete text in the current buffer, often operating at point or on text adjacent to point. Many are interactive. All the functions that change the text provide for undoing the changes (see <a href="undo">Undo</a>). </p> <p>Many text-related functions operate on a region of text defined by two buffer positions passed in arguments named <var>start</var> and <var>end</var>. These arguments should be either markers (see <a href="markers">Markers</a>) or numeric character positions (see <a href="positions">Positions</a>). The order of these arguments does not matter; it is all right for <var>start</var> to be the end of the region and <var>end</var> the beginning. For example, <code>(delete-region 1
10)</code> and <code>(delete-region 10 1)</code> are equivalent. An <code>args-out-of-range</code> error is signaled if either <var>start</var> or <var>end</var> is outside the accessible portion of the buffer. In an interactive call, point and the mark are used for these arguments. </p>  <p>Throughout this chapter, “text” refers to the characters in the buffer, together with their properties (when relevant). Keep in mind that point is always between two characters, and the cursor appears on the character after point. </p> <table class="menu" border="0" cellspacing="0"> <tr>
<td align="left" valign="top">• <a href="near-point" accesskey="1">Near Point</a>
</td>
<td> </td>
<td align="left" valign="top">Examining text in the vicinity of point. </td>
</tr> <tr>
<td align="left" valign="top">• <a href="buffer-contents" accesskey="2">Buffer Contents</a>
</td>
<td> </td>
<td align="left" valign="top">Examining text in a general fashion. </td>
</tr> <tr>
<td align="left" valign="top">• <a href="comparing-text" accesskey="3">Comparing Text</a>
</td>
<td> </td>
<td align="left" valign="top">Comparing substrings of buffers. </td>
</tr> <tr>
<td align="left" valign="top">• <a href="insertion" accesskey="4">Insertion</a>
</td>
<td> </td>
<td align="left" valign="top">Adding new text to a buffer. </td>
</tr> <tr>
<td align="left" valign="top">• <a href="commands-for-insertion" accesskey="5">Commands for Insertion</a>
</td>
<td> </td>
<td align="left" valign="top">User-level commands to insert text. </td>
</tr> <tr>
<td align="left" valign="top">• <a href="deletion" accesskey="6">Deletion</a>
</td>
<td> </td>
<td align="left" valign="top">Removing text from a buffer. </td>
</tr> <tr>
<td align="left" valign="top">• <a href="user_002dlevel-deletion" accesskey="7">User-Level Deletion</a>
</td>
<td> </td>
<td align="left" valign="top">User-level commands to delete text. </td>
</tr> <tr>
<td align="left" valign="top">• <a href="the-kill-ring" accesskey="8">The Kill Ring</a>
</td>
<td> </td>
<td align="left" valign="top">Where removed text sometimes is saved for later use. </td>
</tr> <tr>
<td align="left" valign="top">• <a href="undo" accesskey="9">Undo</a>
</td>
<td> </td>
<td align="left" valign="top">Undoing changes to the text of a buffer. </td>
</tr> <tr>
<td align="left" valign="top">• <a href="maintaining-undo">Maintaining Undo</a>
</td>
<td> </td>
<td align="left" valign="top">How to enable and disable undo information. How to control how much information is kept. </td>
</tr> <tr>
<td align="left" valign="top">• <a href="filling">Filling</a>
</td>
<td> </td>
<td align="left" valign="top">Functions for explicit filling. </td>
</tr> <tr>
<td align="left" valign="top">• <a href="margins">Margins</a>
</td>
<td> </td>
<td align="left" valign="top">How to specify margins for filling commands. </td>
</tr> <tr>
<td align="left" valign="top">• <a href="adaptive-fill">Adaptive Fill</a>
</td>
<td> </td>
<td align="left" valign="top">Adaptive Fill mode chooses a fill prefix from context. </td>
</tr> <tr>
<td align="left" valign="top">• <a href="auto-filling">Auto Filling</a>
</td>
<td> </td>
<td align="left" valign="top">How auto-fill mode is implemented to break lines. </td>
</tr> <tr>
<td align="left" valign="top">• <a href="sorting">Sorting</a>
</td>
<td> </td>
<td align="left" valign="top">Functions for sorting parts of the buffer. </td>
</tr> <tr>
<td align="left" valign="top">• <a href="columns">Columns</a>
</td>
<td> </td>
<td align="left" valign="top">Computing horizontal positions, and using them. </td>
</tr> <tr>
<td align="left" valign="top">• <a href="indentation">Indentation</a>
</td>
<td> </td>
<td align="left" valign="top">Functions to insert or adjust indentation. </td>
</tr> <tr>
<td align="left" valign="top">• <a href="case-changes">Case Changes</a>
</td>
<td> </td>
<td align="left" valign="top">Case conversion of parts of the buffer. </td>
</tr> <tr>
<td align="left" valign="top">• <a href="text-properties">Text Properties</a>
</td>
<td> </td>
<td align="left" valign="top">Assigning Lisp property lists to text characters. </td>
</tr> <tr>
<td align="left" valign="top">• <a href="substitution">Substitution</a>
</td>
<td> </td>
<td align="left" valign="top">Replacing a given character wherever it appears. </td>
</tr> <tr>
<td align="left" valign="top">• <a href="registers">Registers</a>
</td>
<td> </td>
<td align="left" valign="top">How registers are implemented. Accessing the text or position stored in a register. </td>
</tr> <tr>
<td align="left" valign="top">• <a href="transposition">Transposition</a>
</td>
<td> </td>
<td align="left" valign="top">Swapping two portions of a buffer. </td>
</tr> <tr>
<td align="left" valign="top">• <a href="replacing">Replacing</a>
</td>
<td> </td>
<td align="left" valign="top">Replacing the text of one buffer with the text of another buffer. </td>
</tr> <tr>
<td align="left" valign="top">• <a href="decompression">Decompression</a>
</td>
<td> </td>
<td align="left" valign="top">Dealing with compressed data. </td>
</tr> <tr>
<td align="left" valign="top">• <a href="base-64">Base 64</a>
</td>
<td> </td>
<td align="left" valign="top">Conversion to or from base 64 encoding. </td>
</tr> <tr>
<td align="left" valign="top">• <a href="checksum_002fhash">Checksum/Hash</a>
</td>
<td> </td>
<td align="left" valign="top">Computing cryptographic hashes. </td>
</tr> <tr>
<td align="left" valign="top">• <a href="gnutls-cryptography">GnuTLS Cryptography</a>
</td>
<td> </td>
<td align="left" valign="top">Cryptographic algorithms imported from GnuTLS. </td>
</tr> <tr>
<td align="left" valign="top">• <a href="parsing-html_002fxml">Parsing HTML/XML</a>
</td>
<td> </td>
<td align="left" valign="top">Parsing HTML and XML. </td>
</tr> <tr>
<td align="left" valign="top">• <a href="parsing-json">Parsing JSON</a>
</td>
<td> </td>
<td align="left" valign="top">Parsing and generating JSON values. </td>
</tr> <tr>
<td align="left" valign="top">• <a href="jsonrpc">JSONRPC</a>
</td>
<td> </td>
<td align="left" valign="top">JSON Remote Procedure Call protocol </td>
</tr> <tr>
<td align="left" valign="top">• <a href="atomic-changes">Atomic Changes</a>
</td>
<td> </td>
<td align="left" valign="top">Installing several buffer changes atomically. </td>
</tr> <tr>
<td align="left" valign="top">• <a href="change-hooks">Change Hooks</a>
</td>
<td> </td>
<td align="left" valign="top">Supplying functions to be run when text is changed. </td>
</tr> </table><div class="_attribution">
  <p class="_attribution-p">
    Copyright &copy; 1990-1996, 1998-2022 Free Software Foundation, Inc. <br>Licensed under the GNU GPL license.<br>
    <a href="https://www.gnu.org/software/emacs/manual/html_node/elisp/Text.html" class="_attribution-link">https://www.gnu.org/software/emacs/manual/html_node/elisp/Text.html</a>
  </p>
</div>