Star Citizen:Editing/Your first edit

This is part 1 of the series of editing guides of the Star Citizen Wiki. This guide is a step-by-step process to your first edit - or, how to edit plain text with the visual editor.

This guide is made from the perspective of a logged-in user with default preferences.

Walkthrough

Spotting an error

Finding an error to fix can sometimes be hard, but there are definitely pages that need fixing; the wiki is far from perfect. Let's assume you've found a page with something simple to fix (e.g. just something in the prose). I have found such an example for this demonstration: the second paragraph of the Defender page introduction contains a repetition of information that is covered in more detail later in the articles. I'm going to reword it.

Opening the editor

Opening the editor is simple; just click the Edit (the one that resembles a pen) button on the left or the right of the page title (depending on the width of the browser window).

You are now in the editor. It looks like the page, but some bits may move around, and there's an edit toolbar at the top. This editor is called the VisualEditor, a WYSIWYG (what you see is what you get) editor. It behaves like any word processor (e.g. Microsoft Word). Feel free to click around and explore the parts of a page and what they look like when left-/right-clicked.

Editing the page

Now, I'm just going to edit the introduction. This bit is just plain text with no additional stuff; so to edit it, we just select where to type, and type there. You can select text to copy, paste, delete, etc. A new paragraph can be created by pressing enter.

Here's my finished reword. It may not be perfect, but it should be more readable and clear.

Saving the edit

Saving an edit is done by clicking the 'Save changes' button on the right side of the toolbar. Click it to open the save dialogue.

In the dialogue, there's a textbox to put an edit summary and three buttons. First, we're going to check the 'Review your changes' button.

Reviewing changes

Changes are shown to you as a diff (which you may be familiar with if you use tools like git). The left column of text (with the green theme) is the currently viewable page, and the right column (with the blue theme) is the text as you've changed it. Lines with something that has changed have a thick left border, and lines with nothing changed are flat grey. Text that was added, changed, or removed is highlighted in green on the left, and the replacement (and new) text is highlighted in blue on the right. This text is in a markup language known as wikicode (covered in greater detail with later guides).

What we're looking for is twofold: double-check our changes are what we want to do (proofread it), and see if anything has changed that should not have changed. The VisualEditor has persistent bugs that can cause it to insert/delete a lot of extraneous text. If you notice this has happened to you, it may be possible to fix it by using source mode (see source mode introduction guide); however, you might have to start the edit over. Luckily, our example edit seems fine so we'll continue.

It is optional but recommended to do this for every edit.

Saving

Clicking Return to save form brings us back to the previous form. Here we're going to add an edit summary and finally save the page.

An edit summary is a comment attached to your edit that isn't visible on the page itself, but is publicly viewable when looking at the changes that have been made. You should try to succinctly summarise your edit so that other editors can see what you've done. You can be as brief or descriptive as you like, but bear in mind there is a 255 character limit. You can also use wikicode links in edit summaries if you like.

Edit summaries aren't subject to most style policies/guidelines, but they are subject to community ones (i.e. if you are rude to other users in a summary, that is grounds for a block as much as an edit). Edit summaries can't be changed after the fact, only deleted by an administrator (and only within certain criteria).

I've gone by simply describing the edit as "rewritten introduction".

Now, we just click save. After a short time (don't close or reload the page during this; your edit may be lost if you do!), the edit is saved and the page automatically reloads to show the newest version of your page.

And that's it! The edit has been saved and is viewable to all.

Common things to fix and not fix

There are several simple things you should fix if you see them, for example:

Typos
Links to incorrect places
Incorrect or outdated information
Poorly-formatted/worded paragraphs

Things you shouldn't change or should otherwise bear in mind:

The wiki uses American spelling and style throughout to be consistent with CIG. This means that:
- Words should be spelled using American English; common examples include "color" (not "colour"), "utilize" (not "utilise"), and so on.
- Dates should be in YYYY-MM-DD (ISO 8601) format.
Always use sentence case unless the name is/includes a proper noun; i.e. don't capitalize names unless it is capitalized by CIG. "The quantum drive of the Anvil Carrack is Agni." not "The Quantum Drive of the Anvil Carrack is Agni."
Opinions are not valuable content; e.g. "The Retribution is the best UEE ship" is not appropriate, but "The Retribution is the biggest UEE ship" is.