Differences between revisions 6 and 7

HelpOnBasicFormatting

Contents

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 Hide the details 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 Hide the details 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 Hide the details 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 Hide the details 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 Hide the details 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:

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

Bulleted Lists

Show Hide the details 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 Hide the details 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 Hide the details the details

This:

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

leads to what you are looking at!

Links

Page names or CamelCasing or internal links

Show Hide the details 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

Alternatively with an optional link text:

[[Page name | link to some page]]

leads to this: link to some page

Prevent CamelCase links

Show Hide the details the details

External links

Show Hide the details the details

This:

  http://sandbox.aplwiki.com

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

Alternatively you can use an optional link text:

  [[http://sandbox.aplwiki.com | Link to the APL wiki sandbaox]]

results in this: Link to the APL wiki sandbaox

Links within a page

Show Hide the details the details

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.

Alternatively you can use an optional link text. This:

  [[ MyPage#My address | Link to my address]]

results in Link to my address.

Links to attachments

See Attachments

Links to images

Show Hide the details the details

Before you start linking to an image first upload it as an attachment; click the "Attachments" button and act accordingly.

Once the image is uploaded it is, among other things, available for link purposes. Since it is always associated with a certain page you can refer to it by its simple filename. For example, a link to the file "APL-Logo.png" which is attached to this page can be created with:

  [[attachment:APL-Logo.png]]

which leads to APL-Logo.png.

Alternatively with an optional link text as in:

  [[attachment:APL-Logo.png | download the APL logo ]]

which leads to link to the attachment

For how to display an image within a page (rather than linking to it) see Images.

Images

Show Hide the details the details

First upload the image(s) as an attachment; click the "Attachments" button and act accordingly.

Once the image is uploaded and attached to a page it can be used, either in order to display it within the page or for download (= linking, see there). Since it is always associated with a certain page you can refer to it by its simple filename. Since linking to an image is discussed in the #Links to images chapter here we attempt to actually display the image.

  {{attachment:APL-Logo.png || height=40,width=40}}

which leads to

Note that images can be aligned:

Finally it should be mentioned that sometimes tables are useful to arrange images:

}}}}

Attachments

Show Hide the details the details

Before you start linking to an attachment (for download purposes, for example) first upload the attachment; click the "Attachments" button and act accordingly.

Once the attachment is uploaded it is available for link purposes. Since it is always associated with a certain page you can refer to it by its simple filename. For example, a link to the file "sample.txt" which is attached to this page can be created with:

  [[attachment:sample.txt]]

which leads to sample.txt.

Alternatively with an optional link text as in:

  [[attachment:sample.txt | link to the attachment]]

which leads to link to the attachment

Show Hide the details the details

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

    <<TableOfContents>>

-  ⇤ ← Revision 6 as of 2014-05-31 16:19:06 → 
  Size: 8067
  Editor: KaiJaeger
  Comment:
+   ← Revision 7 as of 2014-05-31 16:53:43 → ⇥
  Size: 10161
  Editor: KaiJaeger
  Comment:
-Deletions are marked like this.
+Additions are marked like this.
 Line 97:
