Help:New editors: Difference between revisions From Online Manual

Jump to: navigation, search
No edit summary
(Reverted to English.)
 
(11 intermediate revisions by 4 users not shown)
Line 1: Line 1:
or ''Help! the Wiki gives me the Willies!''
{{TOCright}}
{{TOCright}}
Relax. The wiki is mostly harmless. And it would be very difficult for you to harm the wiki. If you are an SMF forum member in good standing, you can edit almost any document. If you haven't already, please join the Doc Helpers group (join from the [http://www.simplemachines.org/community/index.php?action=profile;area=groupmembership Group Membership page of your profile]) and bring your question on over to the [http://www.simplemachines.org/community/index.php?board=202.0 Doc Helpers] board on the SMF forum.
All members of the forum at ''simplemachines.org'' can edit this wiki, as long as you have made at least ten posts. Do not worry about making mistakes because all changes are logged in the history of each page and they can be reversed if necessary.
 
We strongly recommend discussing your ideas with others in the [http://www.simplemachines.org/community/index.php?board=202.0 Doc Helpers] board on the SMF forum before making any changes to a wiki page.


==Wiki Basics==
==Wiki Basics==
*Instead of having a topic and replies, the wiki has articles and versions.
*When you use '''Edit''', you are creating a new version. The older versions never get changed.
*You can always see the older versions using the '''History''' button.  You can even compare versions.
*Don't worry about editing "at the same time" as somebody else. The wiki will warn you if someone else has edited the same article while you were working, and give you a chance to merge your changes.
*Every forum member in good standing can edit almost any wiki article.
*We ask that you not edit articles that are being translated
*Please follow the [[Help:Documentation Guidelines|Documentation Guidelines]]
*And please do not create new articles with '''?''' or '''&''' in the title -- they confuse the webserver


==Searching for an Article, or for help writing Articles==
* When editing the wiki, please follow the [[Help:Documentation Guidelines|Documentation Guidelines]].
Just type something into the search box, and hit the search button. If you start at one of the SMF manual content pages, like the Main Page, the results will usually be limited to the content pages. So if you are looking for something in another "namespace" -- like help, or these "how-to" pages for people working on the online manual, you can use one of the links you'll see when you land on the search page.  "Everything" will make sure you don't leave anything out.
* Instead of having a topic and replies, the wiki has articles and versions.
* When you use '''Edit''', you are creating a new version of a page. The older versions never get changed.
* You can always see the older versions using the '''History''' button.  You can even compare versions.
* Do not worry about editing "at the same time" as somebody else. The wiki will warn you if someone else has edited the same article while you were working, and give you a chance to merge your changes.
* If a wiki page has translated versions (you will see a list of languages at the top of the page), please discuss any substantial changes in the [http://www.simplemachines.org/community/index.php?board=202.0 Doc Helpers] board. This is because we try to keep these pages as stable as possible to make life easier for the translators. On the other hand, if you just want to make small corrections to the grammar and spelling, then you do not have to discuss this because it will not affect the translations.
* Please do not create new pages with '''?''' or '''&''' in the title -- they confuse the webserver.
 
==Searching for an Article, or for Help Writing Articles==
 
Just type something into the search box in the top left-hand corner, and then click either ''Go'' or ''Search''. The ''Go'' option will take you directly to a page if it has the exact same name as the text that you have entered in the search box. If there is no exact match, you will be presented with a list of pages that contain the word(s) you are searching. The ''Search'' button always presents you with the list of search results, even if there is an exact match.
 
By default, the search results include all namespaces, but if you want to search in only one namespace (for example "Multimedia" or "Help and Project Pages"), you can select it at the top of the page that lists the search results.
 
==Editing an Existing Article==
 
If you can see the '''Edit''' button above an article, you have permission to edit it. During editing, you will find the following features:
* '''Wiki editing buttons''' - Bold, Italic, Underline, External Link, Level 2 Heading, Picture, File, Math, <nowiki><nowiki></nowiki>, signature, and horizontal line. These are located above the editing box.
* '''Editing box''' - this is where you enter the content of the wiki page.
* '''Summary box''' - here you can briefly explain your changes. We highly recommend using this as it makes it easier for other users to track the changes and understand your reasoning.
* '''This is a minor edit''' - If you are just making small corrections to grammar or typos, for example, you can check this box.
* '''Watch this page''' - Check this box if you want to be informed of any new edits to the page by other users. In your wiki preferences you can elect to be informed by email.
* '''Editing help''' - This link is below the editing box and it leads to the help pages at Mediawiki. This is useful for learning more about wiki formatting and how the wiki works.
* '''Show changes''' - You can click this button to compare your new version to the previous one. This is a good way of reviewing your changes before you save the page.
* '''Show preview''' - When you click this button, you will see a preview of how your page will look after you save your edits. This is a good way of checking for any mistakes you might have made with the wiki formatting, for example.
* '''Save page''' - When you are happy with the changes that you have made, you can save your new version of the page by clicking this button.
 
==Starting a New Page==
<br>
{{ambox | type = content | text = Before you start a new page (article), it is better to first use the wiki search function to check that there is not already an existing page which might be suitable for the content you are intending to enter. In this respect, it is better to use the ''Search'' button and not the ''Go'' button and then look carefully through the list of search results.}}
 
Here are two ways of creating a new page:
 
* Enter the title of the new page in the search box and then press ''Go''. If there is no existing page with the same title, you will be offered the possibility of creating a new page by clicking on a red link.
* While working on another page, create a wikilink to the new wiki page. The next time you preview or save, you will see a red link to that new page. Follow that red link and get started on the new page.
 
For further information, please see the Mediawiki article [https://www.mediawiki.org/wiki/Help:Starting_a_new_page "Starting a new page"]. On that page you can also find out how to create a new page by using the URL.


==Editing an existing article==
==Wikilinks and Wiki Formatting==
If you can see the '''Edit''' button above an article, you have permission to edit it. Only -- please ask first before editing articles that are in translation (you'll see the translation notice at the top). During editing, look for
* Wiki editing buttons (Bold, Italic, Underline, External Link, Level 2 Heading, Picture, File, Math, <nowiki><nowiki></nowiki>, signature, and horizontal line) above the editing box
* The editing box, where you type the article
* The Summary box, where you briefly explain your changes
* The '''Editing help''' link below the editing box for more information on wiki formatting
* '''Show changes'' to compare your new version to the last one
* '''Show preview''' to see how your version is coming along
* '''Save page''' to save your new version.


==Starting a new article==
BBCode cannot be used for formatting wiki articles. You will need to familiarise yourself with wiki code. One really helpful wiki formatting feature is the automatic table of contents. Every time you use a '''==''' to make a heading, it gets added to the table of contents. You can find more information about links and formatting when you follow the [[Help:Editing|Editing help]] link at the bottom of every editing page.
* Type the new article title into the wiki search box, and hit the '''Go''' button. If an article with that title does not already exist, The wiki will offer up a red link to create that article. Follow that red link and get started on the new article.
* While working on another article, create a wikilink to a new wiki article. The next time you preview or save, you will see a red link to that new article. Follow that red link and get started on the new article.


==Wikilinks and wiki formatting==
Some things that work anywhere on the page:
Wiki formatting is just like BBC formatting, only completely different. One really nice wiki formatting feature is the automatic table of contents -- every time you use a '''==''' to make a heading, it gets added to the table of contents. You'll find more about links and formatting when you follow the [[Help:Editing|Editing help]] link at the bottom of every editing page.
 
* '''Wikilinks''' - Links within the wiki. For example, <nowiki>[[Name of article]]</nowiki>. See also [[Help:Links|Links]].
* '''External links''' - Links to some place else. For example, <nowiki>[http://simplemachines.org]</nowiki>
* '''Basic Formatting''' - <nowiki>''italic''</nowiki>, '''<nowiki>'''bold'''</nowiki>''', and '''''<nowiki>'''''bold italic'''''</nowiki>''''' text.
* '''Pictures''' - <nowiki>[[File:Yes_check.png|thumb]]</nowiki>. For this to work, the images have to be [[Special:Upload|Uploaded]] to the wiki. The [[Special:ListFiles|File List]] shows all the images that have been uploaded.


Some things that work anywhere on the page
* A wikilink -- a link within the wiki: <nowiki>[[Name of article]]</nowiki> also see [[Help:Links|Links]]
* An external link -- a link to some place else <nowiki>[http://simplemachines.org]</nowiki>
* ''<nowiki>''italic''</nowiki>'', '''<nowiki>'''bold'''</nowiki>''', and '''''<nowiki>'''''bold italic'''''</nowiki>''''' text
* Pictures <nowiki>[[File:Yes_check.png|thumb]]</nowiki>, but only if they are already on the wiki.
* [[Special:Upload|Upload]] pictures to the wiki
Some things that only work at the start of a line:
Some things that only work at the start of a line:
* Section headings -- <nowiki>== Level 2 ==</nowiki>, <nowiki>===Level 3===</nowiki>, etc. Please do not use Level 1 headings.
* Lists. Just start the line with a '*' to create a bullet, '#' to create a number, and double them up '**' to create indented lists.


==Images on the wiki==
* '''Section Headings''' - <nowiki>== Level 2 ==</nowiki>, <nowiki>===Level 3===</nowiki>, etc. Do not use Level 1 headings because they are reserved for the page titles.
If you've read above how to put picture in your document, you've noticed that all images used in the wiki must be found on the wiki.  Also see [[Help:Images|Images]]
* '''Lists''' - Just start the line with a '*' to create a bullet, '#' to create a number, and double them up '**' to create indented lists.
===A new picture===
 
Here's how to upload a new picture to the wiki:
==Images on the Wiki==
* On the left side of the wiki page, under '''Toolbox''', find the '''upload file''' link. Follow the directions.
 
===Updating an existing picture===
All images used in the wiki must be found on the wiki.  See [[Help:Images|Images]] for further information.
* While viewing the picture in a document, click on it.
 
===A New Picture===
 
Here is how to upload a new picture to the wiki:
* On the left side of the wiki page, under '''Toolbox''', find the '''upload file''' link, and follow the directions.
 
===Updating an Existing Picture===
 
* While viewing the picture on a page, click on it.
* On the image page, find the '''Upload a new version of this file''' link.
* On the image page, find the '''Upload a new version of this file''' link.
* Follow the instructions to upload a new file from your desktop.  The new file must have the same file extension as the old one.
* Follow the instructions to upload a new file from your desktop.  The new file must have the same file extension as the old one.


 
[[Category:Help]]
[[Category:Help]

Latest revision as of 17:15, 2 April 2017

All members of the forum at simplemachines.org can edit this wiki, as long as you have made at least ten posts. Do not worry about making mistakes because all changes are logged in the history of each page and they can be reversed if necessary.

We strongly recommend discussing your ideas with others in the Doc Helpers board on the SMF forum before making any changes to a wiki page.

Wiki Basics

  • When editing the wiki, please follow the Documentation Guidelines.
  • Instead of having a topic and replies, the wiki has articles and versions.
  • When you use Edit, you are creating a new version of a page. The older versions never get changed.
  • You can always see the older versions using the History button. You can even compare versions.
  • Do not worry about editing "at the same time" as somebody else. The wiki will warn you if someone else has edited the same article while you were working, and give you a chance to merge your changes.
  • If a wiki page has translated versions (you will see a list of languages at the top of the page), please discuss any substantial changes in the Doc Helpers board. This is because we try to keep these pages as stable as possible to make life easier for the translators. On the other hand, if you just want to make small corrections to the grammar and spelling, then you do not have to discuss this because it will not affect the translations.
  • Please do not create new pages with ? or & in the title -- they confuse the webserver.

Searching for an Article, or for Help Writing Articles

Just type something into the search box in the top left-hand corner, and then click either Go or Search. The Go option will take you directly to a page if it has the exact same name as the text that you have entered in the search box. If there is no exact match, you will be presented with a list of pages that contain the word(s) you are searching. The Search button always presents you with the list of search results, even if there is an exact match.

By default, the search results include all namespaces, but if you want to search in only one namespace (for example "Multimedia" or "Help and Project Pages"), you can select it at the top of the page that lists the search results.

Editing an Existing Article

If you can see the Edit button above an article, you have permission to edit it. During editing, you will find the following features:

  • Wiki editing buttons - Bold, Italic, Underline, External Link, Level 2 Heading, Picture, File, Math, <nowiki>, signature, and horizontal line. These are located above the editing box.
  • Editing box - this is where you enter the content of the wiki page.
  • Summary box - here you can briefly explain your changes. We highly recommend using this as it makes it easier for other users to track the changes and understand your reasoning.
  • This is a minor edit - If you are just making small corrections to grammar or typos, for example, you can check this box.
  • Watch this page - Check this box if you want to be informed of any new edits to the page by other users. In your wiki preferences you can elect to be informed by email.
  • Editing help - This link is below the editing box and it leads to the help pages at Mediawiki. This is useful for learning more about wiki formatting and how the wiki works.
  • Show changes - You can click this button to compare your new version to the previous one. This is a good way of reviewing your changes before you save the page.
  • Show preview - When you click this button, you will see a preview of how your page will look after you save your edits. This is a good way of checking for any mistakes you might have made with the wiki formatting, for example.
  • Save page - When you are happy with the changes that you have made, you can save your new version of the page by clicking this button.

Starting a New Page


Here are two ways of creating a new page:

  • Enter the title of the new page in the search box and then press Go. If there is no existing page with the same title, you will be offered the possibility of creating a new page by clicking on a red link.
  • While working on another page, create a wikilink to the new wiki page. The next time you preview or save, you will see a red link to that new page. Follow that red link and get started on the new page.

For further information, please see the Mediawiki article "Starting a new page". On that page you can also find out how to create a new page by using the URL.

Wikilinks and Wiki Formatting

BBCode cannot be used for formatting wiki articles. You will need to familiarise yourself with wiki code. One really helpful wiki formatting feature is the automatic table of contents. Every time you use a == to make a heading, it gets added to the table of contents. You can find more information about links and formatting when you follow the Editing help link at the bottom of every editing page.

Some things that work anywhere on the page:

  • Wikilinks - Links within the wiki. For example, [[Name of article]]. See also Links.
  • External links - Links to some place else. For example, [http://simplemachines.org]
  • Basic Formatting - ''italic'', '''bold''', and '''''bold italic''''' text.
  • Pictures - [[File:Yes_check.png|thumb]]. For this to work, the images have to be Uploaded to the wiki. The File List shows all the images that have been uploaded.

Some things that only work at the start of a line:

  • Section Headings - == Level 2 ==, ===Level 3===, etc. Do not use Level 1 headings because they are reserved for the page titles.
  • Lists - Just start the line with a '*' to create a bullet, '#' to create a number, and double them up '**' to create indented lists.

Images on the Wiki

All images used in the wiki must be found on the wiki. See Images for further information.

A New Picture

Here is how to upload a new picture to the wiki:

  • On the left side of the wiki page, under Toolbox, find the upload file link, and follow the directions.

Updating an Existing Picture

  • While viewing the picture on a page, click on it.
  • On the image page, find the Upload a new version of this file link.
  • Follow the instructions to upload a new file from your desktop. The new file must have the same file extension as the old one.


Advertisement: