Turn widgets into sub module

[Ichmed]

Remove widgets from rulebook and turn it into its own submodule and host on github

related to #11

• improve api
• register widgets with format strings
• customize what widget strings look like. default $(...)
• add sanitization to prevent XSS, injections etc
• make into proper django app (https://docs.djangoproject.com/en/3.1/ref/applications/)
• enable/disable cache and provide non cython alternative to cache
• Add (default) debugging messages so exceptions do not bubble up to users but user can still fix formatting errors

Format Strings

name type? (parametername:type?:error?)*

name

unique widget name (Exception for duplicates)

type

sets default parameters and handles display if widget construction is disabled. defaults to display

• display adds display:text parameter
  • if construction is disabled (display)
• search adds table:model, query:query and display:text
  • if construction is disabled (display) or query
  • default formatting if NO search results have been found
• plain noadditional parameters
  • if construction is disabled is fully hidden

parameters

name

The name of the parameter

type

Used for sanitation and default error handling, new types can be registered. defaults to text

• text accepts any text, escapes html tags
• list accepts any text separated by commas
• number accepts any number
• int accepts any Integer
• uint accepts any natural number
• model accepts any name or alias of a registered model
• widget accepts a widget string (may or may not include initial symbol and/or brackets)
  • $(link target) == (link target) == link target
• queryaccepts any query that matches your set query string
  • if the parameter before this is a model the query parameters are restricted to those of that model

any type can be appended with a list of valid choices e.g int[0,1,2] or regexes e.g {"[abc\d]"}

error

A regex used to format a custom error message, otherwise default will be used

examples

list search Create a list of matching results formatted as links

table search exclude:list include:list Create a table containing fields from the model excluding any/limiting to the given lists

Calling widgets

$(name "parameter") $(name parametername="value")