Best practices: Difference between revisions

From WIKI FOSSCELL NITC
No edit summary
mNo edit summary
Tags: Visual edit Mobile edit Mobile web edit
 
(2 intermediate revisions by one other user not shown)
Line 1: Line 1:
==Best Practices==
Creating a well-structured and easy-to-navigate wiki page is essential for effectively sharing information. Here are some best practices to help you set up your wiki page:
Creating a well-structured and easy-to-navigate wiki page is essential for effectively sharing information. Here are some best practices to help you set up your wiki page:


==Using Different Levels of Headers==
==Using Different Levels of Headers==
Organize your content using headers of various levels. This creates a clear hierarchy and makes it easier for readers to follow. Use == Heading == for main sections and === Subheading === for subsections. For deeper levels, you can use more equal signs.<br><br>
Organize your content using [https://en.wikibooks.org/wiki/MediaWiki_User_Guide/Sections_and_Headings headers] of various levels. This creates a clear hierarchy and makes it easier for readers to follow. Use == Heading == for main sections and === Subheading === for subsections. For deeper levels, you can use more equal signs.<br><br>
  == Main Heading ==
  == Main Heading ==
  === Subheading ===
  === Subheading ===
  ==== Sub-subheading ====
  ==== Sub-subheading ====
==Utilize Lists==
==Utilize Lists==
Lists are great for breaking down information into manageable chunks. You can use bullet points or numbered lists to organize your points.
[https://www.mediawiki.org/wiki/Help:Lists Lists] are great for breaking down information into manageable chunks. You can use bullet points or numbered lists to organize your points.
===bulleted lists===
===bulleted lists===
  * Item 1
  * Item 1
Line 17: Line 18:
  2. Second item
  2. Second item
  3. Third item
  3. Third item
This can be attained by adding # at the first line.


==Line Breaks==
==Line Breaks==
Line 24: Line 28:


==Using Bold And Italics Texts==
==Using Bold And Italics Texts==
Highlight important information by using bold and italic texts.  
Highlight important information by using [https://www.mediawiki.org/wiki/Help:Formatting bold and italic texts].  
  ''<nowiki>''Italic text''</nowiki>'' for emphasis
  ''<nowiki>''Italic text''</nowiki>'' for emphasis
  '''<nowiki>'''Bold text'''</nowiki>''' for strong emphasis
  '''<nowiki>'''Bold text'''</nowiki>''' for strong emphasis
==Code Blocks==
To use code blocks as seen in the above subsections ,simply add a space before the text you are going to write (in a new line)

Latest revision as of 23:34, 8 June 2024

Best Practices

Creating a well-structured and easy-to-navigate wiki page is essential for effectively sharing information. Here are some best practices to help you set up your wiki page:

Using Different Levels of Headers

Organize your content using headers of various levels. This creates a clear hierarchy and makes it easier for readers to follow. Use == Heading == for main sections and === Subheading === for subsections. For deeper levels, you can use more equal signs.

== Main Heading ==
=== Subheading ===
==== Sub-subheading ====

Utilize Lists

Lists are great for breaking down information into manageable chunks. You can use bullet points or numbered lists to organize your points.

bulleted lists

* Item 1
* Item 2
* Item 3

Numbered Lists

1. First item
2. Second item
3. Third item


This can be attained by adding # at the first line.

Line Breaks

Use the
tag to insert a line break when you need to create space without starting a new paragraph.

Line one
Line two

Using Bold And Italics Texts

Highlight important information by using bold and italic texts.

''Italic text'' for emphasis
'''Bold text''' for strong emphasis

Code Blocks

To use code blocks as seen in the above subsections ,simply add a space before the text you are going to write (in a new line)