mdform 0.2

Parse Markdown form and generate useful templates and data.

mdform

An extension for python-markdown to generate parse a form in Markdown based document.

This document:

Please fill this form:

name* = ___
email = @

And also this important question:

Do you like this = () YES () NO

will generate the following jinja template:

Please fill this form:

{{ form.name }}
{{ form.email }}

And also this important question:

{{ form.do_you_like_this }}

and this dict:

that you can consume to generate a form.

Installation

pip install mdform

Usage

Syntax

The syntax is strongly based on this wmd fork.

Text fields

name = ___

or:

name = ___[50]

Exactly 3 underscores will be matched. Any more will be handled as standard underline directives.

Text area

name = |||

or:

name = |||[50]

Exactly 3 slashes will be matched.

Radio buttons

sex = (x) male () female

The option with an x will be the default.

Check boxes

phones = [] Android [x] iPhone [x] Blackberry

The option with an x will be the default.

Drop down

city = {BOS, SFO, (NYC)}

Or with user-friendly labels:

city = {BOS -> Boston, SFO -> San Francisco, (NYC -> New York City)}

city = {BOS, SFO, (NYC -> New York City)}

The option in parenthesis will be the default.

File Field

name = ...

or:

name = ...[png]

name = ...[png,jpg]

name = ...[png,jpg;Only image files]

Required fields

To flag a field as required, just add an asterisk after the name.

zip code* = ___

Sections

In certain cases is useful to create a named section.

[section:university]

name = ___

[section:school]

name = ___

will render as:

{{ form.university_name }} {{ form.school_name }}

and:

{'university_name': {'type': 'StringField',
                     'required': True,
                     'length': None
                     },
 'school_name': {'type': 'StringField',
                 'required': True,
                 'length': None
                 }
}

Collapsable parts

In certain cases is useful to create a part of the form which collapses based on the value of a dropdown box. Just use the modifier [c] for the dropdown item that will collapse the part of the html and enclose the collapsable part as shown:

extra = {Yes, (No[c])}

[collapse:extra]

name = ___

[endcollapse]

The extra in the collapse tag indicates which dropdown box is used as control.

See AUTHORS for a list of the maintainers.

To review an ordered list of notable changes for each version of a project, see CHANGES