== Creole {{images\viki.png|Creole}}\\ Creole is a common wiki markup language intended to be used across many different wikis. Its aim is not to replace existing markup, but instead to enable wiki users to transfer basic content seamlessly across wikis, and lower the barrier to entry for novice users. == Regular Language "Recursive Descent Parser" This text has been formatted using a //regular language "recursive descent// (RLRD) parser" design. That is, rules are applied in a recursive descent that matches the ultimate XML output; at each level of the descent, a set of regular expressions define the text that each child rule can "consume". Rules are applied greedily (i.e. earliest-match first). Unlike standard markup designs, this makes edge-cases between rules explicit, and allows a parser to be certified XHTML-compliant. The parser is written in Javascript, allowing greater flexibility in the deployment of the parser. The underlying RLRD design can be implemented in any language. == Live Preview This document demonstrates a live Javascript preview, using this RLRD renderer. Editing the above text area will change this text. The markup follows the basic rules of [[http://www.wikicreole.org/wiki/Creole0.4|Creole v0.4]]. == Use in CHM Implementation Notes test markup htmlized to compare to eudoc extended creole 1.0 rendering to fix in the javascript parser are, eucode, toc, everything macro & pluigin comments, tilde escaping and triple braces, super sub del underline, link text options. note, this javascript parser is for creole .4 haven't looked for a newer version so some of this may already be a solved problem. what does already work is tables w/o the link text options in eu creole parser. bold, emphasis , headers (more whitespace sensitive), images, plain http is rendered as a link, bullet and numbered lists, hr, force linebreak. think the headers need trailing ==? still need breakdown of what works from inside the chm on various OS and readers. on win98 seems tables do not work while ouside chm in firefox2 they do work have to deal with the the javascript compatibility problem first. the css to group the buttons works in ffox2, IE6 but not the CHM wonder what common keystroke commands work or don't in the chm vrs browsers can I add a custom rclick menu that will work inside and outside the chm? === Creole markup ==== Text Formatting Rules !!could include page {CreoleHelp} lifted from an early euwiki Creole help page, You can freely intermix Creole markup to format page output. ====Paragraphs are created by simply typing the text. To separate paragraphs, just leave an empty line between them. Line ends will **NOT** be preserved inside paragraphs. You can also use "{{{\\}}}" to force a line break most everywhere. ====Emphasis can be marked {{{//like this//}}} or {{{**like this**}}}, to produce //italic text// or **bold text**. ====Link to a {{{[[wikipage]]}}} will render as [[wikipage]]. You can also use {{{[[wikipage|different text]]}}} that will show [[wiki page|different text]]. Web page addresses, like {{{[[http://wikicreole.org|WikiCreole]]}}} can be also used and will display as [[http://wikicreole.org|WikiCreole]]. Normal Link: http://wikicreole.org/ - now same link, but escaped: ~http://wikicreole.org/ ====Images are included with {{{{{images/viki.png|WikiCreole Logo}} }}}, the text is displayed when the image cannot be shown. You can put images inside links:\\ {{{[[http://wikicreole.org|{{images/viki.png|WikiCreole Logo}}]]}}}. ==== escape next char ~~ ~** no bold ~** ~~ tilde, will remove the formatting power of the next char. for ex: so you don't inadvertently create a list with leading *. ====No markup is in effect if you type text {{{{{{like this~}}}}}}, or ”when you need several lines” like this: {{{ {{{ line 1 line 2 line 3 ~}}} }}} ====Headings are created like this: {{{ == Section heading === Subsection heading ==== Subsubsection heading }}} trailing ='s not required in eudoc but may be in euforum or euwiki, not sure ====Bullet lists are created like this: {{{ * first item * second item ** first subitem of second item * third item }}} * first item * second item ** first subitem of second item * third item !!could be nice to select the type of bullet ====Numbered lists are made like this:\\ {{{ # first item # second item ## first subitem of second item # third item }}} # [[item 1]] # item 2 ## item 2.1 ### item 2.1.1 ## item 2.2 # // italic item 3 // ## // item 3.1 // ### // item 3.1.1 // ## // item 3.2 // FIXME: sub items are numbered wrong? maybe it's the html?\\ notice: leading space is not significant. ====Tables can be made easily: {{{ | first row first column | first row second column | | second row first column | second row second column | }}} | first row first column | first row second column | | second row first column | second row second column | ====Horizontal line like this one ---- can be used to separate parts of text, you just need to type: {{{ ---- }}} ====subscript super Examples of ,,subscript,, ^^super^^ --deleted-- ++inserted++ script. {{{ Examples of ,,subscript,, ^^super^^ --deleted-- ++inserted++ script. }}} ====comment {{{ !! This is a comment because it begins with two '!' }}} it will not be displayed or included in output in eudoc.\\ it may be rendered as an html comment in euwiki and will be retained in the source page/post in euwiki and euforum. a triple ~!!! might be used for comments or code intended for output html/text this could be used to embed script or comment. {feature request} ====Force Linebreak To force a line break: {{{Force\\Linebreak ->}}} Force\\Linebreak adding blank lines works too. blank lines required to end bullet lists ====Fixed width font Fixed width font is {{{##text##}}} ##Fixed width font## ====eucode tag Example of the <##eucode##>...</##eucode##> tags\\ notice these have to be on a separate lines. eudoc colorizes and depending on the css used will offset the code/text but does not format or indent the code and can only colorize euphoria as yet. <##eucode##> <eucode> global function find_all(object x, sequence source, integer from) sequence ret ret = {} while from > 0 with entry do ret &= from from += 1 entry from = find_from(x, source, from) end while return ret end function </eucode> </##eucode##> ==== Creole links and cheat sheet !!this is working in the rendered docs, but how to adjust height & width? !!not sure I can just copy this image for official docs either !!should these comment be in the generated docs? maybe !!! gen comment !! {{{<!-- include comment in generated doc is not working -->}}} {{images/wikicreoleCheatSheet.png|wikicreoleCheatSheet}} the basic markup is Creole, look it up here. [[http://wikicreole.org|WikiCreole]]