[elpa] externals/m-buffer 31b6db5145 080/115: New start file for lentic doc.

[ELPA Syncer]

branch: externals/m-buffer
commit 31b6db51454b6f1df0bd676d58e18708c67045a8
Author: Phillip Lord <phillip.lord@newcastle.ac.uk>
Commit: Phillip Lord <phillip.lord@newcastle.ac.uk>

    New start file for lentic doc.
    
    Adding an overview file for m-buffer which imports all
    of the others.
---
 .gitignore       |  8 +++++++-
 Makefile         |  6 ++++++
 m-buffer-doc.org | 48 ++++++++++++++++++++++++++++++++++++++++++++++++
 3 files changed, 61 insertions(+), 1 deletion(-)

diff --git a/.gitignore b/.gitignore
index f5222b804a..b83ad7696f 100644
--- a/.gitignore
+++ b/.gitignore
@@ -1,2 +1,8 @@
 /.cask/
-m-buffer*org
\ No newline at end of file
+m-buffer*org
+!m-buffer-doc.org
+*html
+*elc
+/dist/
+/org/
+m-buffer-pkg.el
\ No newline at end of file
diff --git a/Makefile b/Makefile
index 50524b2d5b..4eae36d16a 100644
--- a/Makefile
+++ b/Makefile
@@ -10,4 +10,10 @@ test: install
        cask exec ert-runner
 
 
+clean:
+       find . -name "m-buffer*org" -not -name "m-buffer-doc.org" \
+          -exec rm {} \;
+       rm m-buffer-doc.html
+
+
 .PHONY: test
diff --git a/m-buffer-doc.org b/m-buffer-doc.org
new file mode 100644
index 0000000000..b649eca038
--- /dev/null
+++ b/m-buffer-doc.org
@@ -0,0 +1,48 @@
+
+#+TITLE: Manipulate the Contents of Emacs Buffers
+#+AUTHOR: Phillip Lord
+
+#+INFOJS_OPT: view:info toc:nil
+
+
+* Introduction
+
+m-buffer provides functions for accessing and manipulating the contents of an
+Emacs buffer. While Emacs already provides these features, m-buffer provides a
+higher-level interaction. It achieves this in several ways: many of the
+functions are list-orientated, so avoiding the need for iteration; it avoids
+the use of global emacs state whenever it can be avoided, so avoiding
+side-effects. And, it adds some macros for cleanup, so again, helping to
+manage the process of global state where it can be avoided.
+
+
+** Caveat
+
+This is the first version of m-buffer with full 
[[http://github.com/phillord/lentic][lenticular]] documentation. Both
+lentic and this documentation are a work in progress. They will improve.
+
+
+* m-buffer
+
+m-buffer.el provides list-orientated search both for any regexp and standard
+regexps, as well as the ability to do things with these matches: replace, add
+overlays or text-properties or, most generically of all, call any function on
+matches.
+
+#+include: "m-buffer.org" :minlevel 2
+
+* m-buffer-at
+
+m-buffer-at.el provides a set of stateless functions which for accessing data
+about buffers, without requiring changing the `current-buffer'.
+
+#+include: "m-buffer-at.org" :minlevel 2
+
+* m-buffer-macro
+
+m-buffer-macro.el provides some general purpose macros for:
+ 
+ - dealing with markers and their cleanup
+ - running code at a specific location
+
+#+include: "m-buffer-macro.org" :minlevel 2