Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

first commit

  • Loading branch information...
commit cb9b281bf397aba9ebb2ba27d34b76ae8c031786 0 parents
@hypernumbers authored
89 Makefile
@@ -0,0 +1,89 @@
+# Makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS =
+SPHINXBUILD = sphinx-build
+PAPER =
+BUILDDIR = _build
+
+# Internal variables.
+PAPEROPT_a4 = -D latex_paper_size=a4
+PAPEROPT_letter = -D latex_paper_size=letter
+ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
+
+.PHONY: help clean html dirhtml pickle json htmlhelp qthelp latex changes linkcheck doctest
+
+help:
+ @echo "Please use \`make <target>' where <target> is one of"
+ @echo " html to make standalone HTML files"
+ @echo " dirhtml to make HTML files named index.html in directories"
+ @echo " pickle to make pickle files"
+ @echo " json to make JSON files"
+ @echo " htmlhelp to make HTML files and a HTML help project"
+ @echo " qthelp to make HTML files and a qthelp project"
+ @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
+ @echo " changes to make an overview of all changed/added/deprecated items"
+ @echo " linkcheck to check all external links for integrity"
+ @echo " doctest to run all doctests embedded in the documentation (if enabled)"
+
+clean:
+ -rm -rf $(BUILDDIR)/*
+
+html:
+ $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
+ @echo
+ @echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
+
+dirhtml:
+ $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
+ @echo
+ @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
+
+pickle:
+ $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
+ @echo
+ @echo "Build finished; now you can process the pickle files."
+
+json:
+ $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
+ @echo
+ @echo "Build finished; now you can process the JSON files."
+
+htmlhelp:
+ $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
+ @echo
+ @echo "Build finished; now you can run HTML Help Workshop with the" \
+ ".hhp project file in $(BUILDDIR)/htmlhelp."
+
+qthelp:
+ $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
+ @echo
+ @echo "Build finished; now you can run "qcollectiongenerator" with the" \
+ ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
+ @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/LearneLispTheHardWay.qhcp"
+ @echo "To view the help file:"
+ @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/LearneLispTheHardWay.qhc"
+
+latex:
+ $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+ @echo
+ @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
+ @echo "Run \`make all-pdf' or \`make all-ps' in that directory to" \
+ "run these through (pdf)latex."
+
+changes:
+ $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
+ @echo
+ @echo "The overview file is in $(BUILDDIR)/changes."
+
+linkcheck:
+ $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
+ @echo
+ @echo "Link check complete; look for any errors in the above output " \
+ "or in $(BUILDDIR)/linkcheck/output.txt."
+
+doctest:
+ $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
+ @echo "Testing of doctests in the sources finished, look at the " \
+ "results in $(BUILDDIR)/doctest/output.txt."
1  README
@@ -0,0 +1 @@
+This is the source code for the book *Learn eLisp The Hard Way*
4 _build/html/.buildinfo
@@ -0,0 +1,4 @@
+# Sphinx build info version 1
+# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
+config: 3eb2f7d468f63cadd7d6413ca5d093e1
+tags: fbb0d17656682115ca4d033fb2f83ba1
194 conf.py
@@ -0,0 +1,194 @@
+# -*- coding: utf-8 -*-
+#
+# Learn eLisp The Hard Way documentation build configuration file, created by
+# sphinx-quickstart on Sat Nov 6 22:31:37 2010.
+#
+# This file is execfile()d with the current directory set to its containing dir.
+#
+# Note that not all possible configuration values are present in this
+# autogenerated file.
+#
+# All configuration values have a default; values that are commented out
+# serve to show the default.
+
+import sys, os
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+#sys.path.append(os.path.abspath('.'))
+
+# -- General configuration -----------------------------------------------------
+
+# Add any Sphinx extension module names here, as strings. They can be extensions
+# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
+extensions = ['sphinx.ext.todo']
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# The suffix of source filenames.
+source_suffix = '.rst'
+
+# The encoding of source files.
+#source_encoding = 'utf-8'
+
+# The master toctree document.
+master_doc = 'index'
+
+# General information about the project.
+project = u'Learn eLisp The Hard Way'
+copyright = u'2010, Gordon Guthrie'
+
+# The version info for the project you're documenting, acts as replacement for
+# |version| and |release|, also used in various other places throughout the
+# built documents.
+#
+# The short X.Y version.
+version = '1.0'
+# The full version, including alpha/beta/rc tags.
+release = '1.0.1'
+
+# The language for content autogenerated by Sphinx. Refer to documentation
+# for a list of supported languages.
+#language = None
+
+# There are two options for replacing |today|: either, you set today to some
+# non-false value, then it is used:
+#today = ''
+# Else, today_fmt is used as the format for a strftime call.
+#today_fmt = '%B %d, %Y'
+
+# List of documents that shouldn't be included in the build.
+#unused_docs = []
+
+# List of directories, relative to source directory, that shouldn't be searched
+# for source files.
+exclude_trees = ['_build']
+
+# The reST default role (used for this markup: `text`) to use for all documents.
+#default_role = None
+
+# If true, '()' will be appended to :func: etc. cross-reference text.
+#add_function_parentheses = True
+
+# If true, the current module name will be prepended to all description
+# unit titles (such as .. function::).
+#add_module_names = True
+
+# If true, sectionauthor and moduleauthor directives will be shown in the
+# output. They are ignored by default.
+#show_authors = False
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = 'sphinx'
+
+# A list of ignored prefixes for module index sorting.
+#modindex_common_prefix = []
+
+
+# -- Options for HTML output ---------------------------------------------------
+
+# The theme to use for HTML and HTML Help pages. Major themes that come with
+# Sphinx are currently 'default' and 'sphinxdoc'.
+html_theme = 'default'
+
+# Theme options are theme-specific and customize the look and feel of a theme
+# further. For a list of options available for each theme, see the
+# documentation.
+#html_theme_options = {}
+
+# Add any paths that contain custom themes here, relative to this directory.
+#html_theme_path = []
+
+# The name for this set of Sphinx documents. If None, it defaults to
+# "<project> v<release> documentation".
+#html_title = None
+
+# A shorter title for the navigation bar. Default is the same as html_title.
+#html_short_title = None
+
+# The name of an image file (relative to this directory) to place at the top
+# of the sidebar.
+#html_logo = None
+
+# The name of an image file (within the static path) to use as favicon of the
+# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
+# pixels large.
+#html_favicon = None
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = ['_static']
+
+# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
+# using the given strftime format.
+#html_last_updated_fmt = '%b %d, %Y'
+
+# If true, SmartyPants will be used to convert quotes and dashes to
+# typographically correct entities.
+#html_use_smartypants = True
+
+# Custom sidebar templates, maps document names to template names.
+#html_sidebars = {}
+
+# Additional templates that should be rendered to pages, maps page names to
+# template names.
+#html_additional_pages = {}
+
+# If false, no module index is generated.
+#html_use_modindex = True
+
+# If false, no index is generated.
+#html_use_index = True
+
+# If true, the index is split into individual pages for each letter.
+#html_split_index = False
+
+# If true, links to the reST sources are added to the pages.
+#html_show_sourcelink = True
+
+# If true, an OpenSearch description file will be output, and all pages will
+# contain a <link> tag referring to it. The value of this option must be the
+# base URL from which the finished HTML is served.
+#html_use_opensearch = ''
+
+# If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml").
+#html_file_suffix = ''
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'LearneLispTheHardWaydoc'
+
+
+# -- Options for LaTeX output --------------------------------------------------
+
+# The paper size ('letter' or 'a4').
+#latex_paper_size = 'letter'
+
+# The font size ('10pt', '11pt' or '12pt').
+#latex_font_size = '10pt'
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title, author, documentclass [howto/manual]).
+latex_documents = [
+ ('index', 'LearneLispTheHardWay.tex', u'Learn eLisp The Hard Way Documentation',
+ u'Gordon Guthrie', 'manual'),
+]
+
+# The name of an image file (relative to this directory) to place at the top of
+# the title page.
+#latex_logo = None
+
+# For "manual" documents, if this is true, then toplevel headings are parts,
+# not chapters.
+#latex_use_parts = False
+
+# Additional stuff for the LaTeX preamble.
+#latex_preamble = ''
+
+# Documents to append as an appendix to all manuals.
+#latex_appendices = []
+
+# If false, no module index is generated.
+#latex_use_modindex = True
BIN  images/emacs-components.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
BIN  images/emacs.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
BIN  images/synaptic_package_manager.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
27 index.rst
@@ -0,0 +1,27 @@
+.. Learn eLisp The Hard Way documentation master file, created by
+ sphinx-quickstart on Sat Nov 6 22:31:37 2010.
+ You can adapt this file completely to your liking, but it should at least
+ contain the root `toctree` directive.
+
+Welcome to Learn eLisp The Hard Way's documentation!
+====================================================
+
+Contents:
+
+.. toctree::
+ :maxdepth: 1
+
+ rsts/learning-elisp
+ rsts/why
+ rsts/what
+ rsts/getting-started
+ rsts/lesson-0
+ rsts/lesson-1
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`
+
113 make.bat
@@ -0,0 +1,113 @@
+@ECHO OFF
+
+REM Command file for Sphinx documentation
+
+set SPHINXBUILD=sphinx-build
+set BUILDDIR=_build
+set ALLSPHINXOPTS=-d %BUILDDIR%/doctrees %SPHINXOPTS% .
+if NOT "%PAPER%" == "" (
+ set ALLSPHINXOPTS=-D latex_paper_size=%PAPER% %ALLSPHINXOPTS%
+)
+
+if "%1" == "" goto help
+
+if "%1" == "help" (
+ :help
+ echo.Please use `make ^<target^>` where ^<target^> is one of
+ echo. html to make standalone HTML files
+ echo. dirhtml to make HTML files named index.html in directories
+ echo. pickle to make pickle files
+ echo. json to make JSON files
+ echo. htmlhelp to make HTML files and a HTML help project
+ echo. qthelp to make HTML files and a qthelp project
+ echo. latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter
+ echo. changes to make an overview over all changed/added/deprecated items
+ echo. linkcheck to check all external links for integrity
+ echo. doctest to run all doctests embedded in the documentation if enabled
+ goto end
+)
+
+if "%1" == "clean" (
+ for /d %%i in (%BUILDDIR%\*) do rmdir /q /s %%i
+ del /q /s %BUILDDIR%\*
+ goto end
+)
+
+if "%1" == "html" (
+ %SPHINXBUILD% -b html %ALLSPHINXOPTS% %BUILDDIR%/html
+ echo.
+ echo.Build finished. The HTML pages are in %BUILDDIR%/html.
+ goto end
+)
+
+if "%1" == "dirhtml" (
+ %SPHINXBUILD% -b dirhtml %ALLSPHINXOPTS% %BUILDDIR%/dirhtml
+ echo.
+ echo.Build finished. The HTML pages are in %BUILDDIR%/dirhtml.
+ goto end
+)
+
+if "%1" == "pickle" (
+ %SPHINXBUILD% -b pickle %ALLSPHINXOPTS% %BUILDDIR%/pickle
+ echo.
+ echo.Build finished; now you can process the pickle files.
+ goto end
+)
+
+if "%1" == "json" (
+ %SPHINXBUILD% -b json %ALLSPHINXOPTS% %BUILDDIR%/json
+ echo.
+ echo.Build finished; now you can process the JSON files.
+ goto end
+)
+
+if "%1" == "htmlhelp" (
+ %SPHINXBUILD% -b htmlhelp %ALLSPHINXOPTS% %BUILDDIR%/htmlhelp
+ echo.
+ echo.Build finished; now you can run HTML Help Workshop with the ^
+.hhp project file in %BUILDDIR%/htmlhelp.
+ goto end
+)
+
+if "%1" == "qthelp" (
+ %SPHINXBUILD% -b qthelp %ALLSPHINXOPTS% %BUILDDIR%/qthelp
+ echo.
+ echo.Build finished; now you can run "qcollectiongenerator" with the ^
+.qhcp project file in %BUILDDIR%/qthelp, like this:
+ echo.^> qcollectiongenerator %BUILDDIR%\qthelp\LearneLispTheHardWay.qhcp
+ echo.To view the help file:
+ echo.^> assistant -collectionFile %BUILDDIR%\qthelp\LearneLispTheHardWay.ghc
+ goto end
+)
+
+if "%1" == "latex" (
+ %SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex
+ echo.
+ echo.Build finished; the LaTeX files are in %BUILDDIR%/latex.
+ goto end
+)
+
+if "%1" == "changes" (
+ %SPHINXBUILD% -b changes %ALLSPHINXOPTS% %BUILDDIR%/changes
+ echo.
+ echo.The overview file is in %BUILDDIR%/changes.
+ goto end
+)
+
+if "%1" == "linkcheck" (
+ %SPHINXBUILD% -b linkcheck %ALLSPHINXOPTS% %BUILDDIR%/linkcheck
+ echo.
+ echo.Link check complete; look for any errors in the above output ^
+or in %BUILDDIR%/linkcheck/output.txt.
+ goto end
+)
+
+if "%1" == "doctest" (
+ %SPHINXBUILD% -b doctest %ALLSPHINXOPTS% %BUILDDIR%/doctest
+ echo.
+ echo.Testing of doctests in the sources finished, look at the ^
+results in %BUILDDIR%/doctest/output.txt.
+ goto end
+)
+
+:end
35 rsts/getting-started.rst
@@ -0,0 +1,35 @@
+===============
+Getting Started
+===============
+
+--------------------------
+What Needs To Be Installed
+--------------------------
+
+This book assumes that you have a clean install of Ubuntu 10.10 Desktop which can be obtained `from Ubuntu`_.
+
+Having created a clean install the Emacs package (version 23.1+1-4ubunutu7) should be installed.
+
+This can be done by:
+
+* selecting the Ubuntu menu `System -> Administration -> Synaptic Package Manager`
+* use the Quick search input box in the top right
+* select `emacs` by clicking the tick box in the first column
+* click the `Apply` button and click `Apply` in the Summary dialog box
+
+.. image :: /images/synaptic_package_manager.png
+
+A dialog box entitled `Applying Changes` will appear. When the changes have been applied you may close the dialog box.
+
+**Please** only install the Emacs package as indicated. The exercises in this book are predicated on that being the case.
+
+-----------------------
+How This Book Will Work
+-----------------------
+
+The work on learning eLisp will take place within an X-Windows enabled version of Emacs as shown below.
+
+.. image :: /images/emacs.png
+
+
+.. _from Ubuntu: http://www.ubuntu.com/desktop/get-ubuntu/alternative-download
17 rsts/learning-elisp.rst
@@ -0,0 +1,17 @@
+==============
+Learning eLisp
+==============
+
+--------------------
+Who This Book Is For
+--------------------
+
+This book is for people who can already programme, but who are not familiar with functional programming. It is suitable for most programmers with experience of popular programming languages like Ruby, Java, Python, Perl, C, C++ and so on.
+
+It assumes that the reader can get a clean install of Ubuntu GNU/Linux up and running.
+
+---------------------------
+How This Book Teaches eLisp
+---------------------------
+
+This book teaches eLisp throught the medium of Emacs. Emacs has a *scratch* window in which arbritary eLisp expressions can be evaluated. Intitial lessons will use the *scratch* window. Later lessons will move on to creating external lisp files and loading them into Emacs to use them.
48 rsts/lesson-0.rst
@@ -0,0 +1,48 @@
+====================
+Lesson 0 Using Emacs
+====================
+
+--------------
+Learning Emacs
+--------------
+
+This book is not designed to teach you how to use Emacs. It will teach you enough Emacs to complete the work in this book, but not more.
+
+If you want to learn to use Emacs then you should consider buying a book - I recommend `Learning Gnu Emacs`_.
+
+----------------
+Emacs Components
+----------------
+
+The version of Emacs we are using has 5 components on it:
+
+* a menubar
+* a toolbar
+* a window area (it is possible to have multiple window views)
+* a mode line
+* a minibuffer
+
+These are used for different things and are marked on the diagram below:
+
+.. image :: /images/emacs-components.png
+
+A file is referred to as a buffer - and a window is therefore a view of a buffer.
+
+----------
+Emacs Keys
+----------
+
+Emacs is primarly a keyboard-focused editor. The version we are using has mouse-friendly components (the menu bar, the toolbar) but they are very much tacked on. In a lot of environments the non-X Windows version isn't supported so learning the key short cuts for **all** menu actions is essential.
+
+In this book the various keyboard short cuts will be introduced as needed. There are two keys that you will need to know about.
+
+Emacs uses so-called key modifiers to implement keyboard shortcuts. The two important ones are the Control Key (`[Ctrl]` on your keyboard) and the Meta Key (`[Alt]` on your keyboard). Some keyboard shortcuts require you to use both of them at the same time.
+
+The most common key modifier on the keyboard is the Shift Key `[Shift]`. Control and Meta/Alt work in the same way. You implement Control-x by pressing `[Ctrl]` first, and then, whilst holding it down, pressing `x` - the same way as you do Shift-x.
+
+Where keyboard commands are required in this book they will be spelled out, but in other publication online (or the Emacs help) they are often written in a contracted form like C-x or M-x
+
+
+
+
+.. _Learning Gnu Emacs: http://oreilly.com/catalog/9781565921528
105 rsts/lesson-1.rst
@@ -0,0 +1,105 @@
+================================
+Lesson 1 - First eLisp Programme
+================================
+
+This lesson will show you how to execute your first eLisp programme.
+
+* start Emacs
+* go to the scratch buffer by using the menu `Buffers -> \*scratch\*`
+
+--------------------
+What You Should Type
+--------------------
+``(+ 1 2)``
+
+Now put the cursor at the **end** of the expression - that is to say after the right bracket and type ``Control-j``
+
+-------------------
+What You Should See
+-------------------
+| ``(+ 1 2)``
+| ``3``
+
+---------------
+What This Means
+---------------
+
+What you typed in consists of an expression ``(+ 1 2)`` and a command to Emacs to execute it ``[Control-j]``. Expressions are sometimes called *forms*.
+
+eLisp is a dialect of Lisp - which stands for List Processing. A list is any thing between two brackets ``(`` and ``)``
+
+The programme that was executed consisted of an operator ``+`` and two constants ``1`` and ``2``
+
+The command to Emacs is applied at the point where the cursor is - it evaluates all the eLisp in the window up to that point and prints the output.
+
+Lets look at executing the same expression in a different way. Delete the expression in the \*scracha\* buffer
+
+--------------------
+What You Should Type
+--------------------
+``(+ 1.0 2.0)``
+
+Now put the cursor in the **middle** of the expression - that is to say between the brackets and type ``Control-Alt-x``
+
+-------------------
+What You Should See
+-------------------
+
+In the window nothing will change
+``(+ 1.0 2.0)``
+
+The result of the expression is now put in the *minibuffer*
+``3.0``
+
+---------------
+What This Means
+---------------
+
+The way in which you evaluate the expression determines where the output goes. Alos notice that the previous examples used integers like ``1`` and ``2`` and returned an integer value. This expression uses floating point numbers like ``1.0`` and returns a float as the result.
+
+--------------------
+What You Should Type
+--------------------
+``(+ 1.0e+3 2.0e-2)``
+
+Now put the cursor at the **end** of the expression and type ``Control-x Control-e``
+
+-------------------
+What You Should See
+-------------------
+
+In the window nothing will change
+``(+ 1.0e+3 2.0-2)``
+
+The result of the expression is now put in the *minibuffer*
+``1000.02``
+
+---------------
+What This Means
+---------------
+
+You can express floating point numbers is scientific notation
+
+---------------------
+What You Have Learned
+---------------------
+
+You have learned how to evaluate a basic eLisp expression (or form) in the scratch buffer.
+
+----------------
+Extra Activities
+----------------
+
+Try some expressions that add integers to floats. What is the result?
+
+What happens if you use scientific integers like ``1e+10``?
+
+Can you add negative numbers?
+
+| What do you think the following expressions will return?
+| ``(- 3 4)``
+| ``(* 4 5)``
+| ``(/ 1.0 4.0)``
+
+| Evaluate the following expression and try and work out why it returns why it does?
+| ``(/ 1 4)``
33 rsts/lesson-1.rst~
@@ -0,0 +1,33 @@
+================================
+Lesson 1 - First eLisp Programme
+================================
+
+This lesson will show you how to execute your first eLisp programme.
+
+* start Emacs
+* go to the scratch buffer by using the menu `Buffers -> \*scratch\*`
+
+--------------------
+What You Should Type
+--------------------
+``(+ 1 2)``
+
+Now put the cursor at the **end**of the experssion - that is to say after the right bracket and type ``Control-j``
+
+-------------------
+What You Should See
+-------------------
+| ``(+ 1 2)``
+| ``3``
+
+---------------
+What This Means
+---------------
+
+What you typed in consists of an expression ``(+ 1 2)`` and a command to Emacs to execute it ``[Control-j]``. Expressions are sometimes called *forms*.
+
+eLisp is a dialect of Lisp - which stands for List Processing. A list is any thing between two brackets ``(`` and ``)``
+
+The programme that was executed consisted of an operator ``+`` and two constants ``1`` and ``2``
+
+The command to Emacs is applied at the point where the cursor is - it evaluates all the eLisp in the window up to that point and prints the output.
21 rsts/what.rst
@@ -0,0 +1,21 @@
+==========================
+What This Book Will Cover?
+==========================
+
+---------
+What's In
+---------
+
+This book will cover enough eLisp to enable you to:
+
+* understand ``.emacs`` files
+* write your own functions to put in ``.emacs`` files
+* create your own Emacs menu's
+* write functions that execute on events like opening and closing a file
+* attach functions to key strokes to enable you to customise the behaviour of your Emacs
+
+-------------
+What's Not In
+-------------
+
+This book will not teach you enough Lisp to be an proper Lisp developer.
61 rsts/why.rst
@@ -0,0 +1,61 @@
+==========================
+Why Did I Write This Book?
+==========================
+
+----------
+Why eLisp?
+----------
+I am writing this book to lean eLisp myself. I used Emacs every day because it the IDE of choice for Erlang and I am an Erlang programmer.
+
+My relationship with Emacs is that of Simson Garfinkel, Daniel Weise and Steven Strassmann to `Unix`_ - I genuinely loathe it.
+
+Emacs is the most prominent piece of software in the *apolstolic* tradition. You are supposed to learn it by being instructed by someone who learnt it by being instructed by someone recursively all the way back to the original authors in a continuous apostolic succession.
+
+I would fain be the John Knox, the Calvin, the Luther, and hell mend them.
+
+By writing this book I hope to be able to write eLisp to configure and extend Emacs in my working environment.
+
+-----------------------
+Why Choose This Format?
+-----------------------
+
+The *Learn X The Hard Way* format is specifically aimed at writing books for non-programmers.
+
+I occassionally have to dip into eLisp in the form of .emacs files which are executed on startup and are how you configure Emacs to do specific stuff for your particular requirements.
+
+eLisp still looks like line noise to me and I have been programming since the late 70s in languages as diverse as Fortran, VB, C++, Java, Perl, Python, PHP, Ruby and Erlang.
+
+The transition from Fortran to the Obect Orientated paradigm of C++ was enormously painful. The shift from the OO paradigm (Ruby was my language *de jour* then) to functional programming in the form of Erlang was also horrendous.
+
+I may be wrong, but I think that many experienced programmers who have no previous exposure to functional programming would benefit from a pretty brutal beginners style book about eLisp.
+
+I have copies of `On Lisp`_ by Paul Graham and `Common Lisp A Gentle Introduction To Symbolic Computing`_ but have never been able to learn Lisp because of the very basic problem that Zed Shaw identified in `his article`_ on *How To Write A LxTHW* - I could never work out how to get to a basic working shell to type the code examples into. It's not that I didn't try, its just that after a summer of trying to start learning Lisp I had gotten nowhere. If you think that that's my fault, then it falls to you to explain how I managed to learn a brazillian other languages succesfully.
+
+The other appealing part of this format is that it isn't a reference book. To make clear just how unsuited I am to write a reference book about Lisp, let me enumerate ATTIDNK (All The Things I Do Not Know):
+
+* the difference between Emacs and XEmacs
+* the difference between eLisp and Lisp
+* how Common Lisp is related to Clojure or any other Lisp
+* how Lisp does package management
+* pretty much everything else I would need to know to write a reference book
+
+----------------------------------
+On Learning Functional Programming
+----------------------------------
+
+If you just want to learn **a functional programming language** you really should learn Erlang and I recommend `Joe's book`_ or `Franceso and Simon's one`_.
+
+-------------------
+Big Up For Zed Shaw
+-------------------
+
+Zed Shaw? `Who?`_ `Why?`_
+
+.. _Unix: http://www.amazon.com/UNIX-Haters-Handbook-Daniel-Weise/dp/1568842031/ref=sr_1_1?ie=UTF8&s=books&qid=1290297419&sr=1-1
+.. _On Lisp: http://www.amazon.com/LISP-Advanced-Techniques-Common/dp/0130305529/ref=sr_1_1?ie=UTF8&qid=1290295941&sr=8-1
+.. _Common Lisp A Gentle Introduction To Symbolic Computing: http://www.amazon.com/Common-Lisp-Introduction-Symbolic-Computation/dp/0805304924/ref=sr_1_8?s=books&ie=UTF8&qid=1290296197&sr=1-8
+.. _his article: http://sheddingbikes.com/posts/1288945508.html
+.. _Joe's book: http://www.amazon.com/Programming-Erlang-Software-Concurrent-World/dp/193435600X/ref=sr_1_2?s=books&ie=UTF8&qid=1290296292&sr=1-2
+.. _Franceso and Simon's one: http://www.amazon.com/ERLANG-Programming-Francesco-Cesarini/dp/0596518188/ref=sr_1_1?s=books&ie=UTF8&qid=1290296292&sr=1-1
+.. _Who? : http://www.zedshaw.com/
+.. _Why? : http://sheddingbikes.com/posts/1288945508.html
Please sign in to comment.
Something went wrong with that request. Please try again.