How can I help?

At the moment I'm in the process of importing pages from the old help and updating them. Also updating the tool tips.

Things you can do to help include:

Links to the tool tips pages for each window
Go through any pages in the wiki and look for any reference to one of the Tune Smithy windows. Replace it by a link to the page of all the tool tips help for that window.

E.g. if the help says "Look in the Parts window" change the word Parts there to a link to the tips for the appropriate window, like this:

Look in the Parts window.

(edit this section to see the wiki markup).

Be sure to get the capitalisation right - do it as Window 9, rather than window 9 or WINDOW 9 - since titles in this wiki are case sensitive. You can find the window number in the title of the window when you show it in Tune Smithy.

Some of the tool tip pages aren't very informative at present. Don't be put off by that - I'm going through them right now and updating them. Each will have an introductory section with an overview of how you use the window, and tips for any controls that need extra help.

For an example of what those pages will be like when that is done in a week or two, see Window 5 - New Scale which is close to finished.

Fix Broken links
The urls in the help linking to external sites break frequently. It's not unusual to find that half of them are broken when you revise the help. You can help by going through and updating any broken links - this is a very long task to do by hand, and any help with it is much appreciated.

The best way to locate a site which has moved is often to use the Wayback machine.

Type the old link into the web page there, and you will normally find old versions of the page. Look for the last one in the history. It often has a note on it to say that the page has moved - if so just update to the new link.

If that doesn't work, the next step is to grab some of the text from the old version of the page and put it into the Google search box - that will often take you to the new site.

If that doesn't work either, you may want to try a title search or other google searches.

The page may sometimes have been removed altogether and some get left out of the wayback machine as well.

If you do find the site in the wayback machine, you can change the link to a link to the wayback machine, and put (WAYBACK) after the link so the reader knows that the material there may be out of date.

If you can't find the site at all, put a note after the link saying (BROKEN LINK). Maybe someone else editing this help will know where it has moved to (for instance if the author of the site comes across this help).

New links
Perhaps you may find other useful links at the time, or you may know of links that should be added. If so do add them as well.

Highlighting
The old help used color tags throughout, together with bold case or italics. This is better changed to styles. I update some of them as I go, but others may still be left as the original colors. Also some that should be in colour may not be yet. Follow these examples (edit this section to see the wiki markup you need to use):

Keyboard Shortcut

Navigation

UserInput

WindowTitle

This can make it easier for readers to follow the help.

Add screen shots
Sometimes you can make instructions easier to read if you add screen shots to show the user step by step how it is done in FTS.

You can help by adding more screenshots to this help wherever they seem needed - with more detailed step by step instructions too if the instructions here are cryptic in any way.

If possible reduce the size of the images as this will make the page load more quickly. There I mean - the saved size in KB not the image resolution. You can often make a jpeg for instance into a much smaller and faster loading image by increasing its compression by just a few percent.

A useful free tool for working with images is Paint.net. It is particularly useful for reducing the size of images as it shows the size in the save window, along with a preview to show you what the saved image is like. So you can see how far you can increase the compression of a jpeg for instance, before it begins to deteriorate visually.

You can get it here: Get Paint.net

Add new content
At the moment the most useful content you can add may be new tutorials. If there is something you frequently use Tune Smithy for which isn't covered in the help, then add a tutorial about it for newbie users of the program. You can add your tutorial to the Tutorials page.

If new to wiki editing - it is very easy to start a new page. Just make a link to a new page like this Tutorial: Example Tutorial Link. (Please don't use that one to start a new page).

Then click on your new link and you will be presented with a blank edit window. Enter the text you want to have for the new page, press Save and the page is made.

You can link to your tutorials from the FAQ as well if appropriate, also from the relevant task in the Tasks page once it is done (that page is work in progress right now though)

Please don't add large amounts of content from the old help yet, without consulting me
The help needs to be completely redone and re-organised. Many things in the old help no longer apply to FTS as it is now.

So for now - keep with tutorials and the FAQ as far as new content is concerned, and leave other sections especially the reference type sections for now.

Once the old help is imported, you are welcome to dive in and help to improve any of it. Any suggestions about how to organise it all and so on are very welcome!

Various ways of importing content - from documents, or web pages etc.
If you prefer to work with a Word style document - Open Office has an option to save documents as wiki text which you can copy / paste into the edit window.

If you want to copy / paste from the old help or the web site or other web pages, you can convert Html pages to wiki text using html2wiki (on-line converter) Make sure that you have the author's permission if you copy from any other web site other than robertinventor.com or the FTS help.

WikiEd
This is a useful tool to do such things as search and replace the text in a window, you can also copy / paste web page content and convert it to wiki text.

I haven't installed it for all users as it only works with Firefox, not with Internet Explorer. Also some of its features don't work 100%, but most work very well indeed.

To install it go to your javascript page for your current skin.

It will have a title like this:

User:YourName/monobook.js

Replace YourName there by your user name. If you have changed the skin, replace monobook by the name of your current skin (all lower case).

Add this to the end of that page:

Wiki maintenance - Skins and other add ons
Do you have any skins or other add ons that you would like to see in this wiki. Let me know. Particularly skins are very easy to install, just let me know where to get it, and I'll add it to the wiki.

Wiki maintenance - Sysop
Do you have sysop / admin type experience with MediaWiki?

There's lots to do configuring this wiki. Let me know if there is anything you would like to see installed, or if you have any techy suggestions or tips.