User Tools

Site Tools


instikis_take_on_syntax

This is an old revision of the document!


Wiki Syntax

Internal Wiki links can be generated by

 [[Name of Page]]

or

 [[Name of Page|Alternate link text]]

If the page already exists (or if there’s an existing page that redirects for it), then the result is a link to that page. If not, then a ‘new’ page link is created. Click on the question-mark to create the new page.

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 “FileUploads”, can also generate Wiki links, turning, respectively, into HomePage and File Uploads. Personally, I prefer to disable that feature in the Edit Web page. If you do turn it on, you can “escape” camel-cased words, preventing them from being turned into hyperlinks, by prepending a ”\”.

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]]

If you are interested in the HTML5 <audio> and <video> elements, they can be, in similar fashion, created using :audio and :video links.

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]]

Say you have a page named “liquor”. Now, you create a Wiki-link, [[booze]]. If a page by the latter name already exists, then this Wiki-link will point to that. If no such page exists, it would normally create a “wanted page” link. But, perhaps you don’t want that. Perhaps [[booze]] should point to the “liquor” page.

Edit the “liquor” page, and add a

 [[!redirects booze]]

directive to it. Now all [[booze]] links (or [[!include booze]] directives) point to the “liquor” page, instead.

Rules:

  1. A real page always trumps a [[!redirects ...]] directive.
  2. A page can have multiple [[!redirects ...]] directives.
  3. When you change the name of a page, a [[!redirects Old Name]] directive is added to the page, so that existing Wiki-links will continue to function. (Of course, you can remove it, if you wish.)
  4. Instiki automatically does HTTP 301 Redirects for redirected pages, so that (for instance) external links won’t break when you rename a 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

~~~~~~~~~~

This is **very** bad.

~~~~~~~~~~~~~~~~~~~~~~~~ is rendered as

This is **very** bad.

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

~~~~~~~~~~

This is very good.

~~~~~~~~~~~~~~~~~~~~~~~~ is rendered as

This is very good.
instikis_take_on_syntax.1674636552.txt.gz · Last modified: 2023/01/25 09:49 by boris