Instiki
Syntax (changes)

Showing changes from revision #10 to #11: Added | Removed | Changed

Markdown

Instiki sports a variety of markup options, but the main one for use with mathematics (that’s why you’re here, after all) is Markdown.

The Markdown implementation is based on Maruku, a greatly enhanced implementation which augments John Gruber’s orginal Markdown syntax with Michel Fortin’s extensions (tables, footnotes, definition-lists, …). It also sports a very nice metadata syntax for adding attributes (id, class, style, etc.) to the generated XHTML.

Itex

With the (default) Markdown+itex2MML filter, you can enter equations in itex, a LaTeX-like dialect. Inline and display equations are supported, as is automatic equation numbering and other such niceties.

Theorems

Instiki support a range of Theorem-like environments, modeled on amsthm. (Indeed, the LaTeX-export is amsthm-compatible.). See here for details.

Wiki Syntax

Links

Internal Wiki links can be generated by

 [[Name of Page]]

or

 [[Name of Page|Alternate link text]]

You can also link to other Webs on the same Instiki installation, using

 [[Name of Web:Name of Page]]

or

 [[Name of Web:Name of Page|Alternate link text]]

If you so choose, camel-cased words, like “HomePage” and “IKnowBetter”, “FileUploads”, can also generate Wiki links links, (personally, turning, I respectively, prefer into to disable that in theHomePage and File Uploads. Personally, I prefer to disable that feature in the Edit Web page). page. If you do turn it on, you can “escape” camel-cased words, preventing them from being turned into hyperlinks, by prepending a ”\”.

File and Image Links

It’s easy to upload files and pictures to your Wiki. To display an uploaded image, called mypic.jpg, you can use

 [[mypic.jpg:pic]]

or

 [[mypic.jpg|some alt text:pic]]

Similarly, you can link to an uploaded file, myfile.pdf, with

 [[myfile.pdf:file]]

or

 [[myfile.pdf|some link text:file]]

Suppressing Wiki Syntax

<nowiki>...</nowiki>

protects its contents from being interpreted. Thus, you can type

<nowiki>[[Not a link]]</nowiki>

and have it appear as [[Not a link]]. At least in this case, the same effect can be achieved using backslashes for escaping, i.e., by typing \[\[Not a link\]\].

Including Pages

You’ve probably noticed the sidebar on the pages of this Wiki. That’s achieved with via a Wiki-include

[[!include Name of Page]]

XHTML

If, for whatever reason, the extended Markdown syntax, and Wiki syntax, are not rich enough to express what you want, you can always include XHTML in your page. Note that Markdown processing is disabled inside XHTML. Thus

 <div>This is **very** bad.</div>

is rendered as

This is **very** bad.

If you want to mix XHTML and Markdown syntax, include the markdown="1" attribute.

 <div markdown="1">This is **very** good.</div>

is rendered as

This is very good.