Using Edit Toolbar

From TNG_Wiki
Jump to navigation Jump to search

The TNG Wiki edit toolbar has been expanded to include new buttons to help with formatting articles. The buttons when clicked will include the wiki syntax and generate an example of the data and text for the specific formatting button.

TNG Wiki Edit Toolbar

All buttons up to the Horizonal Rule button are part of the normal MediaWiki edit toolbar. Some explanations on how to use each button are shown below.

Normal MediaWiki buttons

Bold Text

Click on Button bold.png (the Bold Text icon) in order to make a selected string of text bold or replace the words Bold text with your own text when the following is inserted

'''Bold text'''.

Italic Text

Click on Button italic.png (the Italic Text icon) in order to make a selected string of text bold or replace the words Italic text with your own text when the following is inserted

''Italic text''.

Wiki internal link

Click on Button link.png (the Wiki Internal link) button to insert a link to another article within the TNG Wiki. Replace the

[[Link title]]

with the link to the appropriate TNG article. Note that you only need to enter the portion that follows the title= in the browser URL when viewing that article. You may also want to replace the Underscores with blanks for readability, since MediaWiki will automatically substitute underscores for blanks in a URL.

External URL link

Click on Button extlink.png (the External URL Link button) to insert a link to an external web site. Replace the www.example.com with the URL to the external web site and then replace the link title with an appropriate text to be displayed in the following code

[http://www.example.com link title]

inserted by the button.

Headline Text

Click on the Button headline.png to create the first level heading for the table of contents. It will generate the following entry, where you should edit the Headline text to be the text you want to display for the headline.

== Headline text ==

Headline text is indexed as the first level in the table of contents.

Embed file or image

Click on the Button image.png to insert an image to illustrate your article. It will generate the following entry, where you should replace the Example.jpg with your image file name.

[[Image:Example.jpg]]

Once you save the article, you should be able to click on the image link in order to upload it to the TNG Wiki.

File Link

Click on Button media.png (the File Link button) to insert a file link. It will generate the following entry, where you should replace the Example.ogg with your file name.

[[Media:Example.ogg]]

Once you save the article, you should be able to click on the image link in order to upload your file to the TNG Wiki. Note that not all file types can be uploaded.

Math Formula

You can use Button math.png (the Math Formula icon) to insert a math formula in an article. It will generate the following

<math>Insert formula here</math>

You should replace the Insert formula here with your math formula.

Ignore Wiki Formatting

The Button nowiki.png (Ignore Wiki Formatting button) can be used to tell MediaWiki to ignore formatting the text embedded within the ignore parameters. It will generate the following

<nowiki>Insert non-formatted text here</nowiki>

It is useful for illustrating wiki syntax or code that might be interpreted as wiki syntax.

Signature and timestamp

The Button sig.png (Signature and timestamp button) can be clicked to insert your Username as a signature and add a timestamp when you made a specific comment. It will generate the following

--~~~~

You should consider using it within Discussions and Talk entries, so other users can know who made the comment.

Horizontal Rule

The Button hr.png (Horizontal Rule button) will insert a horizontal rule when clicked. It generates the following

----

It should be used sparingly.

TNG Wiki additional buttons

The following buttons were added to the TNG Wiki to facilitate creating / editing articles, in the hope of getting a wider TNG community participation in creating and editing articles.

Insert Right Align TOC

Click the Insert TOC button Button toc.png to generate the code to right-align the table of contents. Normally you would to this as the first line of an article. The table of contents defaults to being left align and displayed before the article text. The button generates the following wiki syntax

{|align=right
|__TOC__<br />
|}

Secondary Heading

Click the Secondary Heading button Button headline2.png to generate a subordinate table of contents entry. The button generates the following wiki syntax

=== Secondary Heading ===
You should then change the Secondary Heading to the heading you want to assign.

Note that if you need to add a 3rd level heading you can use the Secondary Heading button and then add an equal sign before and after the text as shown below

==== Third Level Heading ====

Bulleted List

The Bulleted List icon Button list bulleted.png can be used to create a bulleted list within an article. It will generated the following

* first bullet
* second bullet
* third bullet

Note that you can also use bulleted lists within a bulleted entry.

Numbered List

The Numbered List icon Button list numbered.png can be used to create an ordered or numbered list within an article. It will generated the following

# first ordered step
# second ordered step
# third ordered step

You should use it when steps must be executed in a specific order.

Definition List

The Definition List icon Button list definition.png can be used to create a glossary type list within an article. It will generated the following

; Definition
: Item 1
: Item 2


Tab or right shift text

The tab or right shift text icon Button shifting.png can be used to indent text. It will generate the following

:

You can enter multiple tabs to indent the text more than once.

Editor Comment

The Editor Comment icon Button hide comment.png can be used to add comments within an article that are only viewable to the editors of the article and are not displayed to the viewer. It will generate the following

<!-- Insert your editor comment here -->

You should replace the Insert your editor comment here with your appropriate comment.

Line Break

The Line Break icon Button enter.png is used to enter a line break with text. It will generate the following

<br />

Block quoted text

The Block-quoted text icon Button blockquote.png can be used to enter text as formatted and indented. It will generate the following

<blockquote>
Enter your block quoted text here.
</blockquote>


Pre-formatted text

The Pre-formatted text icon Button pre.png can be used to enter a section of text that will be displayed as pre-formatted. It will generate the following

<pre>Enter your pre-formatted text here.</pre>


It can be used to enter code snippets. Notice that it will generate a frame around the pre-formatted text.

Code Snippet

The Code icon Button insert code snippet.png can be used to enter a snippet of code. It will generate the following

<code><nowiki>Enter your code snippet here.</nowiki>

It can be used to enter code snippets. Note that if code contains any characters that can be interpreted as wiki syntax, the code will not display correctly if you just use the <code></code> parameters, which is why I added the <nowiki></nowiki> as a wrapper.

Font Color

You can use the Font Color icon Button font color.png to enclose text within a colored font. It generates the following

<span style="color: ColourName">Enter text you want to display in color. Note you must change the ColourName</span>

You should replace the generated text string with your own text. You must also update the ColourName to a valid color, like red, green, or blue.

Advanced image

The Advanced Image icon Button advanced image.png embeds an image with additional parameters. It generates the following

[[Image:]]your_image_name.jpg|thumb|right or left align|NNNpx|Your Image Caption]]

