Changes between Version 40 and Version 41 of TracPlugins

Timestamp:

Jul 16, 2007, 2:05:59 PM (17 years ago)

Author:

Noah Kantrowitz

Comment:

Clean up these docs a bit

TracPlugins

@@ -24 +24 @@
 
 If you have downloaded a source distribution of a plugin, and want to build the `.egg` file, follow this instruction:
- * unzip the file. It should provide a setup.py. 
+ * Unpack the source. It should provide a setup.py. 
  * Run:
 {{{
@@ -57 +57 @@
 You should end up with a directory having the same name as the zipped egg (complete with `.egg` extension) and containing its uncompressed contents.
 
-Trac also searches for globally installed plugins under `$prefix/share/trac/plugins` ''(since 0.10)''.
+Trac also searches for globally installed plugins under `$PREFIX/share/trac/plugins` ''(since 0.10)''.
 
 ==== From source ====
 
-Download directly into your trac environment's plugins directory, then run the `setup.py` to create the .egg, and finally easy_install the .egg, like so (example is from an ubuntu install; your plugins directory may be elsewhere:
-
+`easy_install` makes installing from source a snap. Just give it the URL to either a Subversion repository or a tarball/zip of the source:
 {{{
-cd /usr/share/trac/plugins
-svn co http://svn.edgewall.com/repos/trac/sandbox/webadmin/
-cd webadmin
-python setup.py bdist_egg
-cd dist
-easy_install-2.4 TracWebAdmin-0.1.2dev_r4429-py2.4.egg
+easy_install http://svn.edgewall.com/repos/trac/sandbox/webadmin
 }}}
-
 
 ==== Enabling the plugin ====
@@ -80 +73 @@
 }}}
 
-The name of the option is the Python package of the plugin. This should be specified in the documentation of the Plugin, but can also be easily find out by looking at the source (look for a top-level directory that contains a file named `__init__.py`.)
+The name of the option is the Python package of the plugin. This should be specified in the documentation of the plugin, but can also be easily discovered by looking at the source (look for a top-level directory that contains a file named `__init__.py`.)
 
-Note: After installing the plugin, you may need to restart Apache.
+Note: After installing the plugin, you need to restart your web server.
 
 == Setting up the Plugin Cache ==
@@ -144 +137 @@
  * you actually added the necessary line(s) to the `[components]` section
  * the package/module names are correct
- * if you're reference a module (as opposed to a class), you've appended the necessary “.*”
  * the value is “enabled", not e.g. “enable”
 
 === Check the permissions on the egg file ===
 
-Trac must of course be able to read the file. Yeah, you knew that ;-)
+Trac must be able to read the file. 
 
 === Check the log files ===
 
-Enable [TracLogging logging] in Trac, set the log level to `DEBUG` and then watch the log file for messages about loading plugins.
+Enable [wiki:TracLogging logging] and set the log level to `DEBUG`, then watch the log file for messages about loading plugins.
 
 === Verify you have proper permissions ===
@@ -161 +153 @@
 === If all of the above failed ===
 
-OK, so the logs don't mention plugins, the egg is readable, the python version is correct ''and'' the egg has been installed globally (and is enabled in the trac.ini) and it still doesn't work or give any error messages or any other indication as to why?
-
-''If you have a umask like 027, then your setup tools is probably only readable as root.''
+OK, so the logs don't mention plugins, the egg is readable, the python version is correct ''and'' the egg has been installed globally (and is enabled in the trac.ini) and it still doesn't work or give any error messages or any other indication as to why? Hop on the IrcChannel and ask away.
 
 ----