Difference between revisions of "Help:Syntax and formatting"

From Official Wiki of the Renaissance Kingdoms
 
(4 intermediate revisions by the same user not shown)
Line 29: Line 29:
 
|style="text-align:center;"|Help:
 
|style="text-align:center;"|Help:
 
|  
 
|  
* a guide providing users with help on a specific subject
+
* a guide that offers assistance to users on a particular topic or subject
 
|-
 
|-
 
|'''Templates<br/>namespace'''
 
|'''Templates<br/>namespace'''
Line 68: Line 68:
 
'''Remarks:'''
 
'''Remarks:'''
 
* To generate a page in a namespace other than the main namespace, you should add a prefix to a selected page name, such as "Help:", "Drafts:", "Talk:", "Template:", or "User:".
 
* To generate a page in a namespace other than the main namespace, you should add a prefix to a selected page name, such as "Help:", "Drafts:", "Talk:", "Template:", or "User:".
* Regarding the user pages, it is highly advisable to only create your own profile page. <br/><br/>
+
* Regarding the user pages, it is highly advisable to only create your own user (profile) page. <br/><br/>
  
 
= Create a redirect to a page =
 
= Create a redirect to a page =
There are several approaches to creating a Wiki page:<br/><br/>
+
There are several approaches to creating a redirect to a Wiki page:<br/><br/>
 
* '''<span style="color:#EF9B0F">Approach 1:</span>'''
 
* '''<span style="color:#EF9B0F">Approach 1:</span>'''
 
** click on the "Special characters" and select the redirection icon: [[File:RedirectionIcon.png|25px]],
 
** click on the "Special characters" and select the redirection icon: [[File:RedirectionIcon.png|25px]],
Line 132: Line 132:
  
 
== Examples and remarks (formatting) ==
 
== Examples and remarks (formatting) ==
 +
 +
When adding examples and remarks to an article page, following formatting are used:
  
 
<pre>
 
<pre>
Line 179: Line 181:
 
</pre>
 
</pre>
  
* It is easy to create lists::
+
* It is easy to create lists:
 
** to create a bulleted list item
 
** to create a bulleted list item
 
* use an asterisk followed by a space
 
* use an asterisk followed by a space

Latest revision as of 14:30, 19 September 2023

You are reading an article that we are « updating ». This article will be updated soon. Some mistakes could remain.

This page should help you get familiar with the syntax and formatting used to create and update pages of the Renaissance Kingdoms Wiki.

Namespaces

A namespace is a reserved word that serves as the common prefix for a group of Wiki pages. Several namespaces are used to structure the Renaissance Kingdoms Wiki:

Namespace Prefix Visibility When to use
Articles (or main)
namespace
/ Public
  • an article introducing a specific game-related item or mechanism
Discussions
namespace
Talk:
  • a discussion on game-related topics among Wiki users
Users
namespace
User:
  • a profile introducing a registered user of the Wiki
Help
namespace
Help:
  • a guide that offers assistance to users on a particular topic or subject
Templates
namespace
Template:
  • a template used to simplify the creation of pages with a similar structure
Drafts
namespace
Drafts: wiki editors
  • a draft is typically created before it is moved to the main namespace

Create a page

There are several approaches to creating a Wiki page:

  • Approach 1: using links while creating or editing another page
    • create a link for a future article page that will be created and save the page: [[My new page]]
    • if you (or anyone else) create a link to an article that doesn't exist yet, the link will be colored red (e.g. My new page)
    • clicking a red link will take you to the edit page for the new article

  • Approach 2: from the search box
    • enter the title of the new page to the search box and search for it (e.g. My new page)
    • if the search results do not display a page with the desired title, you'll typically see an option or link to create a new page with that title
    • clicking a red link (e.g. My new page) will take you to the edit page for the new article

  • Approach 3: using the URL
    • the URL to an article typically looks something like this: https://wiki.renaissancekingdoms.com/en/ARTICLE
    • if you replace ARTICLE with the name of the page you wish to create, you will be taken to a blank page which indicates that no article of that name exists yet
    • clicking on one of the links create this page or Create will take you to the edit page for the new article

Once a page is created, it is possible to:

  • "Show preview" which generates a preview of how your edits will appear on the page without actually saving them. This allows you to review the formatting, layout, and content to ensure it looks the way you intend it to. It's a useful feature to catch and correct any errors or formatting issues before committing your changes.
  • "Save page" which commits your changes and updates the Wiki page with the edits you've made. Once you save the page, the changes become visible to other users, and the previous version of the page is replaced by your updated version.

Remarks:

  • To generate a page in a namespace other than the main namespace, you should add a prefix to a selected page name, such as "Help:", "Drafts:", "Talk:", "Template:", or "User:".
  • Regarding the user pages, it is highly advisable to only create your own user (profile) page.

Create a redirect to a page

There are several approaches to creating a redirect to a Wiki page:

  • Approach 1:
    • click on the "Special characters" and select the redirection icon: RedirectionIcon.png,
    • type the name of the destination page.

  • Approach 2:
    • use the code: #REDIRECTION [[Destination page]].

Edit a page

To edit a Wiki page, simply click on the "Edit" link, and you'll be taken to the editing interface:

  • at the top of the page, to see the full content of the page in the editing interface
  • at the top of the section, to see the content of the section in the editing interface.

