Difference between revisions of "SgWiki:Guidebook/Editing & Formatting"

From SgWiki
Jump to navigation Jump to search
(→‎HTML & CSS: New sgWiki common CSS class code)
m
Line 21: Line 21:


====Example 1====
====Example 1====
To bold the word "sgWiki" in the following sentence: "Welcome to sgWiki", all you need is to type in the following code.<br>
To bold the word "sgWiki" in the following sentence: "Welcome to sgWiki", all you need to do is to type in the following code.<br>
{{dottedbox|@=Code|#=<nowiki>Welcome to '''sgWiki'''</nowiki>}}
{{dottedbox|@=Code|#=<nowiki>Welcome to '''sgWiki'''</nowiki>}}
{{dottedbox|@=Result|#=Welcome to '''sgWiki'''}}
{{dottedbox|@=Result|#=Welcome to '''sgWiki'''}}


====Example 2====
====Example 2====
To italic the word "sgWiki" in the following sentence: "Welcome to sgWiki", all you need is to type in the following code.<br>
To italic the word "sgWiki" in the following sentence: "Welcome to sgWiki", all you need to do is to type in the following code.<br>
{{dottedbox|@=Code|#=<nowiki>Welcome to ''sgWiki''</nowiki>}}
{{dottedbox|@=Code|#=<nowiki>Welcome to ''sgWiki''</nowiki>}}
{{dottedbox|@=Result|#=Welcome to ''sgWiki''}}
{{dottedbox|@=Result|#=Welcome to ''sgWiki''}}


===Headers===
===Headers===
Headers are meant to create sections of an articles. This help to keep the articles neater and finding information without an article faster. To put it in simper terms, treat 'Headers' as your textbook/stories books chapters. Just like your textbook chapters which have sub-chapters, there will be sub-headers.
Headers are used to create sections of an article. This helps by keeping articles neater and allowing information without an article to be found more quickly. To put it simply, treat 'Headers' as your textbook/story book chapters. Just like how your textbook chapters have sub-chapters, there is also sub-headers.


To create a header, simply add "<nowiki>=</nowiki>" before and after the text. Do note that the amount of "<nowiki>=</nowiki>" before the text must match the amount of "<nowiki>=</nowiki>" after the text.
To create a header, simply add "<nowiki>=</nowiki>" before and after the text. Do note that the amount of "<nowiki>=</nowiki>" before the text must match the amount of "<nowiki>=</nowiki>" after the text.
Line 46: Line 46:
Tables are meant to display information in rows and columns like an excel spreadsheet. It is greatly useful for data as this will present a neater presentation and a glance of a single data can pinpoint to two different information.
Tables are meant to display information in rows and columns like an excel spreadsheet. It is greatly useful for data as this will present a neater presentation and a glance of a single data can pinpoint to two different information.


To create a table, simply add "<nowiki>{|</nowiki>" to the start of the table and "<nowiki>|}</nowiki>" to the end of the table.
To create a table, simply add "<nowiki>{|</nowiki>" to start a table and "<nowiki>|}</nowiki>" at the end of the table.


A table could consists of rows (horizontal bar) or columns (vertical bar).
A table may consist of rows (horizontal bar) and columns (vertical bar).


To add a row, just add "<nowiki>|-</nowiki> before the table row on a new line.
To add a row, just add "<nowiki>|-</nowiki>" before the table row on a new line.


There are 2 types of columns, or table cells. 1 is called header cells, 1 is data cells. Header cells is a data cells, but typically, header cells came in bold.
There are 2 types of columns, or table cells. One is called header cell, the other is data cell. A header cell is a data cell, but typically, header cells are bolded.


To add a header cell(s), just add "<nowiki>!</nowiki>" before the cell on a new line.
To add a header cell, just add "<nowiki>!</nowiki>" before the cell on a new line.


To add a data cell(s), just add "<nowiki>|</nowiki>" before the cell on a new line.
To add a data cell, just add "<nowiki>|</nowiki>" before the cell on a new line.


To style a cell(s), you may use CSS inline-styling. For more information on the available CSS inline-styling, you may wish to read [http://www.w3schools.com/cssref/pr_tab_table-layout.asp W3Schools].
To style a cell, you may use CSS inline-styling. For more information on the available CSS inline-stylings, you may wish to read [http://www.w3schools.com/cssref/pr_tab_table-layout.asp W3Schools].


It is a common practice to use a collapsed table then non-collapsed table for neat view.
It is a common practice to use a collapsible table than a non-collapsible table for neater viewing.


====Example 4====
====Example 4====
To create a collapsed table with 2 rows and 2 columns, the first row is a header row and styled with red background. All you need is to type in the following code.<br>
To create a collapsible table with 2 rows and 2 columns, the first row is a header row and styled with red background. All you need to do is to type in the following code.<br>
{{dottedbox|@=Code|#=<nowiki>{| style="border-collapse:collapse"</nowiki><br><nowiki>|- style="background-color:#FF000;"</nowiki><br><nowiki>!Column 1</nowiki><br><nowiki>!Column 2</nowiki><br><nowiki>|-</nowiki><br><nowiki>|Column 1</nowiki><br><nowiki>|Column 2</nowiki><br><nowiki>|}</nowiki>}}
{{dottedbox|@=Code|#=<nowiki>{| style="border-collapse:collapse"</nowiki><br><nowiki>|- style="background-color:#FF000;"</nowiki><br><nowiki>!Column 1</nowiki><br><nowiki>!Column 2</nowiki><br><nowiki>|-</nowiki><br><nowiki>|Column 1</nowiki><br><nowiki>|Column 2</nowiki><br><nowiki>|}</nowiki>}}


===HTML & CSS===
===HTML & CSS===
sgWiki also allows HTML and CSS codes. sgWiki could utilise the more powerful HTML5 and CSS3 codes provided that your internet browser supported it. However, please limit the usage of certain commands as it may not be compatible to older PCs which some users may use. For more information about HTML5 and CSS3, you may wish to read [http://www.w3schools.com/ W3Schools].
sgWiki supports both HTML and CSS codes. sgWiki utilises the more powerful HTML5 and CSS3 codes provided that your internet browser supports it. However, please limit the usage of certain commands as it may not be compatible with older PCs which some users may be using. For more information about HTML5 and CSS3, you may wish to read [http://www.w3schools.com/ W3Schools].


For common background colours and font colours used regularly in sgWiki, we had added in new HTML elements classes with specified codes. The following are some of the example:
For common background colours and font colours used regularly in sgWiki, we have added in new HTML element classes with specified codes. The following are some of the examples:
*Operators
*Operators
**class="LTA" - Background - #004250, Text - #FFFFFF
**class="LTA" - Background - #004250, Text - #FFFFFF

Revision as of 07:38, 26 December 2019

Introductions Editing & Formatting Links Citing sources sgWiki Buses sgWiki Trains Ban & Warning Points
Editing and Formatting of sgWiki articles are much more simpler than html codes. To simply edit an article, just click 'Edit' button/tab on the Top Left-hand button. If the article is not yet created, press 'Create'.

Basic Formatting

To apply basic formatting to text - such as bold and italic, you just need to add "'" before and after the text. Do note that the amount of "'" before the text must match the amount of "'" after the text.

Example 1

To bold the word "sgWiki" in the following sentence: "Welcome to sgWiki", all you need to do is to type in the following code.
Code

Welcome to '''sgWiki'''

Result

Welcome to sgWiki

Example 2

To italic the word "sgWiki" in the following sentence: "Welcome to sgWiki", all you need to do is to type in the following code.
Code

Welcome to ''sgWiki''

Result

Welcome to sgWiki

Headers

Headers are used to create sections of an article. This helps by keeping articles neater and allowing information without an article to be found more quickly. To put it simply, treat 'Headers' as your textbook/story book chapters. Just like how your textbook chapters have sub-chapters, there is also sub-headers.

To create a header, simply add "=" before and after the text. Do note that the amount of "=" before the text must match the amount of "=" after the text.

To create a sub-header, simply add an additional "=" before and after the text. Do note that the amount of "=" before the text must match the amount of "=" after the text.

Do take note that the number of "=" refers to the type of headers. 1 "=" represents Header 1 which is the biggest header while 6 "="s represents Header 6 which is the smallest header.

Example 3

To create a header with the text "Hi" and a sub-header with the text "Welcome", all you need is to type in the following code.
Code

===Hi===
====Welcome====

Tables

Tables are meant to display information in rows and columns like an excel spreadsheet. It is greatly useful for data as this will present a neater presentation and a glance of a single data can pinpoint to two different information.

To create a table, simply add "{|" to start a table and "|}" at the end of the table.

A table may consist of rows (horizontal bar) and columns (vertical bar).

To add a row, just add "|-" before the table row on a new line.

There are 2 types of columns, or table cells. One is called header cell, the other is data cell. A header cell is a data cell, but typically, header cells are bolded.

To add a header cell, just add "!" before the cell on a new line.

To add a data cell, just add "|" before the cell on a new line.

To style a cell, you may use CSS inline-styling. For more information on the available CSS inline-stylings, you may wish to read W3Schools.

It is a common practice to use a collapsible table than a non-collapsible table for neater viewing.

Example 4

To create a collapsible table with 2 rows and 2 columns, the first row is a header row and styled with red background. All you need to do is to type in the following code.
Code

{| style="border-collapse:collapse"
|- style="background-color:#FF000;"
!Column 1
!Column 2
|-
|Column 1
|Column 2
|}

HTML & CSS

sgWiki supports both HTML and CSS codes. sgWiki utilises the more powerful HTML5 and CSS3 codes provided that your internet browser supports it. However, please limit the usage of certain commands as it may not be compatible with older PCs which some users may be using. For more information about HTML5 and CSS3, you may wish to read W3Schools.

For common background colours and font colours used regularly in sgWiki, we have added in new HTML element classes with specified codes. The following are some of the examples:

  • Operators
    • class="LTA" - Background - #004250, Text - #FFFFFF
    • class="SBST" - Background - #5D1E79, Text - #FFFFFF
    • class="SMRT" - Background - #E3031E, Text - #FFFFFF
    • class="TTS" - Background - #009548, Text - #FFFFFF
    • class="GAS" - Background - #FFCC33, Text - #FD1E23
  • MRT Colours
    • class="NSL"
    • class="EWL"
    • class="NEL"
    • class="CCL"
    • class="DTL"
    • class="TEL"
    • class="BPLRT"
    • class="SKLRT"
    • class="PGLRT"