I. Getting Started

Your Account

---

The first step to making your first edit is Creating an Account. You can do this by navigating to the top-right corner of the page and clicking the "Sign Up" button. Then, choose your Wiki Username, Email Address, and Password, or alternatively, you may "Sign up with Discord"*.

Once your accout has been created, customize your User Profile by logging in, navigating to the User Dropdown Menu at the top-right corner of the page, clicking "My Account", and changing your User Avatar, Preferred Language, or UI Shortcut Preferences. If you did not sign up for Discord, but decide to later, you may connect your User Profile to your Discord account later by following the steps above, then navigating to the "Access & Security" section of your profile, and clicking "Connect Account" under the Discord "Social Accounts" icon.

* What is Discord?

Navigating the Wiki

---

Bookshelves Books Chapters Pages Draft Pages

The principles of storing information within BookStack is based of the ideas of a normal stack of books. Just like normal books, BookStack books can contain chapters and pages. You start off by creating a book which acts as the highest level of categorisation. Ideally you’d have separate books for separate topics.

Within a book you can directly create pages or you can first create chapters. Chapters provide an additional level of page grouping to keep pages organised but are optional. All the information you write is held within pages. Although books and chapters do not hold information they can be given a short description to assist with searching and visibility.

~ Content Overview, Bookstack User Documentation

Getting Editor Access

---

All accounts are given "User" access upon creation. This access is View-Only, and if you would like to help contribute to the Wiki, you will need to request the ability make edits. We know it’s a small hoop to jump through, but it helps us keep the wiki secure, organized, and free from spam or vandalism.

"Contributor" access gives accounts the ability to create or edit Chapters and Pages; this is where the vast majority of wiki content lives. Currently, the best way to request Contributor access is to join the Red Company Discord server. Once you've joined, simply navigate to the #monmara-wiki-workshop channel and ask! The wiki needs editors and will gladly welcome anyone who wishes to contribute!

Alternatively, please submit the Role Update Form [LINK PENDING]. You will need to provide your Account Username, Your Current Role/Access Level ("New/Existing User"), the Role/Access Level you are requesting ("Contributor"), and a brief explanation of why you would like the updated access (Let us know what you are interested in!). An Administrator will review and process the Access Request, and you will be notified once the change has been completed.

In the meantime, please check out our Policies. You will find more details on the different Roles available to wiki members (User -> Contributor -> Editor -> Moderator -> Administrator) and on our Content Guidelines.

"How can I contribute?"

---

Once you've been given Contributor access, the first thing you should know is that it's okay if you mess up! Even if you get something wrong or delete all the contents of an entire Page, Editors, Moderators, and other Contributors can help fix or restore the page! Every edit is recorded and can easily be reverted.

Creating a New Page

Navigate to the Book or Chapter where you want to place the newly created Page.

For example, if you want to create a Page for a new planet in the Centaurus Arm, navigate to Locations > Centaurus Arm.

Then, click the "New Page" button to create your Page. Give it a title, and start editing as described below!

Note: This process works for the Creation of Chapters too! Simply navigate to the Book where you want to place the newly created Chapter, give it a title and description, and optionally, create or select Chapter Tags and/or choose a Default Page Template.

Page Templates

When creating or editing a page, you may use any of the established Page Templates. In the Editor Sidebar, you should see a Templates Icon (An Equal Sign surrounded by a Dotted-Line Border ). Any available templates will be listed in that section, and the built-in search bar can be used to quickly find the page setup you need.

There are several ways to use the template on a page:

• Select the template box itself to replace the editor content with contents of the template.
• Select the up arrow of the template box to prepend its contents to the editor.
• Select the down arrow of the template box to append its contents to the editor.
• Drag the template box into the editor to insert its contents into the dragged location.

Making your First Edit

Once you've created a Page, you should then see two windows: the HTML Markdown Editor (left), and the Editor Preview (right).

The HTML Markdown Editor is the editor pane that displays the plain text format of your HTML syntax. You'll want to get familiar with the HTML language that the wiki uses for formatting, but don't worry, it's not too difficult! You can read more about this on XI. Wiki Syntax.

The Editor Preview pane is a live preview feature of Bookstack that allows you to see how your content will appear as you are typing. You can toggle this preview on or off by navigating to the three vertical dots at the top-right corner of the HTML Markdown Editor pane, then checking or uncheck the "Show preview" box. The "Sync Preview scroll" box determines whether the content preview in the Editor Preview pane scrolls up or down depending on the lines you are viewing in the Markdown Editor.

Note: To Edit an Existing Page, first navigate to the Page you want edit, then in the "Actions" section on the right-hand side of the screen, click the Edit button. For Mobile contributors, you will need to select the Info button, then click Edit.

For more information on the types of edits you can make, see the other pages of the Editor's Guide.

Save your edits by clicking the "Save Page" button in the top-right corner.

Links

When editing, it is a common need to link to other pages on the wiki. The preferred way to do this is using the <a> tag. Use it like this:

<a href="link here">displayed text here</a>

Place your link between the quotation marks, and the text you'd like to be displayed between the starting- and ending- <a> tags. For example:

<a href="https://www.suneater.wiki/books/meidua-red-company/page/hadrian-marlowe">Hadrian Marlowe</a>

Will display as: Hadrian Marlowe.

Drafts

As you edit, drafts of your progress will be saved periodically. If you happen to exit the editor without saving, the draft will let you pick up where you left off. Do note, however, that if another editor makes changes to the page in between you saving a draft and saving an edit, you risk overwriting those changes if you do not first discard said draft. In general, it is best practice to not rely overmuch on drafts, and instead save your edits immediately, or use a separate word processor.

Revisions and Reversions

Revisions are snapshots of Page history, allowing Contributors to view, compare, and restore previous versions of content. When on the desired page, you will see a Clock icon with a counter-clockwise arrow; this is the Revisions button. Click this button to see a full record of the number of Page edits, who made the edit, and options to either view the page with the Changes highlighted, to see a Preview of that version of the Page, or to Restore the current version of the Page to that version. This final process is called Reversion and is very handy during testing or if you made a mistake.

Copying Pages

Duplicating a page is an easy process. Whether, you would like to speed up the process of creating a similar page or you would like to do some testing on a private page, copying a page is as simple as navigating to the desired page, opening it, and clicking the Copy button. You will be asked to give the page an updated title and to choose the Book or Chapter you want the copy to be located in.

Moving Pages

If you find (or create) a page in the wrong location in the wiki hierarchy, you may want to use the Move function. To move a page, simply locate the "Move" button on the right-hand side of the screen, and select the Book or Chapter you want this page to be located in.

"What Now?"

---

Now, you're almost ready to make your first edits! We only ask that you check out II. Guidelines before getting started. Of course, we still recommend that you read our III. Spoiler Policy and IV. References before making any major edits, but this short tutorial should hopefully get you familiar enough to get started!