As explained before, the "Show preview" link will generate a preview of how your edits will appear on the page without actually saving them, while the "Save page" link will commit your changes and update the Wiki page with the edits you've made.

Remarks:

Syntax and formatting basics

Text color

To change the color of text, you can use the <span> HTML tag along with the style attribute to specify the text color:

  • <span style="color:#Code of the color"> Colored text </span>

Color can be specified by its hexadecimal code or RGB values for more precise control.

Colored text is typically used when presenting the item descriptions. The hexadecimal codes in use are:

  • purple #CA6AD0: 3D furnishing to be placed inside or outside of the house
  • turquoise #50B9EA: information on how the item can be obtained (e.g. artisan making the item, peasant producing the item, or an event during which the item can be obtained)
  • yellow #C2Ad3A: durability of the item
  • golden yellow doré #808025: prosperity of the item
  • dark brown #4C0B09: copy limit of the item bringing prosperity
  • orange #DE7435: information to specify whether the clothing item is suitable for women, men, or both
  • red #D3312C: weapon type
  • green #469A43: impact of the item on the characteristics, virtue, actions of a character, a county, a kingdom
  • dark green #265911: luxury food
  • white: rest of the description, typically describing the item in a humorous way

Exemple:
'''<span style="color:#EF9B0F">Colored text</span>'''

Colored text

Text alignment

The text can be aligned in different ways:

  • centered: <div style="text-align: center;"> Text </div>
  • right-aligned: <div style="text-align: right"> Text </div>
  • left-aligned: <div style="text-align: left"> Text </div>

Example:

The text can be:<br/><br/>
<div style="text-align: center;">centered</div><br/>
<div style="text-align: right">right-aligned</div><br/>
<div style="text-align: left">left-aligned</div><br/><br/>

The text can be:

centered
right-aligned
left-aligned



Examples and remarks (formatting)

When adding examples and remarks to an article page, following formatting are used:

'''Remarks:'''<br/>
* Lorem Ipsum Text<br/><br/><br/><br/>

Remarks:

  • Lorem Ipsum Text

'''<span style="color:#EF9B0F">Example:</span>'''<br/><br/>
Lorem Ipsum Text<br/><br/>

Exemple:
Lorem Ipsum Text

Files

To upload a file:

  • click an "Upload file" link in the Tools menu
    • choose a file
    • add a file summary to help other editors when using it
    • upload a file

To view or search for previously uploaded files, consult a file list page which shows all uploaded files.

Lists

In Wiki, you can create lists to organize and present information in a structured and easy-to-read format. There are typically three main types of lists used in Wiki:

  • unordered (or bulleted) list
    • used to present items in no particular order
    • each item in the list is preceded by a bullet point or some other marker (e.g. *)
  • ordered (or numbered) list
    • used to present items in a specific sequence or order
    • each item in the list is preceded by a number or a hash symbol ( # )
  • definition (or description) list
    • used to present a list of terms and their corresponding definitions or descriptions
    • each item consists of two main parts: the term and the definition

Example :

* It is easy to create lists:<br/>
** to create a bulleted list item<br/>
* use an asterisk followed by a space<br/>
** more asterisk symbols<br/>
*** create a nested list<br/><br/>
  • It is easy to create lists:
    • to create a bulleted list item
  • use an asterisk followed by a space
    • more asterisk symbols
      • create a nested list

# Ordered lists are<br/>
## very well organized, and<br/>
## easy to follow<br/><br/>
  1. Ordered lists are
    1. very well organized, and
    2. easy to follow

; Nested definition list<br/>
; element 1 : definition<br/>
:; sub-element 1 and its term<br/>
:: definition<br/>
:; sub-elemnt 2 : definition<br/>
; element 2<br/>
: returning to the main list<br/><br/>
Nested definition list
element 1 
definition
sub-element 1 and its term
definition
sub-element 2 
definition
element 2
returning to the main list

Line breaks

To start text in a new line, you should use the <br/> tag to insert a line break wherever you need one.

Remarks:

  • Doubling the <br/> code increases the number of line breaks.

Tables

Creating tables typically involves using several markup formattings:

  • {|: start of the table
    • a mandatory tag
  • |-: table row
  • !: table header
    • an optional tag
    • single exclamation mark ( ! ) if at the start of a new line
    • double exclamation mark ( !! ) if on the same line
  • |: data cell
    • an optional tag
    • single vertical bar ( | ) if at the start of a new line
    • double vertical bar ( || ) if on the same line
  • |}: end of the table
    • a mandatory tag

Example:

:{| class="wikitable"<br/>
! Header 1 !! Header 2 !! Header 3<br/>
|-
| Column 1, Row 1 || Column 2, Row 1 || Column 3, Row 1<br/>
|-
| Column 1, Row 2<br/>
| Column 2, Row 2<br/>
| Column 3, Row 2<br/>
|-
|}<br/><br/><br/>
Header 1 Header 2 Header 3
Column 1, Row 1 Column 2, Row 1 Column 3, Row 1
Column 1, Row 2 Column 2, Row 2 Column 3, Row 2

Section titles

To create section titles within a page, you should use headings. Headings are created by using a series of equal signs (=) before and after the text of the section title. The number of equal signs indicates the level of the heading (higher numbers indicate lower-level headings).

Example:

= Section title =<br/>
== Subsection title ==<br/>
=== Sub-subsection tile ===<br/>
===== Sub-sub-subsection tile =====<br/><br/>