User Tools

Site Tools


using_the_wiki

Using The Wiki

This is a collection of style basics and best practices for editing the Encyclopaedia Robotica, it is imperative that any edits adhere to the general principles set forth in the section.

Structure

The Encyclopaedia has five main categories:


The maintenance of these main categories generally lies in the domain of their respective sub teams(with the obvious exclusion of Temporary) and the specifics of structure for each main category can be found on the main category's home page.

Adding Pages

The best way to add pages is to edit the sidebar and to create an Internal Link which you can then follow to create the page.

Best Structure Practice

It takes very little time to put a page in its proper place, please try to avoid using Temporary as much as possible.

It is also advisable not to have duplicate pages in different categories, as we'd like to make all information on the wiki as easily accessible as possible.

Editing Pages

For a more comprehensive editing guide, see The Dokuwiki Official Editing Guide The most important piece of text formatting that you'll have to know for this wiki is header syntax, headers can make longer pages a lot easier to parse.

We can make headers of different sizes, like these:

Headline Level 3

Headline Level 4

Headline Level 5

with different numbers of continuous = before and after the heading text.

==== Headline Level 3 ====
=== Headline Level 4 ===
== Headline Level 5 ==
Internal links are created by using square brackets. You can either just give
a [[pagename]] or use an additional ''|'' to give the link different text [[pagename|link text]].

You can use namespaces(directories) by using a colon in the pagename, like this:

we can use [[mech:drivetrain]] to go to the drivetrain page, or we can go to the 2021 climber page with [[mech:climbers:mech_climbers_2021_climbing_mechanism]].

This is also how we create pages, if we link to a page that doesn't exist yet and then click on that link, we'll be sent to a page that allows us to create this new page.

[[mech:page_that_does_not_exist]]

pagenames are converted to lowercase automatically, special characters are not allowed.

Linking to a specific header is possible, too. Just add the header text behind a hash character as known from HTML. This links to This Section.

This links to [[using_the_wiki#Internal Links| This Section]].

Other Tips

Remember that you can see the text of any page by just clicking on the Show Page button on the right edge of the webpage, which will show you what syntax is used to perform different text actions on that page, this can be helpful if you ever forget how something is done.

Grammar

Here at the Omnicats, we value good grammar, so it is important that you buy and read this book.

using_the_wiki.txt · Last modified: 2022/11/12 21:34 by connormolinski