Differences between revisions 5 and 6
Revision 5 as of 2014-05-31 14:00:00
Size: 4150
Editor: KaiJaeger
Comment:
Revision 6 as of 2014-05-31 16:19:06
Size: 8067
Editor: KaiJaeger
Comment:
Deletions are marked like this. Additions are marked like this.
Line 27: Line 27:
For details how white space at the beginning of a line is processed see [[HelpOnBasicFormatting#Indentation]] For details how white space at the beginning of a line is processed see [[HelpOnBasicFormatting#Indentation | Indentation]]
Line 50: Line 50:
{{{{#!wiki seesaw/indent/lindentbg/hide {{{{#!wiki seesaw/indent/indent-bg/hide
Line 75: Line 75:
{{{{#!wiki seesaw/titles/titles/hide {{{{#!wiki seesaw/titles/titles-bg-/hide
Line 88: Line 88:
 * To the right of the very last "=" char their must not be any other white space.  * To the right of the very last "=" char their must not be any white space.
Line 103: Line 103:
 1.#6 level1-3
  Normally this interrupts and therefore restart the numbering

 1.#3 level1-3
Line 112: Line 115:
 1.#6 level1-3
  Normally this interrupts and therefore restart the numbering

 1.#3 level1-3
Line 133: Line 139:
   * level2-1    * level2-2
Line 161: Line 167:

* The first "=" char must be the first character on a line.
 * To the right of the very last "=" char their must not be any other white space.
 * The first "|" char must be the first character on a line.
 * To the right of the very last "|" char their must not be any white space.
Line 175: Line 180:
    {{⍵/⍨2=+⌿0=⍵∘.|⍵}⍳⍵}
Line 179: Line 185:
}}}}
Line 181: Line 189:
=== Page names or CamelCasing or internal links ===

<<SeeSaw(section="CamelCase", toshow="<<Show>> the details", tohide="<<Hide>> the details", bg="#FEE1A5", speed="Slow")>>
{{{{#!wiki seesaw/CamelCase/CamelCase/hide

Names of pages in a wiki more often than not use !CamelCasing as in the name of this page: !HelpOnBasicFormatting. !CamelCase names are automatically converted into links within the realm of the current wiki.

If a page name contains blanks surround them with `[[` and `]]`. Therefore this:

{{{
[[Page name]]
}}}

leads to this: [[Page name]]

Of course sometimes you don't want certain names to be converted into links. You can achieve that by prefixing the name with a "!" as in

{{{
  !JavaScript
}}}

That leads to !JavaScript

Note that a link to a non-existent page is shown in italic: ThisPageDoesNotExist

}}}}

=== External links ===

<<SeeSaw(section="ExLinks", toshow="<<Show>> the details", tohide="<<Hide>> the details", bg="#FEE1A5", speed="Slow")>>
{{{{#!wiki seesaw/ExLinks/ExLinks/hide

This:
{{{
  http://sandbox.aplwiki.com
}}}

results in this: http://sandbox.aplwiki.com

}}}}

=== Links within a page ===

<<SeeSaw(section="subLinks", toshow="<<Show>> the details", tohide="<<Hide>> the details", bg="#FEE1A5", speed="Slow")>>
{{{{#!wiki seesaw/subLinks/subLinks/hide

You can link to another part of a page, but only to titles. For example, on a page "MyPage" with a level 3 title "My address" you could create a link somewhere on that page with

{{{
  [[ MyPage#My address]]
}}}

which leads to [[ MyPage#My address]].

}}}}

=== Change the link text ===

<<SeeSaw(section="LinkText", toshow="<<Show>> the details", tohide="<<Hide>> the details", bg="#FEE1A5", speed="Slow")>>
{{{{#!wiki seesaw/LinkText/LinkText/hide

Sometimes you want the text presented to the user not to be just a page name or a url but what is called a link text in Moin speak. For example, to make "Link to the APL Wiki's sandbox" appear as a link:

{{{
 [[ http://sandbox.aplwiki.com | Link to the APL Wiki's sandbox ]]
}}}

That leads to this: [[ http://sandbox.aplwiki.com | Link to the APL Wiki's sandbox ]].

}}}}

||internal link to a section ||`[[SomePage#subsection|subsection of Some Page]]` || See [[#Anchors]] section below ||
||internal link with linktext & parameter ||`[[SomePage|some Page|target="_blank"]]` ||see below for parameter configurations ||
||internal link using a graphic as button ||`[[SomePage|{{attachment:imagefile.png}}]]` || ||
||internal link using graphic button, open new window ||`[[SomePage|{{attachment:samplegraphic.png}}|target="_blank"]]` || ||
||link to attachment ||`[[attachment:image.png]]` ||links to attachment image ||
||link to attachment of another page ||`[[attachment:SomePage/image.png]]` ||links to image attached to a different page ||


||external link with linktext ||`[[http://example.net/|example site]]` || ||
||external link with linktext, open new window ||`[[http://example.net/|example site|target="_blank"]]` ||see below for parameter configurations ||
||external link using a graphic as button ||`[[http://example.net/|{{attachment:samplegraphic.png}}]]` || ||
||external link using graphic button, open new window ||`[[http://example.net/|{{attachment:samplegraphic.png}}|target="_blank"]]` || ||
||border of internal link ||{{{WikiName``s}}} ||2 backticks - for when a !WikiName ends in the middle of a word ||
||avoid an internal link ||`!WikiName` ||configurable function ||

}}}}
Line 187: Line 283:
<<SeeSaw(section="toc", toshow="<<Show>> the details", tohide="<<Hide>> the details", bg="#FEE1A5", speed="Slow")>>
{{{{#!wiki seesaw/toc/toc/hide
Line 192: Line 291:

}}}}

HelpOnBasicFormatting

This page contains basic information about MoinMin's formatting capabilities. It covers only a small amount of the formatting features but these are possibly covering about 99% of every-day problems. If you need more detailed information start with HelpOnEditing or HelpOnMoinWikiSyntax.

Basics

White space

Show the details

Note that white space most of the time is ignored. This:

The   only       exception is white space at the beginning of a line.
This is not another line.

leads to this:

The only exception is white space at the beginning of a line. This is not another line.

For details how white space at the beginning of a line is processed see Indentation

Line breaks

Show the details

Insert a line break with the <<BR>>. This:

This goes onto the first line<<BR>>This goes onto the second line.

leads to this:

This goes onto the first line
This goes onto the second line

Indentation

Show the details

This:

no space
 Line 1
 Line 2
   Line 3
 Line 4

leads to this:

no space

  • Line 1 Line 2
    • Line 3
    Line 4

Titles

Show the details

The different levels depend on the number of "=" signs:

= level 1 =
== level 2 ==
=== level 3 ===
==== level 4 ====

Notes:

  • The first "=" char must be the first character on a line.
  • To the right of the very last "=" char their must not be any white space.

A word of advice: try to avoid using level 4 headers, and never use headers of level 5 and 6!

Numbered Lists

Show the details

 1. level1-1
 1. level1-2
   1. level2-1
   1. level2-2

  Normally this interrupts and therefore restart the numbering 

 1.#3 level1-3

leads to this:

  1. level1-1
  2. level1-2
    1. level2-1
    2. level2-1
    • Normally this interrupts and therefore restart the numbering
  3. level1-3

Bulleted Lists

Show the details

 * level1-1
 * level1-2
   * level2-1
   * level2-2
 * level1-3

leads to this:

  • level1-1
  • level1-2
    • level2-1
    • level2-2
  • level1-3

Tables

Show the details

This:

|| '''col1''' || '''col2''' || '''col3''' ||
|| cell A1 || cell B1 || cell C1 ||
|| cell A2 || cell B2 || cell C2 ||
|| cell A2 || cell B2 || cell C2 ||

leads to this:

col1

col2

col3

cell A1

cell B1

cell C1

cell A2

cell B2

cell C2

cell A2

cell B2

cell C2

Notes:

  • The first "|" char must be the first character on a line.
  • To the right of the very last "|" char their must not be any white space.

APL Code

Show the details

This:

    {⍵/⍳⍴,⍵}
    {{⍵/⍨2=+⌿0=⍵∘.|⍵}⍳⍵}

leads to what you are looking at!

Show the details

Names of pages in a wiki more often than not use CamelCasing as in the name of this page: HelpOnBasicFormatting. CamelCase names are automatically converted into links within the realm of the current wiki.

If a page name contains blanks surround them with [[ and ]]. Therefore this:

[[Page name]]

leads to this: Page name

Of course sometimes you don't want certain names to be converted into links. You can achieve that by prefixing the name with a "!" as in

  !JavaScript

That leads to JavaScript

Note that a link to a non-existent page is shown in italic: ThisPageDoesNotExist

Show the details

Show the details

Show the details

Sometimes you want the text presented to the user not to be just a page name or a url but what is called a link text in Moin speak. For example, to make "Link to the APL Wiki's sandbox" appear as a link:

 [[ http://sandbox.aplwiki.com | Link to the APL Wiki's sandbox ]]

That leads to this: Link to the APL Wiki's sandbox.

internal link to a section

[[SomePage#subsection|subsection of Some Page]]

See #Anchors section below

internal link with linktext & parameter

[[SomePage|some Page|target="_blank"]]

see below for parameter configurations

internal link using a graphic as button

[[SomePage|{{attachment:imagefile.png}}]]

internal link using graphic button, open new window

[[SomePage|{{attachment:samplegraphic.png}}|target="_blank"]]

link to attachment

[[attachment:image.png]]

links to attachment image

link to attachment of another page

[[attachment:SomePage/image.png]]

links to image attached to a different page

external link with linktext

[[http://example.net/|example site]]

external link with linktext, open new window

[[http://example.net/|example site|target="_blank"]]

see below for parameter configurations

external link using a graphic as button

[[http://example.net/|{{attachment:samplegraphic.png}}]]

external link using graphic button, open new window

[[http://example.net/|{{attachment:samplegraphic.png}}|target="_blank"]]

border of internal link

WikiName``s

2 backticks - for when a WikiName ends in the middle of a word

avoid an internal link

!WikiName

configurable function

}}}}

Images

Attachments

Table of contents

Show the details

Insert this right after the = title = part of your page:

    <<TableOfContents>>

HelpOnBasicFormatting (last edited 2014-06-01 06:06:10 by KaiJaeger)