Notice that the image include has additional parameters that can used to control the image display, such as

  • thumb - whether to display the image as a thumbnail where the user can click to view a full size image
  • right or left to align the image to the right or the left
  • NNNpx - where you can specify how my pixels wide to use to display the image


Picture Gallery

The Picture Gallery icon Button gallery.png allows your to embed a picture gallery within an article. It generates the following

<gallery>
Image:Example.jpg|Caption1
Image:Example.jpg|Caption2
</gallery>


Insert zip file

Click on the Zip File button Button zipfile.png to insert a zip file link. It will generate the following entry, where you should replace the Enter_zipfile_name_here with your file name.

[[Media:Enter_zipfile_name_here.zip]]

Once you save the article, you should be able to click on the image link in order to upload your file to the TNG Wiki. This button is very similar to the Embed File icon.

Insert Table

Click on the Insert Table icon Button add table.png in order to add a table to the article. It will generate the following

{| border="5" cellspacing="5" cellpadding="2" width="100%" class="wikitable"
|-
! 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
|}

If you need more than 3 columns, you can repeat the syntax for ! header 3, | row 1, cell 3 and | row 2, cell 3. If you only need 2 columns, then delete the syntax shown for column 3. You can add additional rows as appropriate.

Note that the border="5" generates a wide border with shading. You may want to decrease this number to 1 or 3.

Insert Table Caption

The Insert Table Caption icon Button table caption.png allows you to add a caption to your table. It will generate the following

|+Add your table caption here.

You should replace the Add your table caption here. text with your table caption.

Column Headings

The Column Headings icon Button column and row headers.png allows you to add addition column headings. It generates the following

! header 1 !! header 2 !! header 3

Note that you will also have to use the Add Table Column icon to add the same number of columns to each row.

Add Table Row

The Add Table Row icon Button table row.png allows you to add addition rows to a table. It generates the following

|-

Note that you must also use the Add Table Column icon to add the appropriate number of columns to each row.

Add Table Column

The Add Table Column icon Button table column.png allows you to add addition columns to a row. It generates the following

|
| row 1, cell 1|| row 1, cell 2|| row 1, cell 3

Note that you may also need to use the Column Headings icon to add the same number of columns headers to the table.

Redirect Page

The Redirect Page icon Button redirect.png allows you to create a page whose only purpose is to display the content of another page

#REDIRECT [[page to redirect to]]

For an example, see the Media - 1 - Image Viewer Mod page.

Add Languages Template

The Add Languages Template Button languages template.png allows you to add the language switching template code

{{Languages|English equivalent page}}

Note that if you are adding the Languages template to the English page, you should just delete the high lighted text. When typing the English page equivalent of this page, you also need to include the | Pipe before you type the text for the English page.

For additional information, see Template:Languages

Add Category

The Add Category icon Button add category.png is used to assign the article to one or more TNG Wiki Categories. It will generate the following

[[Category:Enter the TNG Category name]]

You should replace the Enter the TNG Category name with the appropriate TNG Wiki Category.