Changes between Version 2 and Version 3 of StaticDocsPlugin

Timestamp:

Jul 20, 2015, 3:01:26 PM (9 years ago)

Author:

figaro

Comment:

Cosmetic changes, tagged as external and with license

StaticDocsPlugin

@@ -1 @@
-= !StaticDocs Plugin =
+= Add static pages to your Trac pages
 
-== Description ==
+== Description
 
-The staticdocs-plugin allows one to serve one more more directories of static web documents through trac.
-The motivation for writing this was to be able to control access to static files (e.g. project documentation)
-using trac’s authentication and authorization system.
+This plugin allows you to serve one more more directories of static web documents through Trac.
+The motivation for writing this was to be able to control access to static files, eg project documentation, using Trac's authentication and authorisation system.
 
-== Configuration ==
-
-Somewhere in your trac configs put a section like:
-
-{{{
-[staticdocs]
-
-# (Optional) Set the required permission for viewing static docs
-# The default is WIKI_VIEW
-permission         = WIKI_VIEW
-
-# Set up some aliases (you need at least one alias for this plugin
-# to be worthwhile.)
-alias./docs/       = /path/to/docs/
-alias./docs/other/ = /path/to/other/docs/
-
-# (Optional) Override the required permission for a specific alias
-permission./docs/other/  = TICKET_VIEW
-}}}
-
-Also, you will want to enable the plugin. Probably like this:
-
-{{{
-[components]
-
-staticdocsplugin.* = enabled
-}}}
-
-Now if you visit, e.g., `http://example.com/yourtrac/docs/file.html`, you will get served the file `/path/to/docs/file.html`.
-
-== Downloads ==
-
-The package can be installed from [http://pypi.python.org/pypi/staticdocs-plugin PyPI] using, e.g., 
-[http://www.pip-installer.org/en/latest/index.html pip]:
-
-{{{
-pip install staticdocs-plugin
-}}}
-
-== Source, Downloads Bugs ==
+== Source, Bugs
 
 The source in on [https://github.com/dairiki/staticdocs-plugin github].
@@ -53 +13 @@
 The code is released under the [http://www.opensource.org/licenses/bsd-license.php BSD license].
 
-== Author ==
+== Downloads
+
+The package can be installed from [pypi:staticdocs-plugin PyPI] using, eg
+[http://www.pip-installer.org/en/latest/index.html pip]:
+
+{{{#!sh
+pip install staticdocs-plugin
+}}}
+
+== Configuration
+
+In your `trac.ini` file put a section like:
+
+{{{#!ini
+[staticdocs]
+
+# (Optional) Set the required permission for viewing static docs
+# The default is WIKI_VIEW
+permission = WIKI_VIEW
+
+# Set up some aliases: you need at least one alias for this plugin to be worthwhile
+alias./docs/ = /path/to/docs/
+alias./docs/other/ = /path/to/other/docs/
+
+# (Optional) Override the required permission for a specific alias
+permission./docs/other/ = TICKET_VIEW
+}}}
+
+Also, enable the plugin by adding the following to your `trac.ini` file:
+
+{{{#!ini
+[components]
+staticdocsplugin.* = enabled
+}}}
+
+Now if you visit, e.g., `http://example.com/yourtrac/docs/file.html`, you will get served the file `/path/to/docs/file.html`.
+
+== Author
 
 [mailto:dairiki@dairiki.org Jeff Dairiki]