Commits

Anonymous committed 1ce6145

Initial draft of the doc

Comments (0)

Files changed (1)

-== Welcome ==
-
-Welcome to your wiki! This is the default page we've installed for your convenience. Go ahead and edit it.
-
-=== Wiki features ===
-
-This wiki uses the [[http://www.wikicreole.org/|Creole]] syntax, and is fully compatible with the 1.0 specification.
-
-The wiki itself is actually a hg repository, which means you can clone it, edit it locally/offline, add images or any other file type, and push it back to us. It will be live immediately.
-
-Go ahead and try:
-
-{{{
-$ hg clone http://bitbucket.org/roberto.aloi/php-mode/wiki/
-}}}
-
-Wiki pages are normal files, with the .wiki extension. You can edit them locally, as well as creating new ones.
-
-=== Syntax highlighting ===
-
-You can also highlight snippets of text, we use the excellent [[http://www.pygments.org/|Pygments]] library.
-
-Here's an example of some Python code:
-
-{{{
-#!python
-
-def wiki_rocks(text):
-	formatter = lambda t: "funky"+t
-	return formatter(text)
-}}}
-
-You can check out the source of this page to see how that's done, and make sure to bookmark [[http://pygments.org/docs/lexers/|the vast library of Pygment lexers]], we accept the 'short name' or the 'mimetype' of anything in there.
-
-Have fun!
+== What is php-mode ==
+
+php-mode is a set of tools to increase productivity in Emacs when programming PHP.
+
+It can be used in conjunction with any other pre-existing PHP mode for Emacs.
+
+=== INSTALL ===
+
+1. Download the official PHP documentation (in HTML format) from:
+
+http://www.php.net/download-docs.php
+
+Please ensure you download the "Many HTML files" zipped file.
+
+2. Untar the documentation files into your favourite location:
+
+{{{
+#!bash
+
+tar -xvzf php_manual_en.tar.gz
+}}}
+
+*** NOTE: FROM NOW ON, WE WILL ASSUME YOU EXTRACTED THE PHP DOC IN ~/phpdoc/html
+
+3. Copy the provided browse-php-doc.el file into your favourite location:
+
+{{{
+#!bash
+
+mkdir ~/php-mode
+cp browse-php-doc.el ~/php-mode
+}}}
+
+4. Edit your ~/.emacs file so it contains the following lines:
+
+{{{
+#!bash
+
+(setq phpdoc-root-dir "~/phpdoc/html")
+(setq load-path (cons "~/php-mode" load-path))
+(load "browse-php-doc")
+}}}
+
+5. Restart Emacs
+
+6. From now on the following command will be available:
+{{{
+#!bash
+
+
+M-x browse-php-doc ENTER
+}}}
+
+A "Search:" label will show up, allowing you to browse the whole PHP documentation.
+
+For example, if you're looking for the stripslashes function, you can just type:
+{{{
+#!bash
+
+
+Search: function.stripslashes
+}}}
+
+Your browser should start up and the documentation page for the selected function should appear.
+
+*** PLEASE NOTE THAT TAB COMPLETION SHOULD BE AVAILABLE WHEN SEARCHING FUNCTIONS.
+
+=== Troubleshooting ===
+
+Feel free to contact me if you problems in getting this working.
+
+=== Licence ===
+
+This code is released under GNU GPLv3 license.
+
+=== Credits ===
+
+The browse-php-doc.el file is based on Magnus Henoch's browse-erlang-doc.el one,
+released under WTFPL licence and available for download at:
+
+[[http://forum.trapexit.org/viewtopic.php?p=44248&sid=cfc162ee3e2cbcc16b9af5e20a2bc85a|http://forum.trapexit.org/viewtopic.php?p=44248&sid=cfc162ee3e2cbcc16b9af5e20a2bc85a]]
+
+