Formatting Articles: Difference between revisions

From Grooper Wiki
← Older edit
No edit summary
Redirected page to Article Formatting
Tags: New redirect visualeditor-switched
 
(32 intermediate revisions by 2 users not shown)
Line 1: Line 1:
The following article will give you guidance on writing articles in the Grooper Wiki.
#REDIRECT [[Article Formatting]]
 
== Creating a New Article ==
 
<tabs style = "margin:20px">
<tab name="Step 1" style="margin:20px">
1)  Using the search bar, type the name of the article you wish to create.
 
 
[[file:add article 1.png|border]]
 
</tab>
<tab name="Step 2" style="margin:20px">
2)  If the article does not exist, you will see a message reading "Create the page "Article Name" on this wiki!" above the search results.  Click the searched article's name in quotes to create it.
 
 
[[file:add article 2.png|border]]
 
</tab>
<tab name="Step 3 and 4" style="margin:20px">
 
3)  Use the text editor box to write your article.  For more information on Mediawiki's markup formatting refer to the [[Writing Articles#Text Formatting - Markup Syntax]] section of this article.
 
4)  Press the "Save Page" button at the bottom of the text editor to save the page.
 
 
[[file:add article 3.png|border]]
 
 
</tab>
<tab name="Step 5" style="margin:20px">
5) If you need to edit your page further.  Press the "Edit" button at the top of the article.
 
 
[[file:add article 4.png|border]]
 
</tab>
</tabs>
 
== Text Formatting - Markup Syntax==
 
Your article's text can be formatting using MediaWiki's markup.  This is a syntax consisting of special characters, like asterisks, apostrophes and equals signs to do special things.  For example, you can place a word in ''italics'' by placing a pair of apostrophies on both sides of the word, like <code><nowiki>''this''</nowiki></code>.
 
=== Character Formatting ===
 
This is also referred to as "inline" formatting.
 
