Adding to the ISoft Wiki
From ISoft Wiki
In the interest of making it easy to find information, we have come up with some standards for adding information to the ISoft Wiki.
Contents |
Naming new pages
New page names should match this format:
- First letter of each word uppercase
- All other words all lowercase letters (unless they are proper names)
- If the article applies to a specific product, the article name should begin with one of the following extensions, followed by a backslash:
- ITrack (Articles applicable to all versions of ITrack)
- ITrack/Pro (Articles specific to only ITrack Pro)
- ITrack/Enterprise (Articles specific to only ITrack Enterprise)
- ITrack/AX
- ITrack/U-Pull-It
- Replikwando
- HeavyTruckParts.net
- CycleRecyclers.net
Examples:
Formatting
Wikipedia has a very useful cheat sheet for formatting text in the MediaWiki system.
Wiki articles should follow this general format:
- A quick introduction to the article
- A different section for each topic covered by the article, with subsections where appropriate
- Lists of information should be bulleted or numbered as appropriate
Good practices
There are several things you can do to keep some of the more anal ISoft employees from having to do much editing of your article to get it up to snuff.
- Avoid using formatting methods such as lines and manual newlines (<br>). You should be able to format your article well by using section headings and bullet lists.
- Use paragraph breaks (a blank line between paragraphs) often. If you find yourself typing a paragraph with more than three lines (four as a high max), Duff thinks you're doing it wrong.
- Preview your changes before you save. Seriously. No matter how small your edit is, it's always a good idea.
Categories
To make articles easier to find, we have created a series of Categories for articles to be flagged with. Pages may be in more than one category. For example, an article in the category ITrack/Problems/Error Messages category should also be in the more general ITrack/Problems category.
Moderation by ISoft
All changes will be seen by ISoft employees, and will be edited further if they need to be. This is no reason to not make changes! We would rather have people contributing something mediocre than nothing at all. If you have specific questions, you can email Josh or contact him using the support chat.
Why can't I edit the wiki??
I see by those two question marks that you must be frustrated!
Three things are required to be able to edit the wiki:
- You must have a user account
- You must be logged in
- Your account must have a confirmed email address
As long as those conditions are met, you can edit most pages. A few of the more prominent front pages or categories may be protected so that only ISoft employees can edit them, but there aren't many pages like that.
