summaryrefslogtreecommitdiff
path: root/addons/wiki/static/src/lib/wiky/Readme.md
diff options
context:
space:
mode:
authorXavier Morel <xmo@openerp.com>2012-01-17 12:22:46 +0100
committerXavier Morel <xmo@openerp.com>2012-01-17 12:22:46 +0100
commit24ef362e7f3c05decf176a9e2ff94440fe749e6a (patch)
treefc95d226aecf760fdf51946b6f38763d25b27788 /addons/wiki/static/src/lib/wiky/Readme.md
parentecfcf9c409b64b2b8bd026c92e329d608a017c92 (diff)
[ADD] extremely basic wikitext support for web client, in page view
* Headers work (kinda) * Lists work * Text decoration (bold, italics) work * Indentation works BUT Internal links, OpenERP actions, images, attachments and tables don't work lp bug: https://launchpad.net/bugs/910527 fixed bzr revid: xmo@openerp.com-20120117112246-mrpjld9382ibupr6
Diffstat (limited to 'addons/wiki/static/src/lib/wiky/Readme.md')
-rwxr-xr-xaddons/wiki/static/src/lib/wiky/Readme.md41
1 files changed, 41 insertions, 0 deletions
diff --git a/addons/wiki/static/src/lib/wiky/Readme.md b/addons/wiki/static/src/lib/wiky/Readme.md
new file mode 100755
index 00000000000..5d9bfe175a6
--- /dev/null
+++ b/addons/wiki/static/src/lib/wiky/Readme.md
@@ -0,0 +1,41 @@
+Wiky.js - a javascript library to convert Wiki Markup language to HTML.
+=======================
+
+(It is buggy, please use with care)
+
+Wiky.js is a javascript library that converts Wiki Markup language to HTML.
+
+
+How to use it
+-------------------
+Include wiki.js into your HTML file. Wiky.js has only one function, which is wiky.process(wikitext).
+
+Please see index.html for an example.
+
+*wiky.js does not depend on jQuery, which is included for testing purpose.
+
+
+
+Supported Syntax
+-------------------
+* == Heading ==
+* === Subheading ===
+* [http://www.url.com Name of URLs]
+* [[File:http://www.url.com/image.png Alternative Text]]
+* -------------------- (Horizontal line)
+* : (Indentation)
+* # Ordered bullet point
+* * Unordered bullet point
+
+
+
+License
+------------------
+Creative Commons 3.0
+
+
+
+Contributors
+-------------------
+Tanin Na Nakorn
+Tanun Niyomjit (Designer) \ No newline at end of file