User Guide

Editing and creating pages

You can edit an existing page using the at the top right of the page. If the button is missing, you lack the permissions to edit the page. However, you are still able to view the source code using View Source.

To create a page use the Create page button. Next, you have to pick a name for the page you want to create. To help you organize your page structure, buttons provide shortcuts to add the path to recently visited pages and directories. Please note: The name of the page will be sanitized; ?$.#\ and trailing slashes / will be removed. See below on how to create pages in Subdirectories. After submitting the form, the new page is opened in the editor. In case of the page already existing, the existing page will be opened.

You can preview your changes using . Either while editing or from previewing the article your changes can be committed via . This will open a modal where you can enter a commit message. To discard your changes use and return to the view of the page.

Editor Shortcuts

Page history

You can view the history of a page with History. All edits of the page will be listed in order. The date of the commit, the Author and the commit message are displayed.

Comparing revisions: Select the two revisions to compare and hit Compare Revisions. The diff will be displayed.

View revision: You can open every revision using the date YYYY-MM-DD hh:mm link in the history.

Display a single commit: You can view a single commit using the revision link, e.g. 012abc

Revert a commit: You can revert a commit using the link in the history. This will create a revert commit.

Page blame

Using Blame you can display the source of a page having each line annotated with information about the revision that last modified the line and the author of the commit.

View revision: You can open every revision using the date YYYY-MM-DD HH:mm link of the line.

Display a single commit: You can view the state of the page when a specific commit was made using the revision link of the line, e.g. 012abc.

Page rename

You can rename a page using Rename. For renaming, the same rules as for creating pages apply.

Attachments will be moved with the renamed page.

Page delete

A page (with all its attachments) can be deleted with Delete. Please note: This deletion can be reverted. An Otter Wiki never makes the repository forget.

Attachments

Attachments to pages can be created in two ways. First you can access the attachments of the current page using Attachments. Second, while editing a page, you can simply paste an image into the editor. The pasted image will be uploaded and attached to the page you are editing.

Editing attachments

Open the attachment menu via Attachments. In addition to uploading, each attachment can also be opened via the for editing, which allows you to replace, rename or delete the attachment. The history of the attachment is displayed and offers the possibility to revert changes using .

Inline attached images

To inline images in pages use the markdown syntax: ![](/Page/attachment.jpg). On large screens, the editor displays a list of the most recent attachments on the right hand side. There you can use Copy to copy the markdown code to your clipboard and paste it in the editor. On the attachment page, markdown codes can be found by opening a pop-up using next to the filename.jpg.

Thumbnails

Adding ?thumbnail to the URL of an attachment, e.g. ![](/Page/attachment.jpg?thumbnail) you get a scaled down version of the attached image. Per default the image is scaled down to an image with a maximum size of 80x80. You can configure the maximum size by adding a number to the option. E.g. ?thumbnail=400 will scale the image symmetrically to have its longest side not larger than 400 pixels. Thumbnails are never scaled up.

Search

The search covers the content of all pages in the most recent commit. The results are ranked by the number of hits. Matching page names will be prioritized. For each page a brief summary of the matching part will be displayed.

The search is by default not case-sensitive. Case-sensitivity can be enabled with Match case .

For more complex searches you can make use of regular expressions. Enable these with Regular expression. For case-sensitive regex searches enable both Match case and Regular expression.

Page index

An overview about all pages is given by the Page index, you can open it with A-Z from the left sidebar. All listed pages are sorted by page name and grouped by their first letter.

To list the headings of all pages use the toggle on top of the page:

This may make the Page index look convoluted.

Changelog

The Changelog Changelog displays all commits that have been made in the wiki. Each and every change to pages or their attachments are stored as commits.

View revision: You can open each page in the state listed using the links in the File column.

Display a single commit: You can show the state of the page when a specific commit was made by using the revision link in the line, e.g. 012abc.

Revert a commit: You can revert a commit using the link in the history. This will create a revert commit.

Subdirectories

You can create a page in a subdirectory by placing the name of the subdirectory before the page name separated by a slash. For example: Subdirectory/Page. For a better overview, a subdirectory has its own Page index.

Subdirectories can have subdirectories. The limit is given by git and the underlying file system. Given normal, human usage, hitting those limits is highly unlikely.