New Editor Guide: Difference between revisions

From HorizonXI Wiki
(Created page with "{{Tocright}} This guide is aimed at anyone who would like to to start Wiki editing but has no previous experience. As long as you know your way around the keyboard, this guide will explain how to do the all the basics and more. I originally wrote this guide for the FFXI private server HorizonXI but feel free to use it anywhere it may help other fledgling editors. Starting out editing can be a daunting time for new editors. I remember all too well starting out with zero...")
 
m (page formatting)
Line 8: Line 8:
=== Keyboard Shortcut ===
=== Keyboard Shortcut ===
On Horizon Wiki, simply hitting the '''"N"''' key will bring up the "Create a New Page" popup box. Type a page title and click the "Create" button.
On Horizon Wiki, simply hitting the '''"N"''' key will bring up the "Create a New Page" popup box. Type a page title and click the "Create" button.
[[File:create_a_new_page1.png]]
[[File:create_a_new_page1.png]]


Line 15: Line 16:
=== Search Bar ===
=== Search Bar ===
If an editor tries to '''search for a page that doesnt exist''', the search results page will provide the editor with a red link to create the page.
If an editor tries to '''search for a page that doesnt exist''', the search results page will provide the editor with a red link to create the page.
[[File:create_a_new_page2.png]]
[[File:create_a_new_page2.png]]


Line 22: Line 24:
=== Headings ===
=== Headings ===
Headings are used to '''seperate different sections''' of a page. Each heading can be broken down into four further '''sub-headings'''. To create a heading or sub-heading, surround the heading title with a single '''equals sign (=)'''. Using two equal symbols on either side of the title creates a sub-heading. This can be taken as far as five equals symbols, as can be seen below.
Headings are used to '''seperate different sections''' of a page. Each heading can be broken down into four further '''sub-headings'''. To create a heading or sub-heading, surround the heading title with a single '''equals sign (=)'''. Using two equal symbols on either side of the title creates a sub-heading. This can be taken as far as five equals symbols, as can be seen below.
<div class="flex-container">
<div class="flex-container-item-2">
<pre>= Heading 1 =
<pre>= Heading 1 =
Paragraph one
Paragraph one
Line 35: Line 39:


===== Sub-heading =====
===== Sub-heading =====
Paragraph 5</pre>
Paragraph 5</pre></div>
[[File:headings1.png]]
<div class="flex-container-item-2>
[[File:headings1.png]]</div></div>


== Table of Contents ==
== Table of Contents ==
Headings lead us nicely to adding a '''table of contents''' to a page. This is primarily used as a way for Wiki users to navigate to a particular section of a page. A table of contents will be automatically added to a page when '''four''' headings or more are present.
Headings lead us nicely to adding a '''table of contents''' to a page. This is primarily used as a way for Wiki users to navigate to a particular section of a page. A table of contents will be automatically added to a page when '''four''' headings or more are present.
[[File:tocexample.png]]
[[File:tocexample.png]]



Revision as of 23:26, 30 October 2023

This guide is aimed at anyone who would like to to start Wiki editing but has no previous experience. As long as you know your way around the keyboard, this guide will explain how to do the all the basics and more. I originally wrote this guide for the FFXI private server HorizonXI but feel free to use it anywhere it may help other fledgling editors.

Starting out editing can be a daunting time for new editors. I remember all too well starting out with zero knowledge of coding and slowly fumbling my way through my editing. It took a long time and a lot of trial and error but eventually, with years of learning and experience behind me, I feel confident in sharing my knowledge with others. I consider this guide a working progress and I'm very welcome to constructive criticism. The best place to give feedback would be on the Wiki discord.

Creating a Page

Starting from the beginning, lets create a new page. There are several ways of doing this.

Keyboard Shortcut

On Horizon Wiki, simply hitting the "N" key will bring up the "Create a New Page" popup box. Type a page title and click the "Create" button.

Create a new page1.png

Red Links

On any Wiki, red links can be found. A red link is simply a link to a page that doesn't exist. Clicking on these will take an editor to the "Creating Name of New Page" page.

Search Bar

If an editor tries to search for a page that doesnt exist, the search results page will provide the editor with a red link to create the page.

Create a new page2.png

Basic Page Formatting

Now we have a blank page, lets add something to it. A Wiki page can be as simple as adding some text and hitting the save page button at the bottom however, that's going to make for a boring page. There are many things we can do to make things look interesting...

Headings

Headings are used to seperate different sections of a page. Each heading can be broken down into four further sub-headings. To create a heading or sub-heading, surround the heading title with a single equals sign (=). Using two equal symbols on either side of the title creates a sub-heading. This can be taken as far as five equals symbols, as can be seen below.

= Heading 1 =
Paragraph one

== Sub-Heading ==
Paragraph two

=== Sub-Heading ===
Paragraph 3

==== Sub-Heading ====
Paragraph 4

===== Sub-heading =====
Paragraph 5
Headings1.png

Table of Contents

Headings lead us nicely to adding a table of contents to a page. This is primarily used as a way for Wiki users to navigate to a particular section of a page. A table of contents will be automatically added to a page when four headings or more are present.

Tocexample.png

No Table of Contents

An editor can remove a table of contents from their page by adding the following code, anywhere on the page:

__notoc__


An editor can also add a table of contents to their page, even when fewer than four headings are present. Again, this can be added anywhere on their page:

__toc__