Compiling the Offline Help Manual

Harbinger · June 27, 2009, 03:14:21

I'm going to start assembling the COMPLETE Help manual in an offline format (so that an internet connection is not required), using the few Wiki pages we have, and then going from my own experience. I will also be exploring the threads in these forums for info. Some of you may have already written your own tips that you've never been able to format into the Wiki or elsewhere. If you e-mail me what you have or provide a link if it's not in these forums or in Wiki, i will include your tips and how-to's in the manual.

I'm a pretty good technical instruction writer, and i'd like to make it easier for new users to dive right in. I use MPT exclusively and i'm not getting bored with composing, so i can maintain this manual continuously. I intend to submit sections to our esteemed devs to make sure the info is correct, but once verified, i will post the text here, and everyone can pitch in with corrections to the guide, or additional information that will help any MPT user in a particular subject. The guide will be image-rich!

I'll keep you aware in this thread of Offline Help Manual changes or developments, and you can make any comments here as we go. Please, no threadjacking!

Here's the proposed outline:

1. What is ModPlug Tracker?

2. System Setup

3. MIDI input/output setup

4. Basics of tracking

5. Basics of ModPlug Tracker

6. General setup

7. Using Samples

8. Using Instruments

9. All about Patterns

10.Saving modules
11.Exporting audio files

12.MPT's formats

13.VSTs

14.Tunings

15.Appendix A: FX commands

16.Appendix B: MIDI commands
17.Reference: Menus

18.Reference: Dialogs

19.Reference: Tabs

20.Known Issues

g · June 27, 2009, 08:29:58

I hope you do not considering this threadjacking, but I think it would be a better idea to update the Wiki. In the Wiki there are options to print or export to HTML, PDF, RTF or XAR which I think covers the offline options (an offline guide could easliy be compiled from the Wiki).

Other than that, great initiative!

Rakib · June 27, 2009, 09:19:32

No, a proper updated help file in offline format included with the installation files would be a great help for new MPT users and other who want a quick access to the help files.

uncloned · June 27, 2009, 12:46:20

I'd like off line help too - my music computer is not on the net

Harbinger · June 27, 2009, 21:32:07

Quote from: "g"I hope you do not considering this threadjacking, but I think it would be a better idea to update the Wiki. In the Wiki there are options to print or export to HTML, PDF, RTF or XAR which I think covers the offline options (an offline guide could easliy be compiled from the Wiki).

Other than that, great initiative!

No, this isn't threadjacking. This has every bit to do with the subject at hand.

Concerning the online issue, i'm not on the internet at home, which is my impetus for making this. I want new users to be able to use the help button if they're stuck, without having to be online.

Also, i do not know the Wiki syntax (and i won't be trying to learn), so i won't be doing that. Once (or perhaps AS) everything is written up and posted, someone who can, can post it in the Wiki page, which can be used if an MPT user is online.

Saga Musix · June 27, 2009, 23:08:27

I wonder what the offline help should look like if you're not even willing to learn the wiki syntax (which is very simple) - raw .TXT?
Actually, I'd prefer if there weren't so many documents at all, but rather one big (like the wiki) which can be exported into many formats - for example for offline reading.

Rakib · June 28, 2009, 00:39:09

Use the windows help file system, with chm extension. Here is a software to compile these help files:
HTML Help Workshop and Documentation
https://www.microsoft.com/downloads/details.aspx?familyid=00535334-c8a6-452f-9aa0-d597d16580cc&displaylang=en

http://en.wikipedia.org/wiki/Microsoft_Compiled_HTML_Help

Harbinger · June 28, 2009, 01:28:20

Quote from: "Jojo"I wonder what the offline help should look like if you're not even willing to learn the wiki syntax (which is very simple) - raw .TXT?
Actually, I'd prefer if there weren't so many documents at all, but rather one big (like the wiki) which can be exported into many formats - for example for offline reading.

As i'm writing, i'll just use WORD format, as it's second nature to me. There will be lots of links (between chapters especially) and lots of images, which both WORD and our forum's BBCode can handle.

After that, if anyone wants to translate to HTML (which i'm asserting now, will NOT be me), i can make the original .doc or the original BBCode available to them for translation.

uncloned · June 28, 2009, 03:38:22

Word can save as HTML - not sure how good the html is - but it is a possible route.

LPChip · June 28, 2009, 08:23:44

The wiki also has a tutorial. You should add it to the manual.

Saga Musix · June 28, 2009, 10:27:01

uncloned: Putting "HTML" and "Word" in the same sentence is just... wrong. Microsoft HTML generators tend to output the worst HTML that I've ever seen.

psishock · June 28, 2009, 10:48:47

Quote from: "Jojo"Putting "HTML" and "Word" in the same sentence is just... wrong.

:lol:

uncloned · June 28, 2009, 14:02:58

Quote from: "Jojo"uncloned: Putting "HTML" and "Word" in the same sentence is just... wrong. Microsoft HTML generators tend to output the worst HTML that I've ever seen.

but would it not be closer to the desired final product?

- what about open office - can it do html?

It can certainly import Word files with flying colors

Saga Musix · June 28, 2009, 14:09:46

Not sure if OOo can do it (but if it can do it, the HTML would look much better with no doubt, because it wouldn't use proprietary M$ elements), but it can export to PDF at least, which is also nicht - but it's not as convenient for manuals because searching is more difficult and I don't think that you can call PDFs "dynamically" (with jumping to the correct chapter etc) from an external app like modplug.

uncloned · June 28, 2009, 14:17:15

pdf - yes that is a good option. It preserves Harbinger's work and is a portable monolithic format.