This is the WikklyText user documentation (version 1.3.0).

Contents

• Formatting
• Unicode and Multibyte Character Sets
• Macros
• Built-in Macros
• User-defined Macros (Local)
• Differences from TiddlyWiki
  
  

Formatting

Bold	Italic	Strikethrough	Underline
Superscript	Subscript	Comments	Inline styling
Links	Images	HTML-markup	NoWiki
Inline code	Block code	Block-Indent	Line-Indent
Lists	Headings	Definitions	Tables

Tables

Use | to separate columns and ! to mark header cells.

For column spans, put > in the skipped columns:

For row spans, put ~ in the skipped rows:

You can add a caption by adding a row like this (note there is no trailing '|'):



Example:



Result:

A Table Caption

aaaaaaaa	bbbbbbbb	ccccccccc
d	e	f
g	h	i

Coloring cells with bgcolor():

Text Justification in Table Cells

Text justification follows TiddlyWiki's rules on leading/trailing spaces:

• Leading spaces: Right justify
• Trailing spaces: Left justify
• Leading and trailing spaces: Center justify
• No spaces:
  • Header cell: Center justify
  • Normal cell: Left justify
• Leading spaces on bgcolor(), if used: No effect on calculation
  
  

Example



Result

aaaaaaaaaaaaaaaaaaa	bbbbbbbbbbbbbbbbb	cccccccccccccccccccc
left header	center header
right header	center header
left text	center text	right text
left text
left text	center text	right text
left text

Unicode and Multibyte character sets

WikklyText fully supports multilingual content using both traditional multibyte character sets as well as Unicode. See multilanguage examples for details.

Macros

Calling a Macro

Markup	<<macroname arg1 arg2 ...>>
Example	<<echos aaa "bbb" 'ccc' """ddd""" '''eee''' <quote>"fff"</quote>>>
Result	aaa bbb ccc ddd eee "fff"

Writing Macros

See coremacros.py in the WikklyText distribution for complete examples of macros.

You can also define macros inside your wikitexts like this:



Inside a macro, the following globals are always available:

Element, SubElement	From ElementTree
Text	Convenience to make a <Text> node. Usage: Text("some text")
WikError	If you need to raise an Exception, use this type.
FS_CWD	The (physical) location of your wikitext. If you need to open a file relative to your wikitext location, do: open(os.path.join(FS_CWD,filename), ...)

When writing inline code, <?py and ?> must be the first and last things on a line (although the code can span multiple lines).

Differences between TiddlyWiki & WikklyText

There are probably more differences than I've listed here, these are just the ones I've noted to date. Most are due to personal preference in situations where I don't like something TiddlyWiki does. See the footnotes for details, if you are interested.

Item	TiddlyWiki	WikklyText
Allows leading spaces in listitems * # ; :	NO	YES1
Allows leading spaces in separators ----	NO	YES1
Allows leading spaces in bgcolor()	NO	YES2
Allow extra spaces inside @@ .. @@	NO	YES2
Allows full markup in links	NO	YES
Effect of a single linebreak character	Breaks paragraph	Paragraph continues flowing until double linebreak3 Use <<set $REFLOW 0>> to get TiddlyWiki behavior
Maximum header depth	5; extra "!" chars are shown	6; extra "!" chars are hidden4
WikiWords are automatic links	YES	YES5
Anchors within document	NO	YES6
Output Formats	TiddlyWiki All-in-one self-contained wiki	XML, HTML, Drupal plugin, or standalone Wiki Modular library useful in any number of situations, plus a wiki server.
Image float left/right	YES	NO10
In tables: Classes, THEAD, TFOOT	YES	NO10 Use {{class{ to set styles for tables and elements.
Macros
Macro language	Javascript	Python
How macros work ...	Create DOM elements directly in wiki	Return etree.Elements or strings (that are reparsed for wiki content)
Arg quoting	unquoted, ', "	unquoted, ', ", ''', """, <quote> .. </quote>7
Arg: "aaa"bbb'ccc'	Two args (aaa and bbb'ccc')	One arg (aaabbbccc) Auto-concatenation of adjacent strings8
Nested macro calls?	PARTIAL11	YES9
Thread-safe storage for data persistence across macro calls?	NO	YES
Python/C style escapes in argument strings?	NO	YES

Footnotes:

1. I like my wiki source texts to be indented the same as they will render in HTML. Also, many editors (like jEdit) auto-indent by default, and it is harder to delete the indents than leave them in.
2. No particular reason, just to be lenient.
3. This could be argued either way - TiddlyWiki's way is more WYSIWYG, but I prefer to be able to write a long paragraph without having to put it all on one line.
4. 6 levels are supported because that is what HTML defines as the maximum.
5. WikklyText does not create automatic links to undefined CamelCaseWords. I personally find this TiddlyWiki behavior annoying since, more often than not, I have to add a ~ to turn them off.
6. You can create document anchors like this:
   • Create anchor: [[#anchor_name]]
   • Link to anchor: [[Link text|#anchor_name]]
7. I say, the more quoting methods the better, and this was inspired by Python's triple-quoted strings. The extension <quote> ... </quote> comes in handy especially when you are quoting Python code in a macro call that already contains the other quote types.
   NOTE: Unlike Python, Single-vs-Triple strings are not special. They are both allowed to contain embedded newlines, etc.
8. Similar to Python and the C-preprocessor, cramming strings together works.
9. The only time they cause a problem is if a macro returns text containing << that is then parsed as another macro call.
10. Will likely be added to WikklyText at some point.
11. As I understand it, TiddlyWiki somewhat supports nested macros with an extended call syntax, but WikklyText supports nesting like this:
    <<one <<two <<three>> >> >>
    ... where <<two gets the returned value from <<three>> as an input arg.
    
    

Built-in Macros

• closeAll
• codebox
• debug (Full Mode only)
• echo
• echos
• get
• help
• if_full_mode
• if_safe_mode
• include (Full Mode only)
• include_code (Full Mode only)
• include_pyfunc (Full Mode only)
• include_pymod (Full Mode only)
• indent
• info
• infobox
• note
• py_add_path (Full Mode only)
• set
• version
• warn
• warnbox

closeAll

codebox

debug (Full Mode only)

echo

echos

get

help

if_full_mode

if_safe_mode

include (Full Mode only)

include_code (Full Mode only)

include_pyfunc (Full Mode only)

include_pymod (Full Mode only)

indent

info

infobox

note

py_add_path (Full Mode only)

set

version

warn

warnbox