Argot 0.5

syntax

The general syntax is ‘{{{’ followed by an optional shebang and desired pygments parser, followed by your code block, and bookended with ‘}}}’:

{{{#!parser
    ... code ...
}}}

By default, if no parser is provided, argot uses pygments to try and guess what language is being used. It falls back to the plain text lexer. If you want to force the text lexer, use a lexer of text.

syntax

The syntax for blockquote blocks is similar to that of the code blocks, except that parens are used instead of braces:

((("citation url"
quoted text
)))

The quoted text is converted to HTML via regular markdown syntax rules. Nesting blockquote blocks is not supported. The optional citation url can be surrounded in single quotes (') or double quotes (").

syntax

Link processors are made up of the processor tag, followed by a colon, followed by a query for that processor. For example:

[Quick reStructured Text](google: restructured text quick ref)

This calls the link processor google with the query restructured text quick ref. By default, only the link processor google is enabled. There is an amazon link processor that can be enabled, but it is suggested that for stable queries you append ‘amazon’ to google queries.

setting a google referer

Google’s ajax search API (which the link processor uses) requires that you set a referer url. If you set a google referer, Argot will fetch the first link and use that url directly:

from argot import set_google_referer
set_google_referer('http://example.com')

By default, the google link processor will return a url to an “I’m feeling lucky” google search page, which will then forward to the first search result. It’s highly recommended that you cache the results of your argot rendering as searching google for each url every time a page is loaded will be extremely slow.

writing new link processors

Link processors are functions that take a single argument, the query as a string, and return another string:

def wiki_processor(query):
    return google_processor('wikipedia %s' % query)
argot.enable_link_processor(wiki_processor)

This hypothetical wiki processor merely does a google search for ‘wikipedia’ and the query provided. The tag for the processor can be provided in 3 ways:

• the name of the function before the first underscore

• a tag attribute on the function

• an optional second argument to enable_link_processor