https://github.com/heardacat/formdown
formdown is a markdown inspired markup language for html forms.
https://github.com/heardacat/formdown
Last synced: 2 months ago
JSON representation
formdown is a markdown inspired markup language for html forms.
- Host: GitHub
- URL: https://github.com/heardacat/formdown
- Owner: HeardACat
- License: mit
- Created: 2014-08-22T09:58:25.000Z (almost 11 years ago)
- Default Branch: master
- Last Pushed: 2014-08-24T23:18:20.000Z (almost 11 years ago)
- Last Synced: 2025-03-26T16:40:36.852Z (2 months ago)
- Language: Python
- Size: 168 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
- License: license.md
Awesome Lists containing this project
README
Readme
======
`formdown` is a markdown inspired markup language for html forms. It is based on the proposed markup on [stackoverflow](http://stackoverflow.com/questions/5759661/wiki-or-markdown-like-syntax-for-simple-forms).
Testing
-------
The tests (incomplete) can be run by typing:
```
nosetests
```
Installation
------------
To install it in your Python installation run:
```python
python setup.py install
```
Format Specification
--------------------
Using the specification as defined below, we can generate the forms.
* `text = _____`
* `gender = (X) Male () Female`
* `checklist = [x] item 1 [] item 2 [] item 3`
* `textbox = [[]]`
* `selection = {item 1, (item 2), item 3}`
* `date:datepicker = ________`
```python
print formdown.parse_form("name=____\ndate:datepicker=_____")
```
Output:
```html
Name
Date
```
Usage with Datepicker
---------------------
To use this with datepicker, simply follow the information contained on the [homepage](http://jqueryui.com/datepicker/). Remember to change the script since `"datepicker"` is not an `id` but a `class` in `formdown`.
i.e.
```js
$(function() {
$( ".datepicker" ).datepicker();
});
```
Copyright and license
---------------------
Code and documentation copyright 2014 Chapman Siu. Code released under [the MIT license](https://github.com/chappers/formdown/blob/master/license.md).