replacing the old HTML user guide with a Sphinx-managed user guide

4 files changed, 70 insertions, 0 deletions

diff --git a/user_guide_src/cilexer/README b/user_guide_src/cilexer/README
new file mode 100644
index 000000000..b9d9baf09
--- /dev/null
+++ b/user_guide_src/cilexer/README
@@ -0,0 +1,22 @@
+To install the CodeIgniter Lexer to Pygments, run:
+
+	sudo python setup.py install
+
+Confirm with
+
+	pygmentize -L
+	
+
+You should see in the lexer output:
+
+* ci, codeigniter:
+    CodeIgniter (filenames *.html, *.css, *.php, *.xml, *.static)
+
+You will need to run setup.py and install the cilexer package anytime after cilexer/cilexer.py is updated
+
+NOTE: Depending on how you installed Sphinx and Pygments,
+you may be installing to the wrong version. 
+If you need to install to a different version of python
+specify its path when using setup.py, e.g.:
+
+	sudo /usr/bin/python2.5 setup.py install
\ No newline at end of file
diff --git a/user_guide_src/cilexer/cilexer/__init__.py b/user_guide_src/cilexer/cilexer/__init__.py
new file mode 100644
index 000000000..8b1378917
--- /dev/null
+++ b/user_guide_src/cilexer/cilexer/__init__.py
@@ -0,0 +1 @@
+
diff --git a/user_guide_src/cilexer/cilexer/cilexer.py b/user_guide_src/cilexer/cilexer/cilexer.py
new file mode 100644
index 000000000..265b4077f
--- /dev/null
+++ b/user_guide_src/cilexer/cilexer/cilexer.py
@@ -0,0 +1,24 @@
+import re
+import copy
+
+from pygments.lexer import DelegatingLexer
+from pygments.lexers.web import PhpLexer, HtmlLexer
+
+__all__ = ['CodeIgniterLexer']
+
+
+class CodeIgniterLexer(DelegatingLexer):
+    """
+    Handles HTML, PHP, JavaScript, and CSS is highlighted
+    PHP is highlighted with the "startline" option
+    """
+
+    name = 'CodeIgniter'
+    aliases = ['ci', 'codeigniter']
+    filenames = ['*.html', '*.css', '*.php', '*.xml', '*.static']
+    mimetypes = ['text/html', 'application/xhtml+xml']
+
+    def __init__(self, **options):
+        super(CodeIgniterLexer, self).__init__(HtmlLexer,
+                                               PhpLexer,
+                                               startinline=True)
diff --git a/user_guide_src/cilexer/setup.py b/user_guide_src/cilexer/setup.py
new file mode 100644
index 000000000..db4bbea43
--- /dev/null
+++ b/user_guide_src/cilexer/setup.py
@@ -0,0 +1,23 @@
+"""
+Install and setup CodeIgniter highlighting for Pygments.
+"""
+
+from setuptools import setup
+
+entry_points = """
+[pygments.lexers]
+cilexer = cilexer.cilexer:CodeIgniterLexer
+"""
+
+setup(
+    name='pycilexer',
+    version='0.1',
+    description=__doc__,
+    author="EllisLab, Inc.",
+    packages=['cilexer'],
+    install_requires=(
+        'sphinx >= 1.0.7',
+        'sphinxcontrib-phpdomain >= 0.1.3-1'
+    ),
+    entry_points=entry_points
+)