Minki Syntax

Basic Syntax


Use the following markup to add pieces of flair to any pages you may create or edit.

Table of Contents

Headers

h1.secName will make a header ( 1 - 7 ) with an ID of secName
you can then link to that section as ^secName:Label^.
h1.secName:blue:white: will make a header with blue text and white background.

H1 example

colored h2 example


Table of Contents

Horizontal Rules

---secName will create a horizontal rule with an ID of secName
you can then link to that section as ^secName:Label^

Table of Contents

Bold Text

*text* will produce bold text
example text

Table of Contents

Underlined Text

_text_ will produce underlined text
example text

Table of Contents

Italic Text

/text/ will produce italic text
example text

Table of Contents

Strikethrough Text

-text- will produce strike-through (deleted) text
example text

Table of Contents

Automatic URL Linking

http://url.com/fileName will automatically link
http://url.com/fileName will automatically link

Table of Contents

Named Links

"Link Name":LinkUrl will create a link
Link Name

Table of Contents

MinkiPage Linking

{ Name } will make a link to a wikipage
{ Name:text } will make a link to a wikipage text export
{ Name:html } will make a link to a wikipage html export
{ Name#target } will make a link to a wikipage "name" and go to section "target" (if target is valid)
Name

Table of Contents

Targets and Anchors

^target:label^ will link to header/hr titled "target" in page
{ page#target } will link to "page" and go to "target" within that page
{ page#target:html } will link to "page" exported as HTML and go to "target" within that page

Table of Contents


Tag Links

{,tag name} will link to a tag
For example, the support tag

Table of Contents


Images

!image url!alt-text! will display an image
prawnCirc
!l:image url!alt-text! will display a left aligned image

!r:image url!alt-text! will display a right aligned image

!alt-text is optional but recommended. It will be used in the text export.

Table of Contents

Paragraphs

%:white:blue:text text text% will change the text 
color to white and background color to blue
for all text between : and %.
See a changed text selection

Table of Contents

Change Colors

You can change the text color of an entire paragraph with :color:background:
Colons are all mandatory but either color may be left out.

This is an example of a paragraph color change.

Table of Contents

Quoted Text

: Quoted text will display block-quoted text.
This is an example blockquote.

Table of Contents

Lists

Lists can be created as unordered or ordered -- ordered lists will be preceeded by a counting number.
Unordered list:
* list item
** Nested item
*** Nested item
* list item
** Nested item

Ordered List:
# list item
## Nested item
### Nested item
# list item
## Nested item

Nested lists may mix types, for example
* Unordered item
## Ordered sub-item
## Ordered sub-item
* Unordered item
Example of a mixed list

Table of Contents

Tables

|pipes|as|delimeter|
|will|become|table|
pipesasdelimeter
willbecometable
Tables can also have colored cells
using the color markup.
|:green:white:o|:white:green:o|:green:white:x|
|:white:green:-x-|:green:white:-x-|:white:green:-x-|
|:green:white:o|:white:green:x|:green:white:o|
oox
xxx
oxo
Or you can color the entire table
|:white:red:blue:|
|Foreground|Background|
|And border|are colored!|
ForegroundBackground
And bordersare colored!

Table of Contents

Preformatted Text

 ===
 Preformatted Text
 Will ignore all special markup
 ===

Notice how the *bold* /italic/ and _underlined_
text markup has been ignored.

 ===:white:blue:
 Preformatted text may also be colored
 It is foreground/background
 ===
 Preformatted text may also be colored
 It is foreground/background

Table of Contents

Preformatted+

 ===+
 Preformatted+ Text
 will -not- ignore special markup
 ===
 Notice how the bold italic and underlined
 text markup has not been ignored.
 ===+:white:blue:
 Preformatted+ text may also be colored
 It is foreground/background
 ===
 Preformatted+ text may also be colored
 It is foreground/background

Table of Contents

MinkiSearch

Minki has a feature that allows you to turn any page into a quick access hub for all your favorite search engines. This allows you to access your favorite search engines from any web browser without having to visit the search pages manually. All you have to do is type the keyword for the engine you want followed by your search query and Minki will do the rest.

For example, in the search box below, type g minki to google search for Minki.

Info

Click the "Info" link to go directly to the source page for that search -- it will show you the search engine keywords that have been defined for that page as well as provide more information on how to use the search functionality within Minki.

To create a new page that lists your favorite searches, all you have to do is create a new page as you normally would -- place #search as the first line of the page and after that define your search engines as keyword search_query_url. Use %s to indicate where the query should be inserted in the URL. For example g http://google.com/?q=%s

Sample search source file:
#search
g http://www.google.com/search?q=%s&sourceid=minki
r http://groups.google.com/groups?q=%s&sourceid=minki
n http://news.google.com/news?q=%s&sourceid=minki
d http://m-w.com/dictionary/%s
c http://clusty.com/search?query=%s

There are several ways to take advantage of the search.


Table of Contents

Custom Syntax


Minki allows you to easily configure your own custom syntax as well. While more complicated, multi-line syntax cannot be handled this way, simple text markup can be defined with relative ease. By default, usersyntax is used as the source for custom user syntax. The page used can be changed via the 'usersyntax' option in your options page.

A syntax file should consist of one syntax definition per line. Each line should consist first of the syntax definition followed by an equal sign (=) then the replacement definition and finally another space and the text export replacement. Should the export replacement be leftout, %1 will be assumed. %# should be used in both to define what text to substitute in the replacement. Replace '#' with incrementing numbers starting with 1. %1, %2, %3 etc. Variables can be re-used in the replacement but should be used only once in the syntax definition.

The sample source file below illustrates how to make a syntax definition to open links in wikipedia. The first item makes the link the very word being replaced while the second syntax item allows you to define the link name independently from the destination using 2 separate variables in the definition.

Sample Syntax Source File:
[[%1]] = <a href="http://en.wikipedia.org/wiki/%1">%1</a> %1
[[%1,%2]] = <a href="http://en.wikipedia.org/wiki/%1">%2</a> %2

When creating custom syntax, take care not to use syntax that may mistakenly be used unintentionally. Too common or loosely defined syntax may produce unexpected results when your markup is parsed.

Table of Contents

Tags: support, minki, syntax, info
Modified 10:21 Sat 21 Apr, 2007 (Page Changes)
Export: html, text