Eliminated redundant LuaDoc.

1 files changed, 44 insertions, 0 deletions

diff --git a/core/.pm.lua b/core/.pm.lua
index bd82bac3..3b1ffbd8 100644
--- a/core/.pm.lua
+++ b/core/.pm.lua
@@ -7,6 +7,50 @@
 -- [Dummy file]
 module('textadept.pm')
 
+-- Usage:
+-- Interactive search:
+--   Typing text into the project manager view begins the interactive search.
+--   If the text matches ANY part of an item in the view (case sensitively), the
+--   item is highlighted and subsequent matches can be navigated to using the
+--   up/down arrow keys.
+--
+-- Customizing look and feel:
+--   There are no function calls to make that customize the look and feel of the
+--   project manager. Instead you can manipulate it via GTK rc files. The pm
+--   entry and view have widget names of 'textadept-pm-entry' and
+--   'textadept-pm-view' respectively. Resource file documentation can be found
+--   at http://library.gnome.org/devel/gtk/unstable/gtk-Resource-Files.html.
+--   My rc file is something like this:
+--
+--     pixmap_path "/usr/share/icons/Tango/:/home/mitchell/.icons/prog/"
+--
+--     style "textadept-pm-display-style" {
+--        fg[NORMAL]     = "#AAAAAA" # treeview arrows foreground
+--        fg[PRELIGHT]   = "#AAAAAA" # treeview arrows hover foreground
+--        bg[NORMAL]     = "#333333" # entry border background
+--        base[NORMAL]   = "#333333" # entry, treeview background
+--        base[ACTIVE]   = "#444444" # treeview unfocused selection background
+--        base[SELECTED] = "#444444" # entry, treeview selection background
+--        text[NORMAL]   = "#AAAAAA" # entry, treeview text foreground
+--        text[ACTIVE]   = "#AAAAAA" # treeview unfocused selection text
+--        text[SELECTED] = "#DDDDDD" # entry, treeview selection text foreground
+--
+--        stock["gtk-directory"]  = {{ "16x16/places/stock_folder.png", LTR }}
+--        stock["gtk-folder-new"] = {{ "16x16/actions/folder_new.png", LTR }}
+--        stock["prog-class"]     = {{ "class.png", LTR }}
+--        stock["prog-enum"]      = {{ "enum.png", LTR }}
+--        stock["prog-field"]     = {{ "field.png", LTR }}
+--        stock["prog-interface"] = {{ "interface.png", LTR }}
+--        stock["prog-literal"]   = {{ "literal.png", LTR }}
+--        stock["prog-method"]    = {{ "method.png", LTR }}
+--        stock["prog-namespace"] = {{ "namespace.png", LTR }}
+--        stock["prog-reference"] = {{ "reference.png", LTR }}
+--        stock["prog-struct"]    = {{ "struct.png", LTR }}
+--      }
+--
+--      widget "*textadept-pm-entry" style "textadept-pm-display-style"
+--      widget "*textadept-pm-view" style "textadept-pm-display-style"
+
 ---
 -- Textadept's project manager table.
 -- @class table