reorganize conkeratorrc a bit, add folds and comments

1 files changed, 89 insertions, 68 deletions

diff --git a/conkerorrc b/conkerorrc
index 9cdbd5c..00f0e16 100644
--- a/conkerorrc
+++ b/conkerorrc
@@ -1,41 +1,102 @@
 // vim: ft=javascript
+
+// Global configuration {{{
+// Built-in {{{
+// Don't let kill-buffer close the window
 can_kill_last_buffer = false;
+// display the url before going to it in hints mode
 hints_display_url_panel = true;
+// don't use a homepage
 homepage = "about:blank";
+// keep the found item selected after search mode ends
 isearch_keep_selection = true;
+// always use autocompletion in the minibuffer
 minibuffer_auto_complete_default = true;
+// T and O shouldn't leave the url highlighted
 minibuffer_read_url_select_initial = false;
+// use bookmarks rather than history for url completion (history gets included
+// anyway though)
 url_completion_use_bookmarks = false;
 url_completion_use_history = true;
+// use a single window, even when external programs open a url in conkeror
 url_remoting_fn = load_url_in_new_buffer;
+// }}}
+// Custom {{{
+// Proxy information
+proxy_server_default = "127.0.0.1";
+proxy_port_default = 8118;
+// }}}
+// }}}
+// Helper functions {{{
+function set_proxy_session (window, server, port) { // {{{
+    if (server == "N") {
+        session_pref ('network.proxy.type', 0); //direct connection
+        window.minibuffer.message ("Direction connection to the internet enabled for this session");
+    } else {
+        if (!server) server = proxy_server_default;
+        if (!port)   port   = proxy_port_default;
 
-require("clicks-in-new-buffer.js");
-clicks_in_new_buffer_target = OPEN_NEW_BUFFER_BACKGROUND;
-
-require("new-tabs.js");
+        session_pref ('network.proxy.ftp',    server);
+        session_pref ('network.proxy.gopher', server);
+        session_pref ('network.proxy.http',   server);
+        session_pref ('network.proxy.socks',  server);
+        session_pref ('network.proxy.ssl',    server);
 
-require("page-modes/wikipedia.js");
-wikipedia_enable_didyoumean = true;
+        session_pref ('network.proxy.ftp_port',    port);
+        session_pref ('network.proxy.gopher_port', port);
+        session_pref ('network.proxy.http_port',   port);
+        session_pref ('network.proxy.socks_port',  port);
+        session_pref ('network.proxy.ssl_port',    port);
 
-require("session.js");
-session_auto_save_auto_load = true;
+        session_pref ('network.proxy.share_proxy_settings', 'true');
+        session_pref ('network.proxy.type', 1);
 
-interactive(
-    "copy-current-url",
-    "Copy the current buffer's URL to the clipboard",
-    function(I) {
-        var text = I.window.buffers.current.document.location.href;
-        writeToClipboard(text);
-        I.window.minibuffer.message("Copied: " + text);
+        window.minibuffer.message ("All protocols using "+server+":"+port+" for this session");
     }
-);
-
-interactive(
-    "q",
-    "Quit Conkeror",
-    "quit"
-);
-
+} // }}}
+// }}}
+// Plugins {{{
+require("clicks-in-new-buffer.js"); // {{{
+// open new tabs in the background
+clicks_in_new_buffer_target = OPEN_NEW_BUFFER_BACKGROUND;
+// }}}
+require("new-tabs.js"); // {{{
+// }}}
+require("page-modes/wikipedia.js"); // {{{
+// automatically follow "did you mean" links on wikipedia search pages
+wikipedia_enable_didyoumean = true;
+// }}}
+require("session.js"); // {{{
+// automatically load saved session on startup
+session_auto_save_auto_load = true;
+// }}}
+// }}}
+// Additional commands {{{
+interactive("copy-current-url", // {{{
+            "Copy the current buffer's URL to the clipboard",
+            function(I) {
+                var text = I.window.buffers.current.document.location.href;
+                writeToClipboard(text);
+                I.window.minibuffer.message("Copied: " + text);
+            }); // }}}
+interactive("q", // {{{
+            "Quit Conkeror",
+            "quit"); // }}}
+interactive("set-proxy-session", // {{{
+            "set the proxy server for all protocols for this session only",
+            function (I) {
+                set_proxy_session(
+                    I.window,
+                    (yield I.minibuffer.read(
+                        $prompt = "server ["+proxy_server_default+"] or N: "
+                    )),
+                    (yield I.minibuffer.read(
+                        $prompt = "port ["+proxy_port_default+"]: "
+                    ))
+                );
+            }); // }}}
+// }}}
+// Webjumps {{{
 define_webjump("imdb", "http://imdb.com/find?q=%s");
 define_webjump("urban", "http://www.urbandictionary.com/define.php?term=%s");
 define_webjump("cpan", "http://search.cpan.org/search?query=%s&mode=all");
@@ -43,7 +104,8 @@ define_webjump("youtube", "http://www.youtube.com/results?search_query=%s&search
 define_webjump("de", "http://pda.leo.org/?lp=ende&lang=de&searchLoc=0&cmpType=relaxed&relink=on&sectHdr=off&spellToler=std&search=%s");
 define_webjump("trans", "http://translate.google.com/translate_t#auto|en|%s");
 define_webjump("gl", "http://www.google.com/search?q=%s&btnI=I'm Feeling Lucky");
-
+// }}}
+// Keybindings {{{
 // commands are in modules/commands.js
 undefine_key(content_buffer_normal_keymap, "b");
 undefine_key(content_buffer_normal_keymap, "g");
@@ -90,51 +152,10 @@ define_key(default_global_keymap, "C-tab", "buffer-next");
 define_key(default_global_keymap, "C-S-tab", "buffer-previous");
 define_key(default_global_keymap, "g t", "buffer-next");
 define_key(default_global_keymap, "g T", "buffer-previous");
-
-//set the proxy server for this session only
-proxy_server_default = "127.0.0.1";
-proxy_port_default = 8118;
-
-function set_proxy_session (window, server, port) {
-    if (server == "N") {
-        session_pref ('network.proxy.type', 0); //direct connection
-        window.minibuffer.message ("Direction connection to the internet enabled for this session");
-    } else {
-        if (!server) server = proxy_server_default;
-        if (!port)   port   = proxy_port_default;
-
-        session_pref ('network.proxy.ftp',    server);
-        session_pref ('network.proxy.gopher', server);
-        session_pref ('network.proxy.http',   server);
-        session_pref ('network.proxy.socks',  server);
-        session_pref ('network.proxy.ssl',    server);
-
-        session_pref ('network.proxy.ftp_port',    port);
-        session_pref ('network.proxy.gopher_port', port);
-        session_pref ('network.proxy.http_port',   port);
-        session_pref ('network.proxy.socks_port',  port);
-        session_pref ('network.proxy.ssl_port',    port);
-
-        session_pref ('network.proxy.share_proxy_settings', 'true');
-        session_pref ('network.proxy.type', 1);
-
-        window.minibuffer.message ("All protocols using "+server+":"+port+" for this session");
-    }
-}
-
-interactive(
-    "set-proxy-session",
-    "set the proxy server for all protocols for this session only",
-    function (I) {
-        set_proxy_session(
-        I.window,
-            (yield I.minibuffer.read ($prompt = "server ["+proxy_server_default+"] or N: ")),
-            (yield I.minibuffer.read ($prompt = "port ["+proxy_port_default+"]: "))
-        );
-    }
-);
-
+// }}}
+// Hooks {{{
 add_hook("window_initialize_hook", set_proxy_session);
+// }}}
 
 /*
  * TODO: