diff --git a/README.md b/README.md index f6c07c8..88672d4 100644 --- a/README.md +++ b/README.md @@ -50,46 +50,87 @@ using a parser.) The following commands are supplied to manipulate folds in the buffer: -* origami-open-node -- Open a fold node. + + + + + -* origami-open-node-recursively -- Open a fold node and all of its - children. + + + + -* origami-show-node -- Like origami-open-node but also opens parent - fold nodes recursively so as to ensure the position where point is - is visible. + + + + -* origami-close-node -- Close a fold node. + + + + -* origami-close-node-recursively -- Close a fold node and all of its - children. + + + + -* origami-toggle-node -- Toggle open or closed a fold node. + + + + -* origami-forward-toggle-node -- Search forward on this line for a - node and toggle it open or closed. This makes toggling nodes much - more convenient. + + + + -* origami-recursively-toggle-node -- Acts like org-mode header - collapsing. Cycle a fold between open, recursively open, closed. + + + + -* origami-open-all-nodes -- Open every fold in the buffer. + + + + -* origami-close-all-nodes -- Close every fold in the buffer. + + + + -* origami-show-only-node -- Close everything but the folds necessary - to see the point. Very useful for concentrating on an area of code. + + + + -* origami-previous-fold -- Move to the previous fold. + + + + -* origami-next-fold -- Move to the next fold. + + + + -* origami-undo -- Undo the last folding operation. + + + + -* origami-redo -- Redo the last undone folding operation. + + + + -* origami-reset -- Remove all folds from the buffer and reset all - origami state. Useful if origami messes up! + + + + +
origami-open-nodeOpen a fold node.
origami-open-node-recursivelyOpen a fold node and all of its children.
origami-show-nodeLike origami-open-node but also opens parent fold nodes recursively so as to ensure the position where point is is visible.
origami-close-nodeClose a fold node.
origami-close-node-recursivelyClose a fold node and all of its children.
origami-toggle-nodeToggle open or closed a fold node.
origami-forward-toggle-nodeSearch forward on this line for a node and toggle it open or closed. This makes toggling nodes much more convenient.
origami-recursively-toggle-nodeActs like org-mode header collapsing. Cycle a fold between open, recursively open, closed.
origami-open-all-nodesOpen every fold in the buffer.
origami-close-all-nodesClose every fold in the buffer.
origami-show-only-nodeClose everything but the folds necessary to see the point. Very useful for concentrating on an area of code.
origami-previous-foldMove to the previous fold.
origami-next-foldMove to the next fold.
origami-undoUndo the last folding operation.
origami-redoRedo the last undone folding operation.
origami-resetRemove all folds from the buffer and reset all origami state. Useful if origami messes up!
# Does it support my favourite major-mode? @@ -121,4 +162,4 @@ function. Best to use an example: (list (funcall create beginning-of-the-fold-node-point-position end-of-the-fold-node-point-position offset ; this allows you to show some of the start of the folded text - child-nodes)))) \ No newline at end of file + child-nodes))))