From: James Moger <james.moger@gitblit.com>
Date: Sun, 30 Mar 2014 19:26:54 +0000 (-0400)
Subject: Documentation
X-Git-Tag: v1.5.0~68^2~16
X-Git-Url: https://source.dussan.org/?a=commitdiff_plain;h=ec3b719dab4ae3c51d8bd52ab2b4176f82c5006f;p=gitblit.git

Documentation
---

diff --git a/src/site/resources/6x12.dfont b/src/site/resources/6x12.dfont
new file mode 100644
index 00000000..8c35f35a
Binary files /dev/null and b/src/site/resources/6x12.dfont differ
diff --git a/src/site/resources/6x13.dfont b/src/site/resources/6x13.dfont
new file mode 100644
index 00000000..6cf59fe9
Binary files /dev/null and b/src/site/resources/6x13.dfont differ
diff --git a/src/site/resources/7x13.dfont b/src/site/resources/7x13.dfont
new file mode 100644
index 00000000..577d638b
Binary files /dev/null and b/src/site/resources/7x13.dfont differ
diff --git a/src/site/resources/7x14.dfont b/src/site/resources/7x14.dfont
new file mode 100644
index 00000000..465af8ea
Binary files /dev/null and b/src/site/resources/7x14.dfont differ
diff --git a/src/site/setup_plugins.mkd b/src/site/setup_plugins.mkd
index 4e5c733a..6ab4f1ef 100644
--- a/src/site/setup_plugins.mkd
+++ b/src/site/setup_plugins.mkd
@@ -3,4 +3,45 @@
 
 *SINCE 1.5.0*
 
-Document (limited) plugin infrastructure.
+Gitblit supports extending and enhacing the core functionality through plugins.  This mechanism is very young and incomplete with few extension points, but you can expect it to evolve rapidly in upcoming releases.
+
+### Architecture
+
+The existing plugin mechanism is based on [pf4j](https://github.com/decebals/pf4j).  Plugins are distributed as zip files and may include their runtime dependencies or may rely on the bundled dependencies of other plugins and/or Gitblit core.
+
+The zip plugins are stored in `${baseFolder}/plugins` and are unpacked on startup into folders of the same name.
+
+A plugin defines it's metadata in the META-INF/MANIFEST.MF file:
+
+    Plugin-Class: com.gitblit.plugins.cookbook.CookbookPlugin
+    Plugin-Dependencies: foo, bar
+    Plugin-Id: gitblit-plugin
+    Plugin-Provider: John Doe
+    Plugin-Version: 1.0
+
+In addition to extending Gitblit core, plugins can also define extension points that may be implemented by other plugins.  Therefore a plugin may depend on other plugins.
+
+    Plugin-Dependencies: foo, bar
+
+Plugins are controlled by the `plugin` SSH dispatch command.  Only *administrators* have permission to use this dispatch command.
+
+The pf4j plugin framework relies on a javac apt processor to generate compile-time extension information, so be sure to enable apt processing in your build process.
+
+### Extension Point: SSH DispatchCommand
+
+You can provide your own custom SSH commands by extending the DispatchCommand.
+
+For some examples of how to do this, please see:
+
+[gitblit-cookbook-plugin (Maven project)](https://dev.gitblit.com/summary/gitblit-cookbook-plugin.git)
+[gitblit-powertools-plugin (Ant/Moxie project)](https://dev.gitblit.com/summary/gitblit-powertools-plugin.git)
+
+### Mac OSX Fonts
+
+Gitblit's core SSH commands and those in the *powertools* plugin rely on use of ANSI border characters to provide a pretty presentation of data.  Unfortunately, the fonts provided by Apple - while very nice - don't work well with ANSI border characters.  The following public domain fixed-width, fixed-point, bitmapped fonts work very nicely.  I find the 6x12 font with a line spacing of ~0.8 to be quite acceptable.
+
+[6x12.dfont](6x12.dfont)
+[6x13.dfont](6x13.dfont)
+[7x13.dfont](7x13.dfont)
+[7x14.dfont](7x14.dfont)
+