{|cellpadding="10" cellspacing="5"
|-style="background-color:#36b0a7; color:white"
|'''Format'''||'''You Type'''||'''You Get'''
|-
|Italics||<pre>''This is italic text''</pre>||''This is italic text''
|-
|Bold Text||<pre>'''This is bold text'''</pre>||'''This is bold text'''
|-
|Bold and Italics||<pre>'''''This is bold and italic text'''''</pre>||'''''This is bold and italic text'''''
|-
|Escape wiki markup||<pre><nowiki><nowiki>Don't use '''markup''' syntax</nowiki></nowiki></pre>||<nowiki>Don't use '''markup''' syntax</nowiki>
|}
 
=== Sections  ===
 
Section headers are useful to break up sections of information in your article.  Sections and subsections are called out by pairs of equals signs on both sides of the sections name.
 
{|cellpadding="10" cellspacing="5"
|-style="background-color:#36b0a7; color:white"
|'''You Type'''||'''You Get'''
|-
|
<pre>
== Section Level 2 ==
 
=== Section Level 3 ===
 
==== Section Level 4 ====
 
===== Section Level 5 =====
 
====== Section Level 6 ======
</pre>
|
[[File:Section 1.png]]
|}
 
==== Further Guidance ====
 
DO NOT use the "Level 1" section by typing a single equals sign on either side of the section name. 
* For example: <code><nowiki>= Level 1 =</nowiki></code>
** Don't do this!  This is bad.
 
Level 1 is reserved for the page level for the article you are editing.  Begin all subsections at Level 2
* For example: <code><nowiki>== Level 2 ==</nowiki></code>
** Do this.  This is good.
 
Do not type text on the same line of the section name.  It will break the section.
 
{|cellpadding="10" cellspacing="5"
|-style="background-color:#36b0a7; color:white"
|'''You Type'''||'''You Get'''
|-
|<pre>== Section Name ==  Section info</pre>||== Section Name ==  Section info
|-
|
<pre>== Section Name ==
Section info</pre>
|
[[File:Section 2.png]]
|}
 
=== Bullets and Indents ===
 
Bulleted lists can be created using the asterisk <code>*</code>.
 
{|cellpadding="10" cellspacing="5"
|-style="background-color:#36b0a7; color:white"
|'''You Type'''||'''You Get'''
|-
|
<pre>
Normal line of text.
* First bullet
* Second bullet
* Third bullet
** First sub-bullet
** Second sub-bullet
* Fourth bullet
** First sub-bullet
*** First sub-sub bullet
</pre>
|
Normal line of text.
* First bullet
* Second bullet
* Third bullet
** First sub-bullet
** Second sub-bullet
* Fourth bullet
** First sub-bullet
*** First sub-sub bullet
|}
 
Numbered bulleted lists can be created using the pound sign <code>#</code>.
 
{|cellpadding="10" cellspacing="5"
|-style="background-color:#36b0a7; color:white"
|'''You Type'''||'''You Get'''
|-
|
<pre>
Normal line of text.
# First bullet
# Second bullet
# Third bullet
## First sub-bullet
## Second sub-bullet
# Fourth bullet
## First sub-bullet
### First sub-sub bullet
</pre>
|
Normal line of text.
# First bullet
# Second bullet
# Third bullet
## First sub-bullet
## Second sub-bullet
# Fourth bullet
## First sub-bullet
### First sub-sub bullet
|}
 
Lines can be indented using the colon character <code>:</code>
 
{|cellpadding="10" cellspacing="5"
|-style="background-color:#36b0a7; color:white"
|'''You Type'''||'''You Get'''
|-
|
<pre>
Normal line of text.
: First indented line
: Second indented line
: Third indented line
:: First twice indented line
:: Second twice indented line
: Fourth indented line
:: First twice indented line
::: First thrice indented line
</pre>
|
Normal line of text.
: First indented line
: Second indented line
: Third indented line
:: First twice indented line
:: Second twice indented line
: Fourth indented line
:: First twice indented line
::: First thrice indented line
|}
 
Bullets and indents can be mixed as well.
 
{|cellpadding="10" cellspacing="5"
|-style="background-color:#36b0a7; color:white"
|'''You Type'''||'''You Get'''
|-
|
<pre>
Normal line of text.
# First numbered line
# Second numbered line
# Third numbered line
#* Bullet under third numbered line
#: Indent under third numbered line
# Fourth numbered line
## Numbered bullet under fourth numbered line
##* First bullet under numbered bullet under the fourth numbered line
</pre>
|
Normal line of text.
# First numbered line
# Second numbered line
# Third numbered line
#* Bullet under third numbered line
#: Indent under third numbered line
# Fourth numbered line
## Numbered bullet under fourth numbered line
##* First bullet under numbered bullet under the fourth numbered line
|}
 
Notice the leftmost character of each line is always a pound sign <code>#</code>.  If you break this pattern, you will start a new sequence of numbers.
 
{|cellpadding="10" cellspacing="5"
|-style="background-color:#36b0a7; color:white"
|'''You Type'''||'''You Get'''
|-
|
<pre>
Normal line of text.
# First numbered line
# Second numbered line
# Third numbered line
#* Bullet under third numbered line
* NEW SINGLE BULLET
# New numbered sequence line.
## Numbered bullet under new numbered line
##* First bullet under numbered bullet under the new numbered line
</pre>
|
Normal line of text.
# First numbered line
# Second numbered line
# Third numbered line
#* Bullet under third numbered line
* NEW SINGLE BULLET
# New numbered sequence line.
## Numbered bullet under new numbered line
##* First bullet under numbered bullet under the new numbered line
|}
 
=== HTML Tags ===
 
Some HTML tags are allowed in MediaWiki.
 
{|cellpadding="10" cellspacing="5"
|-style="background-color:#36b0a7; color:white"
|'''Format'''||'''You Type'''||'''You Get'''
|-
|Fixed Width Text
|
<pre>Fixed width text is useful for calling out regular expressions, such as <code>[^\r\n\t\f]+</code>.</pre>
|Fixed width text is useful for calling out regular expressions, such as <code>[^\r\n\t\f]+</code>.
|-
|Underlines||<pre><u>This text is underlined.</u></pre>||<u>This text is underlined.</u>
|-
|Strike-through||<pre>I want to <s>strike-through</s> a word.</pre>||I want to <s>strike-through</s> a word.
|-
|Blockquotes
|<pre>Text before
<blockquote>Blockquote</blockquote>
Text after</pre>
|Text before
<blockquote>Blockquote</blockquote>
Text after
|}
 
== Adding Images ==
 
There are two parts to inserting images into an article.
 
# Uploading the file.
# Using markup syntax to insert the image into an article.
 
=== Uploading Images ===
 
<tabs style="margin:20px">
<tab name="Step 1" style="margin:20px">
1)  On any page, find the "Tools" section in the left hand tool-bar.
 
2)  Press the "Upload File" button.
 
[[file:add image 1.png|border]]
 
</tab>
<tab name="Step 2" style="margin:20px">
3)  On the following page, press the "Choose File" button and choose the image you wish to upload from the file browser.
 
[[file:add image 2.png|border]]
 
</tab>
<tab name="Step 3" style="margin:20px">
4)  Press the "Upload File" button at the bottom of the page to upload the image.
 
[[file:add image 3.png|border]]
 
</tab>
</tabs>
 
=== Adding the Image to an Article ===
 
The basic syntax for adding an image once it is uploaded is <code><nowiki>[[file:filename.extension]]</nowiki></code>
 
{|cellpadding="10" cellspacing="5"
|-style="background-color:#36b0a7; color:white"
|'''You Type'''||'''You Get'''
|-
|
<pre>
[[file:doge.jpg]]
</pre>
|
[[file:doge.jpg]]
|}
 
==== Options ====
 
There are several options you can add to further format the image.  Options are called out within the square brackets after the filename and extension, separated by a vertical bar character <code>|</code>.  A single image can be modified using multiple options, each separated by a vertical bar.  The syntax is as follows:
 
<code><nowiki>[[file:filename.extension|Option1|Option2|Option3]]</nowiki></code>
 
===== Format Options =====
 
{|cellpadding="10" cellspacing="5"
|-style="background-color:#36b0a7; color:white"
|style="width:25%"|'''Format'''
|style="width:25%|'''You Type'''
|'''You Get'''
|-
|The '''Border''' option adds a thin grey border to the image.
|
<pre>
text text text
[[file:Goodboy.jpg|border]]
text text text
</pre>
|
text text text
[[file:Goodboy.jpg|border]]
text text text
|-
|The '''Frameless''' option creates a frameless thumbnail of the image.
|
<pre>
text text text
[[file:Goodboy.jpg|frameless]]
text text text
</pre>
|
text text text
[[file:Goodboy.jpg|frameless]]
text text text
|-
|Here, two format options are used '''Frameless''' and '''Border'''.  Note the '''Frameless''' and '''Border''' options are rendered inline with the text.  Adding a blank line before and after the image will put it on a new line.
|
<pre>
text text text
 
[[file:Goodboy.jpg|frameless|border]]
 
text text text
</pre>
|
text text text
 
[[file:Goodboy.jpg|frameless|border]]
 
text text text
|-
|The '''Frame''' option adds a frame around the image.  A caption can be added to the bottom of the frame as well.  Frames are rendered as a right justified floating (rather than inline) block.
|
<pre>
text text text
[[file:Goodboy.jpg|frame|Insert caption here]]
text text text
</pre>
|
text text text
[[file:Goodboy.jpg|frame|Insert caption here]]
text text text
|-
|The '''Thumb''' option creates a framed thumbnail of the image.  Captions can also be added to thumbed images, which are also rendered as a right floating block.
|
<pre>
text text text
[[file:Goodboy.jpg|thumb|Who's a good boy?]]
text text text
</pre>
|
text text text
[[file:Goodboy.jpg|thumb|Who's a good boy?]]
text text text
|}
 
===== Size Options =====
 
Images can be reduced in size or enlarged, with some caveats.
* The '''Frame''' option may not be reduced or enlarged.  It will ignore all size specifications
* The '''Thumb''' and '''Frameless''' options can be reduced, but not enlarged more than the original size.
 
Images can be resized using the following options (Original file size is 800 x 400 pixels).
 
{|cellpadding="10" cellspacing="5"
|-style="background-color:#36b0a7; color:white"
|style="width:33%|'''Format'''||'''You Type'''||'''You Get'''
|-
|Width adjustment in pixels.||<pre>[[file:Goodboy.jpg|border|250px]]</pre>||[[file:Goodboy.jpg|border|250px]]
|-
|Height adjustment in pixels||<pre>[[file:Goodboy.jpg|border|x250px]]</pre>||[[file:Goodboy.jpg|border|x250px]]
|-
|Width and height adjustment in pixels.  Note, this fits the image into box of the specified dimensions, but does not stretch or skew the image.||<pre>[[file:Goodboy.jpg|border|250x250px|]]</pre>||[[file:Goodboy.jpg|border|250x250px]]
|}
 
== Links ==
 
=== Internal Links ===
 
Links to articles within the wiki are called out with a double set of square brackets.
 
{|cellpadding="10" cellspacing="5"
|-style="background-color:#36b0a7; color:white"
|'''Links'''||'''You Type'''||'''You Get'''
|-
|Link to the Example Article page.||<pre>[[Example Article]]</pre>||[[Example Article]]
|-
|Link to an article, but display different text.||<pre>[[Example Article|This is an example]]</pre>||[[Example Article|This is an example]]
|-
|Characters after the brackets will be added to the hyperlink.||<pre>[[Example Article]]s</pre>||[[Example Article]]s
|-
|Avoid characters after brackets being added using the <code><nowiki><nowiki /></nowiki></code> tag||<pre>[[Example Article]]<nowiki />s</pre>||[[Example Article]]<nowiki />s
|-
|Link to a section in this article.||<pre>[[#Links]]</pre>||[[#Links]]
|-
|Link to a section in another article.||<pre>[[Example Article#About]]</pre>||[[Example Article#About]]
|-
|Using the pipe to change the links name is especially helpful for section linking.||<pre>[[Example Article#About|About]]</pre>||[[Example Article#About|About]]
|}
 
=== External Links ===
 
Links outside of this wiki can be "bare", or linked with no formatting.  Or, they can be called out with a set of single square brackets to change the displayed text or show as a numbered annotation.
 
{|cellpadding="10" cellspacing="5"
|-style="background-color:#36b0a7; color:white"
|'''Links'''||'''You Type'''||'''You Get'''
|-
|Bare link||<pre>https://www.grooper.com</pre>||https://www.grooper.com
|-
|Annotation link||<pre>[https://www.grooper.com]</pre>||[https://www.grooper.com]
|-
|Change the link's displayed text||<pre>[https://www.grooper.com Grooper]</pre>||[https://www.grooper.com Grooper]
|}
 
== Tables - Basic Formatting ==
 
Table formatting can be confusing.  But, tables can be powerful additions to your articles.  This is a very quick introduction.
 
{|cellspacing="5" cellspacing="10"
|'''Markup Character'''||'''Use'''
|-
|<pre>{|</pre>||Table start - Always required at the begining of the table
|-
|<pre>|-</pre>||Row start - Required to start a new row ''except'' for the first row.  Wiki syntax always assumes the first row.
|-
|<pre>|</pre>||New cell - Use a single "<nowiki>|</nowiki>" for the first cell.  Use a double "<nowiki>||</nowiki>" for each new cell ''or'' another single "<nowiki>|</nowiki>" if starting the cell on a new line (more on this later).
|-
|<pre>|}</pre>||Table end - Always required at the end of the table.
|}
 
If you want to create a table with three columns and three rows, the table would look as follows
 
<pre>
{|
|Header 1||Header 2||Header 3
|-
|Row 1 - Cell 1||Row 1 - Cell 2||Row 1 - Cell 3
|-
|Row 2 - Cell 1||Row 2 - Cell 2||Row 2 - Cell 3
|-
|Row 3 - Cell 1||Row 3 - Cell 2||Row 3 - Cell 3
|}
</pre>
 
This would render the following table
 
{|
|Header 1||Header 2||Header 3
|-
|Row 1 - Cell 1||Row 1 - Cell 2||Row 1 - Cell 3
|-
|Row 2 - Cell 1||Row 2 - Cell 2||Row 2 - Cell 3
|-
|Row 3 - Cell 1||Row 3 - Cell 2||Row 3 - Cell 3
|}
 
You can also render the same table placing each cell on its own line in the editor.  This is often necessary for tables with longer or more complicated text in a single cell.  Note, only a single pipe is used to call out a new cell in this case.
 
<pre>
{|
|Header 1||Header 2||Header 3
|-
|Row 1 - Cell 1
|Row 1 - Cell 2
|Row 1 - Cell 3
|-
|Row 2 - Cell 1
|Row 2 - Cell 2
|Row 2 - Cell 3
|-
|Row 3 - Cell 1
|Row 3 - Cell 2
|Row 3 - Cell 3
|}
</pre>
 
And the same exact table is created, seen below.
 
{|
|Header 1||Header 2||Header 3
|-
|Row 1 - Cell 1
|Row 1 - Cell 2
|Row 1 - Cell 3
|-
|Row 2 - Cell 1
|Row 2 - Cell 2
|Row 2 - Cell 3
|-
|Row 3 - Cell 1
|Row 3 - Cell 2
|Row 3 - Cell 3
|}
 
A great deal of styling and formatting can be done to tables.  Refer to the MediaWiki's help page on tables [https://www.mediawiki.org/wiki/Help:Tables here] for more information.
 
Below are a couple examples of fancier formatted tables used in this wiki.
 
==== FYI Box ====
 
<pre>
{|cellpadding="10" cellspacing="5"
|-style="background-color:#36b0a7; color:white"
|style="font-size:14pt"|'''FYI'''||Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor inviduntut labore et dolore magna aliquyam erat, sed diam voluptua.
 
At vero eos et accusam et justo duo dolore set ea rebum. Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet.
 
* Lorem ipsum dolor sit amet
* consetetur sadipscing elitr
* sed diam nonumy eirmod tempor invidunt
|}
</pre>
 
{|cellpadding="10" cellspacing="5"
|-style="background-color:#36b0a7; color:white"
|style="font-size:14pt"|'''FYI'''||Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor inviduntut labore et dolore magna aliquyam erat, sed diam voluptua.
 
At vero eos et accusam et justo duo dolore set ea rebum. Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet.
 
* Lorem ipsum dolor sit amet
* consetetur sadipscing elitr
* sed diam nonumy eirmod tempor invidunt
|}
 
==== Caution Box ====
 
<pre>
{|cellpadding="10" cellspacing="5"
|-style="background-color:#f89420; color:white"
|style="font-size:14pt"|'''!'''||Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor inviduntut labore et dolore magna aliquyam erat, sed diam voluptua.
 
At vero eos et accusam et justo duo dolore set ea rebum. Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet.
 
* Lorem ipsum dolor sit amet
* consetetur sadipscing elitr
* sed diam nonumy eirmod tempor invidunt
 
* Lorem ipsum dolor sit amet
* consetetur sadipscing elitr
* sed diam nonumy eirmod tempor invidunt
|}
</pre>
 
{|cellpadding="10" cellspacing="5"
|-style="background-color:#f89420; color:white"
|style="font-size:14pt"|'''!'''||Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor inviduntut labore et dolore magna aliquyam erat, sed diam voluptua.
 
At vero eos et accusam et justo duo dolore set ea rebum. Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet.
 
* Lorem ipsum dolor sit amet
* consetetur sadipscing elitr
* sed diam nonumy eirmod tempor invidunt
|}
 
==== Property Details ====
 
<pre>
{|cellpadding=10 cellspacing=5 style="margin:auto"
|-style="background-color:#36B0A7; color:white"
|style="width:17%"|'''Property'''
|style="width:17%"|'''Default Value'''
|'''Information'''
|-style="background-color:#36B0A7; color:white"
|colspan=3|General Properties
|-style="background-color:#ddf5f5
|Property Name||Default Val||Info
|}
</pre>
 
{|cellpadding=10 cellspacing=5 style="margin:auto"
|-style="background-color:#36B0A7; color:white"
|style="width:17%"|'''Property'''
|style="width:17%"|'''Default Value'''
|'''Information'''
|-style="background-color:#36B0A7; color:white"
|colspan=3|General Properties
|-style="background-color:#ddf5f5
|Property Name||Default Val||Info
|}
 
== Tabbed Containers ==
 
Tabbed containers can be very helpful for step by step "how to" instructions.  Below is the markup for a simple tabbed container.
 
<pre>
<tabs>
<tab name="Step 1">
Text for the first tab.
</tab>
<tab name="Step 2">
Text for the second tab.
</tab>
</tabs>
</pre>
 
It produces the following result.
 
<tabs>
<tab name="Step 1">
Text for the first tab.
</tab>
<tab name="Step 2">
Text for the second tab.
</tab>
</tabs>
 
Each container must start with the <code><nowiki><tabs></nowiki></code> tag and end with the <code><nowiki></tabs></nowiki></code>
 
Each tab must start with the <code><nowiki><tab></nowiki></code> tag and end with the <code><nowiki></tab></nowiki></code> tag.
 
Text inside each tab is formatted just as you would a full page.
 
Tabs may be named using the <code><nowiki>name</nowiki></code> modifier, using the following syntax <code><nowiki><tab name="Tab Name"></nowiki></code>
 
Tabbed containers may also be styled.  One common styling is adjusting the margins.  Here is the same tabbed container from earlier with the whole container indented 20 pixels on all sides.
 
<pre>
<tabs style="margin:20px">
<tab name="Step 1">
Text for the first tab.
</tab>
<tab name="Step 2">
Text for the second tab.
</tab>
</tabs>
</pre>
 
<tabs style="margin:20px">
<tab name="Step 1">
Text for the first tab.
</tab>
<tab name="Step 2">
Text for the second tab.
</tab>
</tabs>
 
Here, we go one step further and indent the margins in each individual tab.
 
<pre>
<tabs style="margin:20px">
<tab name="Step 1" style="margin:20px">
Text for the first tab.
</tab>
<tab name="Step 2" style="margin:20px">
Text for the second tab.
</tab>
</tabs>
</pre>
 
<tabs style="margin:20px">
<tab name="Step 1" style="margin:20px">
Text for the first tab.
</tab>
<tab name="Step 2" style="margin:20px">
Text for the second tab.
</tab>
</tabs>
 
[[Category:Style Guide]]

Latest revision as of 10:04, 5 March 2024

Redirect to:

Retrieved from "https://wiki.grooper.com/index.php?title=Formatting_Articles&oldid=19507"