-{{{{#!wiki seesaw/nos/nos/hide
+{{{{#!wiki seesaw/nos/nos-bg/hide
 Line 124:
-{{{{#!wiki seesaw/bullets/bullets/hide
+{{{{#!wiki seesaw/bullets/bullets-bg/hide
 Line 147:
-{{{{#!wiki seesaw/table/table/hide
+{{{{#!wiki seesaw/table/table-bg/hide
 Line 175:
-{{{{#!wiki seesaw/code/code/hide
+{{{{#!wiki seesaw/code/code-bg/hide
 Line 192:
-{{{{#!wiki seesaw/CamelCase/CamelCase/hide
+{{{{#!wiki seesaw/CamelCase/CamelCase-bg/hide
 Line 204:
+Alternatively with an optional link text:
{{{
[[Page name | link to some page]]
}}}

leads to this: [[Page name | link to some page]]

=== Prevent CamelCase links ===

<<SeeSaw(section="Prevent", toshow="<<Show>> the details", tohide="<<Hide>> the details", bg="#FEE1A5", speed="Slow")>>
{{{{#!wiki seesaw/Prevent/Prevent-bg/hide
-Line 219:
+Line 231:
-{{{{#!wiki seesaw/ExLinks/ExLinks/hide
+{{{{#!wiki seesaw/ExLinks/ExLinks-bg/hide
-Line 228:
+Line 240:
+Alternatively you can use an optional link text:

{{{
  [[http://sandbox.aplwiki.com | Link to the APL wiki sandbaox]]
}}}

results in this:   [[http://sandbox.aplwiki.com | Link to the APL wiki sandbaox]]
-Line 233:
+Line 253:
-{{{{#!wiki seesaw/subLinks/subLinks/hide
+{{{{#!wiki seesaw/subLinks/subLinks-bg/hide
-Line 243:
+Line 263:
-}}}}

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

}}}}
+Alternatively you can use an optional link text. This:

{{{
  [[ MyPage#My address | Link to my address]]
}}}

results in   [[ MyPage#My address | Link to my address]].

}}}}

=== Links to attachments ===

See [[ HelpOnBasicFormatting#Attachments | Attachments ]]


=== Links to images ===

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

Before you start linking to an image first upload it as an attachment; click the "Attachments" button and act accordingly.

Once the image is uploaded it is, among other things, available for link purposes. Since it is always associated with a certain page you can refer to it by its simple filename. For example, a link to the file "APL-Logo.png" which is attached to this page can be created with:

{{{
  [[attachment:APL-Logo.png]]
}}}

which leads to [[attachment:APL-Logo.png]].

Alternatively with an optional link text as in:
{{{
  [[attachment:APL-Logo.png | download the APL logo ]]
}}}

which leads to [[attachment:sample.txt | link to the attachment]]

}}}}

For how to display an image within a page (rather than linking to it) see [[#Images | Images]].
-Line 279:
+Line 306:
+<<SeeSaw(section="images", toshow="<<Show>> the details", tohide="<<Hide>> the details", bg="#FEE1A5", speed="Slow")>>
{{{{#!wiki seesaw/images/images-bg/hide

First upload the image(s) as an attachment; click the "Attachments" button and act accordingly.

Once the image is uploaded and attached to a page it can be used, either in order to display it within the page or for download (= linking, [[#links to images|see there]]). Since it is always associated with a certain page you can refer to it by its simple filename. Since linking to an image is discussed in the [[#Links to images]] chapter here we attempt to actually display the image.

{{{
  {{attachment:APL-Logo.png || height=40,width=40}}
}}}

which leads to {{attachment:APL-Logo.png || height=40,width=40}}

Note that images can be aligned:

  {{attachment:APL-Logo.png || align="right",height=40,width=40}}

}}}}

Finally it should be mentioned that sometimes tables are useful to arrange images:

|| {{attachment:APL-Logo.png || height=40,width=40}} || {{attachment:APL-Logo.png || height=40,width=40}} || {{attachment:APL-Logo.png || height=40,width=40}} ||
|| {{attachment:APL-Logo.png || height=40,width=40}} || {{attachment:APL-Logo.png || height=40,width=40}} || {{attachment:APL-Logo.png || height=40,width=40}} ||

}}}}
-Line 280:
+Line 332:
+<<SeeSaw(section="attach", toshow="<<Show>> the details", tohide="<<Hide>> the details", bg="#FEE1A5", speed="Slow")>>
{{{{#!wiki seesaw/attach/attach-bg/hide

Before you start linking to an attachment (for download purposes, for example) first upload the attachment; click the "Attachments" button and act accordingly.

Once the attachment is uploaded it is available for link purposes. Since it is always associated with a certain page you can refer to it by its simple filename. For example, a link to the file "sample.txt" which is attached to this page can be created with:

{{{
  [[attachment:sample.txt]]
}}}

which leads to [[attachment:sample.txt]].

Alternatively with an optional link text as in:
{{{
  [[attachment:sample.txt | link to the attachment]]
}}}

which leads to [[attachment:sample.txt | link to the attachment]]

}}}}
-Line 284:
+Line 357:
-{{{{#!wiki seesaw/toc/toc/hide
+{{{{#!wiki seesaw/toc/toc-bg/hide

HelpOnBasicFormatting

Basics

White space

Line breaks

Indentation

Titles

Numbered Lists

Bulleted Lists

Tables

APL Code

Links

Page names or CamelCasing or internal links

Prevent CamelCase links

External links

Links within a page

Links to attachments

Links to images

Images

Attachments

Table of contents