define_webjump

Webjumps are created by the define_webjump function. Define_webjump has two required arguments, and a number of optional keyword arguments.

define_webjump(name, handler);

• name - String that you type into the find-url prompt in order to follow this webjump.

• handler - A string or a function.

  • string - For most webjumps, a string spec is sufficient. Give the url as a string, with the format code %s in the place where the webjump argument (typically a search term) can be subtituted in. When your webjump is called with no argument, an alternative webjump will be auto-generated by trimming the path off of the url. For example:

  •   define_webjump("example","http://www.example.com/search?term=%s");

    If you called the above webjump with no search term, Conkeror will go to http://www.example.com/. The alternative may instead be given explicitly using the $alternative keyword to define_webjump.

  • function - The spec may also be a function that takes the webjump argument as its parameter and returns the url to go to. A function of no arguments may also be given, in which case the webjump does not take an argument. If the handler is a function of one argument, the presence of $alternative determines whether the argument is required. If $alternative is given, the argument is optional; if not, the argument is required.

• $doc - A documentation string.

• $alternative - String URL to go to when no webjump argument was given.

• $completer - A completer for the webjump argument.

• $require_match - Whether an exact match is required when using a completer.

• $post_data - Described below.

Post Webjumps

Webjumps that emulate filling in an html form can also be defined by providing the parameters in a $post_data array. For example, a language translation webjump could be defined as follows:

define_webjump("e2j", "http://www.freedict.com/onldict/onldict.php",
  $post_data = [['search', '%s'], ['exact', 'true'], ['selected', '10'],
                ['from', 'English'], ['to', 'Japanese'],
                ['fname', 'eng2jap1'], ['back', 'jap.html']],
               $alternative = "http://www.freedict.com/onldict/jap.html");

Index Webjumps

Webjumps that construct an index from links in a web page and then provide access to those links with completion can be defined using index webjumps.

OpenSearch Webjumps

See OpenSearch. For versions of Conkeror older than November 2010, see SearchEngine.

Managing Webjumps

All webjumps are in Conkeror's memory in a simple object called webjumps. This object can be manipulated for such things as deleting webjumps or creating aliases.

Deleting Webjumps

delete webjumps.google;

Making a Webjump Alias

webjumps.g = webjumps.google;

Selection search webjumps

See this contributed tip.