
$ inline("index_menu.wiki.txt");

= Planpad Reference =

== text markup

text-markup is specified in nested square braces ('[' und ']'), and can be used everywhere in text blocks.

* [%[i ..]] italics
* [%[b ..]] bold
* [%[u ..]] underline
* [%[s ..]] strikeout
* [%[+ ..]] font larger
* [%[- ..]] font smaller
* [%[tc #xxxxxx ..]] text color
* [%[bc #xxxxxx ..]] back color
* [%[lc #xxxxxx ..]] line color (tables & stuff)
* [%[hc #xxxxxx ..]] headline color 
* [%[% ..]] code
* [%[fixedfont ..]] use courier new
* [%[propfont ..]] use arial
* [%[symbolfont ..]] use webdings
* [%[img "file.xxx" ..]] image (bmp, png, jpg, pic)
* [%[>> "file.pdf" <..]] link to document
* [%[>: "format c:" ..]] execute shell code
* [%[> "index" ..]] link to *.wiki.txt
 
* [%[I ..]] italics
* [%[B ..]] bold
* [%[U ..]] underline
* [%[S ..]] strikeout
* [%[left ..]] block layout left aligned (only for "!" block markup)
* [%[right ..]] block layout right aligned (only for "!" block markup)
* [%[center ..]] block layout center aligned (only for "!" block markup)
* [%[block ..]] block layout justified aligned (only for "!" block markup)

* [%[~en ..]] enable spell-checking English
* [%[~de ..]] enable spell-checking German
* [%[~ .. ]] disable spell-checking

== Block Markup

Block markup is specified by special symbols at the beginning of a paragraph. 
Blocks can be nested by indentions.

* [% * ..] Bullet (list)
* [% = .. =] Headline, big, with form-feed
* [% == .. ==] Headline
* [% === .. ===] Headline, small
* [% ==== .. ====] Headline, smallest
* [% % ..] Code
* [% &* ..] Task
* [% >> "bla.pdf" ..] Link to document
* [% >: "format c:" ..] execute shell code
* [% > "index" ..] link to "*.wiki.txt
* [% $ ..] script, mostly undocumented
* [% $ inline("menu.wiki.txt");] script: inline this file.
* [% ! ..] apply text markups for all following blocks in this nesting level.
* [% !t ..] Table without border
* [% !T ..] Table with border
* [% !I ..] Table in Table (border inside, not outside)
* [% !i ..] Table item
* [% !| .. | .. | ..] Multiple table items
* [% !title  ..] title for cover page of a book
* [% !img "bla.jpg"] image
* [% !break] page break
* [% !toc] insert table of context
* [% ~ ..] new line
* [% ~~ ..] new line without additional spacing
* [% <<<<<<<] svn conflict
* [% =======] svn conflict
* [% >>>>>>>] svn conflict
* [% +~ add words to spell checking dictionary, all languages.

== Other

=== Comments

All lines starting with '[% #]' are treated as comments.

=== File Names for Wiki Links

* All files will end with '*.wiki.txt', but you need not specify that in the link.
* A '[% !]' in the file name will change the directory permanently. This can be used to link to another planpad wiki.
* You can specify a headline with '[% #]' after the file name. When using the link the page will automatically scroll to that headline.
* You can use block markup or text markup for links

Example:

% [> "c:\temp\testwiki!index#news" bla]

* Change permanently to the directory "c:\temp\testwiki"
* Load file "index.wiki.txt"
* Scroll to headline "news"

=== images

You can specify size and alignment when loading images.

* [% !img 50% "bla.bmp"] # scale
* [% !img 64 "bla.bmp"] # pixel size
* [% !img 0 "bla.bmp"] # fit window

=== Tables

* [% !T 3] # 3 columns, same width
* [% !T 5] # 5 columns, same width
* [% !T 3 min] # 3 columns, as narrow as possible
* [% !T 2 : 3 1] # 2 columns, first one 3 times wider as the second one

=== Spell Checking

To use spell checking, you need a dictionary. create a directory called "spelldict" in 
the same place as the planpad executable. Put the files "dict_en.txt" and "dict_de.txt" 
with English and German words.

To enable spell checking, use the "~en" or "~de" text markup. You can add words to the 
dictionary using the "~+" block markup. 

Here is an example that will work even without the dictionaries:

% # add some words, only for this page

  \~+ hinter wenn fliegen nach

  # display a text with spell checking

  \[~de Wenn fliegen hinter fliegen fliegen fliegen fliegen fliegen nach.]

  # Btw: the above sentence is correct use of german language :-)

  # enable spell checking for the whole document

  \! ~de
  Wenn fliegen hinter fliegen fliegen fliegen fliegen fliegen nach.

== Keyboard Shortcuts

* CTRL-t:  Open new tab.
* CTRL-s:  Save. Planpad will save automatically quite often.
* CTRL-r:  Open referenced or inlined files.
* CTRL-f:  Incremental search.
* CTRL-u:  Edit user dictionary for spell checking.
* F3: Find next.
* SHIFT-F3: Find previous.
* Middle mouse click on link: Open in new tab.

== Config File

% FontSize = 0;
  EditFontSize = 0;
  SplitterPos = 539;
  SizeX = 1027;
  SizeY = 659;

== Command Line Switches

* [% filename] Open this file when starting.
* [% -font n] Override font size in layout window.
* [% -editfont n] Override font size in edit window.
* [% -splitpos n] Set splitter position.
