Help:Editing

This page explains how to change a page and how to write the Markdown this wiki uses. For the habits of this wiki (which code languages, notes, keys), see Help:Editing/Tips.

The editor

edit

Click Edit at the top of a page, or edit next to a heading to change only that section. You need to be logged in.

  • The editor shows the page roughly as it will look. Edit Markdown source switches to the plain text, and back.
  • Insert image uploads a picture from your computer and puts it at the cursor.
  • Preview shows the page as it will be published, before you save.
  • Summary is a short note on what you changed. It shows in the history and the recent changes.
  • Save publishes the change. The page is updated within a few seconds.
  • Without JavaScript, the Edit link opens a plain text form with the same Preview and Save buttons.

If someone else saved the page while you were editing, you get an edit conflict. The wiki merges both changes when they touch different lines. Where you both changed the same lines, you choose which text to keep.

Raw HTML is not allowed: anything that looks like an HTML tag is shown as text. Everything is written with Markdown and the extensions below.

Text

edit
You write You get
*italic* or _italic_ italic
**bold** bold
~~struck out~~ struck out
`code` code
:sup[2] and :sub[2] x2 and H2O
:kbd[Ctrl+F9] Ctrl+F9
A backslash before a character: \* *

An empty line starts a new paragraph. A backslash at the end of a line starts a new line inside the paragraph.

Headings

edit
## Section
### Subsection
#### Smaller still

The page title is the first-level heading, so sections start at ##. A page with four or more headings gets a table of contents. Each heading can be linked: [[Some page#Section]].

Lists

edit
- An item
- Another item
  - Indented by two spaces: a nested item

1. First
2. Second

- [ ] A task still to do
- [x] A task done

Term
: Its definition
edit
You write Links to
[[Lazarus Tutorial]] the page Lazarus Tutorial
[[Lazarus Tutorial|the tutorial]] the same page, shown as "the tutorial"
[[Lazarus Tutorial#Your first program]] a section of that page
[[Category:Tutorials]] a category page
[[Wikipedia:Free Pascal]] the page of another site, from a fixed list of prefixes
[Free Pascal](https://www.freepascal.org) an external page
<https://www.freepascal.org> an external page, showing the address

A link to a page that does not exist is red. Clicking it creates the page.

The text after | is shown as written, without Markdown. Inside a table cell, write \| instead of |, because | separates the cells.

Pictures and files

edit

Use Insert image in the editor, or write the file name after /_files/:

![Tux, the Linux penguin](/_files/Tux.png)
![Tux, the Linux penguin](/_files/Tux.png "Shown when the mouse is over it")
[The manual as PDF](/_files/Manual.pdf)

Every uploaded file has a page of its own, such as File:Tux.png, with its history and the pages that use it.

For a size, a position or a frame with a caption, use :img:

:img[Tux]{src="/_files/Tux.png" width=70 .floatright}
:img[The IDE after the first start]{src="/_files/Lazarus_IDE.png" width=180 .floatright.thumb}

width and height are in pixels. .floatleft, .floatright and .center place the picture. .thumb draws a frame with the text between the brackets as caption.

A row of pictures with captions is a gallery:

:::gallery[Platforms]
- ![Linux](/_files/Tux.png) Linux
- ![Windows](/_files/Windows.png) Windows
:::

Source code

edit

Put code between two lines of three backticks, and name the language after the first ones:

```pascal
program Hello;
begin
  WriteLn('Hello, world');
end.
```

gives

program Hello;
begin
  WriteLn('Hello, world');
end.

The tips page lists the languages that get colours.

Tables

edit
| Type    | Size | Range           |
|---------|-----:|-----------------|
| Byte    |    1 | 0..255          |
| Integer |    4 | -2^31..2^31-1   |
Type Size Range
Byte 1 0..255
Integer 4 -2^31..2^31-1

A colon in the second line aligns a column: ---: to the right, :---: centred. Each cell holds one line. For cells that span rows or columns, or hold lists or code, use a list table:

:::table[Caption]{.wikitable header=1}
- {tr}
  - Name
  - Value
- {tr}
  - {colspan=2} One cell over both columns
:::

Notes, tips and warnings

edit
:::note
Text worth knowing.
:::

:::warning
This can lose your data.
:::

Text worth knowing.

This can lose your data.

:::tip and :::important work the same way. GitHub's form is understood too:

> [!TIP]
> Press F9 to run.

Quotes and lines

edit
> A quotation, or text set apart.

---

A line of three dashes on its own, with empty lines around it, draws a horizontal line.

Footnotes

edit
Free Pascal runs on many platforms.[^1]

[^1]: See the list on freepascal.org.

The notes are collected at the foot of the page.

Diagrams and formulas

edit

A code block with the language mermaid is drawn as a diagram:

```mermaid
flowchart LR
  A[Edit] --> B{Compiles?}
  B -->|yes| C[Run]
  B -->|no| A
```
yes no Edit Compiles? Run

Formulas are written in LaTeX: :math[\sqrt{2}] in a line, or a code block with the language math for a formula on its own line. They are shown as LaTeX source in code style.

Page settings

edit

A block between two lines of --- at the very start of the page holds settings:

---
categories: [Tutorials, LCL]
title: An optional title shown instead of the page name
toc: false
---
  • categories: the categories of the page.
  • title: the heading shown at the top of the page.
  • toc: false hides the table of contents, true shows it even with fewer than four headings. ::toc on its own line puts the table of contents at that place.

Layout

edit

Raw HTML and inline styles are not allowed, so layout uses a fixed set of classes:

:::div{.floatright.box}
A framed box on the right.
:::

The :span[begin]{.key} keyword, and :span[FPC]{.abbr title="Free Pascal Compiler"}.

The classes are floatleft, floatright, clear, center, right, justify, box, underline, strike, small, big, huge, bold, italic, mono, nowrap, noprint, mark and abbr. The code colours are key, symbol, dir, cmt, int and str. Side by side columns are two floats with a width: :::div{.floatleft.w50}, using w10 up to w100.

Colons

edit

A colon directly followed by a letter can start a directive such as :kbd[...]. In running text, write \: when a colon is followed by a letter: ratio a\:b. Inside code, and inside [[...]] links, colons need no backslash.

Templates

edit

A template is a page with text that other pages include: ::tpl[Name]{param=value} on its own line, or :tpl[Name] inside a sentence. Help:Templates explains how to use and write them.