Glossary

A-Z glossary of PageSeeder concepts

Comment format (Markdown)

Comments posted by email or via the user interface are stored in plain text but they will be automatically formatted in the user interface so that they are more readable.

PageSeeder uses a lightweight syntax that is similar to other plain text formatting languages, and is mostly compatible with Markdown. It is designed to be easy read and write.

In some of the examples below, the full stop character is used to represent spaces.

Block formatting

StylePatternDescription
Title
Main title
==========
Title is formatted as heading1 if a paragraph is followed by a line of '=' (applies to previous line only)
Subtitle
A subtitle
----------
Subtitle is formatted as heading2 if  a paragraph is followed by a line of '-' (applies to previous line only)
Heading
# Heading 1
## Heading 2
more text
###### Heading 6
To express a hierarchical collection of headings, prefix single line paragraphs with between one '#' to six '######' characters.
Unordered list
* Red
* Blue
  Aqua
Unordered list items are preceded by a single '*', '-' or '+'. All paragraphs that follow the list item are treated as additional items until the occurrence of a blank line terminates the list. Nested (multi-level) lists are not supported.
Numbered list
1. Red
2. Blue
   Aqua
Ordered list items are initiated by a new paragraph that begins with a digit and a full stop '.' with the digit providing the starting number. All paragraphs that follow are treated as new list items until a blank line terminates the list. Nested (multi-level) lists are not supported.
Preformatted
..function () {
....// do something!
..}
Any line preceded by at least two spaces. Indentation is preserved no further formatting within preformatted text.
Preformatted block
```
function () {
  // do something!
}
```
Any group of lines preceded and followed by a line with ``` is preserved within preformatted text.
Blockquote
> First paragraph
> 
> Second paragraph.
Any line preceded by at least one '>'. No other formatting within quoted content.
Paragraph
Start of paragraph 1
text text text...
end of paragraph 1.

Paragraph 2.
Paragraphs are blocks of text separated by at least one empty line.
Line breaks
Short text.
More text.
Any line of less than 66 characters long inserts a line break inside a paragraph. Multiple empty lines also add line breaks outside paragraphs.

Inline formatting

Inline formatting only apply to paragraphs, headings and lists.

StylePatternDescription
Bold
An **important** note
Any inline text surrounded by double '*' appears in bold
Italic
An *important* note
Any inline text surrounded by single '*' appears in italics
Code
`a+b=c`
Any inline text surrounded by single left quotes '`' is interpreted as code and displayed using a monospace font.
Autolink
At http://example.org!
Any text starting with 'http://' or https://' will automatically turned into link. The link is displayed verbatim but must end with a letter or number.
Explicit link
<mailto:support@example.org>
<http://www.example.org>
To explicitly create a link that may include characters to be escaped or for email addresses. Must start with 'http://', 'https://' or 'mailto:'. The protocol is hidden from text.
Titled link
[PageSeeder](http://pageseeder.com)
To display a link title different from the actual link address.

Created on , last edited on