TourGuide/Guide Creation

=Introduction= There are two places you can create your own guides in
 * Appending to the TourGuide addon
 * Creating your own Addon Folder

We shall look at Creating your own Addon Folder here.

=Preperation= You will need to access the Interface/Addons folder of World of Warcraft, and then create a new folder. A sample folder name would be TourGuide_UserOwnGuide

=Initial Files= Your folder will be filled with three types of files


 * .toc - the detail of your addon supplemental files, so that it can be controlled from the Addon Menu
 * .xml - a directory of your addon guides
 * .lua - one for each guide you create.

You can either use a basic ASCII editor like Notepad, or you can obtain a custom program such as SciTE to create all these files.

.toc file
Create a text file called TourGuide_MyOwnGuide.toc, and enter the following:

TourGuide_MyOwnGuide.xml
 * 1) Interface: 30200
 * 2) Title: Tour Guide - My Own Guides
 * 3) Notes: My Own Guides
 * 4) Author: Your Name
 * 5) Version: 1.00
 * 6) X-Category: User Guide
 * 7) RequiredDeps: TourGuide
 * 8) OptionalDeps: TomTom
 * 9) DefaultState: enabled
 * 10) LoadManagers: AddonLoader
 * 11) X-LoadOn-Always: delayed

Of course, you can change some of these elements to your own requirements, such as the Title, Notes, Author and version.

.xml file
Create a text file called TourGuide_MyOwnGuide.xml, and enter the following:

  

You will need a line for every script file (.lua) that you have, with the exact filename. If it's not in this .xml file, it won't show up in the game

.toc file
This is the guts of your guides, each guide should have it's own .toc file. Ensure you add the filename to the .xml file created above otherwise it won't show in the game. For this demonstration, create a text file called Guide1.lua, and as a bare minimum, enter:

TourGuide:RegisterGuide("Guide Title", nil, nil, function returnN|This is where your guide will go| end)

Trial Run
After you've completed all the above steps, load up the game and you should find your guide available to select. Of course, it doesn't have much in it, but everything has to start somewhere.

=Customising your Guide= Okay, as said above, the .lua file is the guts of your guide, and that's where to put everything you need for your guide. So, lets go through it all to help you create a wonderful guide.

First off, the file we created above has the line TourGuide:RegisterGuide("Guide Title", "NextGuide", Faction, function This has three customisable parts
 * "Guide Title" - The title as displayed at the top of your guide list, inside Quote Marks
 * The next guide to load up when the current guide is finished in Quote Marks (or enter nil without quotes to not open a new guide)
 * The faction, enter "Alliance", "Horde" or nil (nil is without quotes, Alliance and Horde are with quotes)

Now you need to enter the guide entries one by one. You can use the TourGuide Recorder to help here, with that addon installed, typing /tgr will display a list of all logged entries of what you've just done. To manually create them, this is what you need to enter:

type DisplayTitle |tag|tagnotes|

Type
These are the valid type that can be entered:

Tag
These are the valid tag that can be entered: