User Guide
Editing and creating pages
You can edit an existing page use the on the top right. If the button is missing, you lack the permissions to edit the page. You can still look at the source code, using , though.
To create a page using the ?$.#\
and trailing slashes /
will be removed. See below how to create pages in Subdirectories. After submitting the form the new page is opened in the editor, in case the page already exists, the existing page will be opened.
You can preview your changes using either while editing or from the preview you can save and commit your changes with . 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.
Page history
You can show the history of a page with
. Here are the edits that were made 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
link in the history.Display a single commit: You can show a single commit using the revision link, e.g.
Revert a commit: You can revert a commit using the
link in the history. This will create a revert commit.Page blame
Using
you can display the source of a page, with 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
link of the line.Display a single commit: You can show the state of the page when a specific commit was made revision link in the line, e.g.
.Page rename
You can rename a page using creating pages.
. For renaming the same rules apply as forAttachments will moved with the renamed page.
Page delete
A page (with all it's attachments) can be deleted with
. Please note, that 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
. 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
. In addition to uploading, you can here also open each attachment 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 to copy the markdown code to your clipboard and paste it in the editor. On the attachment page, you find the markdown codes when opening the pop-up using via next to the .
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 maximum size of 80x80. You can configure the maximum size by adding an number to the option, e.g. ?thumbnail=400
will scale the image symmetrically so that the longest side is 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, this can be enabled with
.For more complex searches you can make use of regular expressions. Enable this with
. 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
from the left sidebar. All pages are listed, 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 can make the Page index look convoluted.
Changelog
The 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 revision link in the line, e.g.
.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 has a subdirectory it's own Page index.
Subdirectories can have subdirectories. The limit is given by git and the underlying file system. No limit that would be touched during human use.