No edit summary |
|||
| (45 intermediate revisions by 7 users not shown) | |||
| Line 1: | Line 1: | ||
The SimpleMachines Online Manual wiki is the SMF Online Manual that anyone can edit. | The SimpleMachines Online Manual wiki is the SMF Online Manual that anyone can edit. Want to talk about it? Start a new thread in the Documentation Help board [http://www.simplemachines.org/community/index.php?board=202.0 here]. | ||
You can | Whenever you write documentation, please follow the [[Help:Documentation Guidelines|Documentation Guidelines]]. | ||
==Are you new to the wiki?== | |||
That's OK. Most wiki editing is actually pretty easy, and it is pretty hard to break anything. | |||
On almost every page on this wiki, you'll find an "edit" button. You can click it to start editing. Just plain text is fine, or you can use the formatting buttons above the editing box or click on the [http://wiki.simplemachines.org/smf/Help:Editing Editing help] link below the editing box (at the same level of the "Save page" button, on the right). You can ask for help in the [http://www.simplemachines.org/community/index.php?board=202.0 SMF Doc Helpers Board]. | |||
Starting an article is pretty easy, too. Just see the instructions for [[Help:New_editors#Starting_a_new_article|Starting a new article]]. | |||
Don't worry about editing at the same time as somebody else. The wiki does all kinds of checks to protect us from writing "on top of" one another. And you can always see every old version in an article's history. | |||
Two really important rules we've discovered the hard way are: | |||
# Never create a document with a "?" in the title and | |||
# Please do not make changes to pages that are being translated. Instead, please discuss the changes, and allow doc team members to work together with the translators to help make less work for everyone. | |||
For more information for new wiki editors, please see [[Help:New_editors|New Editors]] | |||
<br />To discuss the online manual and how to edit it, please see the [http://www.simplemachines.org/community/index.php?board=202.0 SMF Doc Helpers Board] | |||
<br />To see the comprehensive guide to using a wiki, please see [http://meta.wikimedia.org/wiki/Help:Contents WikiMedia's Help Guide] | |||
==How You Can Help== | ==How You Can Help== | ||
| Line 8: | Line 23: | ||
<div style="padding: 5px; border: solid 2px red; background-color: pink"> | <div style="padding: 5px; border: solid 2px red; background-color: pink"> | ||
===Top priorities=== | ===Top priorities=== | ||
# | # Put new FAQs on the wiki, so we can see them in the {{catlink|FAQ}} | ||
# Categorize the FAQs. For articles already in the {{catlink|FAQ}}, but not in a another category, find or create an appropriate category | |||
# | #*Each of these categories must be categorized with {{catlink|FAQ}} so that it gets listed in the {{catlink|FAQ}} | ||
#*An article can have more than one category. | |||
# | |||
# | |||
</div> | </div> | ||
===Other stuff | ===Other stuff we are working on=== | ||
* Check [[:Category:Needs_HTML_cleanup]] for articles with ugly HTML messes. Clean them up | * Check [[:Category:Needs_HTML_cleanup]] for articles with ugly HTML messes. Clean them up | ||
* Find articles that need HTML cleanup, and give them the <nowiki>{{Cleanup html}}</nowiki> tag. That will make it easier to find them and clean them up. | * Find articles that need HTML cleanup, and give them the <nowiki>{{Cleanup html}}</nowiki> tag. That will make it easier to find them and clean them up. | ||
* Help improve documents that are already here -- making them easier to read, and adding the new features information that is not there yet. | * Help improve documents that are already here -- making them easier to read, and adding the new features information that is not there yet.<!-- | ||
* Help write help for people who want to help write documentation | **If the page is a translation made with the translate extension, you cannot mark the page patrolled. | ||
** Or add one of the tags above, if it needs it, then click on "patrolled" when that the article is properly tagged. | |||
* Help write help for people who want to help write documentation --> | |||
**Whenever you write documentation, follow the [[Help:Documentation Guidelines|Documentation Guidelines]]. | **Whenever you write documentation, follow the [[Help:Documentation Guidelines|Documentation Guidelines]]. | ||
* See the list of files that need to be created at [[: | * See the list of files that need to be created at [[Special:WantedPages]] | ||
* See the list of all pages at [[Special:AllPages]], or choose a random page. See if it needs any work. | * See the list of new pages at [[Special:NewPages]], or all pages at [[Special:AllPages]], or choose a random page. See if it needs any work. | ||
== | ==Cool Tools== | ||
'''Search-and-Replace Tools''' -- while editing an article, find '''Custom regex''' below the Scripts heading at the bottom of the left side bar. You can do multiple search-and-replace, and use regex if you want. | '''Search-and-Replace Tools''' -- while editing an article, find '''Custom regex''' below the Scripts heading at the bottom of the left side bar. You can do multiple search-and-replace, and use regex if you want. | ||
| Line 39: | Line 46: | ||
==New Templates== | ==New Templates== | ||
*[[:Template:Upgrade_FAQ]] -- a list of FAQs that can be useful when upgrading. | |||
*[[:Template:Code]] -- to give better formatting to block code samples. See [[:Template:Code]] for how-to-use documentation. | *[[:Template:Code]] -- to give better formatting to block code samples. See [[:Template:Code]] for how-to-use documentation. | ||
*[[:Template:For_More_Information]] -- A standaradized "for more information link" that will not show up if transcluded onto that page (as in a tooltip). | *[[:Template:For_More_Information]] -- A standaradized "for more information link" that will not show up if transcluded onto that page (as in a tooltip). | ||
==Translation Help Needed== | ==Translation Help Needed== | ||
Use the [[Online_Manual:Translation Portal]] to post and view information about translation priorities. | Use the [[Online_Manual:Translation Portal]] to post and view information about translation priorities. | ||
==Administrators== | ==Administrators== | ||
[[Online Manual:Administrator | [[Online Manual:Administrator portal]] | ||
Latest revision as of 08:59, 25 April 2023
The SimpleMachines Online Manual wiki is the SMF Online Manual that anyone can edit. Want to talk about it? Start a new thread in the Documentation Help board here.
Whenever you write documentation, please follow the Documentation Guidelines.
Are you new to the wiki?
That's OK. Most wiki editing is actually pretty easy, and it is pretty hard to break anything. On almost every page on this wiki, you'll find an "edit" button. You can click it to start editing. Just plain text is fine, or you can use the formatting buttons above the editing box or click on the Editing help link below the editing box (at the same level of the "Save page" button, on the right). You can ask for help in the SMF Doc Helpers Board.
Starting an article is pretty easy, too. Just see the instructions for Starting a new article.
Don't worry about editing at the same time as somebody else. The wiki does all kinds of checks to protect us from writing "on top of" one another. And you can always see every old version in an article's history.
Two really important rules we've discovered the hard way are:
- Never create a document with a "?" in the title and
- Please do not make changes to pages that are being translated. Instead, please discuss the changes, and allow doc team members to work together with the translators to help make less work for everyone.
For more information for new wiki editors, please see New Editors
To discuss the online manual and how to edit it, please see the SMF Doc Helpers Board
To see the comprehensive guide to using a wiki, please see WikiMedia's Help Guide
How You Can Help
Right now, we are organizing the documentation that has been copied from the old manual to this wiki. Some of it, we are recategorizing. Some of it, we are updating to better describe SMF 2.0. Some of it, we are preparing to translate. Even if you have just a few minutes to spare, you might be able to help. Every little bit helps your fellow SMF users. Thanks!
Top priorities
- Put new FAQs on the wiki, so we can see them in the [[Category:FAQ]]
- Categorize the FAQs. For articles already in the [[Category:FAQ]], but not in a another category, find or create an appropriate category
- Each of these categories must be categorized with [[Category:FAQ]] so that it gets listed in the [[Category:FAQ]]
- An article can have more than one category.
Other stuff we are working on
- Check Category:Needs_HTML_cleanup for articles with ugly HTML messes. Clean them up
- Find articles that need HTML cleanup, and give them the {{Cleanup html}} tag. That will make it easier to find them and clean them up.
- Help improve documents that are already here -- making them easier to read, and adding the new features information that is not there yet.
- Whenever you write documentation, follow the Documentation Guidelines.
- See the list of files that need to be created at Special:WantedPages
- See the list of new pages at Special:NewPages, or all pages at Special:AllPages, or choose a random page. See if it needs any work.
Cool Tools
Search-and-Replace Tools -- while editing an article, find Custom regex below the Scripts heading at the bottom of the left side bar. You can do multiple search-and-replace, and use regex if you want.
Did you know that the Semantic MediaWiki extension is in use here? It was used to create the Alphabetical list of all bulletin board codes, as well as the Glossary of SMF Terminology. Much more could be done with the Semantic MediaWiki, once we figure it out
New Templates
- Template:Upgrade_FAQ -- a list of FAQs that can be useful when upgrading.
- Template:Code -- to give better formatting to block code samples. See Template:Code for how-to-use documentation.
- Template:For_More_Information -- A standaradized "for more information link" that will not show up if transcluded onto that page (as in a tooltip).
Translation Help Needed
Use the Online_Manual:Translation Portal to post and view information about translation priorities.
