xeals/origami.el
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Improve doc

Browse Source
This commit is contained in:
Greg Sexton 2015-04-26 14:49:24 +01:00
parent 6677218b96
commit fb1db05c3e
1 changed files with 8 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
README.md
View File

@ -52,7 +52,8 @@ Origami has been tested on Emacs 24.3, 24.4 and 24.5.
Origami works by parsing the buffer to determine a fold structure. Origami works by parsing the buffer to determine a fold structure.
The following commands are supplied to manipulate folds in the buffer: The following commands are supplied to manipulate folds in the
buffer - those in bold are particularly useful:
<table> <table>
<tr> <tr>
@ -91,7 +92,7 @@ The following commands are supplied to manipulate folds in the buffer:
</tr> </tr>
<tr> <tr>
<td>origami-recursively-toggle-node</td> <td><strong>origami-recursively-toggle-node</strong></td>
<td>Acts like org-mode header collapsing. Cycle a fold between open, recursively open, closed.</td> <td>Acts like org-mode header collapsing. Cycle a fold between open, recursively open, closed.</td>
</tr> </tr>
@ -111,7 +112,7 @@ The following commands are supplied to manipulate folds in the buffer:
</tr> </tr>
<tr> <tr>
<td>origami-show-only-node</td> <td><strong>origami-show-only-node</strong></td>
<td>Close everything but the folds necessary to see the point. Very useful for concentrating on an area of code.</td> <td>Close everything but the folds necessary to see the point. Very useful for concentrating on an area of code.</td>
</tr> </tr>
@ -126,12 +127,12 @@ The following commands are supplied to manipulate folds in the buffer:
</tr> </tr>
<tr> <tr>
<td>origami-undo</td> <td><strong>origami-undo</strong></td>
<td>Undo the last folding operation.</td> <td>Undo the last folding operation.</td>
</tr> </tr>
<tr> <tr>
<td>origami-redo</td> <td><strong>origami-redo</strong></td>
<td>Redo the last undone folding operation.</td> <td>Redo the last undone folding operation.</td>
</tr> </tr>
@ -156,9 +157,8 @@ To some degree, yes. Currently out of the box support is provided for:
* Python * Python
* elisp * elisp
Anything not in this list will be <strong>folded using Anything not in this list will be folded using indentation. This works
indentation</strong>. This works surprisingly well for most surprisingly well for most major-modes and is great for folding text.
major-modes and is great for folding text.
It should be trivial to add support for any language that uses braces It should be trivial to add support for any language that uses braces
to delimit blocks. Just add to `origami-parser-alist` something like: to delimit blocks. Just add to `origami-parser-alist` something like: